toxicslave package

Submodules

toxicslave.build module

class toxicslave.build.BuildStep(name, command, warning_on_fail=False, timeout=3600, stop_on_fail=False)

Bases: object

async exec_cmd(cmd, cwd, timeout, out_fn, **envvars)

async execute(cwd, out_fn=None, last_step_status=None, last_step_output=None, **envvars)

Executes the step command.

Parameters:

• cwd – Directory where the command will be executed.

• out_fn – Function used to handle each line of the command output.

• last_step_status – The status of the step before this one in the build.

• last_step_output – The output of the step before this one in the build.

• envvars – Environment variables to be used on execution.

Note

In the case of this method, the params last_step_status and last_step_output are not used. They are here for the use of extentions that may need it. For example, run one command in case of one status or another command in case of another status.

async get_command()

Returns the command that will be executed.

class toxicslave.build.Builder(manager, bconf, workdir, platorm='linux-generic', remove_env=True, **envvars)

Bases: LoggerMixin

A builder executes build steps. Builders are configured in the toxicbuild.yml file

STEP_OUTPUT_BUFF_LEN = 0

async build()

property build_uuid

property slave_plugin

toxicslave.cmds module

toxicslave.cmds.create(root_dir, no_token=False)

Create a new toxicslave environment.

Parameters:

• --root_dir – Root directory for toxicslave.

• --no-token – Should we create a access token?

toxicslave.cmds.create_token(conffile, show_encrypted=False)

Creates the access token to the slave.

Parameters:

• conffile – The path for the toxicslave.conf

• --show-encrypted – Show the encrypted token?

toxicslave.cmds.restart(workdir, pidfile='toxicslave.pid', loglevel='info')

Restarts toxicslave

The instance of toxicslave in workdir will be restarted.

Parameters:

• workdir – Workdir for master to be killed.

• --pidfile – Name of the file to use as pidfile. Defaults to toxicslave.pid

• --loglevel – Level for logging messages.

toxicslave.cmds.slave_init(addr, port, use_ssl, certfile, keyfile, loglevel)

toxicslave.cmds.start(workdir, daemonize=False, stdout='toxicslave.log', stderr='toxicslave.log', conffile=None, loglevel='info', pidfile='toxicslave.pid')

Starts toxicslave.

Starts the build server to listen on the specified port for requests from addr (0.0.0.0 means everyone). Addr and port params came from the config file

Parameters:

• workdir – Work directory for server.

• --daemonize – Run as daemon. Defaults to False

• --stdout – stdout path. Defaults to /dev/null

• --stderr – stderr path. Defaults to /dev/null

• --conffile (-c,) – path to config file. Defaults to None. If not conffile, will look for a file called toxicslave.conf inside workdir

• --loglevel – Level for logging messages. Defaults to info.

• --pidfile – Name of the file to use as pidfile. Defaults to toxicslave.pid

toxicslave.cmds.stop(workdir, pidfile='toxicslave.pid', kill=False)

Stops toxicslave.

The instance of toxicslave in workdir will be stopped.

Parameters:

• workdir – Workdir for master to be killed.

• --pidfile – Name of the file to use as pidfile. Defaults to toxicslave.pid

• kill – If true, send signum 9, otherwise, 15.

toxicslave.docker module

class toxicslave.docker.BuildStepDocker(name, command, warning_on_fail=False, timeout=3600, stop_on_fail=False, container_name=None)

Bases: BuildStep, LoggerMixin

A build step that run the commands inside a docker container.

async exec_cmd(cmd, cwd, timeout, out_fn, **envvars)

classmethod from_buildstep(step, container_name)

class toxicslave.docker.DockerContainerBuilder(*args, **kwargs)

Bases: Builder

Class to handle docker containers used to run builds inside it.

async container_exists(only_running=False)

Checks if a container named as its self.cname already exists

Parameters:

only_running – If True, will look only for running containers.

async copy2container()

Recursive copy a directory to the container’s src dir.

async is_running()

async kill_container()

async rm_container()

async rm_from_container()

Removes the source code of a container that will not be removed.

async service_is_up()

Check if the docker service is running in the host (slave) machine.

async start_container()

async wait_service()

The docker service may start a few seconds after the build server is running. Here we wait until the docker service is up.

async wait_start()

Waits for a container to start

toxicslave.exceptions module

