codecraftai-testplus 1.2.0__py3-none-any.whl

ccai/testplus/__init__.py

@@ -0,0 +1,57 @@
+"""
+    .. module:: testplus
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: Top level package for the TestPlus framework which exposes
+    commonly used APIs and decorators from the underlying
+    ``ccai.testbase`` package.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+
+
+from ccai.xmodules.xlogging.enhancedloggers import (
+    EnhancedLogger,
+    getEnhancedLogger
+)
+logger: EnhancedLogger = getEnhancedLogger()
+
+
+from ccai.testbase.declaration import registrations as register
+from ccai.testbase.declaration import originations as originate
+from ccai.testbase.declaration import attachments as attach
+
+from ccai.testbase.verification import (
+    assert_dict_response_has_keys,
+    assert_dict_response_has_paths,
+    assert_equal,
+    assert_expression,
+    assert_greater,
+    assert_lessthan,
+    assert_list_length,
+    assert_list_length_greater,
+    assert_not_equal,
+    assert_type
+)
+
+from ccai.testbase.markers import (
+    mark_categories,
+    mark_keywords,
+    mark_priority,
+    mark_descendent_categories,
+    mark_descendent_keywords,
+    mark_descendent_priority
+)
+
+from ccai.testbase.results.model.taskingresult import (
+    verify_tasking_results
+)
+
+from ccai.testbase.constraints import (
+    Constraints,
+    ConstraintsCatalog,
+    FeatureConstraints
+)

ccai/testplus/cli/__init__.py

@@ -0,0 +1,13 @@
+"""
+    .. module:: cli
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: Package containing the command line interface implementation for
+    the ``testplus`` command.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+

ccai/testplus/cli/cmdtree/__init__.py

@@ -0,0 +1,13 @@
+"""
+    .. module:: cmdtree
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: Package defining the command tree structure for the ``testplus``
+    CLI.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+

ccai/testplus/cli/cmdtree/testing/__init__.py

@@ -0,0 +1,33 @@
+"""
+    .. module:: testing
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: CLI group providing commands for interacting with tests and test
+    results.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+__version__ = "1.0.0"
+
+import click
+
+from ccai.testplus.cli.cmdtree.testing.jobs import group_testplus_testing_jobs
+from ccai.testplus.cli.cmdtree.testing.query import command_testplus_testing_query
+from ccai.testplus.cli.cmdtree.testing.run import command_testplus_testing_run
+
+@click.group("testing", help="Contains command for working with tests and test results.")
+def group_testplus_testing():
+    """
+        Root command group for TestPlus testing related operations.
+
+        :returns: ``None``
+    """
+
+    return
+
+group_testplus_testing.add_command(group_testplus_testing_jobs)
+group_testplus_testing.add_command(command_testplus_testing_query)
+group_testplus_testing.add_command(command_testplus_testing_run)

ccai/testplus/cli/cmdtree/testing/constants.py

