Docker - Jolt Documentation. Robert Andersson. May 18, 2021

remotes = {}

A dictionary with Conan remotes to use when fetching packages.

The dictionary key is the name of remote and its value is the URL.

Example:

remotes = {

"bincrafters": "https://api.bintray.com/conan/bincrafters/public-conan"

}

7.15 Docker

7.15.1 DockerImage

class jolt.plugins.docker.DockerImage(*args, **kwargs) Builds a Docker image and publishes the resulting tarfile.

The image may optionally be compressed using bzip2, gzip or lzma compression.

Example:

from jolt.plugins.docker import DockerImage

class Busybox(DockerImage):

compression = "gz"

dockerfile = """

FROM busybox:latest CMD ["busybox"]

"""

tag = "busybox:latest"

compression = None

Optional image compression “bz2”, “gz”, or “xz”.

context = '.'

Path to build context, relative to joltdir (directory).

dockerfile = 'Dockerfile'

Path to the Dockerfile to build, or the full source code of such a file.

imagefile = None

Name of the image tarball. Defaults to the task’s canonical name.

tag = None

Optional image tag.

7.16 Ninja

7.16.1 CXXExecutable

class jolt.plugins.ninja.CXXExecutable(*args, **kwargs) Builds a C/C++ executable.

The task recognizes these source file types: .asm, .c, .cc, .cpp, .cxx, .h, .hh, .hpp, .hxx, .pch, .s, .S Other file types can be supported through additional rules, see the Rule class.

On Linux, GCC/Binutils is the default toolchain used. The default toolchain can be overridden by setting the environment variables AR, CC, CXX and LD. The prefered method is to assign these variables through the artifact of a special task that you depend on.

On Windows, Visual Studio is the default toolchain and it must be present in the PATH. Run Jolt from a developer command prompt.

Additionally, these environment variables can be used to customize toolchain behavior on any platform:

• ASFLAGS - compiler flags used for assembly code

• CFLAGS - compiler flags used for C code

• CXXFLAGS - compiler flags used for C++ code

• LDFLAGS - linker flags CXXProject.asflags = []

A list of compiler flags used when compiling assembler files.

CXXProject.binary = None

Name of the target binary (defaults to canonical task name) CXXProject.cflags = []

A list of compiler flags used when compiling C files.

CXXProject.cxxflags = []

A list of compiler flags used when compiling C++ files.

CXXProject.incpaths = []

List of preprocessor include paths CXXProject.incremental = True

Compile incrementally.

If incremental build is disabled, all intermediate files from a previous build will be removed before the execution begins.

CXXProject.ldflags = []

A list of linker flags to use.

CXXProject.libpaths = []

A list of library search paths used when linking.

CXXProject.libraries = []

A list of libraries to link with.

CXXProject.macros = []

List of preprocessor macros to set publishdir = 'bin/'

The artifact path where the binary is published.

CXXLibrary.publish(artifact, tools) Publishes the library.

By default, the library is collected into a directory as specified by the publishdir class attribute. Library path metadata for this directory as well as linking metadata is automatically exported. The relative path of the library within the artifact is also exported as a metadata string. It can be read by consumers by accessing artifact.strings.library.

Public headers listed in the headers class attribute are collected into a directory as specified by the publishapiclass attribute. Include path metadata for this directory is automatically exported.

CXXProject.run(deps, tools)

Generates a Ninja build file and invokes Ninja to build the project.

The build file and all intermediate files are written to a build directory within the workspace. By default, the directory persists between different invokations of Jolt to allow projects to be built incrementally. The behavior can be changed with the incremental class attribute.

CXXLibrary.selfsustained = False

Consume this library independently from its requirements.

When self-sustained, all static libraries listed as requirements are merged into the final library. Merging can also be achieved by listing libraries as source files.

See Task.selfsustained for general information.

CXXProject.shell(deps, tools) Invoked to start a debug shell.