exception toxicslave.exceptions.BadBuilderConfig

Bases: Exception

exception toxicslave.exceptions.BadData

Bases: Exception

exception toxicslave.exceptions.BadPluginConfig

Bases: Exception

exception toxicslave.exceptions.BuilderNotFound

Bases: Exception

exception toxicslave.exceptions.BusyRepository

Bases: Exception

exception toxicslave.exceptions.NotConnected

Bases: Exception

toxicslave.managers module

class toxicslave.managers.BuildManager(protocol, repo_id, repo_url, vcs_type, branch, named_tree, config_type='yml', config_filename='toxicbuild.yml', builders_from=None)

Bases: LoggerMixin

A manager for remote build requests

classmethod add_build_task(build_uuid, task)

building_repos = {}

classmethod cancel_build(build_uuid)

cloning_repos = {}

property config

property current_build

classmethod get_build_task(build_uuid)

property is_cloning

Informs if this repository is being cloned.

property is_updating

Informs it this repository is fetching changes

property is_working

Informs if this repository is cloning or updating

list_builders()

Returns a list with all builders names for this branch based on build config file

async load_builder(name, envvars=None)

Loads a builder from toxicbuild.yml. If USE_DOCKER returns a DockerContainerBuilder instance. Otherwise returns a Builder instance.

Parameters:

• name – builder name

• envvars – A dictionary with environment variables used in a build.

async load_config()

log(msg, level='info')

Appends the class name before the log message.

classmethod rm_build_task(build_uuid)

async send_info(info)

async update_and_checkout(work_after_wait=True, external=None)

Updates self.branch and checkout to self.named_tree.

Parameters:

• work_after_wait – Indicates if we should update and checkout after waiting for other instance finishes its job.

• external – Info about a remote repository if the build should be executed with changes from a remote repo.

updating_repos = {}

async wait_all()

Wait until clone and update are done.

async wait_clone()

Wait until the repository clone is complete.

async wait_update()

Wait until the repository update is complete.

property workdir

The directory where the source code of this repository is cloned into

toxicslave.plugins module

class toxicslave.plugins.AptInstallPlugin(packages, timeout=600)

Bases: SlavePlugin

Installs packages using apt.

get_env_vars()

Returns a dictionary containing values for environment variables.

get_steps_before()

Returns a list of steps to be executed before the steps provided by the user.

name = 'apt-install'

no_list = False

class toxicslave.plugins.AptInstallStep(packages, timeout=600)

Bases: BuildStep

async get_command()

Returns the command that will be executed.

class toxicslave.plugins.AptUpdateStep(timeout=600)

Bases: BuildStep

class toxicslave.plugins.PythonCreateVenvStep(data_dir, venv_dir, pyversion)

Bases: BuildStep

Step that checks if the venv already exists before executing the command.

async execute(cwd, **envvars)

Executes the step command.

Parameters:

• cwd – Directory where the command will be executed.

• out_fn – Function used to handle each line of the command output.

• last_step_status – The status of the step before this one in the build.

• last_step_output – The output of the step before this one in the build.

• envvars – Environment variables to be used on execution.

Note

In the case of this method, the params last_step_status and last_step_output are not used. They are here for the use of extentions that may need it. For example, run one command in case of one status or another command in case of another status.

class toxicslave.plugins.PythonVenvPlugin(pyversion, requirements_file='requirements.txt', remove_env=False, extra_indexes=None)

Bases: SlavePlugin

get_env_vars()

Returns a dictionary containing values for environment variables.

get_steps_after()

Returns a list of steps to be executed after the steps provided by the user.

get_steps_before()

Returns a list of steps to be executed before the steps provided by the user.

name = 'python-venv'

no_list = False

property venv_dir

class toxicslave.plugins.SlavePlugin(*args, **kwargs)

Bases: Plugin

This is a base slave plugin. Slave plugins may add steps to a build before and/or after the used defined steps. It may also set enivronment variables to be used in the tests.

property data_dir

The directory where the plugin store its data.

get_env_vars()

Returns a dictionary containing values for environment variables.

get_steps_after()

Returns a list of steps to be executed after the steps provided by the user.

get_steps_before()

Returns a list of steps to be executed before the steps provided by the user.

name = 'BaseSlavePlugin'

no_list = False

toxicslave.protocols module

toxicslave.server module

Module contents

toxicslave.create_settings()