4.1. karr_lab_build_utils package

4.1.1. Subpackages

• 4.1.1.1. karr_lab_build_utils.config package
  • 4.1.1.1.1. Submodules
  • 4.1.1.1.2. karr_lab_build_utils.config.core module
  • 4.1.1.1.3. Module contents

4.1.2. Submodules

4.1.3. karr_lab_build_utils.__main__ module

Karr Lab build utilities

Author

Jonathan Karr <karr@mssm.edu>

Date

2016-10-27

Copyright

2018, Karr Lab

License

MIT

class karr_lab_build_utils.__main__.AnalyzePackageController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Perform static analyses of a package using Pylint

class Meta

Bases: object

arguments = [(['package_name'], {'type': <class 'str'>, 'help': 'Name of the package to analyze'}), (['--messages'], {'type': <class 'str'>, 'default': '', 'help': 'comma-separated list of ids of Pylint checks to run'})]

description = 'Perform static analyses of a package using Pylint'

help = 'Perform static analyses of a package using Pylint'

label = 'analyze_package'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.App(label=None, **kw)

Bases: cement.core.foundation.App

Command line application

class Meta

Bases: object

base_controller = 'base'

handlers = [<class 'karr_lab_build_utils.__main__.BaseController'>, <class 'karr_lab_build_utils.__main__.CreatePackageController'>, <class 'karr_lab_build_utils.__main__.CreateRepositoryController'>, <class 'karr_lab_build_utils.__main__.SetupRepositoryController'>, <class 'karr_lab_build_utils.__main__.CreateDocumentationTemplateController'>, <class 'karr_lab_build_utils.__main__.DownloadInstallPackageConfigFilesController'>, <class 'karr_lab_build_utils.__main__.RunTestsController'>, <class 'karr_lab_build_utils.__main__.DockerController'>, <class 'karr_lab_build_utils.__main__.DockerCreateContainerController'>, <class 'karr_lab_build_utils.__main__.InstallPackageToDockerContainerController'>, <class 'karr_lab_build_utils.__main__.RunTestsInDockerContainerController'>, <class 'karr_lab_build_utils.__main__.DockerRemoveContainerController'>, <class 'karr_lab_build_utils.__main__.FollowCircleciBuildController'>, <class 'karr_lab_build_utils.__main__.GetCircleciEnvironmentVariablesController'>, <class 'karr_lab_build_utils.__main__.SetCircleciEnvironmentVariableController'>, <class 'karr_lab_build_utils.__main__.DeleteCircleciEnvironmentVariableController'>, <class 'karr_lab_build_utils.__main__.CreateCodeClimateGithubWebhookController'>, <class 'karr_lab_build_utils.__main__.DoPostTestTasksController'>, <class 'karr_lab_build_utils.__main__.MakeAndArchiveReportsController'>, <class 'karr_lab_build_utils.__main__.CombineCoverageReportsController'>, <class 'karr_lab_build_utils.__main__.ArchiveCoverageReportController'>, <class 'karr_lab_build_utils.__main__.UploadCoverageReportToCoverallsController'>, <class 'karr_lab_build_utils.__main__.UploadCoverageReportToCodeClimateController'>, <class 'karr_lab_build_utils.__main__.MakeDocumentationController'>, <class 'karr_lab_build_utils.__main__.CompileDownstreamDependenciesController'>, <class 'karr_lab_build_utils.__main__.ArePackageDependenciesAcyclicController'>, <class 'karr_lab_build_utils.__main__.VisualizePackageDependenciesController'>, <class 'karr_lab_build_utils.__main__.AnalyzePackageController'>, <class 'karr_lab_build_utils.__main__.FindMissingRequirementsController'>, <class 'karr_lab_build_utils.__main__.FindUnusedRequirementsController'>, <class 'karr_lab_build_utils.__main__.UploadPackageToPypiController'>]

label = 'karr_lab_build_utils'

class karr_lab_build_utils.__main__.ArchiveCoverageReportController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Archive a coverage report:

• Upload report to Coveralls and Code Climate

class Meta

Bases: object

arguments = [(['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--dry-run'], {'default': False, 'dest': 'dry_run', 'action': 'store_true', 'help': 'If set, do not send results to Coveralls and Code Climate'})]

description = 'Archive coverage report'

help = 'Archive coverage report'

label = 'archive_coverage_report'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.ArePackageDependenciesAcyclicController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Check if the package dependencies are acyclic so they are supported by CircleCI

class Meta

Bases: object

arguments = [(['--packages-parent-dir'], {'type': <class 'str'>, 'default': '..', 'help': 'Path to the parent directory of the other packages'})]

description = 'Check if the package dependencies are acyclic so they are supported by CircleCI'

help = 'Check if the package dependencies are acyclic so they are supported by CircleCI'

label = 'are_package_dependencies_acyclic'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.BaseController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for command line application

class Meta

Bases: object

arguments = [(['-v', '--version'], {'action': 'version', 'version': '0.0.13'})]

description = 'Karr Lab build utilities'

help = 'Karr Lab build utilities'

label = 'base'

archive_test_report()

Upload test report to history server

install_requirements()

Install requirements

upgrade_karr_lab_packages()

Upgrade the packages from the Karr Lab’s GitHub organization

class karr_lab_build_utils.__main__.CombineCoverageReportsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Combine coverage reports

class Meta

Bases: object

