~cjwatson/debconf/dbus

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
my $tmp_base_dir = "/tmp/debconf-test";

package CopyDBTestSetup;

use strict;
use Test::Debconf::DbDriver::SLAPD;
use base qw(Test::Unit::Setup);

sub set_up{
	my $self = shift();

	system("mkdir -p $tmp_base_dir") == 0
		or die "Can not create tmp data directory";

	$self->{slapd} = Test::Debconf::DbDriver::SLAPD->new('localhost',9009,$tmp_base_dir);
	$self->{slapd}->slapd_start();
}

sub tear_down{
	my $self = shift();
    
	$self->{slapd}->slapd_stop();
}

package Test::CopyDBTest;
use strict;
use File::Temp;
use Debconf::Config;
use Debconf::Db;
use Debconf::DbDriver::Backup;
use Debconf::Gettext;
use Debconf::Template;
use FreezeThaw qw(cmpStr freeze);
use Test::Unit::TestSuite;
use base qw(Test::Unit::TestCase);


sub new {
	my $self = shift()->SUPER::new(@_);
	return $self;
}


=head1 METHODS

This is the list of common tests used to validate debconf-copydb.
'test_item_*' methods create an item , put it on source db , copy it to dest db and
test if the result is ok and respect the pattern passed.

=cut

sub test_item_1 {
	my $self = shift;
	$self->{testname} = 'test_item_1';
	my $owner = 'debconf-test';
	my $name = "$owner/$self->{testname}";
	my $type = "note";

	Debconf::Template->new($name,$owner,$type);

	my $item = {
		name => "$name",
		entry => { 
			owners => { "$owner" => 1},
			fields => { template => "$name"},
			variables => {},
		}
	}; 

	$self->{assert} = sub {
		my $item_config_entry = shift;
		my $entry_from_db = shift;
		my $result = cmpStr($item_config_entry, $entry_from_db);
#		print "src: ",freeze($item_config_entry),"\n";
#		print "dest: ",freeze($entry_from_db),"\n";
		$self->assert($result == 0, 
			      'item saved in database differs from the original item');
	};

	@{$self->{src_db_names}} = ('configdb','dirtreedb','packdirdb','ldapdb',);
	@{$self->{dest_db_names}} = ('packdirdb','filedb','dirtreedb','ldapdb',);

	$self->{pattern} = '.*';
	$self->go_test_copy($item,$owner);
}

# Closes: #201431
sub test_201431 {
	my $self = shift;
	$self->{testname} = 'test_item_2';
	my $owner = 'passwd';
	my $name = "$owner/passwd-empty";
	my $type = "note";

	# item for testing
	Debconf::Template->new($name,$owner,$type);

	my $item = { 
		name => "$name",
		entry => { 
			owners => { "$owner" => 1},
			fields => { template => "$name"},
			flags => {},
			variables => {},
		}
	}; 

	$self->{assert} = sub {
		my $item_config_entry = shift;
		my $entry_from_db = shift;
		$self->assert_null($entry_from_db, 
			      'item saved in database differs from the original item');
	};

	@{$self->{src_db_names}} = ('configdb','dirtreedb','packdirdb','ldapdb',);
	@{$self->{dest_db_names}} = ('passwddb',);

	$self->{pattern} = '^passwd/';
	$self->go_test_copy($item, $owner);

}

sub add_item_in_db {
	my $self = shift;
	my $item = shift;
	my $owner = shift;
	my $dbdriver = shift;

	$dbdriver->addowner($item->{name}, $owner);

	foreach my $field (keys %{$item->{entry}->{fields}}) {
		$dbdriver->setfield($item->{name}, $field, $item->{entry}->{fields}->{$field});
	}
	foreach my $flag (keys %{$item->{entry}->{flags}}) {
		$dbdriver->setflag($item->{name}, $flag, $item->{entry}->{flags}->{$flag});
	}
	foreach my $variable (keys %{$item->{entry}->{variables}}) {
		$dbdriver->setvariable($item->{name}, $variable, $item->{entry}->{variables}->{$variable});
	}

	# force to flush
	$self->db_reload();
}

sub go_test_copy {
	my $self = shift;
	my $item = shift;
	my $owner = shift;

	# test to copy item from each src databases  
	my @src_db_names = @{$self->{src_db_names}};
	foreach my $src_db_name (@src_db_names) {

		# test to copy item in all dest databases  
		my @dest_db_names = @{$self->{dest_db_names}};
		foreach my $dest_db_name (@dest_db_names) {
			
			# add item in src db
			$self->add_item_in_db($item, $owner, Debconf::DbDriver->driver($src_db_name));

			$self->copydb(Debconf::DbDriver->driver($src_db_name),
				      Debconf::DbDriver->driver($dest_db_name),
				      'file2file',
				      $self->{pattern});
			
			# force to flush
			$self->db_reload();
			
			my $entry_copied = Debconf::DbDriver->driver($dest_db_name)->cached($item->{'name'});
			
			# test copy result
			my $assert = $self->{assert};
			&$assert($item->{entry}, $entry_copied);

			Debconf::DbDriver->driver($src_db_name)->removeowner($item->{name}, $owner);
			Debconf::DbDriver->driver($dest_db_name)->removeowner($item->{name}, $owner);
		}
	}
}
	

