1bpkg-pkg-test(1)            General Commands Manual           bpkg-pkg-test(1)
2
3
4

NAME

6       bpkg-pkg-test - test package
7

SYNOPSIS

9       bpkg pkg-test|test [options] [vars] pkg...
10       bpkg pkg-test|test [options] [vars] --all|-a
11       bpkg pkg-test|test [options] [vars] (--all-pattern <pattern>)...
12

DESCRIPTION

14       The pkg-test command tests the specified packages (the first form), all
15       the held packages (the second form, see bpkg-pkg-status(1)), or all the
16       held  packages  that  match any of the specified wildcard patterns (the
17       third form). Additionally, immediate or all dependencies of these pack‐
18       ages  can  also  be tested by specifying the --immediate|-i or --recur‐
19       sive|-r options, respectively. Underneath, this command doesn't do much
20       more  than  run  b  test. In the first form the specified packages must
21       have been previously configured with bpkg-pkg-build(1) or bpkg-pkg-con‐
22       figure(1).
23
24       Additional  command  line  variables  (vars,  normally config.*) can be
25       passed to the build system. Such variables apply to all  the  specified
26       packages  but  can also be specified to only apply to specific packages
27       using the argument grouping  mechanism  (see  bpkg-argument-grouping(1)
28       for details).
29

PKG-TEST OPTIONS

31       --all|-a
32              Test all held packages.
33
34       --all-pattern pattern
35              Test  held  packages  that match the specified wildcard pattern.
36              Repeat this option to match multiple patterns. Note that you may
37              need to quote the pattern to prevent expansion by your shell.
38
39       --immediate|-i
40              Also test immediate dependencies.
41
42       --recursive|-r
43              Also test all dependencies, recursively.
44
45       --package-cwd
46              Change  the  current  working directory to the package directory
47              prior to running tests. This may help ported  third-party  pack‐
48              ages since its not uncommon for tests to expect they are running
49              form the project root directory.
50
51       --directory|-d dir
52              Assume configuration is in dir rather than in the current  work‐
53              ing directory.
54

COMMON OPTIONS

56       The  common  options are summarized below with a more detailed descrip‐
57       tion available in bpkg-common-options(1).
58
59       -v     Print essential underlying commands being executed.
60
61       -V     Print all underlying commands being executed.
62
63       --quiet|-q
64              Run quietly, only printing error messages.
65
66       --verbose level
67              Set the diagnostics verbosity to level between 0 and 6.
68
69       --stdout-format format
70              Representation format to use for printing to stdout.
71
72       --jobs|-j num
73              Number of jobs to perform in parallel.
74
75       --no-result
76              Don't print informational messages about the outcome of perform‐
77              ing a command or some of its parts.
78
79       --structured-result fmt
80              Write the result of performing a command in a structured form.
81
82       --progress
83              Display progress indicators for long-lasting operations, such as
84              network transfers, building, etc.
85
86       --no-progress
87              Suppress progress indicators for long-lasting  operations,  such
88              as network transfers, building, etc.
89
90       --diag-color
91              Use color in diagnostics.
92
93       --no-diag-color
94              Don't use color in diagnostics.
95
96       --build path
97              The build program to be used to build packages.
98
99       --build-option opt
100              Additional option to be passed to the build program.
101
102       --fetch path
103              The fetch program to be used to download resources.
104
105       --fetch-option opt
106              Additional option to be passed to the fetch program.
107
108       --fetch-timeout sec
109              The fetch and fetch-like (for example, git) program timeout.
110
111       --pkg-proxy url
112              HTTP proxy server to use when fetching package manifests and ar‐
113              chives from remote pkg repositories.
114
115       --git path
116              The git program to be used to fetch git repositories.
117
118       --git-option opt
119              Additional common option to be passed to the git program.
120
121       --sha256 path
122              The sha256 program to be used to calculate SHA256 sums.
123
124       --sha256-option opt
125              Additional option to be passed to the sha256 program.
126
127       --tar path
128              The tar program to be used to extract package archives.
129
130       --tar-option opt
131              Additional option to be passed to the tar program.
132
133       --openssl path
134              The openssl program to be used for crypto operations.
135
136       --openssl-option opt
137              Additional option to be passed to the openssl program.
138
139       --auth type
140              Types of repositories to authenticate.
141
142       --trust fingerprint
143              Trust repository certificate with a SHA256 fingerprint.
144
145       --trust-yes
146              Assume the answer to all authentication prompts is yes.
147
148       --trust-no
149              Assume the answer to all authentication prompts is no.
150
151       --git-capabilities up=pc
152              Protocol capabilities (pc) for a git repository URL prefix (up).
153
154       --pager path
155              The pager program to be used to show long text.
156
157       --pager-option opt
158              Additional option to be passed to the pager program.
159
160       --options-file file
161              Read additional options from file.
162
163       --default-options dir
164              The directory to load additional default options files from.
165
166       --no-default-options
167              Don't load default options files.
168
169       --keep-tmp
170              Don't remove the bpkg's temporary directory at the  end  of  the
171              command execution and print its path at the verbosity level 2 or
172              higher.
173

DEFAULT OPTIONS FILES

175       See bpkg-default-options-files(1) for an overview of  the  default  op‐
176       tions files. For the pkg-test command the search start directory is the
177       configuration directory. The following options files are  searched  for
178       in each directory and, if found, loaded in the order listed:
179
180       bpkg.options
181       bpkg-pkg-test.options
182
183       The  following  pkg-test command options cannot be specified in the de‐
184       fault options files:
185
186       --directory|-d
187

BUGS

189       Send bug reports to the users@build2.org mailing list.
190
192       Copyright (c) 2014-2023 the build2 authors.
193
194       Permission is granted to copy, distribute and/or modify  this  document
195       under the terms of the MIT License.
196
197
198
199bpkg 0.16.0                        June 2023                  bpkg-pkg-test(1)
Impressum