wlauto.resource_getters package

Submodules

wlauto.resource_getters.standard module

This module contains the standard set of resource getters used by Workload Automation.

class wlauto.resource_getters.standard.DependencyFileGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = '\n Gets resources from the specified mount point. Copies them the local dependencies\n directory, and returns the path to the local copy.\n\n '

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'filer'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'mount_point', 'constraint': None, 'default': '/', 'allowed_values': None, 'global_alias': 'remote_assets_path', 'override': False})"])

priority = -4

relative_path = ''

resource_type = 'file'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentApkGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.EnvironmentFileGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = '\n Uses the same dependency resolution mechanism as ``EnvironmentFileGetter``.\n '

extension = 'apk'

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'environment_apk'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentCommonDependencyGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'environment_common_dependency'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = -1

resource_type = 'file'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentDependencyGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'environment_dependency'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = 0

resource_type = 'file'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentExecutableGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.ExecutableGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'env_exe_getter'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentFileGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = "\n Looks for exactly one file with the specified extension in the owner's directory. If a version\n is specified on invocation of get, it will filter the discovered file based on that version.\n Versions are treated as case-insensitive.\n "

extension = None

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'environment_file'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

register()

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentJarGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.EnvironmentFileGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

extension = 'jar'

finalize(*args, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'environment_jar'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.EnvironmentReventGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.ReventGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get_base_location(resource)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'enviroment_revent'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.ExecutableGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'exe_getter'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = 0

resource_type = 'executable'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.ExtensionAssetGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.EnvironmentDependencyGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'extension_asset'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

resource_type = 'extension_asset'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.HttpGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = '\n Downloads resources from a server based on an index fetched from the specified URL.\n\n Given a URL, this will try to fetch ``<URL>/index.json``. The index file maps extension\n names to a list of corresponing asset descriptons. Each asset description continas a path\n (relative to the base URL) of the resource and a SHA256 hash, so that this Getter can\n verify whether the resource on the remote has changed.\n\n For example, let\'s assume we want to get the APK file for workload "foo", and that\n assets are hosted at ``http://example.com/assets``. This Getter will first try to\n donwload ``http://example.com/assests/index.json``. The index file may contian\n something like ::\n\n {\n "foo": [\n {\n "path": "foo-app.apk",\n "sha256": "b14530bb47e04ed655ac5e80e69beaa61c2020450e18638f54384332dffebe86"\n },\n {\n "path": "subdir/some-other-asset.file",\n "sha256": "48d9050e9802246d820625717b72f1c2ba431904b8484ca39befd68d1dbedfff"\n }\n ]\n }\n\n This Getter will look through the list of assets for "foo" (in this case, two) check\n the paths until it finds one matching the resource (in this case, "foo-app.apk").\n Finally, it will try to dowload that file relative to the base URL and extension name\n (in this case, "http://example.com/assets/foo/foo-app.apk"). The downloaded version\n will be cached locally, so that in the future, the getter will check the SHA256 hash\n of the local file against the one advertised inside index.json, and provided that hasn\'t\n changed, it won\'t try to download the file again.\n\n '

download_asset(asset, owner_name)

fetch_index()

finalize(*args, **kwargs)

get(resource, **kwargs)

geturl(url, stream=False)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'http_assets'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'url', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': 'remote_assets_url', 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'username', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'password', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <function boolean>, 'mandatory': None, 'name': 'always_fetch', 'constraint': None, 'default': False, 'allowed_values': None, 'global_alias': 'always_fetch_remote_assets', 'override': False})", "Param({'kind': <function integer>, 'mandatory': None, 'name': 'chunk_size', 'constraint': None, 'default': 1024, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = -4

resolve_resource(resource)

resource_type = ['apk', 'file', 'jar', 'revent', 'executable']

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageApkGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.PackageFileGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = '\n Uses the same dependency resolution mechanism as ``PackageFileGetter``.\n '

extension = 'apk'

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'package_apk'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageCommonDependencyGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'packaged_common_dependency'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = -11

resource_type = 'file'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageDependencyGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'packaged_dependency'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = -10

resource_type = 'file'

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageExecutableGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.ExecutableGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'package_exe_getter'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

priority = -10

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageFileGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = "\n Looks for exactly one file with the specified extension in the owner's directory. If a version\n is specified on invocation of get, it will filter the discovered file based on that version.\n Versions are treated as case-insensitive.\n "

extension = None

finalize(*args, **kwargs)

get(resource, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'package_file'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

register()

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageJarGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.PackageFileGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

extension = 'jar'

finalize(*args, **kwargs)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'package_jar'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.PackageReventGetter(resolver, **kwargs)

Bases: wlauto.resource_getters.standard.ReventGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get_base_location(resource)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'package_revent'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

validate(*args, **kwargs)

class wlauto.resource_getters.standard.RemoteFilerGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

aliases = AC([])

artifacts = AC([])

core_modules = []

description = '\n Finds resources on a (locally mounted) remote filer and caches them locally.\n\n This assumes that the filer is mounted on the local machine (e.g. as a samba share).\n\n '

finalize(*args, **kwargs)

get(resource, **kwargs)

get_from(resource, version, location)

initialize(*args, **kwargs)

kind = 'resource_getter'

name = 'filer_assets'

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})", "Param({'kind': <type 'str'>, 'mandatory': None, 'name': 'remote_path', 'constraint': None, 'default': '', 'allowed_values': None, 'global_alias': 'remote_assets_path', 'override': False})", "Param({'kind': <function boolean>, 'mandatory': None, 'name': 'always_fetch', 'constraint': None, 'default': False, 'allowed_values': None, 'global_alias': 'always_fetch_remote_assets', 'override': False})"])

priority = -4

resource_type = ['apk', 'file', 'jar', 'revent']

try_get_resource(resource, version, remote_path, local_path)

validate(*args, **kwargs)

class wlauto.resource_getters.standard.ReventGetter(resolver, **kwargs)

Bases: wlauto.core.resource.ResourceGetter

Implements logic for identifying revent files.

aliases = AC([])

artifacts = AC([])

core_modules = []

finalize(*args, **kwargs)

get(resource, **kwargs)

get_base_location(resource)

initialize(*args, **kwargs)

parameters = AC(["Param({'kind': <type 'list'>, 'mandatory': None, 'name': 'modules', 'constraint': None, 'default': None, 'allowed_values': None, 'global_alias': None, 'override': False})"])

register()

validate(*args, **kwargs)

wlauto.resource_getters.standard.get_from_list_by_extension(resource, filelist, extension, version=None, variant=None)

wlauto.resource_getters.standard.get_from_location_by_extension(resource, location, extension, version=None, variant=None)

wlauto.resource_getters.standard.get_owner_path(resource)

Module contents