@@ -0,0 +1,62 @@
+"""
+    .. module:: constants
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: Constants used by the TestPlus testing command tree.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+
+
+from ccai.configuration.normalize import SEPARATOR
+
+CONFIGURATION_CHOICES = [
+    "all",
+    "credentials",
+    "landscape",
+    "topology",
+    "runtime"
+]
+
+HELP_ROOT = "The root directory to use when scanning for tests."
+HELP_INCLUDES = "Add a test inclusion expression."
+HELP_EXCLUDES = "Add a test exclusion expression."
+HELP_OUTPUT = "The output directory where results and artifacts are collected."
+HELP_START = r"A time stamp to associate with the start of the run. Example: 2020-10-17T15:30:11.989120  Bash: date +%Y-%m-%dT%H:%M:%S.%N"
+HELP_BRANCH = "The name of the branch to associate with the test run results."
+HELP_BUILD = "The name of the build to associate with the test run results."
+HELP_FLAVOR = "The name of the flavor to associate with the test run results."
+HELP_JOB_ID = "A unique identifier for the job with respect to the job runner."
+HELP_JOB_INITIATOR = "The name of the initiator of the job."
+HELP_JOB_LABEL = "The label associated with the job."
+HELP_JOB_NAME = "The name of the job."
+HELP_JOB_OWNER = "The ownerid and possibly appended ';(display name)' of the test run result owner."
+HELP_DEFAULT_CONFIGS = "Indicates that one or more default configurations should be used."
+HELP_CONFIG_NAME = "A configuration common base name to use for both the 'landscape' and 'topology' configurations."
+HELP_CREDENTIAL = "The full path or URI of the credentials file to use for the testrun."
+HELP_CREDENTIAL_NAMES = "The base name of the credential files to search for in the credential path."
+HELP_CREDENTIAL_SOURCES = f"A '{SEPARATOR}' seperated list of source uris to search for credential documents."
+HELP_LANDSCAPE = "The full path of the landscape file to use for the testrun."
+HELP_LANDSCAPE_NAMES = "The base name of the landscape files to search for in the landscape path."
+HELP_LANDSCAPE_SOURCES = f"A '{SEPARATOR}' seperated list of source uris to search for landscape documents."
+HELP_RUNTIME = "The full path of the runtime file to use for the testrun."
+HELP_RUNTIME_NAMES = "The base name of the runtime files to search for in the runtime path."
+HELP_RUNTIME_SOURCES = f"A '{SEPARATOR}' seperated list of source uris to search for runtime documents."
+HELP_TOPOLOGY = "The full path of the topology file to use for the testrun."
+HELP_TOPOLOGY_NAMES = "The base name of the topology files to search for in the topology path."
+HELP_TOPOLOGY_SOURCES = f"A '{SEPARATOR}' seperated list of source uris to search for topology documents."
+HELP_RUNID = "A uuid to use for the run id for the testrun."
+HELP_CONSOLE_LOG_LEVEL = "The logging level for console output."
+HELP_FILE_LOG_LEVEL = "The logging level for logfile output."
+HELP_DEBUG = "Output debug information to the console."
+HELP_DEBUGGER = "Debugger to active during the test run."
+HELP_BREAKPOINT = "The breakpoint to activate for the test run."
+HELP_TIMETRAVEL = "Enables tracing for Time-Travel-Debugging."
+HELP_TIMEPORTAL = "The name of a time portal to open for Time-Travel-Debugging."
+HELP_PRERUN_DIAGNOSTIC = "Flag indicating that a pre run diagnostic should be performed."
+HELP_POSTRUN_DIAGNOSTIC = "Flag indicating that a post run diagnostic should be performed."
+HELP_INCLUDE_MARKER_EXP = "Allows the specification of a marker expression that if matched will include a test."
+HELP_EXCLUDE_MARKER_EXP = "Allows the specification of a marker expression that if matched will exclude a test."

ccai/testplus/cli/cmdtree/testing/jobs.py

@@ -0,0 +1,195 @@
+"""
+    .. module:: jobs
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: CLI commands for listing, showing and running TestPlus jobs.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+
+import os
+import sys
+
+import click
+
+from ccai.xmodules.xlogging.levels import LOG_LEVEL_NAMES
+from ccai.xmodules.xlogging.enhancedloggers import getEnhancedLogger
+
+@click.group("jobs", help="Contains commands for working with test jobs.")
+def group_testplus_testing_jobs():
+    """
+        CLI command group for interacting with TestPlus jobs.
+
+        :returns: ``None``
+    """
+
+    return
+
+HELP_ROOT = "The root directory to use when scanning for tests."
+HELP_JOB = "The identifier of the job to run."
+HELP_FILTER = "Add a job filter expression."
+HELP_OUTPUT = "The output directory where results and artifacts are collected."
+HELP_START = r"A time stamp to associate with the start of the run. Example: 2020-10-17T15:30:11.989120  Bash: date +%Y-%m-%dT%H:%M:%S.%N"
+HELP_BRANCH = "The name of the branch to associate with the test run results."
+HELP_BUILD = "The name of the build to associate with the test run results."
+HELP_FLAVOR = "The name of the flavor to associate with the test run results."
+HELP_CONSOLE_LOG_LEVEL = "The logging level for console output."
+HELP_FILE_LOG_LEVEL = "The logging level for logfile output."
+HELP_DEBUG = "Output debug information to the console."
+
+@click.command("list")
+@click.option("--root", default=".", type=str, help=HELP_ROOT)
+@click.option("--filter", "-f", required=False, help=HELP_FILTER)
+@click.option("--debug", default=False, type=bool, help=HELP_DEBUG)
+def command_testing_jobs_list(root, filter, debug):
+    """
+        Lists available TestPlus jobs.
+
+        :param root: Root directory used when scanning for jobs.
+        :param filter: Optional job filter expression.
+        :param debug: Whether to emit debug output.
+
+        :returns: ``None``
+    """
+
+    click.echo("The 'jobs list' command is not yet implemented.", err=True)
+
+    return
+
+@click.command("show")
+@click.option("--root", default=".", type=str, help=HELP_ROOT)
+@click.option("--job", "-j", required=True, help=HELP_JOB)
+@click.option("--debug", default=False, type=bool, help=HELP_DEBUG)
+def command_testplus_testing_jobs_show(root, job, debug):
+    """
+        Displays information about a specific TestPlus job.
+
+        :param root: Root directory used when scanning for jobs.
+        :param job: The identifier of the job to show.
+        :param debug: Whether to emit debug output.
+
+        :returns: ``None``
+    """
+
+    click.echo("The 'jobs show' command is not yet implemented.", err=True)
+
+    return
+
+@click.command("run")
+@click.option("--root", default=".", type=str, help=HELP_ROOT)
+@click.option("--job", "-j", required=True, help=HELP_JOB)
+@click.option("--output", "-o", required=False, help=HELP_OUTPUT)
+@click.option("--start", default=None, required=False, help=HELP_START)
+@click.option("--branch", default=None, required=False, help=HELP_BRANCH)
+@click.option("--build", default=None, required=False, help=HELP_BUILD)
+@click.option("--flavor", default=None, required=False, help=HELP_FLAVOR)
+@click.option("--console-level", default=None, required=False, type=click.Choice(LOG_LEVEL_NAMES, case_sensitive=False), help=HELP_CONSOLE_LOG_LEVEL)
+@click.option("--logfile-level", default=None, required=False, type=click.Choice(LOG_LEVEL_NAMES, case_sensitive=False), help=HELP_FILE_LOG_LEVEL)
+def command_testplus_testing_jobs_run(root, job, output, start, branch, build, flavor, console_level, logfile_level):
+    """
+        Executes a specified TestPlus job.
+
+        :param root: Root directory used when scanning for tests.
+        :param job: Fully qualified job identifier.
+        :param output: Directory for test results.
+
+        :returns: ``None``
+    """
+
+    # pylint: disable=unused-import,import-outside-toplevel
+
+    # We do the imports of the automation framework code inside the action functions because
+    # we don't want to startup loggin and the processing of inputs and environment variables
+    # until we have entered an action method.  Thats way we know how to setup the environment.
+
+    # IMPORTANT: We need to load the context first because it will trigger the loading
+    # of the default user configuration
+
+    from ccai.xmodules.ximport import import_by_name
+    from ccai.xmodules.xpython import prepend_python_path
+
+    # STEP 1 - Initialize the Runtime (Performed by the root command)
+
+    # STEP 2 - Resolve the configuration variables (Performed by the root command)
+
+    # STEP 3 - Apply any 'Configuration' related option overrides
+
+    
+
+    # STEP 4 - Resolve the Configuration Maps
+    #from ccai.configuration.configurationmaps import resolve_configuration_maps
+    #resolve_configuration_maps(use_credentials=use_credentials, use_landscape=use_landscape,
+    #                           use_runtime=use_runtime, use_topology=use_topology)
+    
+    # STEP 5 - The application of the remaining options must happen after we have resolved configuration
+    # maps because some of those settings will get overridden by the options.  So the runtime
+    # needs to be loaded and set first before we apply runtime options    
+
+    # STEP 6 - Initialize the Results Output
+
+    # STEP 7 - Create and kick off the job
+    from ccai.thisapp.activation import activate_profile_job, JobType
+    activate_profile_job(JobType.TestRun)
+
+
+    test_root = os.path.abspath(os.path.expandvars(os.path.expanduser(root)))
+    if not os.path.isdir(test_root):
+        errmsg = "The specified root folder does not exist. root=%s" % root
+        if test_root != root:
+            errmsg += " expanded=%s" % test_root
+        raise click.BadParameter(errmsg, param_hint="--root")
+
+    # Make sure we extend PATH to include the test root
+    prepend_python_path(test_root)
+
+    # Activation of the runtime happens when we initialize test results
+    from ccai.testplus.initialize import initialize_testplus_results
+    initialize_testplus_results()
+
+    logger = getEnhancedLogger()
+
+    tpmod = sys.modules["ccai.testplus"]
+    tpmod.logger = logger
+
+    from ccai.thisapp.wellknown import ConfiguredSuperFactorySingleton
+    from ccai.testbase.factoryprotocols import TestBaseFactoryProtocol
+
+    # At this point in the code, we either lookup an existing test job or we create a test job
+    # from the includes, excludes or test_module
+    sfactory = ConfiguredSuperFactorySingleton()
+    TestJobType = sfactory.get_override_types_by_order(TestBaseFactoryProtocol.get_testbase_default_job_type)
+
+    if job is not None:
+        job_parts = job.split("@")
+        if len(job_parts) != 2:
+            errmsg = "A --job parameter must be of the form 'package.module@JobClass'"
+            raise click.UsageError(errmsg)
+
+        job_package, job_class = job_parts
+
+        try:
+            job_mod = import_by_name(job_package)
+        except ImportError as imperr:
+            errmsg = "Failure while importing job package %r"  % job_package
+            raise click.BadParameter(errmsg, param_hint="--job") from imperr
+
+        if not hasattr(job_mod, job_class):
+            errmsg = "The job package %r does not have a job type %r." % (job_package, job_class)
+            raise click.BadParameter(errmsg, param_hint="--job")
+
+        TestJobType = getattr(job_mod, job_class)
+
+    result_code = 0
+    with TestJobType(logger, test_root) as tjob:
+        result_code = tjob.execute()
+
+    sys.exit(result_code)
+
+    return
+
+group_testplus_testing_jobs.add_command(command_testing_jobs_list)
+group_testplus_testing_jobs.add_command(command_testplus_testing_jobs_show)
+group_testplus_testing_jobs.add_command(command_testplus_testing_jobs_run)

