The Container Structure Tests provide a powerful framework to validate the structure of a container image. Json Format

schemaVersion - The schema version of Structure Tests.

commandTests A list of command tests

#	name	command	exitCode	Actions
{{$index+1}}.	{{row.name}}	{{row.command}}	{{row.exitCode}}

fileExistenceTests File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.

#	name	path	shouldExist	permissions	uid	gid	isExecutableBy	Actions
{{$index+1}}.	{{row.name}}	{{row.path}}	{{row.shouldExistSelected.DisplayText}}	{{row.permissions}}	{{row.uid}}	{{row.gid}}	{{row.isExecutableBy}}

fileContentTests File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists

#	name	path	Actions
{{$index+1}}.	{{row.name}}	{{row.path}}

licenseTests License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.

#	debian	Actions
{{$index+1}}.	{{row.debianSelected.DisplayText}}

.metadataTest

_

metadataTest.workdir - The default working directory of the container.

metadataTest.env A list of environment variable key/value pairs that should be set in the container.

#	key	value	Actions
{{$index+1}}.

metadataTest.labels A list of image labels key/value pairs that should be set on the container.

#	key	value	isRegex	Actions
{{$index+1}}.

metadataTest.entrypoint The entrypoint of the container

#	Values	Actions
{{$index+1}}.

metadataTest.cmd The CMD specified in the container

#	Values	Actions
{{$index+1}}.

metadataTest.exposedPorts The ports exposed in the container.

#	Values	Actions
{{$index+1}}.

metadataTest.unexposedPorts The ports NOT exposed in the container.

#	Values	Actions
{{$index+1}}.

metadataTest.volumes The volumes exposed in the container.

#	Values	Actions
{{$index+1}}.

metadataTest.unmountedVolumes The volumes NOT exposed in the container

#	Values	Actions
{{$index+1}}.

globalEnvVars A list of environment variables can optionally be specified as part of the test setup.

#	key	value	Actions
{{$index+1}}.

name - The name of the test

command - The command to run in the test.

exitCode - Exit code that the command should exit with.

setup A list of commands (each with optional flags) to run before the actual command under test.

#	Values	Actions
{{$index+1}}.

teardown A list of commands (each with optional flags) to run after the actual command under test.

#	Values	Actions
{{$index+1}}.

envVars envVars

#	key	value	Actions
{{$index+1}}.

args The arguments to pass to the command.

#	Values	Actions
{{$index+1}}.

expectedOutput List of regexes that should match the stdout from running the command.

#	Values	Actions
{{$index+1}}.

excludedOutput List of regexes that should not match the stdout from running the command..

#	Values	Actions
{{$index+1}}.

expectedError List of regexes that should match the stderr from running the command.

#	Values	Actions
{{$index+1}}.

excludedError List of regexes that should not match the stderr from running the command.

#	Values	Actions
{{$index+1}}.

ToolMatter

Your Apps in Action

Use this form to visualize The Container Structure Tests provide a powerful framework to validate the structure of a container image..

{{repoTitle.MainEntity}}

commandTests A list of command tests

fileExistenceTests File existence tests check to make sure a specific file (or directory) exist within the file system of the image. No contents of the files or directories are checked. These tests can also be used to ensure a file or directory is not present in the file system.

fileContentTests File content tests open a file on the file system and check its contents. These tests assume the specified file is a file, and that it exists

licenseTests License tests check a list of copyright files and makes sure all licenses are allowed at Google. By default it will look at where Debian lists all copyright files, but can also look at an arbitrary list of files.

_

metadataTest.env A list of environment variable key/value pairs that should be set in the container.

metadataTest.labels A list of image labels key/value pairs that should be set on the container.

metadataTest.entrypoint The entrypoint of the container

metadataTest.cmd The CMD specified in the container

metadataTest.exposedPorts The ports exposed in the container.

metadataTest.unexposedPorts The ports NOT exposed in the container.

metadataTest.volumes The volumes exposed in the container.

metadataTest.unmountedVolumes The volumes NOT exposed in the container

globalEnvVars A list of environment variables can optionally be specified as part of the test setup.

{{repoTitle.MainEntity}}

setup A list of commands (each with optional flags) to run before the actual command under test.

teardown A list of commands (each with optional flags) to run after the actual command under test.

envVars envVars

args The arguments to pass to the command.

expectedOutput List of regexes that should match the stdout from running the command.

excludedOutput List of regexes that should not match the stdout from running the command..

expectedError List of regexes that should match the stderr from running the command.

excludedError List of regexes that should not match the stderr from running the command.

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

expectedContents List of regexes that should match the contents of the file

excludedContents List of regexes that should not match the contents of the file

{{repoTitle.MainEntity}}

files A list of other files to check.

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}