pkglint - Image Packaging System package lint
/usr/bin/pkglint [-c cache_dir] [-r repo_uri]... [-p regexp] [-e extension_path] [-f config_file] [-b branch] [-v] [-l lint_uri]... | manifest ...
/usr/bin/pkglint -L [-v]
pkglint runs a series of checks on one or more package manifests, optionally referencing another repository.
pkglint should be used during the package authoring process, prior to package publication. pkglint performs exhaustive testing on the manifests that might be too expensive to perform during normal operation of pkgsend or pkg.depotd. pkglint checks include tests for duplicate actions, missing attributes, and unusual file permissions.
Manifests for linting can be passed as a space-separated list of local files on the command line, or manifests can be retrieved from a repository.
When retrieving manifests from repositories, on first run pkglint creates and populates pkg(7) user images in the specified cache directory. If the –r option is supplied, a user image named cache_dir/ref_image is created for the reference repository. If the –l option is supplied, a user image named cache_dir/lint_image is created for the lint repository. No content is installed in these images. These images are only used by pkglint to retrieve manifests from the repositories.
Subsequent invocations of pkglint can reuse the cache directory and can omit any –r or –l arguments.
pkglint provides limited support for configuring publishers in the cache directory. Use pkg to perform more complex publisher configuration on these images.
pkglint allows package authors to bypass checks for a given manifest or action. A manifest or action that contains the attribute pkg.linted set to True does not produce any lint output for that manifest or action.
More granular pkg.linted settings can be made using substrings of pkglint check names. For example, pkg.linted. check.id set to True bypasses all checks with the name check.id for the given manifest or action.
The behavior of pkglint can be configured by specifying a pkglintrc file. By default, pkglint searches in /usr/share/lib/pkg/pkglintrc and $HOME/.pkglintrc for configuration options. Use the –f option to specify a different configuration file.
During the lint run, any errors or warnings encountered are printed to stderr.
The following options are supported:
Display a usage message.
Specify a branch used to narrow the list of packages used during linting from lint and reference repositories. If no –b option is specified, the latest versions of packages are used. See also the version.pattern configuration property.
Specify a local directory used for caching package metadata from the lint and reference repositories.
Specify a URI representing the location of the lint repository. Both HTTP and file system based publication are supported. If you specify –l, then you must also specify –c. The –l option can be specified multiple times.
List the known and excluded lint checks and then exit. Display the short name and description of each check. When combined with the –v flag, display the method that implements the check instead of the description.
Configure the pkglint session using the config_file configuration file.
Directory to add to the Python search path when loading pkglint extensions.
Specify a regular expression used to narrow the list of packages to be checked from the lint repository. All manifests from the reference repository are loaded (assuming they match the value for –b, if supplied), ignoring this pattern.
Specify a URI representing the location of the reference repository. If you specify –r, then you must also specify –c. The –r option can be specified multiple times.
Run pkglint in a verbose mode, overriding any log_level settings in the configuration file.
The pkglintrc configuration file takes the following key/value arguments:
The minimum level at which to emit lint messages. Lint messages lower than this level are discarded. The default value is INFO.
Log levels in order of least to most severe are DEBUG, INFO, WARNING, ERROR, and CRITICAL.
If True, perform checks that might only make sense for published packages. The default value is True.
The plugin mechanism of pkglint allows for additional lint modules to be added at runtime. Any key that starts with pkglint.ext. takes a value that must be a fully-specified Python module. See the “Developers” section for more information. The extension_path option specifies additional directory locations to search when loading extensions
An list of directories, separated by ':' no most platforms, to search for extension modules. If the -e flag is specified on the CLI it is added higher in the search order than this config file option.
A space-separated list of fully specified Python modules, classes, or function names to omit from the set of checks performed.
If True, use a progress tracker when iterating over manifests during lint runs. The default value is True.
A version pattern, used when specifying a branch to lint against (–b). If not specified in the configuration file, the –b option uses the pattern *-, matching all branches.
To extend the set of checks performed by pkglint, subclass pkg.lint.base.Checker and its subclasses, ManifestChecker , ActionChecker, and ContentChecker. Add the Python module name that contains those classes to a new pkglint.ext. key in the configuration file.
Instances of those new subclasses are created by pkglint on startup. Methods inside each subclass with the special keyword argument pkglint_id are invoked during the course of the lint session. Those methods should have the same signature as the corresponding check() method in the super class. Methods should also be assigned a pkglint_desc attribute, which is used as the description printed by pkglint -L.
Parameters are available to Checker subclasses, allowing them to tune their behavior. The recommended parameter naming convention is pkglint_id.name. Parameter values can be stored in the configuration file, or accessed in manifests or actions retrieved using the LintEngine.get_param() method. When accessing parameters from the manifest, the prefix pkg.lint is prepended to the key name to ensure that pkglint parameters do not overlap with any existing action or manifest values.
Seconds to wait trying to connect during transport operations (for each attempt) before the client aborts the operation. A value of 0 means wait indefinitely.
Default value: 60
Seconds below the lowspeed limit (1024 bytes/second) during transport operations before the client aborts the operation. A value of 0 means do not abort the operation.
Default value: 30
Maximum number of transient transport errors before the client aborts the operation. A value of 0 means do not abort the operation.
Default value: 4
Maximum number of HTTP or HTTPS redirects allowed during transport operations before a connection is aborted. A value of 0 means do not abort the operation.
Default value: 5
Maximum number of transport attempts per host before the client aborts the operation. A value of 0 means do not abort the operation.
Default value: 4
HTTP or HTTPS proxy server. Use the following syntax to set either http_proxy or https_proxy:
List of host names that should not go through any proxy. If set to asterisk (*) only, all hosts are matched: no hosts will be proxied. Use the following syntax to set no_proxy:
no_proxy [* | host[,host]...]
Running a pkglint session for the first time on a given repository.
$ pkglint -c /space/cache -r http://localhost:10000 mymanifest.mfExample 2 Subsequent Run on the Same Repository
A subsequent run against the same repository used in Example 1.
$ pkglint -c /space/cache mymanifest-fixed.mfExample 3 Using a Lint Repository With a Narrowed Manifest Set
Running a pkglint session with a lint repository and specifying a subset of manifests to check.
$ pkglint -c /space/othercache -l http://localhost:10000 \ -p '.*firefox.*'Example 4 Specifying a Branch
Running a pkglint session against a given branch in verbose mode.
$ pkglint -c /space/cache -r http://localhost:10000 \ -l http://localhost:12000 -b 126.96.36.199.0.147.0 -vExample 5 Modifying a Configuration File
A configuration file with a new lint module, excluding some checks.
$ cat ~/.pkglintrc [pkglint] log_level = DEBUG # log_level = INFO pkglint.ext.mycheck = org.timf.mychecks pkglint.ext.opensolaris = pkg.lint.opensolaris pkglint.exclude: pkg.lint.opensolaris.OpenSolarisActionChecker pkg.lint.pkglint.PkgActionChecker.unusual_perms pkg.lint.pkglint.PkgManifestChecker pkg.lint.opensolaris.OpenSolarisManifestChecker
The following exit values are returned:
One or more package manifests contain lint errors.
An error occurred that is not a lint error in a manifest. For example, an invalid command line option might have been specified.
An unanticipated exception occurred.
See attributes(7) for descriptions of the following attributes: