-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
major work on getting tests in place
- Loading branch information
Showing
17 changed files
with
365 additions
and
297 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ build-backend = "hatchling.build" | |
|
|
||
| [project] | ||
| name = "malcolm-test" | ||
| version = "0.1.0" | ||
| version = "0.2.0" | ||
| authors = [ | ||
| { name="Seth Grover", email="[email protected]" }, | ||
| ] | ||
|
|
@@ -29,7 +29,10 @@ Homepage = "https://github.com/idaholab/malcolm-test" | |
| Issues = "https://github.com/idaholab/malcolm-test/issues" | ||
|
|
||
| [project.scripts] | ||
| malcolm-test = "malcolm_test:main" | ||
| malcolm-test = "maltest:main" | ||
|
|
||
| [tool.hatch.build.targets.wheel] | ||
| packages = ["src/maltest"] | ||
|
|
||
| [tool.pytest.ini_options] | ||
| pythonpath = "src" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,308 @@ | ||
| #!/usr/bin/env python3 | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| import argparse | ||
| import json | ||
| import logging | ||
| import mmguero | ||
| import multiprocessing | ||
| import os | ||
| import psutil | ||
| import pytest | ||
| import signal | ||
| import sys | ||
|
|
||
| from maltest.utils import MalcolmVM, ShuttingDown, set_malcolm_vm_info | ||
|
|
||
| ################################################################################################### | ||
| script_name = os.path.basename(__file__) | ||
| script_path = os.path.dirname(os.path.realpath(__file__)) | ||
|
|
||
|
|
||
| ################################################################################################### | ||
| # handle sigint/sigterm and set a global shutdown variable | ||
| def shutdown_handler(signum, frame): | ||
| ShuttingDown[0] = True | ||
|
|
||
|
|
||
| ################################################################################################### | ||
| # main | ||
| def main(): | ||
| parser = argparse.ArgumentParser( | ||
| description='\n'.join( | ||
| [ | ||
| 'See README.md for usage details.', | ||
| ] | ||
| ), | ||
| formatter_class=argparse.RawTextHelpFormatter, | ||
| add_help=True, | ||
| usage=f'{script_name} <arguments>', | ||
| ) | ||
| parser.add_argument( | ||
| '--verbose', | ||
| '-v', | ||
| action='count', | ||
| default=1, | ||
| help='Increase verbosity (e.g., -v, -vv, etc.)', | ||
| ) | ||
| parser.add_argument( | ||
| '-r', | ||
| '--rm', | ||
| dest='removeAfterExec', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=False, | ||
| help="Remove virtual Malcolm instance after execution is complete", | ||
| ) | ||
|
|
||
| repoArgGroup = parser.add_argument_group('Malcolm Git repo') | ||
| repoArgGroup.add_argument( | ||
| '-g', | ||
| '--github-url', | ||
| required=False, | ||
| dest='repoUrl', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('MALCOLM_REPO_URL', 'idaholab'), | ||
| help='Malcolm repository url (e.g., https://github.com/idaholab/Malcolm)', | ||
| ) | ||
| repoArgGroup.add_argument( | ||
| '-b', | ||
| '--github-branch', | ||
| required=False, | ||
| dest='repoBranch', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('MALCOLM_REPO_BRANCH', 'main'), | ||
| help='Malcolm repository branch (e.g., main)', | ||
| ) | ||
|
|
||
| vmSpecsArgGroup = parser.add_argument_group('Virtual machine specifications') | ||
| vmSpecsArgGroup.add_argument( | ||
| '-c', | ||
| '--cpus', | ||
| dest='vmCpuCount', | ||
| required=False, | ||
| metavar='<integer>', | ||
| type=int, | ||
| default=(multiprocessing.cpu_count() // 2), | ||
| help='Number of CPUs for virtual Malcolm instance', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '-m', | ||
| '--memory', | ||
| dest='vmMemoryGigabytes', | ||
| required=False, | ||
| metavar='<integer>', | ||
| type=int, | ||
| default=max(16, int(round(psutil.virtual_memory().total / (1024.0**3))) // 2), | ||
| help='System memory (GB) for virtual Malcolm instance', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '-d', | ||
| '--disk', | ||
| dest='vmDiskGigabytes', | ||
| required=False, | ||
| metavar='<integer>', | ||
| type=int, | ||
| default=64, | ||
| help='Disk size (GB) for virtual Malcolm instance', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '-i', | ||
| '--image', | ||
| required=False, | ||
| dest='vmImage', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_IMAGE', 'debian-12'), | ||
| help='Malcolm virtual instance base image name (e.g., debian-12)', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--image-user', | ||
| required=False, | ||
| dest='vmImageUsername', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_USER', 'debian'), | ||
| help='Malcolm virtual instance base image username (e.g., debian)', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--vm-name-prefix', | ||
| required=False, | ||
| dest='vmNamePrefix', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_NAME_PREFIX', 'malcolm'), | ||
| help='Prefix for Malcolm VM name (e.g., malcolm)', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--existing-vm', | ||
| required=False, | ||
| dest='vmExistingName', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_EXISTING', ''), | ||
| help='Name of an existing virter VM to use rather than starting up a new one', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--vm-provision', | ||
| dest='vmProvision', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=True, | ||
| help=f'Perform VM provisioning', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--vm-provision-malcolm', | ||
| dest='vmProvisionMalcolm', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=True, | ||
| help=f'Perform VM provisioning (Malcolm-specific)', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--vm-provision-path', | ||
| required=False, | ||
| dest='vmProvisionPath', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_PROVISION_PATH', os.path.join(script_path, 'virter')), | ||
| help=f'Path containing subdirectories with TOML files for VM provisioning (e.g., {os.path.join(script_path, "virter")})', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--build-vm', | ||
| required=False, | ||
| dest='vmBuildName', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('VIRTER_BUILD_VM', ''), | ||
| help='The name for a new VM image to build and commit instead of running one', | ||
| ) | ||
| vmSpecsArgGroup.add_argument( | ||
| '--build-vm-keep-layers', | ||
| dest='vmBuildKeepLayers', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=False, | ||
| help=f"Don't remove intermediate layers when building a new VM image", | ||
| ) | ||
|
|
||
| configArgGroup = parser.add_argument_group('Malcolm runtime configuration') | ||
| configArgGroup.add_argument( | ||
| '--container-image-file', | ||
| required=False, | ||
| dest='containerImageFile', | ||
| metavar='<string>', | ||
| type=str, | ||
| default='', | ||
| help='Malcolm container images .tar.xz file for installation (instead of "docker pull")', | ||
| ) | ||
| configArgGroup.add_argument( | ||
| '-s', | ||
| '--start', | ||
| dest='startMalcolm', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=True, | ||
| help=f'Start Malcolm once provisioning is complete (default true)', | ||
| ) | ||
| configArgGroup.add_argument( | ||
| '--sleep', | ||
| dest='postInitSleep', | ||
| required=False, | ||
| metavar='<integer>', | ||
| type=int, | ||
| default=30, | ||
| help='Seconds to sleep after init before starting Malcolm (default 30)', | ||
| ) | ||
|
|
||
| testArgGroup = parser.add_argument_group('Testing configuration') | ||
| testArgGroup.add_argument( | ||
| '--test-path', | ||
| required=False, | ||
| dest='testPath', | ||
| metavar='<string>', | ||
| type=str, | ||
| default=os.getenv('MALCOLM_TEST_PATH', os.path.join(script_path, 'tests')), | ||
| help=f'Path containing test definitions (e.g., {os.path.join(script_path, 'tests')})', | ||
| ) | ||
| configArgGroup.add_argument( | ||
| '-t', | ||
| '--run-tests', | ||
| dest='runTests', | ||
| type=mmguero.str2bool, | ||
| nargs='?', | ||
| metavar="true|false", | ||
| const=True, | ||
| default=True, | ||
| help=f'Run test suite once Malcolm is started', | ||
| ) | ||
|
|
||
| try: | ||
| parser.error = parser.exit | ||
| args = parser.parse_args() | ||
| except SystemExit as e: | ||
| mmguero.eprint(f'Invalid argument(s): {e}') | ||
| sys.exit(2) | ||
|
|
||
| # configure logging levels based on -v, -vv, -vvv, etc. | ||
| args.verbose = logging.CRITICAL - (10 * args.verbose) if args.verbose > 0 else 0 | ||
| logging.basicConfig( | ||
| level=args.verbose, format='%(asctime)s %(levelname)s: %(message)s', datefmt='%Y-%m-%d %H:%M:%S' | ||
| ) | ||
| logging.info(os.path.join(script_path, script_name)) | ||
| logging.info("Arguments: {}".format(sys.argv[1:])) | ||
| logging.info("Arguments: {}".format(args)) | ||
| if args.verbose > logging.DEBUG: | ||
| sys.tracebacklimit = 0 | ||
|
|
||
| # the whole thing runs on virter, so if we don't have that what are we even doing here | ||
| err, _ = mmguero.RunProcess(['virter', 'version']) | ||
| if err != 0: | ||
| logging.error(f'{script_name} requires virter, please see https://github.com/LINBIT/virter') | ||
| return 1 | ||
|
|
||
| # handle sigint and sigterm for graceful shutdown | ||
| signal.signal(signal.SIGINT, shutdown_handler) | ||
| signal.signal(signal.SIGTERM, shutdown_handler) | ||
|
|
||
| malcolmVm = MalcolmVM( | ||
| args=args, | ||
| debug=(args.verbose <= logging.DEBUG), | ||
| logger=logging, | ||
| ) | ||
| try: | ||
| if args.vmBuildName: | ||
| exitCode = malcolmVm.Build() | ||
| else: | ||
| exitCode = malcolmVm.Start() | ||
| malcolmInfo = malcolmVm.Info() | ||
| logging.info(json.dumps(malcolmInfo)) | ||
| set_malcolm_vm_info(malcolmInfo) | ||
| if args.runTests and os.path.isdir(args.testPath): | ||
| exitCode = pytest.main(['-p', 'no:cacheprovider', args.testPath]) | ||
| malcolmVm.WaitForShutdown() | ||
| finally: | ||
| del malcolmVm | ||
|
|
||
| logging.info(f'{script_name} returning {exitCode}') | ||
| return exitCode | ||
|
|
||
|
|
||
| ################################################################################################### | ||
| if __name__ == '__main__': | ||
| if main() > 0: | ||
| sys.exit(0) | ||
| else: | ||
| sys.exit(1) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # -*- coding: utf-8 -*- | ||
|
|
||
| import pytest | ||
| from maltest.utils import get_malcolm_vm_info | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def malcolm_vm_info(): | ||
| return get_malcolm_vm_info() |
Oops, something went wrong.