arguments = [(['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"})]

description = 'Combine coverage reports (.coverage.*) into a single file (.coverage)'

help = 'Combine coverage reports (.coverage.*) into a single file (.coverage)'

label = 'combine_coverage_reports'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.CompileDownstreamDependenciesController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Compile the downstream dependencies of a package by analyzing the requirements files of other packages

class Meta

Bases: object

arguments = [(['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': 'Path to package'}), (['--packages-parent-dir'], {'type': <class 'str'>, 'default': '..', 'help': 'Path to the parent directory of the other packages'}), (['--config-filename'], {'type': <class 'str'>, 'default': None, 'help': 'Path to save the configuration including downstream dependencies in YAML format'})]

description = 'Compile the downstream dependencies of a package by analyzing the requirements files of other packages'

help = 'Compile the downstream dependencies of a package by analyzing the requirements files of other packages'

label = 'compile_downstream_dependencies'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.CreateCodeClimateGithubWebhookController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Create Code Climate GitHub webhook for the current repository

class Meta

Bases: object

arguments = [(['--repo-type'], {'type': <class 'str'>, 'default': None, 'help': 'Repository type (e.g., github)'}), (['--repo-owner'], {'type': <class 'str'>, 'default': None, 'help': 'Repository owner'}), (['--repo-name'], {'type': <class 'str'>, 'default': None, 'help': 'Name of the repository to build. This defaults to the name of the current repository.'})]

description = 'Create Code Climate GitHub webhook for the current repository'

help = 'Create Code Climate GitHub webhook for the current repository'

label = 'create_code_climate_github_webhook'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.CreateDocumentationTemplateController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Create a Sphinx documentation template for a package

class Meta

Bases: object

arguments = [(['--dirname'], {'default': '.', 'type': <class 'str'>, 'help': "Path to the package; default='.'"})]

description = 'Create a Sphinx documentation template for a package'

help = 'Create a Sphinx documentation template for a package'

label = 'create_documentation_template'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.CreatePackageController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Create a package

• Create local and remote Git repositories;

• Setup the directory structure of the repository;

• Add the repository to CircleCI, Coveralls, Code Climate, Read the Docs, and code.karrlab.org;

• Update the downstream dependencies of the package’’s dependencies

class Meta

Bases: object

arguments = [(['--pypi-repository'], {'default': 'pypi', 'type': <class 'str'>, 'help': 'Repository upload package (e.g. pypi or testpypi)'})]

description = '- Create local and remote Git repositories;\n - Setup the directory structure of the repository;\n - Add the repository to CircleCI, Coveralls, Code Climate, Read the Docs, and code.karrlab.org;\n - Update the downstream dependencies of the packages dependencies'

help = '- Create local and remote Git repositories;\n - Setup the directory structure of the repository;\n - Add the repository to CircleCI, Coveralls, Code Climate, Read the Docs, and code.karrlab.org;\n - Update the downstream dependencies of the packages dependencies'

label = 'create_package'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.CreateRepositoryController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Create a GitHub repository and clone the repository locally

class Meta

Bases: object

arguments = [(['name'], {'type': <class 'str'>, 'help': 'Name of the repository (i.e. repo_<name>)'}), (['--description'], {'default': '', 'type': <class 'str'>, 'help': 'Description of the repository'}), (['--public'], {'default': False, 'action': 'store_true', 'help': 'if set, make the repository public'}), (['--dirname'], {'default': None, 'type': <class 'str'>, 'help': 'Path for the repository'})]

description = 'Create a GitHub repository and clone the repository locally'

help = 'Create a GitHub repository and clone the repository locally'

label = 'create_repository'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DeleteCircleciEnvironmentVariableController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Delete a CircleCI environment variable for a repository

class Meta

Bases: object

arguments = [(['name'], {'type': <class 'str'>, 'help': 'Name of the environment variable.'}), (['--repo-type'], {'type': <class 'str'>, 'default': None, 'help': 'Repository type (e.g., github)'}), (['--repo-owner'], {'type': <class 'str'>, 'default': None, 'help': 'Repository owner'}), (['--repo-name'], {'type': <class 'str'>, 'default': None, 'help': 'Name of the repository to build. This defaults to the name of the current repository.'})]

description = 'Delete a CircleCI environment variable for a repository'

help = 'Delete a CircleCI environment variable for a repository'

label = 'delete_circleci_environment_variable'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DoPostTestTasksController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Do all post-test tasks for CircleCI

class Meta

Bases: object

arguments = [(['installation_exit_code'], {'type': <class 'int'>, 'help': 'Exit code of the package installation tasks'}), (['tests_exit_code'], {'type': <class 'int'>, 'help': 'Exit code of the tests'}), (['--dry-run'], {'default': False, 'dest': 'dry_run', 'action': 'store_true', 'help': 'If set, do not send results to Coveralls and Code Climate'})]

description = 'Do all post-test tasks for CircleCI'

help = 'Do all post-test tasks for CircleCI'

label = 'do_post_test_tasks'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DockerController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Base controller for Docker tasks

class Meta

Bases: object

arguments = []

description = 'Docker utilities'

help = 'Docker utilities'

label = 'docker'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DockerCreateContainerController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Create a Docker container for running tests

class Meta

Bases: object

arguments = [(['--ssh-key-filename'], {'type': <class 'str'>, 'default': '~/.ssh/id_rsa', 'help': 'Path to GitHub SSH key'})]

description = 'Create a Docker container for running tests'

help = 'Create a Docker container for running tests'

label = 'create_container'

stacked_on = 'docker'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DockerRemoveContainerController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Remove a Docker container

class Meta

Bases: object

arguments = [(['container'], {'type': <class 'str'>, 'help': 'Container id'})]

description = 'Remove a Docker container'

help = 'Remove a Docker container'

label = 'remove_container'

stacked_on = 'docker'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.DownloadInstallPackageConfigFilesController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Download and install configuration files from GitHub configuration repository

class Meta

Bases: object

arguments = []

description = 'Download and install configuration files from GitHub configuration repository'

help = 'Download and install configuration files from GitHub configuration repository'

label = 'download_install_package_config_files'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.FindMissingRequirementsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

cement.Controller for finding missing requirements

class Meta

Bases: object

arguments = [(['package_name'], {'type': <class 'str'>, 'help': 'Package name'}), (['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': 'Path to package'})]

description = 'Finding missing requirements for a package.'

help = 'Finding missing requirements for a package.'

label = 'find_missing_requirements'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.FindUnusedRequirementsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

cement.Controller for finding unused requirements

class Meta

Bases: object

arguments = [(['package_name'], {'type': <class 'str'>, 'help': 'Package name'}), (['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': 'Path to package'})]

description = 'Finding unused requirements for a package.'

help = 'Finding unused requirements for a package.'

label = 'find_unused_requirements'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.FollowCircleciBuildController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Follow a CircleCI build for a repository

class Meta

Bases: object

arguments = [(['--repo-type'], {'type': <class 'str'>, 'default': None, 'help': 'Repository type (e.g., github)'}), (['--repo-owner'], {'type': <class 'str'>, 'default': None, 'help': 'Repository owner'}), (['--repo-name'], {'type': <class 'str'>, 'default': None, 'help': 'Name of the repository to build. This defaults to the name of the current repository.'}), (['--has-private-dependencies'], {'default': False, 'action': 'store_true', 'help': 'Set if the build requires an SSH key for the Karr Lab machine user because the repository depends on another private repository'})]

description = 'Follow a CircleCI build for a repository'

help = 'Follow a CircleCI build for a repository'

label = 'follow_circleci_build'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.GetCircleciEnvironmentVariablesController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Get the CircleCI environment variables for a repository and their partial values

class Meta

Bases: object

arguments = [(['--repo-type'], {'type': <class 'str'>, 'default': None, 'help': 'Repository type (e.g., github)'}), (['--repo-owner'], {'type': <class 'str'>, 'default': None, 'help': 'Repository owner'}), (['--repo-name'], {'type': <class 'str'>, 'default': None, 'help': 'Name of the repository to build. This defaults to the name of the current repository.'})]

description = 'Get the CircleCI environment variables for a repository and their partial values'

help = 'Get the CircleCI environment variables for a repository and their partial values'

label = 'get_circleci_environment_variables'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.InstallPackageToDockerContainerController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Copy and install a package to a Docker container

class Meta

Bases: object

arguments = [(['container'], {'type': <class 'str'>, 'help': 'Container id'}), (['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': "Path to package to test; default='.'"})]

description = 'Copy and install a package to a Docker container'

help = 'Copy and install a package to a Docker container'

label = 'install_package_to_container'

stacked_on = 'docker'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.MakeAndArchiveReportsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Make and archive reports:

• Generate HTML test history reports

• Generate HTML API documentation

• Archive coverage report to Coveralls and Code Climate

class Meta

Bases: object

arguments = [(['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--dry-run'], {'default': False, 'dest': 'dry_run', 'action': 'store_true', 'help': 'If set, do not send results to Coveralls and Code Climate'})]

description = 'Make and archive reports'

help = 'Make and archive reports'

label = 'make_and_archive_reports'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.MakeDocumentationController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

cement.Controller for make_documentation.

Make HTML documentation. Optionally, spell check documentation.

class Meta

Bases: object

arguments = [(['--spell-check'], {'default': False, 'dest': 'spell_check', 'action': 'store_true', 'help': 'If set, spell check documentation'})]

description = 'Make HTML documentation. Optionally, spell check documentation.'

help = 'Make HTML documentation. Optionally, spell check documentation.'

label = 'make_documentation'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.RunTestsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

cement.Controller for run_tests.

Run unit tests located at test-path. Optionally, generate a coverage report. Optionally, save the results to an XML file.

class Meta

Bases: object

arguments = [(['--test-path'], {'type': <class 'str'>, 'default': None, 'help': 'Path to tests to run. The path should be relative to the current directory, or an absolute path. Default: the value of the environment variable `test_path` or `./tests` if the environment variable has not been set.'}), (['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': "Path to package to test; default='.'"}), (['--n-workers'], {'type': <class 'int'>, 'default': 1, 'help': 'Numbers of workers to run tests`'}), (['--i-worker'], {'type': <class 'int'>, 'default': 0, 'help': 'Index of worker within {0 .. n-workers - 1}'}), (['--verbose'], {'default': False, 'action': 'store_true', 'help': 'if set display test output'}), (['--with-xunit'], {'default': False, 'action': 'store_true', 'help': 'if set save test results to XML file'}), (['--with-coverage'], {'default': False, 'action': 'store_true', 'help': 'if set assess code coverage'}), (['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--coverage-type'], {'type': <class 'str'>, 'default': 'branch', 'help': "Type of coverage analysis to run {statement, branch, or multiple-decision}; default='branch'"}), (['--environment'], {'type': <class 'str'>, 'default': 'local', 'help': "Environment to run tests (local, docker, or circleci); default='local'"}), (['--ssh-key-filename'], {'type': <class 'str'>, 'default': '~/.ssh/id_rsa', 'help': 'Path to GitHub SSH key'}), (['--keep-docker-container'], {'dest': 'remove_docker_container', 'action': 'store_false', 'default': True, 'help': 'Keep Docker container'})]

description = 'Run unit tests located at `test_path`'

help = 'Run unit tests located at `test_path`'

label = 'run_tests'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.RunTestsInDockerContainerController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Run tests in a Docker container

class Meta

Bases: object

arguments = [(['container'], {'type': <class 'str'>, 'help': 'Container id'}), (['--test-path'], {'type': <class 'str'>, 'default': None, 'help': 'Path to tests to run. The path should be relative to the current directory, or an absolute path. Default: the value of the environment variable `test_path` or `./tests` if the environment variable has not been set.'}), (['--n-workers'], {'type': <class 'int'>, 'default': 1, 'help': 'Numbers of workers to run tests`'}), (['--i-worker'], {'type': <class 'int'>, 'default': 0, 'help': 'Index of worker within {0 .. n-workers - 1}'}), (['--verbose'], {'default': False, 'action': 'store_true', 'help': 'if set display test output'}), (['--with-xunit'], {'default': False, 'action': 'store_true', 'help': 'if set save test results to XML file'}), (['--with-coverage'], {'default': False, 'action': 'store_true', 'help': 'if set assess code coverage'}), (['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--coverage-type'], {'type': <class 'str'>, 'default': 'branch', 'help': "Type of coverage analysis to run {statement, branch, or multiple-decision}; default='branch'"})]

description = 'Run tests in a Docker container'

help = 'Run tests in a Docker container'

label = 'run_tests_in_container'

stacked_on = 'docker'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.SetCircleciEnvironmentVariableController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Set a CircleCI environment variable for a repository

class Meta

Bases: object

arguments = [(['name'], {'type': <class 'str'>, 'help': 'Name of the environment variable.'}), (['value'], {'type': <class 'str'>, 'help': 'Value of the environment variable.'}), (['--repo-type'], {'type': <class 'str'>, 'default': None, 'help': 'Repository type (e.g., github)'}), (['--repo-owner'], {'type': <class 'str'>, 'default': None, 'help': 'Repository owner'}), (['--repo-name'], {'type': <class 'str'>, 'default': None, 'help': 'Name of the repository to build. This defaults to the name of the current repository.'})]

description = 'Set a CircleCI environment variable for a repository'

help = 'Set a CircleCI environment variable for a repository'

label = 'set_circleci_environment_variable'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.SetupRepositoryController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Setup a local Git repository with the default directory structure

class Meta

Bases: object

arguments = [(['name'], {'type': <class 'str'>, 'help': 'Name of the repository (i.e. repo_<name>)'}), (['--description'], {'default': '', 'type': <class 'str'>, 'help': 'Description of the repository'}), (['--keyword'], {'dest': 'keywords', 'default': [], 'type': <class 'str'>, 'action': 'append', 'help': 'Keyword for the repository'}), (['--dependency'], {'dest': 'dependencies', 'default': [], 'type': <class 'str'>, 'action': 'append', 'help': 'Karr Lab package that the package depends on'}), (['--public'], {'default': False, 'action': 'store_true', 'help': 'if set, make the repository public'}), (['--build-image-version'], {'default': None, 'type': <class 'str'>, 'help': 'Build image version'}), (['--dirname'], {'default': None, 'type': <class 'str'>, 'help': 'Path for the repository'}), (['--coveralls-repo-badge-token'], {'default': None, 'type': <class 'str'>, 'help': 'Coveralls badge token for the repository'}), (['--code-climate-repo-id'], {'default': None, 'type': <class 'str'>, 'help': 'Code Climate ID the repository'}), (['--code-climate-repo-badge-token'], {'default': None, 'type': <class 'str'>, 'help': 'Code Climate badge token for the repository'})]

description = 'Setup a local Git repository with the default directory structure'

help = 'Setup a local Git repository with the default directory structure'

label = 'setup_repository'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.UploadCoverageReportToCodeClimateController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Upload coverage report to Code Climate

class Meta

Bases: object

arguments = [(['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--dry-run'], {'default': False, 'dest': 'dry_run', 'action': 'store_true', 'help': 'If set, do not send results to Code Climate'})]

description = 'Upload coverage report to Code Climate'

help = 'Upload coverage report to Code Climate'

label = 'upload_coverage_report_to_code_climate'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.UploadCoverageReportToCoverallsController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Upload coverage report to Code Climate

class Meta

Bases: object

arguments = [(['--coverage-dirname'], {'type': <class 'str'>, 'default': 'tests/reports', 'help': "Directory to store coverage data; default='tests/reports'"}), (['--dry-run'], {'default': False, 'dest': 'dry_run', 'action': 'store_true', 'help': 'If set, do not send results to Coveralls'})]

description = 'Upload coverage report to Coveralls'

help = 'Upload coverage report to Coveralls'

label = 'upload_coverage_report_to_coveralls'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.UploadPackageToPypiController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Upload package to PyPI

class Meta

Bases: object

arguments = [(['--dirname'], {'type': <class 'str'>, 'default': '.', 'help': 'Path to package (e.g. parent directory of setup.py)'}), (['--repository'], {'type': <class 'str'>, 'default': 'pypi', 'help': 'Repository upload package (e.g. pypi or testpypi)'}), (['--do-not-upload-source'], {'default': False, 'action': 'store_true', 'help': 'if set, do not upload source code to PyPI'}), (['--do-not-upload-build'], {'default': False, 'action': 'store_true', 'help': 'if set, do not upload build to PyPI'})]

description = 'Upload package to PyPI'

help = 'Upload package to PyPI'

label = 'upload_package_to_pypi'

stacked_on = 'base'

stacked_type = 'nested'

class karr_lab_build_utils.__main__.VisualizePackageDependenciesController(*args, **kw)

Bases: cement.ext.ext_argparse.ArgparseController

Visualize downstream package dependencies as a graph

class Meta

Bases: object

arguments = [(['--packages-parent-dir'], {'type': <class 'str'>, 'default': '..', 'help': 'Path to the parent directory of the other packages'}), (['--out-filename'], {'type': <class 'str'>, 'default': '../package_dependencies.pdf', 'help': 'Path to save the visualization'})]

description = 'Visualize downstream package dependencies as a graph'

help = 'Visualize downstream package dependencies as a graph'

label = 'visualize_package_dependencies'

stacked_on = 'base'

stacked_type = 'nested'

karr_lab_build_utils.__main__.main()

4.1.4. karr_lab_build_utils._version module

4.1.5. karr_lab_build_utils.core module

Karr Lab build utilities

Author

Jonathan Karr <karr@mssm.edu>

Date

2016-08-02

Copyright

2016-2018, Karr Lab

License

MIT

class karr_lab_build_utils.core.BuildHelper

Bases: object

Utility class to help build projects:

• Run tests

• Archive reports to test history server, Coveralls, and Code Climate

test_runner

name of test runner {pytest, nose}

Type

str

repo_name

repository name

Type

str

repo_owner

name of the repository owner

Type

str

repo_branch

repository branch name

Type

str

repo_revision

sha of repository revision

Type

str

build_num

CircleCI build number

Type

int

proj_tests_dir

local directory with test code

Type

str

proj_tests_xml_dir

local directory to store latest XML test report

Type

str

proj_tests_xml_latest_filename

file name to store latest XML test report

Type

str

proj_docs_dir

local directory with Sphinx configuration

Type

str

proj_docs_static_dir

local directory of static documentation files

Type

str

proj_docs_source_dir

local directory of source documentation files created by sphinx-apidoc

Type

str

proj_docs_build_doctrees_dir

local directory where doc trees should be saved

Type

str

proj_docs_build_html_dir

local directory where generated HTML documentation should be saved

Type

str

proj_docs_build_spelling_dir

local directory where spell check results should be saved

Type

str

build_image

Docker image to use to run tests

Type

str

configs_repo_url

URL to Git repository with passwords

Type

str

configs_repo_username

username for Git repository with passwords

Type

str

configs_repo_password

password for Git repository with passwords

Type

str

configs_repo_path

path to clone Git repository with passwords

Type

str

github_api_token

GitHub API token

Type

str

circleci_api_token

CircleCI API token

Type

str

test_server_token

test history report server token

Type

str

email_hostname

hostname and port for email server

Type

str

email_username

username for email server

Type

str

email_password

password for email_username

Type

str

code_server_hostname

code server host name

Type

str

code_server_directory

code server directory

Type

str

code_server_username

code server username

Type

str

code_server_password

code server password

Type

str

docs_server_hostname

docs server host name

Type

str

docs_server_directory

docs server directory

Type

str

docs_server_username

docs server username

Type

str

docs_server_password

docs server password

Type

str

pypi_repository

PyPI repository name or URL

Type

str

pypi_config_filename

path to PyPI configuration file

Type

str

coveralls_token

Coveralls token

Type

str

code_climate_token

Code Climate token

Type

str

INITIAL_PACKAGE_VERSION

initial package version

Type

str

DEFAULT_BUILD_IMAGE_VERSION

default build image version

Type

str

DEFAULT_TEST_RUNNER

default test runner {pytest, nose}

Type

str

DEFAULT_PROJ_TESTS_DIR

default local directory with test code

Type

str

DEFAULT_PROJ_TESTS_XML_DIR

default local directory where the test reports generated should be saved

Type

str

DEFAULT_PROJ_TESTS_XML_LATEST_FILENAME

default file name to store latest XML test report

Type

str

DEFAULT_PROJ_DOCS_DIR

default local directory with Sphinx configuration

Type

str

DEFAULT_PROJ_DOCS_STATIC_DIR

default local directory of static documentation files

Type

str

DEFAULT_PROJ_DOCS_SOURCE_DIR

default local directory of source documentation files created by sphinx-apidoc

Type

str

DEFAULT_PROJ_DOCS_SPELLING_DIR

default local directory where spell check results should be saved

Type

str

DEFAULT_PROJ_DOCS_BUILD_HTML_DIR

default local directory where generated HTML documentation should be saved

Type

str

DEFAULT_BUILD_IMAGE

default Docker image to use to run tests

Type

str

GITHUB_API_ENDPOINT

GitHub API endpoint

Type

str

CIRCLE_API_ENDPOINT

CircleCI API endpoint

Type

str

COVERALLS_ENABLED

if True, upload coverage reports to Coveralls

Type

bool

CODE_CLIMATE_ENABLED

if True, upload coverage reports to Code Climate

Type

bool

Construct build helper

CIRCLE_API_ENDPOINT = 'https://circleci.com/api'

CODE_CLIMATE_ENABLED = True

COVERALLS_ENABLED = True

DEFAULT_BUILD_IMAGE = 'karrlab/wc_env_dependencies:latest'

DEFAULT_BUILD_IMAGE_VERSION = 'latest'

DEFAULT_PROJ_DOCS_BUILD_DOCTREES_DIR = 'docs/_build/doctrees'

DEFAULT_PROJ_DOCS_BUILD_HTML_DIR = 'docs/_build/html'

DEFAULT_PROJ_DOCS_BUILD_SPELLING_DIR = 'docs/_build/spelling'

DEFAULT_PROJ_DOCS_DIR = 'docs'

DEFAULT_PROJ_DOCS_SOURCE_DIR = 'docs/source'

DEFAULT_PROJ_DOCS_STATIC_DIR = 'docs/_static'

DEFAULT_PROJ_TESTS_DIR = 'tests'

DEFAULT_PROJ_TESTS_XML_DIR = 'tests/reports'

DEFAULT_PROJ_TESTS_XML_LATEST_FILENAME = 'latest'

DEFAULT_TEST_RUNNER = 'pytest'

GITHUB_API_ENDPOINT = 'https://api.github.com'

INITIAL_PACKAGE_VERSION = '0.0.1'

PATCHED_PACKAGES = ('log', 'pip-check-reqs')

analyze_package(package_name, messages=None, config_filename=None, verbose=False)

Perform static analyses of a package using Pylint.

The default options will identify the following issues:

• Unused imported modules, classes, functions, and variables

• Reimported modules, classes, functions, and variables

• Wild card imports outside of __init__.py

• Duplicate arguments and keys

• Missing requirements

Parameters

• package_name (str) – name of the package to analyze

• messages (list of str, optional) – list of Pylint checks to perform

• config_filename (str, optional) – path to Pylist configuration file (rcfile)

• verbose (bool, optional) – if True, display extra Pylint information

Returns

pylint return code

Return type

int

archive_coverage_report(coverage_dirname='tests/reports', dry_run=False)

Archive coverage report:

• Upload report to Coveralls

• Upload report to Code Climate

Parameters

• coverage_dirname (str, optional) – directory to save coverage data

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

archive_test_report()

Upload test report to history server

Raises

BuildHelperError – if there is an error uploading the report to the test history server

are_package_dependencies_acyclic(packages_parent_dir='..')

Check if the package dependencies are acyclic so they are supported by CircleCI

Parameters

packages_parent_dir (str, optional) – path to the parent directory of the packages

Returns

True if the package dependencies are acyclic

Return type

bool

combine_coverage_reports(coverage_dirname='tests/reports')

Parameters

coverage_dirname (str, optional) – directory to merge coverage files

compile_downstream_dependencies(dirname='.', packages_parent_dir='..', config_filename=None)

Compile the downstream dependencies of a package and save them to config_filename

Parameters

• dirname (str, optional) – path to package

• packages_parent_dir (str, optional) – path to the parent directory of the packages

• config_filename (str, optional) – path to save configuration with list of downstream dependencies in YAML format

Returns

downstream dependencies

Return type

list of str

Raises

BuildHelperError – if a package has more than one module

create_code_climate_github_webhook(repo_type=None, repo_owner=None, repo_name=None)

Create GitHub webhook for Code Climate

Parameters

• repo_type (str, optional) – repository type

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

Raises

ValueError – if webhook wasn’t created and didn’t already exist

create_docker_container(ssh_key_filename='~/.ssh/id_rsa')

Create a docker container

Parameters

ssh_key_filename (str, optional) – path to GitHub SSH key

Returns

container id

Return type

str

create_documentation_template(dirname='.')

Create Sphinx documentation template for a package

Parameters

dirname (str, optional) – path to package

Raises

ValueError – if no package or more than one package is specified

create_package(pypi_repository=None)

Create a package

• Create a local Git repository

• Create a remote GitHub repository

• Add the repository to Code Climate

• Add the repository to Coveralls

• Add the repository to CircleCI project (by following the GitHub repository)

  • Add environment variable for tokens for code.karrlab.org, Coveralls, Code Climate, and CircleCI

  • Add environment variable for password for karr.lab.daemon@gmail.com

  • Generate API token for status badge

• If the repository is not private, add the repository to Read the Docs

• Add the package to code.karrlab.org

  • Add JSON-formatted file to ssh://code.karrlab.org:/home/karrlab_code/code.karrlab.org/repo/{{ name }}.json

• Add badges for Code Climate, Coveralls, CircleCI, and Read the Docs to README.md

• Add package name to downstream_dependencies key in .karr_lab_build_utils.yml

Parameters

pypi_repository (str, optional) – name of a repository defined in the PyPI configuration file or a repository URL

create_repository(name, description='', private=True, dirname=None)

Create a GitHub repository and clone the repository locally

Parameters

• ( (name) – obj`str`): package name

• description (str, optional) – package description

• private (bool, optional) – if False, make the GitHub repository public and set up documentation generation with Read the Docs

• dirname (str, optional) – directory name for repository

delete_circleci_environment_variable(var, repo_type=None, repo_owner=None, repo_name=None)

Delete a CircleCI environment variable for a repository

Parameters

• var (str) – name of variable to delete

• repo_type (str, optional) – repository type

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

do_post_test_tasks(installation_error, tests_error, dry_run=False)

Do all post-test tasks for CircleCI

• Make test and coverage reports

• Compile documentation

• Archive test and coverage reports to the Karr Lab test history server, Coveralls, and Code Climate

• Trigger tests of downstream dependencies

• Notify authors of new failures in downstream packages

Parameters

• installation_error (bool) – True if there were other errors during the installation

• tests_error (bool) – obj:False if the tests passes

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

Returns

names of triggered packages dict of str, str: dictionary which maps names of untriggered packages to the reasons

why they weren’t triggered

dict: status of a set of results dict: exception from make_and_archive_reports

Return type

list of str

download_package_config_files()

Download the configuration repository

Parameters

update (bool, optional) – if True, update the configuration

find_missing_requirements(package_name, dirname='.')

Finding missing requirements

Parameters

• package_name (str) – name of the package to analyze

• dirname (str, optional) – path to package

Returns

list of missing dependencies and their occurences in the code

Return type

list

find_unused_requirements(package_name, dirname='.')

Finding unused_requirements

Parameters

• package_name (str) – name of the package to analyze

• dirname (str, optional) – path to package

Returns

name of the unused dependencies

Return type

list

follow_circleci_build(repo_type=None, repo_owner=None, repo_name=None, has_private_dependencies=False)

Follow CircleCI build for a repository

Parameters

• repo_type (str, optional) – repository type

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

• has_private_dependencies (bool, optional) – if True, add a GitHub SSH key for the Karr Lab machine user to the build

Raises

ValueError – if a CircleCI build wasn’t followed and didn’t already exist

get_build_config()

Get build configuration

Returns

build configuration

Return type

dict

get_circleci_environment_variables(repo_type=None, repo_owner=None, repo_name=None)

Get the CircleCI environment variables for a repository and their partial values

Parameters

• repo_type (str, optional) – repository type

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

Returns

dictionary of environment variables and their partial values

Return type

dict

get_latest_docs_version(ftp, dirname)

static get_python_version()

Get the Python version

Returns

the Python version

Return type

str

get_test_results()

Load test results from a set of XML files

Results:

TestResults: test results

get_test_results_status(test_results, installation_error, tests_error, other_error, dry_run=False)

Get the status of a set of results

• Old err

• New error

• Fixed error

• New downstream error

Parameters

• test_results (TestResults) – test results

• installation_error (bool) – True if there were other errors during the installation

• tests_error (bool) – obj:False if the tests passes

• other_error (bool) – True if there were other errors during the build such as in generating and/or archiving the reports

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

Returns

status of a set of results

Return type

dict

get_version()

Get the version of this package

Returns

the version

Return type

str

install_package_config_files(overwrite=False)

Copy third party configs to their appropriate paths from the configs repository

Parameters

overwrite (bool, optional) – if True, overwrite existing configuration files

install_package_to_docker_container(container, dirname='.')

Copy and install package to Docker container

Parameters

• container (str) – container id

• dirname (str, optional) – path to package to copy and install

install_requirements(upgrade=False)

Install requirements

Parameters

upgrade (bool, optional) – if True, upgrade requirements

log_environment()

Log environment

• pip packages

• Quilt packages

make_and_archive_reports(coverage_dirname='tests/reports', dry_run=False)

Make and archive reports:

• Upload test report to history server

• Upload coverage report to Coveralls and Code Climate

Parameters

• coverage_dirname (str, optional) – directory to merge coverage files

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

Returns

analyses of missing and unused requirements

Return type

dict

make_api_documentation()

Compile API documentation

make_documentation(spell_check=False)

Make HTML documentation using Sphinx for one or more packages. Save documentation to proj_docs_build_html_dir

Parameters

spell_check (bool) – if True, run spell checking

Raises

BuildHelperError – If project name not set

remove_docker_container(container)

Stop and remove a docker container

Parameters

container (str) – container id

run_circleci_api(command, version='1.1', method='get', repo_type=None, repo_owner=None, repo_name=None, data=None)

Run the CircleCI API

Parameters

• command (str) – API command

• version (str, optional) – version of the API to use

• method (str, optional) – type of HTTP request (get, post, delete)

• repo_type (str, optional) – repository type (e.g., github)

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

• data (str, optional) – data

Returns

CircleCI result

Return type

dict

Raises

requests.exceptions.HTTPError – if the HTTP request to CircleCI does not succeed

run_method_and_capture_stderr(func, *args, **kwargs)

Run a method that returns a numerical error value, and exit if the return value is non-zero

Parameters

• func (function) – function to run

• *args – arguments to func

• **kwargs – keyword arguments to obj:func

run_method_and_capture_stdout(func, *args, **kwargs)

Run a method that returns a numerical error value, and exit if the return value is non-zero

Parameters

• func (function) – function to run

• *args – arguments to func

• **kwargs – keyword arguments to obj:func

Returns

stdout

Return type

str

run_tests(dirname='.', test_path=None, n_workers=1, i_worker=0, verbose=False, with_xunit=False, with_coverage=False, coverage_dirname='tests/reports', coverage_type=<CoverageType.branch: 1>, environment=<Environment.local: 0>, exit_on_failure=True, ssh_key_filename='~/.ssh/id_rsa', remove_docker_container=True)

Run unit tests located at test_path.

Optionally, generate a coverage report. Optionally, save the results to a file

To configure coverage, place a .coveragerc configuration file in the root directory of the repository - the same directory that holds .coverage. Documentation of coverage configuration is in https://coverage.readthedocs.io/en/coverage-4.2/config.html

Parameters

• dirname (str, optional) – path to package that should be tested

• test_path (str, optional) – path to tests that should be run

• n_workers (int, optional) – number of workers to run tests

• i_worker (int, optional) – index of worker within {0 .. n_workers - 1}

• verbose (str, optional) – if True, display stdout from tests

• with_xunit (bool, optional) – whether or not to save test results

• with_coverage (bool, optional) – whether or not coverage should be assessed

• coverage_dirname (str, optional) – directory to save coverage data

• coverage_type (CoverageType, optional) – type of coverage to run when with_coverage is True

• environment (str, optional) – environment to run tests (local, docker, or circleci-local-executor)

• exit_on_failure (bool, optional) – whether or not to exit on test failure

• ssh_key_filename (str, optional) – path to GitHub SSH key; needed for Docker environment

• remove_docker_container (bool, optional) – if True, remove Docker container

Raises

BuildHelperError – If the environment is not supported or the package directory not set

run_tests_in_docker_container(container, test_path=None, n_workers=1, i_worker=0, verbose=False, with_xunit=False, with_coverage=False, coverage_dirname='tests/reports', coverage_type=<CoverageType.branch: 1>)

Test a package in a docker container

Parameters

• container (str) – container id

• test_path (str, optional) – path to tests that should be run

• n_workers (int, optional) – number of workers to run tests

• i_worker (int, optional) – index of worker within {0 .. n_workers - 1}

• verbose (str, optional) – if True, display stdout from tests

• with_xunit (bool, optional) – whether or not to save test results

• with_coverage (bool, optional) – whether or not coverage should be assessed

• coverage_dirname (str, optional) – directory to save coverage data

• coverage_type (CoverageType, optional) – type of coverage to run when with_coverage is True

send_email_notifications(installation_error, tests_error, other_error, static_analyses, dry_run=False)

Send email notifications of failures, fixes, and downstream failures

Parameters

• installation_error (bool) – True if there were other errors during the installation

• tests_error (bool) – obj:False if the tests passes

• other_error (bool) – True if there were other errors during the build such as in generating and/or archiving the reports

• static_analyses (dict) – analyses of missing and unused requirements

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

Returns

status of a set of results

Return type

dict

set_circleci_environment_variables(vars, repo_type=None, repo_owner=None, repo_name=None)

Set the CircleCI environment variables for a repository

Parameters

• vars (dict) – dictionary of environment variables to set

• repo_type (str, optional) – repository type

• repo_owner (str, optional) – repository owner

• repo_name (str, optional) – repository name

Returns

dictionary of environment variables and their values

Return type

dict

setup_docs_htaccess_files()

Setup htaccess files for docs server

setup_repository(name, description='', keywords=None, dependencies=None, private=True, build_image_version=None, dirname=None, circleci_repo_token=None, coveralls_repo_badge_token=None, code_climate_repo_id=None, code_climate_repo_badge_token=None)

Setup a local Git repository with the default directory structure

Parameters

• ( (name) – obj`str`): package name

• description (str, optional) – package description

• keywords (list of str, optional) – list of keywords

• dependencies (list of str, optional) – list of Karr Lab packages that the package depends on

• private (bool, optional) – if False, make the GitHub repository public and set up documentation generation with Read the Docs

• build_image_version (str, optional) – build image version

• dirname (str, optional) – directory name

• circleci_repo_token (str, optional) – CircleCI API token (e.g. for badges) for the repository

• coveralls_repo_badge_token (str, optional) – Coveralls badge token for the repository

• code_climate_repo_id (str, optional) – Code Climate ID for the repository

• code_climate_repo_badge_token (str, optional) – Code Climate for the repository

trigger_tests_of_downstream_dependencies(config_filename='.karr_lab_build_utils.yml', dry_run=False)

Trigger CircleCI to test downstream dependencies listed in config_filename

Parameters

• config_filename (str, optional) – path to YAML configuration file which contains a list of downstream dependencies

• dry_run (bool, optional) – if true, don’t upload to the Coveralls and Code Climate servers

Returns

names of triggered packages dict of str, str: dictionary which maps names of untriggered packages to the reasons

why they weren’t triggered

Return type

list of str

Todo

support branches

upgrade_karr_lab_packages()

Upgrade the packages from the Karr Lab’s GitHub organization

Returns

upgraded requirements from the Karr Lab’s GitHub organization

Return type

list of str

upload_coverage_report_to_code_climate(coverage_dirname='tests/reports', dry_run=False)

Upload coverage report to Code Climate

Parameters

• coverage_dirname (str, optional) – directory to save coverage data

• dry_run (bool, optional) – if true, don’t upload to the Coveralls server

Raises

BuildHelperError – If error uploading code coverage to Code Climate

upload_coverage_report_to_coveralls(coverage_dirname='tests/reports', dry_run=False)

Upload coverage report to Coveralls

Parameters

• coverage_dirname (str, optional) – directory to save coverage data

• dry_run (bool, optional) – if true, don’t upload to the Coveralls server

upload_documentation_to_docs_server(dirname='.')

Upload compiled documentation to the lab server

Parameters

dirname (str, optional) – path to package

upload_package_to_pypi(dirname='.', repository=None, upload_source=True, upload_build=True)

Upload a package to PyPI

Parameters

• dirname (str, optional) – path to package to upload

• repository (str, optional) – name of a repository defined in the PyPI configuration file or a repository URL

• upload_source (bool, optional) – if True, upload source code

• upload_build (bool, optional) – if True

visualize_package_dependencies(packages_parent_dir='..', out_filename='../package_dependencies.pdf')

Visualize downstream package dependencies as a graph

Parameters

• packages_parent_dir (str, optional) – path to the parent directory of the packages

• out_filename (str, optional) – path to save visualization

exception karr_lab_build_utils.core.BuildHelperError

Bases: Exception

Represents BuildHelper errors

class karr_lab_build_utils.core.CoverageType

Bases: enum.Enum

Types of coverage

branch = 1

decision = 2

multiple_condition = 2

statement = 0

class karr_lab_build_utils.core.Environment

Bases: enum.Enum

Environments to run tests

circleci = 2

docker = 1

local = 0

class karr_lab_build_utils.core.TestCaseResult

Bases: object

The result of a test case

classname

name of the class of the test case

Type

str

name

name of the test case

Type

str

filename

file where the test was defined

Type

str

line

line where the test was defined

Type

int

python_version

python version which ran the test

Type

str

type

type of the result (pass, skip, error, failure)

Type

TestCaseResultType

subtype

detailed type of the result

Type

str

message

message from the result

Type

str

details

detailed message from the result

Type

str

time

duration of the time in seconds

Type

float

stdout

standard output

Type

str

stderr

standard error

Type

str

class karr_lab_build_utils.core.TestCaseResultType

Bases: enum.Enum

Type of test case result

error = 2

failure = 3

passed = 0

skipped = 1

class karr_lab_build_utils.core.TestResults

Bases: object

Unit test results

cases

test case results

Type

list of TestCase

get_num_errors()

Get the number of tests with errors

Returns

number of tests with errors

Return type

int

get_num_failures()

Get the number of tests with failures

Returns

number of tests with failures

Return type

int

get_num_passed()

Get the number of tests that passed

Returns

number of tests that passed

Return type

int

get_num_skipped()

Get the number of skipped tests

Returns

number of skipped tests

Return type

int

get_num_tests()

Get the number of tests

Returns

number of tests

Return type

int

property num_errors

property num_failures

property num_passed

property num_skipped

property num_tests

4.1.6. Module contents