ccai/testplus/cli/cmdtree/testing/query.py

@@ -0,0 +1,165 @@
+"""
+    .. module:: query
+    :platform: Darwin, Linux, Unix, Windows
+    :synopsis: CLI command used to query tests available in a TestPlus
+    environment.
+
+    .. moduleauthor:: Myron Walker <myron.walker@gmail.com>
+"""
+
+__author__ = "Myron Walker"
+__copyright__ = "Copyright 2025, Code Craft AI LLC"
+__credits__ = []
+
+
+from typing import List
+
+from ccai.xmodules.xlogging.enhancedloggers import getEnhancedLogger
+import os
+import sys
+
+import click
+
+from ccai.testplus.cli.cmdtree.testing.constants import (
+    HELP_ROOT,
+    HELP_EXCLUDES,
+    HELP_INCLUDES,
+    HELP_EXCLUDE_MARKER_EXP,
+    HELP_INCLUDE_MARKER_EXP
+)
+
+@click.command("query", help="Command used to query information about tests.")
+@click.option("--root", default=None, type=str, help=HELP_ROOT)
+@click.option("--excludes", "-x", multiple=True, help=HELP_EXCLUDES)
+@click.option("--includes", "-i", multiple=True, help=HELP_INCLUDES)
+@click.option("--include-marker-exp", required=False, multiple=True, help=HELP_INCLUDE_MARKER_EXP)
+@click.option("--exclude-marker-exp", required=False, multiple=True, help=HELP_EXCLUDE_MARKER_EXP)
+def command_testplus_testing_query(root, includes, excludes,
+    include_marker_exp, exclude_marker_exp):
+    """
+        Queries tests available within a TestPlus environment.
+
+        :param root: Root directory used when scanning for tests.
+        :param includes: Inclusion expressions for tests.
+        :param excludes: Exclusion expressions for tests.
+
+        :returns: ``None``
+    """
+
+    # pylint: disable=unused-import,import-outside-toplevel
+
+    # We do the imports of the automation framework code inside the action functions because
+    # we don't want to startup loggin and the processing of inputs and environment variables
+    # until we have entered an action method.  Thats way we know how to setup the environment.
+
+    # IMPORTANT: We need to load the context first because it will trigger the loading
+    # of the default user configuration
+
+    from ccai.thisapp.contextpaths import ContextPaths
+    from ccai.thisapp.wellknown import ThisApplicationSingleton
+
+    from ccai.xmodules.xpython import prepend_python_path
+
+    from ccai.thisapp.runtimevariables import RuntimeVariables
+
+    # STEP 2 - Resolve the configuration variables (performed by the root command)
+
+    # STEP 3 - Apply the configuration related options
+
+    # Instantiate the application singleton so the application context and the default user
+    # configuration are loaded before the configuration maps are resolved.
+    ThisApplicationSingleton()
+
+    # STEP 4 - Resolve the Configuration Maps
+    from ccai.configuration.configurationmaps import resolve_configuration_maps
+    resolve_configuration_maps(use_credentials=False, use_landscape=False,
+                               use_runtime=False, use_topology=False)
+
+    # STEP 5 - Apply any Option Overrides
+
+    from ccai.runtime.optionoverrides import AM_RUNTIME_OPTION_OVERRIDES
+
+    from ccai.testbase.markers import MetaFilter, parse_marker_expression
+
+    # Setup the Test Root
+    if root is None:
+        if RuntimeVariables.AM_TESTROOT is not None:
+            root = RuntimeVariables.AM_TESTROOT
+        else:
+            root = "."
+
+    test_root = os.path.abspath(os.path.expandvars(os.path.expanduser(root)))
+    if not os.path.isdir(test_root):
+        errmsg = "The specified root folder does not exist. root=%s" % root
+        if test_root != root:
+            errmsg += " expanded=%s" % test_root
+        raise click.BadParameter(errmsg)
+
+    AM_RUNTIME_OPTION_OVERRIDES.override_testroot(root)
+
+    # Make sure we extend PATH to include the test roots parent folder so imports will
+    # work properly.
+    test_root_parent = os.path.dirname(test_root)
+    prepend_python_path(test_root_parent)
+
+    metafilters: List[MetaFilter] = []
+    for imexp in include_marker_exp:
+        imexp = imexp.strip("\"")
+        imexp = imexp.strip("'")
+        mfilter = parse_marker_expression("+" + imexp)
+        metafilters.append(mfilter)
+
+    for exmexp in exclude_marker_exp:
+        exmexp = exmexp.strip("\"")
+        exmexp = exmexp.strip("'")
+        mfilter = parse_marker_expression("-" + exmexp)
+        metafilters.append(mfilter)
+
+    
+    # STEP 6 - Initialize the Results Output
+
+    # Initialize testplus results and logging
+    from ccai.testplus.initialize import initialize_testplus_results
+
+    initialize_testplus_results()
+
+
+    # STEP 7 - Kick off the query
+
+    logger = getEnhancedLogger()
+
+    from ccai.thisapp.wellknown import ConfiguredSuperFactorySingleton
+    from ccai.testbase.factoryprotocols import TestBaseFactoryProtocol
+
+    sfactory = ConfiguredSuperFactorySingleton()
+    TestJobType = sfactory.get_override_types_by_order(TestBaseFactoryProtocol.get_testbase_default_job_type)
+
+    # At this point in the code, we either lookup an existing test job or we create a test job
+    # from the includes, excludes or test_module
+    with TestJobType(logger, test_root, includes=includes, excludes=excludes, metafilters=metafilters) as tjob:
+        query_results = tjob.query()
+
+        test_names = [tn for tn in query_results.keys()]
+        test_names.sort()
+        print()
+        print("Tests:")
+        for tname in test_names:
+            tref = query_results[tname]
+            print("    " + tname)
+
+            param_names = [pn for pn in tref.subscriptions.keys()]
+            param_names.sort()
+            for pname in param_names:
+                pinfo = tref.subscriptions[pname]
+                print ("        {}: {}".format(pname, pinfo.describe_source()))
+
+        print()
+
+        if len(tjob.import_errors) > 0:
+            print("IMPORT ERRORS:", file=sys.stderr)
+            for ifilename in tjob.import_errors:
+                imperr_msg = ifilename
+                print("    " + imperr_msg, file=sys.stderr)
+            print("", file=sys.stderr)
+
+    return