pybuilder-integration 104__tar.gz → 105__tar.gz

{pybuilder_integration-104 → pybuilder_integration-105}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pybuilder-integration
-Version: 104
+Version: 105
 Summary: A pybuilder plugin that runs integration tests (Tavern & Cypress) against a target.
 Home-page: https://github.com/rspitler/pybuilder-integration
 Author: 

{pybuilder_integration-104 → pybuilder_integration-105}/pybuilder_integration/artifact_manager.py

@@ -8,7 +8,7 @@ from pybuilder.reactor import Reactor
 
 from pybuilder_integration import exec_utility
 from pybuilder_integration.directory_utility import get_latest_distribution_directory, \
-    get_latest_zipped_distribution_directory
+    get_latest_zipped_distribution_directory, read_tavern_service_markers, write_tavern_manifest
 from pybuilder_integration.properties import *
 
 
@@ -200,13 +200,21 @@ def _unzip_downloaded_artifacts(dir_with_zips: str, destination: str, logger: Lo
         os.makedirs(consolidated_folder, exist_ok=True)
         logger.debug(f"Creating role file for log retrieval {consolidated_folder}/roles")
         open(f"{consolidated_folder}/roles", 'w').close()
+        consolidated_markers = set()
+        has_tavern_manifest = False
         for dirn in os.listdir(f"{destination}/tavern"):
             if "consolidated" != dirn:
                 logger.debug(f"Consolidating directory: {dirn}")
+                markers = read_tavern_service_markers(f"{destination}/tavern/{dirn}")
+                if markers is not None:
+                    has_tavern_manifest = True
+                    consolidated_markers.update(markers)
                 shutil.copytree(f"{destination}/tavern/{dirn}", consolidated_folder, dirs_exist_ok=True)
                 shutil.rmtree(f"{destination}/tavern/{dirn}")
                 with open(f"{consolidated_folder}/roles", "a") as fp:
                     fp.write(f"{dirn}\n")
+        if has_tavern_manifest:
+            write_tavern_manifest(consolidated_folder, consolidated_markers)
     return destination
 
 

pybuilder_integration-105/pybuilder_integration/directory_utility.py

@@ -0,0 +1,168 @@
+import json
+import os
+import re
+import shutil
+import tempfile
+
+
+TAVERN_MANIFEST_DIRECTORY = ".pybuilder-integration"
+TAVERN_MANIFEST_FILENAME = "tavern-manifest.json"
+_TAVERN_MARKER_EXCLUSIONS = {"parametrize", "skip", "skipif", "usefixtures", "xfail"}
+
+
+def prepare_reports_directory(project):
+    return prepare_directory("$dir_reports", project)
+
+
+def prepare_logs_directory(project):
+    return prepare_directory("$dir_logs", project)
+
+
+def prepare_dist_directory(project):
+    return prepare_directory("$dir_dist", project)
+
+
+def prepare_directory(dir_variable, project):
+    package__format = f"{dir_variable}/integration"
+    reports_dir = project.expand_path(package__format)
+    return _ensure_directory_exists(reports_dir)
+
+
+def _ensure_directory_exists(path):
+    if not os.path.exists(path):
+        os.makedirs(path)
+    return path
+
+
+def get_working_distribution_directory(project):
+    dist_directory = prepare_dist_directory(project)
+    return _ensure_directory_exists(f"{dist_directory}/working")
+
+
+def get_latest_distribution_directory(project):
+    dist_directory = prepare_dist_directory(project)
+    from pybuilder_integration import ENVIRONMENT
+    environment = project.get_mandatory_property(ENVIRONMENT)
+    return _ensure_directory_exists(f"{dist_directory}/LATEST-{environment}")
+
+
+def get_latest_zipped_distribution_directory(project):
+    dist_directory = prepare_dist_directory(project)
+    from pybuilder_integration import ENVIRONMENT
+    environment = project.get_mandatory_property(ENVIRONMENT)
+    return _ensure_directory_exists(f"{dist_directory}/LATEST-{environment}/zipped")
+
+
+def get_local_zip_artifact_path(tool, project, include_ending=False):
+    artifact = f"{prepare_dist_directory(project)}/{tool}-{project.name}"
+    if include_ending:
+        return f"{artifact}.zip"
+    return artifact
+
+
+def get_tavern_manifest_path(test_dir):
+    return os.path.join(test_dir, TAVERN_MANIFEST_DIRECTORY, TAVERN_MANIFEST_FILENAME)
+
+
+def collect_tavern_service_markers(test_dir):
+    markers = set()
+    for root, _, files in os.walk(test_dir):
+        for filename in files:
+            if filename.endswith(".tavern.yaml"):
+                markers.update(_collect_markers_from_tavern_file(os.path.join(root, filename)))
+    return sorted(markers)
+
+
+def write_tavern_manifest(test_dir, service_markers=None):
+    manifest_path = get_tavern_manifest_path(test_dir)
+    manifest_directory = os.path.dirname(manifest_path)
+    os.makedirs(manifest_directory, exist_ok=True)
+    if service_markers is None:
+        service_markers = collect_tavern_service_markers(test_dir)
+    manifest_content = json.dumps({"service_markers": sorted(service_markers)}).encode("utf-8")
+    descriptor, temporary_path = tempfile.mkstemp(prefix=".tavern-manifest-", dir=manifest_directory)
+    try:
+        bytes_written = 0
+        while bytes_written < len(manifest_content):
+            written = os.write(descriptor, manifest_content[bytes_written:])
+            if written == 0:
+                raise OSError("Could not write Tavern marker manifest")
+            bytes_written += written
+        os.close(descriptor)
+        descriptor = None
+        os.replace(temporary_path, manifest_path)
+    finally:
+        if descriptor is not None:
+            os.close(descriptor)
+        if os.path.exists(temporary_path):
+            os.unlink(temporary_path)
+
+
+def read_tavern_service_markers(test_dir):
+    manifest_path = get_tavern_manifest_path(test_dir)
+    if not os.path.exists(manifest_path):
+        return None
+    try:
+        with open(manifest_path) as manifest_file:
+            manifest = json.load(manifest_file)
+    except (OSError, ValueError):
+        return None
+    markers = manifest.get("service_markers", [])
+    if not isinstance(markers, list) or not all(isinstance(marker, str) for marker in markers):
+        return None
+    return set(markers)
+
+
+def _collect_markers_from_tavern_file(path):
+    markers = set()
+    in_marks = False
+    marks_indent = 0
+    with open(path) as tavern_file:
+        for line in tavern_file:
+            match = re.match(r"^(\s*)marks:\s*(.*)$", line)
+            if match:
+                in_marks = True
+                marks_indent = len(match.group(1))
+                inline_markers = match.group(2).strip()
+                if inline_markers.startswith("[") and inline_markers.endswith("]"):
+                    for marker in inline_markers[1:-1].split(","):
+                        _add_tavern_marker(markers, marker)
+                continue
+            if not in_marks:
+                continue
+            if not line.strip() or line.lstrip().startswith("#"):
+                continue
+            indent = len(line) - len(line.lstrip())
+            if indent <= marks_indent:
+                in_marks = False
+                continue
+            marker = re.match(r"^\s*-\s*(.+?)\s*(?:#.*)?$", line)
+            if marker:
+                _add_tavern_marker(markers, marker.group(1))
+    return markers
+
+
+def _add_tavern_marker(markers, value):
+    marker = value.strip().strip("'\"")
+    if re.fullmatch(r"[A-Za-z_][A-Za-z0-9_]*", marker) and marker not in _TAVERN_MARKER_EXCLUSIONS:
+        markers.add(marker)
+
+
+def package_artifacts(project, test_dir, tool, role):
+    # Make a copy for easy access in environment validation
+    working_dir = get_working_distribution_directory(project)
+    shutil.copytree(test_dir, f"{working_dir}/{tool}",dirs_exist_ok=True)
+    if tool == "tavern":
+        write_tavern_manifest(f"{working_dir}/{tool}")
+    with tempfile.TemporaryDirectory() as tempdir:
+        shutil.copytree(test_dir, f"{tempdir}/{role}",dirs_exist_ok=True)
+        if tool == "tavern":
+            write_tavern_manifest(f"{tempdir}/{role}")
+        # package a copy for distribution
+        # zip up the test and add them to the integration test dist directory
+        base_name = get_local_zip_artifact_path(tool=tool, project=project)
+        shutil.make_archive(base_name=base_name,
+                            base_dir=role,
+                            format="zip",
+                            root_dir=tempdir)
+

{pybuilder_integration-104 → pybuilder_integration-105}/pybuilder_integration/properties.py

@@ -17,6 +17,7 @@ APPLICATION = "application"
 APPLICATION_GROUP = "application_group"
 RUN_PARALLEL = "pytest_parallel"
 CONSOLIDATE_TESTS = "consolidate_tavern"
+SKIP_NON_MATCHING_TAVERN_ARTIFACTS = "skip_non_matching_tavern_artifacts"
 TESTING_SCOPE = "testing_scope"
 PARALLEL_VERIFY_ENVIRONMENT = "parallel_verify_environment"
 SUBPROCESS_PROPERTIES_FILE_ENV = "PYBUILDER_INTEGRATION_PROPERTIES_FILE"

{pybuilder_integration-104 → pybuilder_integration-105}/pybuilder_integration/tasks.py

@@ -18,7 +18,8 @@ from pybuilder_integration import exec_utility, tool_utility, directory_utility
 from pybuilder_integration.artifact_manager import get_artifact_manager
 from pybuilder_integration.cloudwatchlogs_utility import CloudwatchLogs
 from pybuilder_integration.directory_utility import get_working_distribution_directory, \
-    package_artifacts, prepare_reports_directory, get_local_zip_artifact_path, prepare_logs_directory
+    package_artifacts, prepare_reports_directory, get_local_zip_artifact_path, prepare_logs_directory, \
+    read_tavern_service_markers
 from pybuilder_integration.properties import *
 from pybuilder_integration.tool_utility import install_cypress
 
@@ -40,6 +41,7 @@ _VERIFY_ENVIRONMENT_SUBPROCESS_PROPERTIES = [
     APPLICATION_GROUP,
     RUN_PARALLEL,
     CONSOLIDATE_TESTS,
+    SKIP_NON_MATCHING_TAVERN_ARTIFACTS,
     TESTING_SCOPE,
     "abort_upload",
     "record_cypress",
@@ -449,6 +451,15 @@ def _run_tavern_tests_in_dir(test_dir: str, logger: Logger, project: Project, re
     logger.info(f"Found {len(os.listdir(test_dir))} files in tavern test directory")
     # todo is this unique enough for each run?
     output_file, run_name = get_test_report_file(project, test_dir)
+    extra_args = [project.expand(prop) for prop in project.get_property(TAVERN_ADDITIONAL_ARGS, [])]
+    requested_marker = _extract_tavern_marker_filter(extra_args)
+    declared_markers = read_tavern_service_markers(test_dir)
+    skip_non_matching_artifacts = _get_bool_property(project, SKIP_NON_MATCHING_TAVERN_ARTIFACTS, False)
+    if skip_non_matching_artifacts and requested_marker and declared_markers and requested_marker not in declared_markers:
+        logger.info(
+            f"Skipping Tavern tests: artifact markers {sorted(declared_markers)} do not match {requested_marker}"
+        )
+        return True
     from sys import path as syspath
     syspath.insert(0, test_dir)
     # install any requirements that my exist
@@ -457,7 +468,6 @@ def _run_tavern_tests_in_dir(test_dir: str, logger: Logger, project: Project, re
         dependency = RequirementsFile(requirements_file)
         install_dependencies(logger, project, dependency, reactor.pybuilder_venv,
                              f"{prepare_logs_directory(project)}/install_tavern_pip_dependencies.log")
-    extra_args = [project.expand(prop) for prop in project.get_property(TAVERN_ADDITIONAL_ARGS, [])]
     args = ["--junit-xml", f"{output_file}", test_dir] + extra_args
     if project.get_property("verbose"):
         args.append("-s")
@@ -476,7 +486,7 @@ def _run_tavern_tests_in_dir(test_dir: str, logger: Logger, project: Project, re
         ret = pytest.main(args)
         if ret == pytest.ExitCode.NO_TESTS_COLLECTED:
             fallback_args = _without_tavern_marker_filter(args)
-            if fallback_args != args:
+            if fallback_args != args and (not skip_non_matching_artifacts or not declared_markers):
                 logger.warn(
                     "No Tavern tests matched the marker filter; rerunning the full suite"
                 )
@@ -519,6 +529,19 @@ def _without_tavern_marker_filter(args):
     return fallback_args
 
 
+def _extract_tavern_marker_filter(args):
+    for index, arg in enumerate(args):
+        if arg in {"-m", "--markexpr"} and index + 1 < len(args):
+            marker = args[index + 1]
+        elif arg.startswith("--markexpr="):
+            marker = arg.split("=", 1)[1]
+        else:
+            continue
+        if marker.replace("_", "").isalnum() and marker:
+            return marker
+    return None
+
+
 def get_test_report_file(project, test_dir, tool="tavern"):
     run_name = os.path.basename(test_dir)
     output_file = os.path.join(prepare_reports_directory(project), f"{tool}-{run_name}.out.xml")

{pybuilder_integration-104 → pybuilder_integration-105}/pybuilder_integration.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pybuilder-integration
-Version: 104
+Version: 105
 Summary: A pybuilder plugin that runs integration tests (Tavern & Cypress) against a target.
 Home-page: https://github.com/rspitler/pybuilder-integration
 Author: 

{pybuilder_integration-104 → pybuilder_integration-105}/setup.py

@@ -21,7 +21,7 @@ class install(_install):
 if __name__ == '__main__':
     setup(
         name = 'pybuilder-integration',
-        version = '104',
+        version = '105',
         description = 'A pybuilder plugin that runs integration tests (Tavern & Cypress) against a target.',
         long_description = 'A pybuilder plugin that runs integration tests against a target.  This is intended to be a broader scope than unit-tests encompassing dependant functionality.',
         long_description_content_type = None,

pybuilder_integration-104/pybuilder_integration/directory_utility.py

@@ -1,70 +0,0 @@
-import os
-import shutil
-import tempfile
-
-
-
-def prepare_reports_directory(project):
-    return prepare_directory("$dir_reports", project)
-
-
-def prepare_logs_directory(project):
-    return prepare_directory("$dir_logs", project)
-
-
-def prepare_dist_directory(project):
-    return prepare_directory("$dir_dist", project)
-
-
-def prepare_directory(dir_variable, project):
-    package__format = f"{dir_variable}/integration"
-    reports_dir = project.expand_path(package__format)
-    return _ensure_directory_exists(reports_dir)
-
-
-def _ensure_directory_exists(path):
-    if not os.path.exists(path):
-        os.makedirs(path)
-    return path
-
-
-def get_working_distribution_directory(project):
-    dist_directory = prepare_dist_directory(project)
-    return _ensure_directory_exists(f"{dist_directory}/working")
-
-
-def get_latest_distribution_directory(project):
-    dist_directory = prepare_dist_directory(project)
-    from pybuilder_integration import ENVIRONMENT
-    environment = project.get_mandatory_property(ENVIRONMENT)
-    return _ensure_directory_exists(f"{dist_directory}/LATEST-{environment}")
-
-
-def get_latest_zipped_distribution_directory(project):
-    dist_directory = prepare_dist_directory(project)
-    from pybuilder_integration import ENVIRONMENT
-    environment = project.get_mandatory_property(ENVIRONMENT)
-    return _ensure_directory_exists(f"{dist_directory}/LATEST-{environment}/zipped")
-
-
-def get_local_zip_artifact_path(tool, project, include_ending=False):
-    artifact = f"{prepare_dist_directory(project)}/{tool}-{project.name}"
-    if include_ending:
-        return f"{artifact}.zip"
-    return artifact
-
-
-def package_artifacts(project, test_dir, tool, role):
-    # Make a copy for easy access in environment validation
-    working_dir = get_working_distribution_directory(project)
-    shutil.copytree(test_dir, f"{working_dir}/{tool}",dirs_exist_ok=True)
-    with tempfile.TemporaryDirectory() as tempdir:
-        shutil.copytree(test_dir, f"{tempdir}/{role}",dirs_exist_ok=True)
-        # package a copy for distribution
-        # zip up the test and add them to the integration test dist directory
-        base_name = get_local_zip_artifact_path(tool=tool, project=project)
-        shutil.make_archive(base_name=base_name,
-                            base_dir=role,
-                            format="zip",
-                            root_dir=tempdir)
-