Module lints

Module lints 

Source
Expand description

ยงImplementation of container build lints

This module implements bootc container lint.

Structsยง

Lint ๐Ÿ”’
LintError ๐Ÿ”’
A lint check has failed.
LintExecutionConfig ๐Ÿ”’
LintExecutionResult ๐Ÿ”’

Enumsยง

LintFnTy ๐Ÿ”’
A lint can either operate as it pleases on a target root, or it can be recursive.
LintType ๐Ÿ”’
The classification of a lint type.
RootType ๐Ÿ”’
WarningDisposition ๐Ÿ”’

Constantsยง

API_DIRS ๐Ÿ”’
BASEIMAGE_REF ๐Ÿ”’
Reference to embedded default baseimage content that should exist.
DEFAULT_TRUNCATED_OUTPUT ๐Ÿ”’
Only output this many items by default
RUNTIME_ONLY_DIRS ๐Ÿ”’
Directories that should be empty in container images. These are tmpfs at runtime and any content is build-time artifacts.

Staticsยง

LINTS ๐Ÿ”’
LINT_API_DIRS ๐Ÿ”’
LINT_BASEIMAGE_ROOT ๐Ÿ”’
Check ostree-related base image content.
LINT_BUILDAH_INJECTED ๐Ÿ”’
LINT_COMPOSEFS ๐Ÿ”’
LINT_ETC_USRUSETC ๐Ÿ”’
LINT_KARGS ๐Ÿ”’
Validate that we can parse the /usr/lib/bootc/kargs.d files.
LINT_KERNEL ๐Ÿ”’
LINT_NONEMPTY_BOOT ๐Ÿ”’
LINT_RUNTIME_ONLY_DIRS ๐Ÿ”’
LINT_SYSUSERS ๐Ÿ”’
LINT_UTF8 ๐Ÿ”’
LINT_VARLOG ๐Ÿ”’
LINT_VAR_RUN ๐Ÿ”’
check for the existence of the /var/run directory if it exists we need to check that it links to /run if not error
LINT_VAR_TMPFILES ๐Ÿ”’

Functionsยง

check_api_dirs ๐Ÿ”’
check_baseimage_root ๐Ÿ”’
check_baseimage_root_norecurse ๐Ÿ”’
Check for a few files and directories we expect in the base image.
check_boot ๐Ÿ”’
check_buildah_injected ๐Ÿ”’
check_composefs ๐Ÿ”’
check_kernel ๐Ÿ”’
check_parse_kargs ๐Ÿ”’
check_prepareroot_composefs_norecurse ๐Ÿ”’
check_runtime_only_dirs ๐Ÿ”’
check_sysusers ๐Ÿ”’
check_usretc ๐Ÿ”’
check_utf8 ๐Ÿ”’
check_var_run ๐Ÿ”’
check_var_tmpfiles ๐Ÿ”’
check_varlog ๐Ÿ”’
collect_nonempty_regfiles ๐Ÿ”’
format_items ๐Ÿ”’
format_lint_err_from_items ๐Ÿ”’
lint ๐Ÿ”’
lint_err ๐Ÿ”’
We successfully found a lint failure.
lint_inner ๐Ÿ”’
lint_list ๐Ÿ”’
lint_ok ๐Ÿ”’
Everything is OK - we didnโ€™t encounter a runtime error, and the targeted check passed.
walk_configuration ๐Ÿ”’
Create a default WalkConfiguration with noxdev enabled.

Type Aliasesยง

LintFn ๐Ÿ”’
LintRecursiveFn ๐Ÿ”’
LintRecursiveResult ๐Ÿ”’
LintResult ๐Ÿ”’
The outer error is for unexpected fatal runtime problems; the inner error is for the lint failing in an expected way.