The method prepares the environment with attributes exported by task requirement artifacts. The shell is entered by passing the -g flag to the build command.

For Ninja tasks, a special compile command is made available inside the shell. The command can be used to compile individual source files which is useful when troubleshooting compilation errors. Run compile -hfor help.

Task execution resumes normally when exiting the shell.

CXXProject.sources = []

A list of sources to compile.

Path names may contain simple shell-style wildcards such as ‘*’ and ‘?’. Note: files starting with a dot are not matched by these wildcards.

Example

sources = ["src/*.cpp"]

CXXProject.source_influence = True

Let the contents of source files influence the identity of the task artifact.

When True, a source file listed in the sources attribute will cause a rebuild of the task if modified.

Source influence can hurt performance since every files needs to be hashed. It is safe to set this flag to Falseif all source files reside in a git repository listed as a dependency with the requires attribute or if the task uses the git.influence decorator.

Always use source_influence if you are unsure whether it is needed or not.

7.16.2 CXXLibrary

class jolt.plugins.ninja.CXXLibrary(*args, **kwargs) Builds a C/C++ library.

The task recognizes these source file types: .asm, .c, .cc, .cpp, .cxx, .h, .hh, .hpp, .hxx, .pch, .s, .S Other file types can be supported through additional rules, see the Rule class.

On Windows, Visual Studio is the default toolchain and it must be present in the PATH. Run Jolt from a developer command prompt.

Additionally, these environment variables can be used to customize toolchain behavior on any platform:

• ASFLAGS - compiler flags used for assembly code

• CFLAGS - compiler flags used for C code

• CXXFLAGS - compiler flags used for C++ code

• LDFLAGS - linker flags CXXProject.asflags = []

A list of compiler flags used when compiling assembler files.

CXXProject.binary = None

Name of the target binary (defaults to canonical task name) CXXProject.cflags = []

A list of compiler flags used when compiling C files.

CXXProject.cxxflags = []

A list of compiler flags used when compiling C++ files.

headers = []

List of public headers to be published with the artifact CXXProject.incpaths = []

List of preprocessor include paths CXXProject.incremental = True

Compile incrementally.

If incremental build is disabled, all intermediate files from a previous build will be removed before the execution begins.

CXXProject.ldflags = []

A list of linker flags to use.

CXXProject.libpaths = []

A list of library search paths used when linking.

CXXProject.libraries = []

A list of libraries to link with.

CXXProject.macros = []

List of preprocessor macros to set CXXProject.run(deps, tools)

Generates a Ninja build file and invokes Ninja to build the project.

publishapi = 'include/'

The artifact path where public headers are published.

publishdir = 'lib/'

The artifact path where the library is published.

publish(artifact, tools) Publishes the library.

Public headers listed in the headers class attribute are collected into a directory as specified by the publishapiclass attribute. Include path metadata for this directory is automatically exported.

selfsustained = False

Consume this library independently from its requirements.

When self-sustained, all static libraries listed as requirements are merged into the final library. Merging can also be achieved by listing libraries as source files.

See Task.selfsustained for general information.

CXXProject.shell(deps, tools) Invoked to start a debug shell.

The method prepares the environment with attributes exported by task requirement artifacts. The shell is entered by passing the -g flag to the build command.

Task execution resumes normally when exiting the shell.

CXXProject.sources = []

A list of sources to compile.

Path names may contain simple shell-style wildcards such as ‘*’ and ‘?’. Note: files starting with a dot are not matched by these wildcards.

Example

sources = ["src/*.cpp"]

CXXProject.source_influence = True

Let the contents of source files influence the identity of the task artifact.

When True, a source file listed in the sources attribute will cause a rebuild of the task if modified.

Always use source_influence if you are unsure whether it is needed or not.

7.16.3 Decorators

class jolt.plugins.ninja.attributes

static asflags(attrib, prepend=False)

Decorates a task with an alternative asflags attribute.

The new attribute will be concatenated with the regular asflags attribute.

Parameters