conftest
Last updated
Last updated
Creates a test that runs conftest
on the specified files, with the specified (or default) policy and namespace.
Note: In many cases, you'll let specific conftest providers (e.g. and create this module type automatically, but you may in some cases want or need to manually specify files to test.
See the for details on how to configure policies.
Below is the full schema reference. For an introduction to configuring Garden modules, please look at our .
The contains the complete YAML schema, and the describes each schema key.
conftest
modules also export values that are available in template strings. See the section below for details.
The values in the schema below are the default values.
apiVersion
The schema version of this config (currently not used).
kind
type
The type of this module.
Example:
name
The name of this module.
Example:
build
Specify how to build the module. Note that plugins may define additional keys on this object.
build.dependencies[]
A list of modules that must be built before this module is built.
Example:
build.dependencies[].name
Module name to build ahead of this module.
build.dependencies[].copy[]
Specify one or more files or directories to copy from the built dependency to this module.
build.dependencies[].copy[].source
POSIX-style path or filename of the directory or file(s) to copy to the target.
build.dependencies[].copy[].target
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to the same as source path.
build.timeout
Maximum time in seconds to wait for build to finish.
description
A description of the module.
disabled
Set this to true
to disable the module. You can use this with conditional template strings to disable modules based on, for example, the current environment or other variables (e.g. disabled: ${environment.name == "prod"}
). This can be handy when you only need certain modules for specific environments, e.g. only for development.
Disabling a module means that any services, tasks and tests contained in it will not be deployed or run. It also means that the module is not built unless it is declared as a build dependency by another enabled module (in which case building this module is necessary for the dependant to be built).
If you disable the module, and its services, tasks or tests are referenced as runtime dependencies, Garden will automatically ignore those dependency declarations. Note however that template strings referencing the module's service or task outputs (i.e. runtime outputs) will fail to resolve when the module is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
include[]
Specify a list of POSIX-style paths or globs that should be regarded as the source files for this module. Files that do not match these paths or globs are excluded when computing the version of the module, when responding to filesystem watch events, and when staging builds.
Also note that specifying an empty list here means no sources should be included.
Example:
exclude[]
Specify a list of POSIX-style paths or glob patterns that should be excluded from the module. Files that match these paths or globs are excluded when computing the version of the module, when responding to filesystem watch events, and when staging builds.
Unlike the modules.exclude
field in the project config, the filters here have no effect on which files and directories are watched for changes. Use the project modules.exclude
field to affect those, if you have large directories that should not be watched for changes.
Example:
repositoryUrl
A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #<branch|tag>
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
Example:
allowPublish
When false, disables pushing this module to remote registries.
generateFiles[]
A list of files to write to the module directory when resolving this module. This is useful to automatically generate (and template) any supporting files needed for the module.
generateFiles[].sourcePath
POSIX-style filename to read the source file contents from, relative to the path of the module (or the ModuleTemplate configuration file if one is being applied). This file may contain template strings, much like any other field in the configuration.
generateFiles[].targetPath
POSIX-style filename to write the resolved file contents to, relative to the path of the module source directory (for remote modules this means the root of the module repository, otherwise the directory of the module configuration).
Note that any existing file with the same name will be overwritten. If the path contains one or more directories, they will be automatically created if missing.
generateFiles[].resolveTemplates
By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the value
field, since that's resolved earlier when parsing the configuration.
generateFiles[].value
The desired file contents as a string.
variables
A map of variables scoped to this particular module. These are resolved before any other parts of the module configuration and take precedence over project-scoped variables. They may reference project-scoped variables, and generally use any template strings normally allowed when resolving modules.
varfile
Specify a path (relative to the module root) to a file containing variables, that we apply on top of the module-level variables
field.
The format of the files is determined by the configured file's extension:
.yaml
/.yml
- YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type.
.json
- JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format will change to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.
To use different module-level varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-module.${environment.name}.env
(this assumes that the corresponding varfiles exist).
Example:
sourceModule
Specify a module whose sources we want to test.
policyPath
POSIX-style path to a directory containing the policies to match the config against, or a specific .rego file, relative to the module root. Must be a relative path, and should in most cases be within the project root. Defaults to the policyPath
set in the provider config.
namespace
The policy namespace in which to find deny and warn rules.
combine
Set to true to use the conftest --combine flag
files[]
A list of files to test with the given policy. Must be POSIX-style paths, and may include wildcards.
The following keys are available via the ${modules.<module-name>}
template string key for conftest
modules.
${modules.<module-name>.buildPath}
The build path of the module.
Example:
${modules.<module-name>.name}
The name of the module.
${modules.<module-name>.path}
The local path of the module.
Example:
${modules.<module-name>.var.*}
A map of all variables defined in the module.
${modules.<module-name>.var.<variable-name>}
${modules.<module-name>.version}
The current version of the module.
Example:
The following keys are available via the ${runtime.services.<service-name>}
template string key for conftest
module services. Note that these are only resolved when deploying/running dependants of the service, so they are not usable for every field.
${runtime.services.<service-name>.version}
The current version of the service.
Example:
The following keys are available via the ${runtime.tasks.<task-name>}
template string key for conftest
module tasks. Note that these are only resolved when deploying/running dependants of the task, so they are not usable for every field.
${runtime.tasks.<task-name>.version}
The current version of the task.
Example:
Type | Allowed Values | Default | Required |
---|
Type | Allowed Values | Default | Required |
---|
Type | Required |
---|
Type | Required |
---|
Type | Default | Required |
---|
> dependencies
Type | Default | Required |
---|
> > name
Type | Required |
---|
> > copy
Type | Default | Required |
---|
> > > source
Type | Required |
---|
> > > target
Type | Required |
---|
> timeout
Type | Default | Required |
---|
Type | Required |
---|
Type | Default | Required |
---|
Note that you can also exclude files using the exclude
field or by placing .gardenignore
files in your source tree, which use the same format as .gitignore
files. See the for details.
Type | Required |
---|
Note that you can also explicitly include files using the include
field. If you also specify the include
field, the files/patterns specified here are filtered from the files matched by include
. See the for details.
Type | Required |
---|
Type | Required |
---|
Type | Default | Required |
---|
Type | Default | Required |
---|
> sourcePath
Type | Required |
---|
> targetPath
Type | Required |
---|
> resolveTemplates
Type | Default | Required |
---|
> value
Type | Required |
---|
Type | Required |
---|
.env
- Standard "dotenv" format, as defined by .
Type | Required |
---|
Type | Required |
---|
Type | Required |
---|
Type | Default | Required |
---|
Type | Default | Required |
---|
Type | Required |
---|
Type |
---|
Type |
---|
Type |
---|
Type | Default |
---|
Type |
---|
Type |
---|
Type |
---|
Type |
---|