ovirtlago package

Submodules

ovirtlago.cmd module

ovirtlago.constants module

ovirtlago.paths module

class ovirtlago.paths.OvirtPaths(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

build_dir(*path)

internal_repo(*path)

test_logs(*args)

ovirtlago.prefix module

ovirtlago.reposetup module

exception ovirtlago.reposetup.RepositoryError

Bases: exceptions.Exception

exception ovirtlago.reposetup.RepositoryMergeError

Bases: ovirtlago.reposetup.RepositoryError

ovirtlago.reposetup.merge(output_dir, sources, repoman_config=None)

Run repoman on sources, creating a new RPM repository in output_dir

Args:

output_dir(str): Path to create new repository sources(list of str): repoman sources repoman_config(str): repoman configuration file, if not passed it will

use default repoman configurations, equivalent to:

[main]

on_empty_source=warn

[store.RPMStore]

on_wrong_distro=copy_to_all

with_srcrpms=false

with_sources=false

Raises:

RepositoryMergeError: If repoman command failed. IOError: If repoman_config is passed but does not exists.

Returns:

None

ovirtlago.reposetup.sync_rpm_repository(repo_path, yum_config, repos)

ovirtlago.reposetup.with_repo_server(func)

A decorator that starts an http server which serves the prefix’s internal_repo. The server will listen on the management network’s IP, and on port constans.REPO_SERVER_PORT

Args:

The first argument to the wrapped func should be a

lago.prefix.Prefix instance.

ovirtlago.server module

class ovirtlago.server.LagoThreadingTCPServer(server_address, RequestHandlerClass, allowed_exceptions=(), allowed_errnos=(32, ))

Bases: SocketServer.ThreadingTCPServer

A custom multi-threaded TCP server.

We use allow_reuse_address in order to avoid a race when opening and closing multiple servers (at each point in time only one server is listening). For example, the first server has a connection in ‘time_wait’ state, while the second server tries to bind its socket.

Attributes:

_allowed_exceptions(tuple of Exceptions): If an exception occurs

and its type isn’t not in _allowed_exceptions, its traceback will be printed to the log.

_allowed_errnos(tuple of ints): If an OSError exception occurs

and its errno isn’t not in _allowed_errnos, its traceback will be printed to the log.

allow_reuse_address = True

handle_error(request, client_address)

Handle an error gracefully

Overrides the default implementation which prints the error to stdout and stderr

ovirtlago.server.generate_request_handler(root_dir)

Factory for _BetterHTTPRequestHandler classes

Args:

root_dir (path): Path to the dir to serve

Returns:

_BetterHTTPRequestHandler: A ready to be used improved http request

handler

ovirtlago.server.repo_server_context(*args, **kwds)

Context manager that starts a generic http server that serves root_dir, and listens on gw_ip:port.

Args:

gw_ip(str): IP to listen on port(int): Port to listen on root_dir(str): The root directory that will be served.

ovirtlago.testlib module

class ovirtlago.testlib.LogCollectorPlugin(prefix)

Bases: nose.plugins.base.Plugin

addError(test, err)

addFailure(test, err)

configure(options, conf)

Configure the plugin and system, based on selected options.

The base plugin class sets the plugin to enabled if the enable option for the plugin (self.enableOpt) is true.

name = 'log-collector-plugin'

options(parser, env=None)

Register commandline options.

Implement this method for normal options behavior with protection from OptionConflictErrors. If you override this method and want the default –with-$name option to be registered, be sure to call super().

class ovirtlago.testlib.TaskLogNosePlugin(*args, **kwargs)

Bases: nose.plugins.base.Plugin

addError(test, err)

configure(options, conf)

Configure the plugin and system, based on selected options.

The base plugin class sets the plugin to enabled if the enable option for the plugin (self.enableOpt) is true.

name = 'tasklog-plugin'

options(parser, env)

Register commandline options.

Implement this method for normal options behavior with protection from OptionConflictErrors. If you override this method and want the default –with-$name option to be registered, be sure to call super().

score = 10000

startTest(test)

stopTest(test)

ovirtlago.testlib.assert_equals_within(func, value, timeout, allowed_exceptions=None, initial_wait=10)

ovirtlago.testlib.assert_equals_within_long(func, value, allowed_exceptions=None)

ovirtlago.testlib.assert_equals_within_short(func, value, allowed_exceptions=None)

ovirtlago.testlib.assert_true_within(func, timeout, allowed_exceptions=None)

ovirtlago.testlib.assert_true_within_long(func, allowed_exceptions=None)

ovirtlago.testlib.assert_true_within_short(func, allowed_exceptions=None)

ovirtlago.testlib.engine_capability(caps)

ovirtlago.testlib.get_prefixed_name(entity_name)

ovirtlago.testlib.get_test_prefix()

ovirtlago.testlib.host_capability(caps)

ovirtlago.testlib.test_sequence_gen(test_list)

ovirtlago.testlib.with_ovirt_api(func)

ovirtlago.testlib.with_ovirt_api4(func)

ovirtlago.testlib.with_ovirt_api4_service(func)

ovirtlago.testlib.with_ovirt_prefix(func)

ovirtlago.utils module

ovirtlago.utils.available_sdks(modules=None)

ovirtlago.utils.get_data_file(basename)

Load a data as a string from the data directory

Args:

basename(str): filename

Returns:

str: string representation of the file

ovirtlago.utils.partial(func, *args, **kwargs)

ovirtlago.utils.require_sdk(version, modules=None)

ovirtlago.virt module

class ovirtlago.virt.EngineVM(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

add_iso(path)

check_sds_status(**kwargs)

engine_setup(config=None)

get_api(api_ver=3)

get_api_v3()

get_api_v4(check=False)

get_api_v4_system_service()

start_all_hosts(**kwargs)

start_all_vms(**kwargs)

status(**kwargs)

stop()

stop_all_hosts(**kwargs)

stop_all_vms(**kwargs)

class ovirtlago.virt.HEHostVM(*args, **kwargs)

Bases: ovirtlago.virt.HostVM

class ovirtlago.virt.HostVM(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

class ovirtlago.virt.NodeVM(*args, **kwargs)

Bases: sphinx.ext.autodoc.importer._MockObject

wait_for_ssh()

class ovirtlago.virt.OvirtVirtEnv(prefix, vm_specs, net_spec)

Bases: sphinx.ext.autodoc.importer._MockObject

assert_engine_alive(timeout=120)

Assert service ‘ovirt-engine’ reports running on the engine VM

Args:

timeout(int): timeout

Returns:

None

Raises:

AssertionError: if ovirt-engine is not reported running after the

given timeout, or ssh is unreachable.

assert_vdsm_alive(timeout=120)

Assert service ‘vdsmd’ reports running on all vdsm hosts

Args:

timeout(int): timeout

Returns:

None

Raises:

AssertionError: if vdsmd is not reported running after the

given timeout, or ssh is unreachable.

engine_vm()

get_ovirt_cpu_family(host=None)

Get a suitable string for oVirt Cluster CPU. If host is None, it will use a random host, if no hosts are available it will use the Engine VM for detection. The detection is done by getting the VM host CPU model and vendor, from Lago, which in its turn is based on what was configured in the LagoInitFile. The detected model and vendor are then compared against the definitions in data/ovirt-cpu-map.yaml or against a custom file, if ovirt-cpu-map parameter was defined in the host’s metadata section.

Args:

host(lago.vm.DefaultVM): VM CPU/vendor to use for detection

Returns:

str: oVirt CPU Cluster string

Raises:

RuntimeError: If unsupported cpu vendor or model is detected

host_vms()

update_clusters_cpu(**kwargs)