sub copydb {
	my $self = shift;
	my $src_driver = shift;
	my $dest_driver = shift;
	my $name = shift;
	my $pattern = shift;
	my $owner_pattern = shift;
	
# Set up a copier to handle copying from one to the other.
#	my $src = Debconf::DbDriver->driver("configdb");
	my $copier = Debconf::DbDriver::Backup->new(
						    db => $src_driver, 
						    backupdb => $dest_driver, 
						    name => $name);

# Now just iterate over all items in src that patch the pattern, and tell
# the copier to make a copy of them.
	my $i=$copier->iterator;
	while (my $item=$i->iterate) {
		next unless $item =~ /$pattern/;
		
		if (defined $owner_pattern) {
			my $fit_owner = 0;
			my $owner;
			foreach $owner ($src_driver->owners($item)){
				$fit_owner = 1 if $owner =~ /$owner_pattern/;
			}
			next unless $fit_owner;
		}
		$copier->copy($item, $src_driver, $dest_driver);
	}
	
	$copier->shutdown;

}

sub db_reload {
	my $self = shift;

	# FIXME: we loop on all drivers because Debconf::Db->save shutdown only
	# drivers which are declared in Config and Templates in conf file
	# hope to be fixed soon
#	Debconf::Db->save;
	foreach my $driver_name (keys %Debconf::DbDriver::drivers) {
		Debconf::DbDriver->driver($driver_name)->shutdown;
	}
	Debconf::Db->load;
}

sub db_init {
	my $self = shift;
	chomp(my $pwd = `pwd`);

	# config temp file
	$self->{config_file} = new File::Temp( DIR => $self->{tmp_dir});
	$self->{config_filename} = $self->{config_file}->filename;

	# template temp file
	$self->{template_file} = new File::Temp( DIR => $self->{tmp_dir});
	$self->{template_filename} = $self->{template_file}->filename;

	# filedb temp file
	$self->{filedb_file} = new File::Temp( DIR => $self->{tmp_dir});
	$self->{filedb_filename} = $self->{filedb_file}->filename;

	# dirtreedb temp dir
	$self->{dirtreedb_dir} = File::Temp->tempdir('dirtreedb-XXXX', DIR => $self->{tmp_dir});

	# packdirdb temp dir
	$self->{packdirdb_dir} = File::Temp->tempdir('packdirdb-XXXX', DIR => $self->{tmp_dir});

	# passwddb temp file
	$self->{passwddb_file} = new File::Temp( DIR => $self->{tmp_dir});
	$self->{passwddb_filename} = $self->{passwddb_file}->filename;

	# build conf file
	$self->{conf_file} = new File::Temp( DIR => $self->{tmp_dir});
	$self->{conf_filename} = $self->{conf_file}->filename;
	open(OUTFILE, ">$self->{conf_filename}");
	print OUTFILE gettext(<<EOF);
Config: configdb
Templates: templatedb

Name: configdb
Driver: File
Mode: 644
Filename: $self->{config_filename}

Name: filedb
Driver: File
Mode: 644
Filename: $self->{filedb_filename}

Name: dirtreedb
Driver: DirTree
Directory: $self->{dirtreedb_dir}

Name: packdirdb
Driver: PackageDir
Directory: $self->{packdirdb_dir}

Name: ldapdb
Driver: LDAP
Server: localhost
Port: 9009
BaseDN: cn=debconf,dc=debian,dc=org
BindDN: cn=admin,dc=debian,dc=org
BindPasswd: debian

Name: passwddb
Driver: File
Filename: $self->{passwddb_filename}
Mode: 600
Accept-Type: password

Name: templatedb
Driver: File
Mode: 644
Filename: $self->{template_filename}

EOF

	close OUTFILE;
	
	# the only solution to test debconf-copydb with
	# different conf file => VERY UGLY
	@Debconf::Config::config_files =("$self->{conf_filename}");
	Debconf::Db->load;
}

sub set_up {
	my $self = shift;

#	system("mkdir -p $tmp_base_dir") == 0
#		or die "Can not create tmp data directory";

	$self->{tmp_dir} = $tmp_base_dir;
#	$self->{slapd} = Test::Debconf::DbDriver::SLAPD->new('localhost',9009,$self->{tmp_dir});
#	$self->{slapd}->slapd_start();
	$self->db_init();
}

sub tear_down {
	my $self = shift;

	Debconf::Db->save;
#	$self->{slapd}->slapd_stop();

#	system("rm -rf $self->{tmp_dir}") == 0
#		or die "Can not delete tmp data directory";
}

sub suite {
	my $self = shift;

	my $testsuite = Test::Unit::TestSuite->new(__PACKAGE__);
	my $wrapper = CopyDBTestSetup->new($testsuite);
    
	return $wrapper;
}
1;