Developer Guide

Deploy for development

This project uses pip to manage the package. If you want to work on the project yourself you can create the necessary links via:

$ pip3 install --user -e .

That will install a backlink ~/.local/bin/kas to this project. Now you are able to call it from anywhere.

Docker image build

Just run:

$ docker build -t <image_name> .

When you need a proxy to access the internet, add:

--build-arg http_proxy=<http_proxy> --build-arg https_proxy=<https_proxy> --build-arg ftp_proxy=<ftp_proxy> --build-arg no_proxy=<no_proxy>

to the call.

Community Resources

Project home:

• https://github.com/siemens/kas

Source code:

• https://github.com/siemens/kas.git
• git@github.com:siemens/kas.git

Documentation:

• https://kas.readthedocs.org

Mailing list:

• kas-devel@googlegroups.com
• Subscription:
  • kas-devel+subscribe@googlegroups.com
  • https://groups.google.com/forum/#!forum/kas-devel/join
• Archives
  • https://groups.google.com/forum/#!forum/kas-devel
  • https://www.mail-archive.com/kas-devel@googlegroups.com/

Class reference documentation

kas.kas Module

kas.libkas Module

This module contains the core implementation of kas.

class kas.libkas.LogOutput(live)

Handles the log output of executed applications

log_stderr(line)

This method is called when a line is received over stderr.

log_stdout(line)

This method is called when a line is received over stdout.

kas.libkas.find_program(paths, name)

Find a file within the paths array and returns its path.

kas.libkas.get_build_environ()

Creates the build environment variables.

kas.libkas.kasplugin(plugin_class)

A decorator that registers kas plugins

kas.libkas.repos_apply_patches(repos)

Applies the patches to the repositories.

kas.libkas.repos_fetch(repos)

Fetches the list of repositories to the kas_work_dir.

kas.libkas.run_cmd(cmd, cwd, env=None, fail=True, liveupdate=True)

Runs a command synchronously.

kas.libkas.run_cmd_async(cmd, cwd, env=None, fail=True, liveupdate=True)

Run a command asynchronously.

kas.libkas.ssh_add_key(env, key)

Adds an ssh key to the ssh-agent

kas.libkas.ssh_cleanup_agent()

Removes the identities and stops the ssh-agent instance

kas.libkas.ssh_no_host_key_check()

Disables ssh host key check

kas.libkas.ssh_setup_agent(envkeys=None)

Starts the ssh-agent

kas.libcmds Module

kas.build Module

kas.shell Module

kas.config Module

kas.repos Module

This module contains the Repo class.

class kas.repos.GitRepo(url, path, refspec, layers, patches, disable_operations)

Provides the git functionality for a Repo.

class kas.repos.MercurialRepo(url, path, refspec, layers, patches, disable_operations)

Provides the hg functionality for a Repo.

class kas.repos.Repo(url, path, refspec, layers, patches, disable_operations)

Represents a repository in the kas configuration.

static factory(name, repo_config, repo_fallback_path)

Returns a Repo instance depending on params.

static get_root_path(path, fallback=True)

Checks if path is under version control and returns its root path.

class kas.repos.RepoImpl(url, path, refspec, layers, patches, disable_operations)

Provides a generic implementation for a Repo.

apply_patches_async()

Applies patches to a repository asynchronously.

checkout()

Checks out the correct revision of the repo.

fetch_async()

Starts asynchronous repository fetch.

kas.includehandler Module