-
Notifications
You must be signed in to change notification settings - Fork 0
/
piuparts.1.txt
241 lines (165 loc) · 13.2 KB
/
piuparts.1.txt
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
piuparts(1)
===========
NAME
----
piuparts - .deb installation, upgrade, and removal testing suite
SYNOPSIS
--------
*piuparts* ['-apvV'] ['-d' _distro_] ['-i' _filename_] ['-I' _regexp_] ['-l' _logfile_] ['-m' _url_] ['--bindmount' _dir_] [_package_]... [_changes_file_]...
DESCRIPTION
-----------
*piuparts* tests that Debian packages handle installation, upgrading, and removal correctly. It does this by creating a minimal Debian installation in a chroot, and installing, upgrading, and removing packages in that environment, and comparing the state of the directory tree before and after. *piuparts* reports any files that have been added, removed, or modified during this process.
*piuparts* is meant as a quality assurance tool for people who create Debian packages to test them before they upload them to the Debian package
archive.
By default, piuparts can do three different tests:
. A simple install-purge test within one Debian distribution (chosen with the '-d' option, unstable by default). It sets up the chroot with the desired distribution, then installs and purges the packages, and reports problems.
. A simple install-upgrade-purge test within one Debian distribution. This test is like the install-purge test, but install the packages first via *apt-get* and then from the package files given on the command line. If the command line has package names (option '-a' used), or the packages are not known to *apt-get* (new packages), this test is skipped, otherwise it is performed automatically.
. An upgrade test between Debian releases. This test is enabled by using the '-d' option multiple times and disables the other two tests. It sets up the chroot with the first distribution named, then upgrades it to each successive one, and then remembers the directory tree state at the end. After this, it starts over with the chroot of the first distribution, installs the desired packages (via *apt-get*), and does the successive upgrading (via *apt-get dist-upgrade*). Then, if package files (and not just package names) were given on the command line, it installs them. Finally, it reports problems against the state of the directory tree at the last distribution compared with the state without the packages having been installed. This test can be quite slow to execute.
+
Note that this does not work with experimental, because *apt-get* does not automatically upgrade to packages in experimental. To test a particular package or group of packages in experimental, use the second test.
Command line arguments are the paths to package files (e.g., _piuparts_1.0-1_all.deb_), paths to changes files (e.g., _piuparts_1.0-1_i386.changes_), or names of packages, if the '--apt' option is given.
When processing changes files, by default, all packages in a changes file will be processed together with all individual packages given on the command line. Then each package given on the command line is processed in a single group. If the '--single-changes-list' is used, the packages in all changes files are processed together along with any individual packages that were given on the command line.
*piuparts* outputs to the standard output some log messages to show what is going on. If a log file is used, the messages go there as well.
*piuparts* needs to be run as root.
OPTIONS
-------
Options must come before the other command line arguments.
*-a, --apt*::
The package arguments on the command line are to be treated as package names and installed via *apt-get* instead of being names of package files, to be installed via *dpkg -i*.
*-b* tarball, *--basetgz*='tarball'::
Use tarball as the contents of the initial chroot, instead of building a new one with debootstrap.
+
The tarball can be created with the '-s' option, or you can use one that *pbuilder* has created (see '-p'). If you create one manually, make sure the root of the chroot is the root of the tarball.
*--bindmount*='dir'::
Bind-mount a directory inside the chroot.
*-d* 'name', *--distribution*='name'::
Which Debian distribution to use: a code name (for example lenny, squeeze or sid) or experimental. The default is sid (=unstable).
*-D* 'flavor', *--defaults* 'flavor'::
Use default settings suitable for a particular flavor of Debian: either debian or ubuntu.
*--do-not-verify-signatures*::
Do not verify signatures from the Release files when running debootstrap.
*--dpkg-force-confdef*::
Make dpkg use --force-confdef, which lets dpkg always choose the default action when a modified conffile is found. This option will make piuparts ignore errors it was designed to report and therefore should only be used to hide problems in depending packages. 'This option shall normally not be used.' (See #466118.)
*--dpkg-noforce-unsafe-io*::
Prevent running dpkg with --force-unsafe-io. --force-unsafe-io causes dpkg to skip certain file system syncs known to cause substantial performance degradation on some filesystems. Thus, including this option reverts to safe but slower behavior.
*--no-eatmydata*::
Prevent use of eatmydata.
*--extra-old-packages*='pkg1[,pkg2]...'::
Install additional old packages before upgrading. Allows testing package renames/merges where the old package is no longer available in the new distribution and the new one utilizes Conflicts/Replaces. The argument is a comma separated list of package names and the option can be given multiple times.
*-e* 'dirname', *--existing-chroot*='dirname'::
Use the specified directory as source for the new chroot, instead of building
a new one with debootstrap. This is similar to '--basetgz', but the contents
are not archived.
*-i* 'filename', *--ignore*='filename'::
Add a filename to the list of filenames to be ignored when comparing changes before and after installation. By default, piuparts ignores files that always change during a package installation and uninstallation, such as *dpkg* status files. The filename should be relative to the root of the chroot (e.g., _var/lib/dpkg/status_). This option can be used as many times as necessary.
*-I* 'regexp', *--ignore-regexp*='regexp'::
Add a regular expression pattern to the list of patterns for filenames to be ignored when comparing changes before and after installation. This option can be used as many times as necessary.
*-k, --keep-tmpdir*::
Don't remove the temporary directory for the chroot when the program ends.
*-K, --keyring*='filename'::
Use FILE as the keyring to use with debootstrap when creating chroots.
*--keep-sources-list*::
Don't modify the chroot's etc/apt/sources.list (only makes sense with '--basetgz').
*--list-installed-files*::
List the files added to the chroot after the installation of the package and after the installation of the package dependencies.
*--lvm-volume*='lvm-volume'::
Use the specified lvm-volume as source for the chroot, instead of building a
new one with debootstrap. This creates a snapshot of the given LVM volume and
mounts it to the chroot path.
*--lvm-snapshot-size*='snapshot-size'::
Use the specified snapshot-size as snapshot size when creating a new LVM
snapshot (default: 1G)
*-l* 'filename', *--log-file*='filename'::
Write log file to _filename_ in addition to the standard output.
*--log-level*='level'::
Display messages from loglevel LEVEL, possible values are: error, info, dump, debug. The default is dump.
*-m* 'url', *--mirror*='url'::
Which Debian mirror to use. The default is the first mirror named in _/etc/apt/sources.list_ or _http://ftp.debian.org/_ if none is found. This option may be used multiple times to use multiple mirrors. Only the first mirror is used with *debootstrap*.
+
The 'components' that are used for a mirror can also be set with this option: a space separated list within the same argument (so you need to quote the entire argument in the shell). If no components are given explicitly, the usual Debian components are used (main, contrib, and non-free). For the mirrors read from _/etc/apt/sources.list_, the components are read from the same place.
+
Note that file: addresses works if the directories are made accessible from within the chroot with '--bindmount'.
*--no-diversions*::
Don't check for broken diversions.
*-n, --no-ignores*::
Forget all built-in and other ignores that have been set so far. Any '-i' or '-I' arguments that come after this one will be obeyed, but none of the ones that come before.
*-N, --no-symlinks*::
Don't check for broken symlinks.
*--fail-on-broken-symlinks*::
Fail on broken symlinks. The default is to just issue those errors as warnings.
*--no-upgrade-test*::
Skip testing upgrade from an existing version in the archive.
*--no-install-purge-test*::
Skip the install and purge test.
*-p, --pbuilder*::
Use _/var/cache/pbuilder/base.tgz_ as the base tarball. This is a shorthand so that you don't need to use '-b' for it.
*--pedantic-purge-test*::
Be pedantic when checking if a purged package leaves files behind. If this option is not set, files left in _/tmp_ are ignored.")
*-s* 'filename', *--save*='filename'::
Save the chroot, after it has been set up, as a tarball into _filename_. It can then be used with '-b'.
*-B* 'FILE', *--end-meta*='FILE'::
Load chroot package selection and file meta data from FILE. See the function install_and_upgrade_between_distros() in piuparts.py for defaults. Mostly useful for large scale distro upgrade tests.
*-S* 'FILE', *--save-end-meta*='FILE'::
Save chroot package selection and file meta data in FILE for later use. See the function install_and_upgrade_between_distros() in piuparts.py for defaults. Mostly useful for large scale distro upgrade tests.
*--scriptsdir*='DIR'::
Directory where are placed the custom scripts. For more information about this, read README.txt
*--single-changes-list*::
When processing changes files, piuparts will process the packages in each individual changes file seperately. This option will set piuparts to scan the packages of all changes files together along with any individual package files that may have been given on the command line.
*--skip-minimize*::
Allow skip minimize chroot step. This is useful when you want to test several packages with piuparts. You can prepare a tarball already minimized and skip this step in all the tests. This is the default now.
*--minimize*::
Minimize the chroot with debfoster. This used to be the default until #539142 was fixed.
*--skip-cronfiles-test*::
Skip testing the output from the cron files left in the system after remove a package.
*--skip-logrotatefiles-test*::
Skip testing the output from the logrotate files left in the system after remove a package.
*-t directory, --tmpdir*='directory'::
Use directory as the place where temporary files and directories are created. The default is the environment variable *TMPDIR*, or _/tmp_ if not set.
*-v, --verbose*::
This option no longer has any meaning, but it is still accepted for backwards compatibility.
*-V, --version*::
Write out the version number of the program.
*--warn-on-leftovers-after-purge*::
Print a warning rather than failing if files are left behind after purge.
*--warn-on-others*::
Print a warning rather than failing if files are left behind, modified, or removed by a package that was not given on the command-line.
+
This way, you can basically isolate the purge test to your own packages. If a package that is brought in as a dependency doesn't purge cleanly, the test will not fail because of it (but a warning message will be printed).
+
Behavior with multiple packages given on the command-line could be problematic, particularly if the dependency tree of one package in the list includes another in the list. Therefore, it is recommended to use this option with one package at a time.
EXAMPLES
--------
Assume that you have just built a new version of your Debian package, to be uploaded to Debian unstable. It is in _../foo_1.0-2_i386.deb_ and you would like to know whether it installs and uninstalls properly. Here's what you would do:
----
piuparts ../foo_1.0-2_i386.deb
----
If the package exists in the Debian archive already, the above command also tests that it upgrades properly.
To do the same test, but using a particular mirror, and only the main component, you would do this:
----
piuparts -m 'http://gytha/debian main' ../foo_1.0-2_i386.deb
----
If you want to do the same as above but for your changes files, pass in your changes files when running piuparts, and piuparts will process each package in the changes files as though you had passed all those packages on the command line to piuparts yourself. For example:
----
piuparts ../foo_1.0-2_i386.changes
piuparts -m 'http://gytha/debian main' ../foo_1.0-2_i386.changes
----
If you want to test that a package installs properly in the stable (currently lenny) Debian release, then can be upgraded to the testing (currently squeeze) and unstable (sid) versions, and then uninstalled without problems, you would give the following command:
----
piuparts -a -d lenny -d squeeze -d sid foo
----
ENVIRONMENT
-----------
*TMPDIR* Location for temporary files and directories. If not set, use _/tmp_. See also the '-t' ('--tmpdir') option.
NOTES
-----
Output of commands run by piuparts is limited to three megabytes. To change this limit, the source code needs to be edited.
Commands exceeding this limit will be aborted.
SEE ALSO
--------
*pbuilder*(1), *debootstrap*(8)
AUTHOR
------
Lars Wirzenius ([email protected]) and others
DATE
----
2011-12-06