Debian Codegraph @

Test/CopyDBTest.pm

raw
1 package CopyDBTestSetup; ## no critic (Modules::RequireFilenameMatchesPackage)
2
3 use warnings;
4 use strict;
5 use Test::Debconf::DbDriver::SLAPD;
6 use base qw(Test::Unit::Setup);
7
8 my $tmp_base_dir = "/tmp/debconf-test";
9
10 sub set_up{
11 my $self = shift();
12
13 system("mkdir -p $tmp_base_dir") == 0
14 or die "Can not create tmp data directory";
15
16 $self->{slapd} = Test::Debconf::DbDriver::SLAPD->new('localhost',9009,$tmp_base_dir);
17 $self->{slapd}->slapd_start();
18 }
19
20 sub tear_down{
21 my $self = shift();
22
23 $self->{slapd}->slapd_stop();
24 }
25
26 package Test::CopyDBTest;
27 use strict;
28 use File::Temp;
29 use Debconf::Config;
30 use Debconf::Db;
31 use Debconf::DbDriver::Backup;
32 use Debconf::Gettext;
33 use Debconf::Template;
34 use FreezeThaw qw(cmpStr freeze);
35 use Test::Unit::TestSuite;
36 use base qw(Test::Unit::TestCase);
37
38
39 sub new {
40 my $self = shift()->SUPER::new(@_);
41 return $self;
42 }
43
44
45 =head1 METHODS
46
47 This is the list of common tests used to validate debconf-copydb.
48 'test_item_*' methods create an item , put it on source db , copy it to dest db and
49 test if the result is ok and respect the pattern passed.
50
51 =cut
52
53 sub test_item_1 {
54 my $self = shift;
55 $self->{testname} = 'test_item_1';
56 my $owner = 'debconf-test';
57 my $name = "$owner/$self->{testname}";
58 my $type = "note";
59
60 Debconf::Template->new($name,$owner,$type);
61
62 my $item = {
63 name => "$name",
64 entry => {
65 owners => { "$owner" => 1},
66 fields => { template => "$name"},
67 variables => {},
68 }
69 };
70
71 $self->{assert} = sub {
72 my $item_config_entry = shift;
73 my $entry_from_db = shift;
74 my $result = cmpStr($item_config_entry, $entry_from_db);
75 # print "src: ",freeze($item_config_entry),"\n";
76 # print "dest: ",freeze($entry_from_db),"\n";
77 $self->assert($result == 0,
78 'item saved in database differs from the original item');
79 };
80
81 @{$self->{src_db_names}} = ('configdb','dirtreedb','packdirdb','ldapdb',);
82 @{$self->{dest_db_names}} = ('packdirdb','filedb','dirtreedb','ldapdb',);
83
84 $self->{pattern} = '.*';
85 $self->go_test_copy($item,$owner);
86 }
87
88 # Closes: #201431
89 sub test_201431 {
90 my $self = shift;
91 $self->{testname} = 'test_item_2';
92 my $owner = 'passwd';
93 my $name = "$owner/passwd-empty";
94 my $type = "note";
95
96 # item for testing
97 Debconf::Template->new($name,$owner,$type);
98
99 my $item = {
100 name => "$name",
101 entry => {
102 owners => { "$owner" => 1},
103 fields => { template => "$name"},
104 flags => {},
105 variables => {},
106 }
107 };
108
109 $self->{assert} = sub {
110 my $item_config_entry = shift;
111 my $entry_from_db = shift;
112 $self->assert_null($entry_from_db,
113 'item saved in database differs from the original item');
114 };
115
116 @{$self->{src_db_names}} = ('configdb','dirtreedb','packdirdb','ldapdb',);
117 @{$self->{dest_db_names}} = ('passwddb',);
118
119 $self->{pattern} = '^passwd/';
120 $self->go_test_copy($item, $owner);
121
122 }
123
124 sub add_item_in_db {
125 my $self = shift;
126 my $item = shift;
127 my $owner = shift;
128 my $dbdriver = shift;
129
130 $dbdriver->addowner($item->{name}, $owner);
131
132 foreach my $field (keys %{$item->{entry}->{fields}}) {
133 $dbdriver->setfield($item->{name}, $field, $item->{entry}->{fields}->{$field});
134 }
135 foreach my $flag (keys %{$item->{entry}->{flags}}) {
136 $dbdriver->setflag($item->{name}, $flag, $item->{entry}->{flags}->{$flag});
137 }
138 foreach my $variable (keys %{$item->{entry}->{variables}}) {
139 $dbdriver->setvariable($item->{name}, $variable, $item->{entry}->{variables}->{$variable});
140 }
141
142 # force to flush
143 $self->db_reload();
144 }
145
146 sub go_test_copy {
147 my $self = shift;
148 my $item = shift;
149 my $owner = shift;
150
151 # test to copy item from each src databases
152 my @src_db_names = @{$self->{src_db_names}};
153 foreach my $src_db_name (@src_db_names) {
154
155 # test to copy item in all dest databases
156 my @dest_db_names = @{$self->{dest_db_names}};
157 foreach my $dest_db_name (@dest_db_names) {
158
159 # add item in src db
160 $self->add_item_in_db($item, $owner, Debconf::DbDriver->driver($src_db_name));
161
162 $self->copydb(Debconf::DbDriver->driver($src_db_name),
163 Debconf::DbDriver->driver($dest_db_name),
164 'file2file',
165 $self->{pattern});
166
167 # force to flush
168 $self->db_reload();
169
170 my $entry_copied = Debconf::DbDriver->driver($dest_db_name)->cached($item->{'name'});
171
172 # test copy result
173 my $assert = $self->{assert};
174 &$assert($item->{entry}, $entry_copied);
175
176 Debconf::DbDriver->driver($src_db_name)->removeowner($item->{name}, $owner);
177 Debconf::DbDriver->driver($dest_db_name)->removeowner($item->{name}, $owner);
178 }
179 }
180 }
181
182
183 sub copydb {
184 my $self = shift;
185 my $src_driver = shift;
186 my $dest_driver = shift;
187 my $name = shift;
188 my $pattern = shift;
189 my $owner_pattern = shift;
190
191 # Set up a copier to handle copying from one to the other.
192 # my $src = Debconf::DbDriver->driver("configdb");
193 my $copier = Debconf::DbDriver::Backup->new(
194 db => $src_driver,
195 backupdb => $dest_driver,
196 name => $name);
197
198 # Now just iterate over all items in src that patch the pattern, and tell
199 # the copier to make a copy of them.
200 my $i=$copier->iterator;
201 while (my $item=$i->iterate) {
202 next unless $item =~ /$pattern/;
203
204 if (defined $owner_pattern) {
205 my $fit_owner = 0;
206 foreach my $owner ($src_driver->owners($item)){
207 $fit_owner = 1 if $owner =~ /$owner_pattern/;
208 }
209 next unless $fit_owner;
210 }
211 $copier->copy($item, $src_driver, $dest_driver);
212 }
213
214 $copier->shutdown;
215
216 }
217
218 sub db_reload {
219 my $self = shift;
220
221 # FIXME: we loop on all drivers because Debconf::Db->save shutdown only
222 # drivers which are declared in Config and Templates in conf file
223 # hope to be fixed soon
224 # Debconf::Db->save;
225 foreach my $driver_name (keys %Debconf::DbDriver::drivers) {
226 Debconf::DbDriver->driver($driver_name)->shutdown;
227 }
228 Debconf::Db->load;
229 }
230
231 sub db_init {
232 my $self = shift;
233 chomp(my $pwd = `pwd`);
234
235 # config temp file
236 $self->{config_file} = File::Temp->new( DIR => $self->{tmp_dir});
237 $self->{config_filename} = $self->{config_file}->filename;
238
239 # template temp file
240 $self->{template_file} = File::Temp->new( DIR => $self->{tmp_dir});
241 $self->{template_filename} = $self->{template_file}->filename;
242
243 # filedb temp file
244 $self->{filedb_file} = File::Temp->new( DIR => $self->{tmp_dir});
245 $self->{filedb_filename} = $self->{filedb_file}->filename;
246
247 # dirtreedb temp dir
248 $self->{dirtreedb_dir} = File::Temp->tempdir('dirtreedb-XXXX', DIR => $self->{tmp_dir});
249
250 # packdirdb temp dir
251 $self->{packdirdb_dir} = File::Temp->tempdir('packdirdb-XXXX', DIR => $self->{tmp_dir});
252
253 # passwddb temp file
254 $self->{passwddb_file} = File::Temp->new( DIR => $self->{tmp_dir});
255 $self->{passwddb_filename} = $self->{passwddb_file}->filename;
256
257 # build conf file
258 $self->{conf_file} = File::Temp->new( DIR => $self->{tmp_dir});
259 $self->{conf_filename} = $self->{conf_file}->filename;
260 open(my $outfile, ">", $self->{conf_filename});
261 print $outfile gettext(<<EOF);
262 Config: configdb
263 Templates: templatedb
264
265 Name: configdb
266 Driver: File
267 Mode: 644
268 Filename: $self->{config_filename}
269
270 Name: filedb
271 Driver: File
272 Mode: 644
273 Filename: $self->{filedb_filename}
274
275 Name: dirtreedb
276 Driver: DirTree
277 Directory: $self->{dirtreedb_dir}
278
279 Name: packdirdb
280 Driver: PackageDir
281 Directory: $self->{packdirdb_dir}
282
283 Name: ldapdb
284 Driver: LDAP
285 Server: localhost
286 Port: 9009
287 BaseDN: cn=debconf,dc=debian,dc=org
288 BindDN: cn=admin,dc=debian,dc=org
289 BindPasswd: debian
290
291 Name: passwddb
292 Driver: File
293 Filename: $self->{passwddb_filename}
294 Mode: 600
295 Accept-Type: password
296
297 Name: templatedb
298 Driver: File
299 Mode: 644
300 Filename: $self->{template_filename}
301
302 EOF
303
304 close $outfile;
305
306 # the only solution to test debconf-copydb with
307 # different conf file => VERY UGLY
308 @Debconf::Config::config_files =("$self->{conf_filename}");
309 Debconf::Db->load;
310 }
311
312 sub set_up {
313 my $self = shift;
314
315 # system("mkdir -p $tmp_base_dir") == 0
316 # or die "Can not create tmp data directory";
317
318 $self->{tmp_dir} = $tmp_base_dir;
319 # $self->{slapd} = Test::Debconf::DbDriver::SLAPD->new('localhost',9009,$self->{tmp_dir});
320 # $self->{slapd}->slapd_start();
321 $self->db_init();
322 }
323
324 sub tear_down {
325 my $self = shift;
326
327 Debconf::Db->save;
328 # $self->{slapd}->slapd_stop();
329
330 # system("rm -rf $self->{tmp_dir}") == 0
331 # or die "Can not delete tmp data directory";
332 }
333
334 sub suite {
335 my $self = shift;
336
337 my $testsuite = Test::Unit::TestSuite->new(__PACKAGE__);
338 my $wrapper = CopyDBTestSetup->new($testsuite);
339
340 return $wrapper;
341 }
342 1;