-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PSCE-303 feat: adds trestlebot-sync-upstreams command (#142)
* feat(entrypoint): adds sync-upstreams entrypoint E2E tests are updated to include a step with sync_upstreams to ssp-authoring workflow Signed-off-by: Jennifer Power <[email protected]> * chore: removes additional test data and modifies source test profile We don't need to store an additional test file with small edits. This updates the prep_upstream_repo function to just alter the profile and write it out. Signed-off-by: Jennifer Power <[email protected]> * chore: incorporates changes based on PR feedback Signed-off-by: Jennifer Power <[email protected]> * chore: updates include_models/exclude_models to model_names Using the term include_models/exclude_models could leave confusion about what is being filtered in this instance (model vs model instance). Updating to model_names to be more precise. Signed-off-by: Jennifer Power <[email protected]> --------- Signed-off-by: Jennifer Power <[email protected]>
- Loading branch information
Showing
6 changed files
with
446 additions
and
33 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 |
|---|---|---|
|
|
@@ -36,6 +36,7 @@ | |
| TRESTLEBOT_TEST_IMAGE_NAME, | ||
| build_test_image, | ||
| clean, | ||
| repo_setup, | ||
| ) | ||
| from trestlebot import const | ||
| from trestlebot.transformers.trestle_rule import ( | ||
|
|
@@ -58,28 +59,7 @@ def tmp_repo() -> YieldFixture[Tuple[str, Repo]]: | |
| """Create a temporary git repository with an initialized trestle workspace root""" | ||
| with TemporaryDirectory(prefix=_TEST_PREFIX) as tmpdir: | ||
| tmp_path = pathlib.Path(tmpdir) | ||
| try: | ||
| args = argparse.Namespace( | ||
| verbose=0, | ||
| trestle_root=tmp_path, | ||
| full=True, | ||
| local=False, | ||
| govdocs=False, | ||
| ) | ||
| init = InitCmd() | ||
| init._run(args) | ||
| except Exception as e: | ||
| raise TrestleError( | ||
| f"Initialization failed for temporary trestle directory: {e}." | ||
| ) | ||
| repo = Repo.init(tmpdir) | ||
| with repo.config_writer() as config: | ||
| config.set_value("user", "email", "[email protected]") | ||
| config.set_value("user", "name", "Test User") | ||
| repo.git.add(all=True) | ||
| repo.index.commit("Initial commit") | ||
| # Create a default branch (main) | ||
| repo.git.checkout("-b", "main") | ||
| repo: Repo = repo_setup(tmp_path) | ||
| yield tmpdir, repo | ||
|
|
||
| try: | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -21,11 +21,14 @@ | |
| import pathlib | ||
| import shutil | ||
| import subprocess | ||
| import tempfile | ||
| from typing import Dict, List, Optional | ||
|
|
||
| from git.repo import Repo | ||
| from trestle.common.err import TrestleError | ||
| from trestle.common.model_utils import ModelUtils | ||
| from trestle.core.base_model import OscalBaseModel | ||
| from trestle.core.commands.init import InitCmd | ||
| from trestle.core.models.file_content_type import FileContentType | ||
| from trestle.oscal import catalog as cat | ||
| from trestle.oscal import component as comp | ||
|
|
@@ -49,6 +52,9 @@ | |
| E2E_BUILD_CONTEXT = "tests/e2e" | ||
| CONTAINER_FILE_NAME = "Dockerfile" | ||
|
|
||
| # Location the upstream repo is mounted to in the container | ||
| UPSTREAM_REPO = "/upstream" | ||
|
|
||
|
|
||
| def clean(repo_path: str, repo: Optional[Repo]) -> None: | ||
| """Clean up the temporary Git repository.""" | ||
|
|
@@ -57,6 +63,33 @@ def clean(repo_path: str, repo: Optional[Repo]) -> None: | |
| shutil.rmtree(repo_path) | ||
|
|
||
|
|
||
| def repo_setup(repo_path: pathlib.Path) -> Repo: | ||
| """Create a temporary Git repository.""" | ||
| try: | ||
| args = argparse.Namespace( | ||
| verbose=0, | ||
| trestle_root=repo_path, | ||
| full=True, | ||
| local=False, | ||
| govdocs=False, | ||
| ) | ||
| init = InitCmd() | ||
| init._run(args) | ||
| except Exception as e: | ||
| raise TrestleError( | ||
| f"Initialization failed for temporary trestle directory: {e}." | ||
| ) | ||
| repo = Repo.init(repo_path) | ||
| with repo.config_writer() as config: | ||
| config.set_value("user", "email", "[email protected]") | ||
| config.set_value("user", "name", "Test User") | ||
| repo.git.add(all=True) | ||
| repo.index.commit("Initial commit") | ||
| # Create a default branch (main) | ||
| repo.git.checkout("-b", "main") | ||
| return repo | ||
|
|
||
|
|
||
| def args_dict_to_list(args_dict: Dict[str, str]) -> List[str]: | ||
| """Transform dictionary of args to a list of args.""" | ||
| args = [] | ||
|
|
@@ -321,20 +354,80 @@ def build_test_command( | |
| command_name: str, | ||
| command_args: Dict[str, str], | ||
| image_name: str = TRESTLEBOT_TEST_IMAGE_NAME, | ||
| upstream_repo: str = "", | ||
| ) -> List[str]: | ||
| """Build a command to be run in the shell for trestlebot""" | ||
| return [ | ||
| """ | ||
| Build a command to be run in the shell for trestlebot | ||
| Args: | ||
| data_path (str): Path to the data directory. This is the working directory/trestle_root. | ||
| command_name (str): Name of the command to run. It should be a trestlebot command. | ||
| command_args (Dict[str, str]): Arguments to pass to the command | ||
| image_name (str, optional): Name of the image to run. Defaults to TRESTLEBOT_TEST_IMAGE_NAME. | ||
| upstream_repo (str, optional): Path to the upstream repo. Defaults to "" and is not mounted. | ||
| Returns: | ||
| List[str]: Command to be run in the shell | ||
| """ | ||
| command = [ | ||
| "podman", | ||
| "run", | ||
| "--pod", | ||
| TRESTLEBOT_TEST_POD_NAME, | ||
| "--entrypoint", | ||
| f"trestlebot-{command_name}", | ||
| "--rm", | ||
| "-v", | ||
| f"{data_path}:/trestle", | ||
| "-w", | ||
| "/trestle", | ||
| image_name, | ||
| *args_dict_to_list(command_args), | ||
| ] | ||
|
|
||
| # Add mounts | ||
| if upstream_repo: | ||
| # Add a volume and mount it to the container | ||
| command.extend(["-v", f"{upstream_repo}:{UPSTREAM_REPO}"]) | ||
| command.extend( | ||
| [ | ||
| "-v", | ||
| f"{data_path}:/trestle", | ||
| "-w", | ||
| "/trestle", | ||
| image_name, | ||
| *args_dict_to_list(command_args), | ||
| ] | ||
| ) | ||
| return command | ||
|
|
||
|
|
||
| def prepare_upstream_repo() -> str: | ||
| """ | ||
| Prepare a temporary upstream repo for testing. | ||
| Returns: | ||
| str: Path to the upstream repo | ||
| Notes: | ||
| This includes the test NIST catalog and a modified profile. | ||
| It modifies the simplified_nist_profile to simulate upstream | ||
| changes for testing. | ||
| """ | ||
| tmp_dir = pathlib.Path(tempfile.mkdtemp()) | ||
| repo: Repo = repo_setup(tmp_dir) | ||
| load_from_json( | ||
| tmp_dir, "simplified_nist_catalog", "simplified_nist_catalog", cat.Catalog | ||
| ) | ||
|
|
||
| # Modify the profile to include an additional control and write it out | ||
| src_path = JSON_TEST_DATA_PATH / "simplified_nist_profile.json" | ||
| dst_path: pathlib.Path = ModelUtils.get_model_path_for_name_and_class( | ||
| tmp_dir, "simplified_nist_profile", prof.Profile, FileContentType.JSON # type: ignore | ||
| ) | ||
| dst_path.parent.mkdir(parents=True, exist_ok=True) | ||
|
|
||
| test_profile: prof.Profile = prof.Profile.oscal_read(src_path) | ||
|
|
||
| prof_import: prof.Import = test_profile.imports[0] | ||
| prof_import.include_controls[0].with_ids.append(prof.WithId(__root__="ac-6")) | ||
| test_profile.oscal_write(dst_path) | ||
|
|
||
| repo.git.add(all=True) | ||
| repo.index.commit("Add updated profile") | ||
| repo.close() | ||
| return str(tmp_dir) | ||
Oops, something went wrong.