feat: 295 monorepo directory structure design proposal

pyproject.toml

@@ -48,6 +48,7 @@ flake8-print = "^5.0.0"
 pre-commit = "^3.4.0"
 mkdocs-material = "^9.5.43"
 markdown-include = "^0.8.1"
+types-pyyaml = "^6.0.12.20240917"
 
 [tool.poetry.group.tests]
 optional = true

trestlebot/cli/base.py

@@ -0,0 +1,90 @@
+import argparse
+import logging
+from typing import List
+
+from trestlebot.bot import TrestleBot
+from trestlebot.cli.options.common import handle_exceptions
+from trestlebot.tasks.assemble_task import AssembleTask
+from trestlebot.tasks.authored import types
+from trestlebot.tasks.authored.base_authored import AuthoredObjectBase
+from trestlebot.tasks.base_task import ModelFilter, TaskBase
+from trestlebot.tasks.regenerate_task import RegenerateTask
+
+
+logger = logging.getLogger(__name__)
+
+
+def comma_sep_to_list(string: str) -> List[str]:
+    """Convert comma-sep string to list of strings and strip."""
+    string = string.strip() if string else ""
+    return list(map(str.strip, string.split(","))) if string else []
+
+
+def run_base(args: argparse.Namespace, pre_tasks: List[TaskBase]) -> None:
+    """Reusable logic for all commands."""
+    # from trestlebot.reporter import BotResults, ResultsReporter
+    # git_provider: Optional[GitProvider] = self.set_git_provider(args)
+    # results_reporter: ResultsReporter = self.set_reporter()
+
+    # Configure and run the bot
+    bot = TrestleBot(
+        working_dir=args.working_dir,
+        branch=args.branch,
+        commit_name=args.committer_name,
+        commit_email=args.committer_email,
+        author_name=args.author_name,
+        author_email=args.author_email,
+        # target_branch=args.target_branch,
+    )
+    # results: BotResults = bot.run(
+    bot.run(
+        pre_tasks=pre_tasks,
+        patterns=comma_sep_to_list(args.patterns),
+        commit_message=args.commit_message,
+        # git_provider=git_provider,
+        # pull_request_title=args.pull_request_title,
+        dry_run=args.dry_run,
+    )
+
+    # # Report the results
+    # results_reporter.report_results(results)
+
+
+@handle_exceptions
+def run(oscal_model: str, args: argparse.Namespace, ssp_index_path: str = "") -> None:
+    """Run the autosync for oscal model."""
+
+    pre_tasks: List[TaskBase] = []
+    # Allow any model to be skipped from the args, by default include all
+    model_filter: ModelFilter = ModelFilter(
+        skip_patterns=comma_sep_to_list(args.skip_items),
+        include_patterns=["*"],
+    )
+    authored_object: AuthoredObjectBase = types.get_authored_object(
+        oscal_model, args.working_dir, ssp_index_path
+    )
+
+    # Assuming an edit has occurred assemble would be run before regenerate.
+    # Adding this to the list first
+    if not args.skip_assemble:
+        assemble_task: AssembleTask = AssembleTask(
+            authored_object=authored_object,
+            markdown_dir=args.markdown_path,
+            version=args.version,
+            model_filter=model_filter,
+        )
+        pre_tasks.append(assemble_task)
+    else:
+        logger.info("Assemble task skipped.")
+
+    if not args.skip_regenerate:
+        regenerate_task: RegenerateTask = RegenerateTask(
+            authored_object=authored_object,
+            markdown_dir=args.markdown_path,
+            model_filter=model_filter,
+        )
+        pre_tasks.append(regenerate_task)
+    else:
+        logger.info("Regeneration task skipped.")
+
+    run_base(args, pre_tasks)

trestlebot/cli/commands/autosync.py

@@ -0,0 +1,155 @@
+""" Autosync command"""
+
+import argparse
+
+import click
+
+from trestlebot.cli.base import comma_sep_to_list, run
+from trestlebot.cli.options.common import git_options
+
+
+@click.group(name="autosync", help="Autosync operations")
+@click.option(
+    "--working-dir",
+    help="Working directory wit git repository",
+    type=click.Path(exists=True),
+)
+@click.option(
+    "--dry-run",
+    help="Run tasks, but do not push to the repository",
+    is_flag=True,
+)
+@click.option(
+    "--markdown-path",
+    help="Path to Trestle markdown files",
+    type=click.Path(exists=True),  # Should it exist?
+)
+@click.option(
+    "--skip-items",
+    help="Comma-separated list of glob patterns to skip when running tasks",
+    type=str,  # What's the type?
+)
+@click.option(
+    "--skip-assemble",
+    help="Skip assembly task",
+    is_flag=True,
+    default=False,
+    show_default=True,
+)
+@click.option(
+    "--skip-regenerate",
+    help="Skip regenerate task",
+    is_flag=True,
+    default=False,
+    show_default=True,
+)
+@click.option(
+    "--version",
+    help="Version of the OSCAL model to set during assembly into JSON",
+    type=str,
+)
+@git_options
+@click.pass_context
+def autosync_cmd(
+    ctx: click.Context,
+    working_dir: str,
+    markdown_path: str,
+    dry_run: bool,
+    skip_items: str,
+    skip_assemble: bool,
+    skip_regenerate: bool,
+    file_patterns: str,
+    branch: str,
+    commit_message: str,
+    committer_name: str,
+    committer_email: str,
+    author_name: str,
+    author_email: str,
+    version: str,
+) -> None:
+    """Command to autosync catalog, profile, compdef and ssp."""
+
+    need_to_prompt = any(
+        (
+            not working_dir,
+            not markdown_path,
+            not branch,
+            not committer_email,
+            not committer_name,
+        )
+    )
+    if need_to_prompt:
+        click.echo("\n* Welcome to the Trestle-bot CLI *\n")
+        click.echo("Please provide the following values to start autosync operations.")
+        if not working_dir:
+            working_dir = click.prompt(
+                "Enter path to working directory wit git repository",
+                default=".",
+                type=click.Path(exists=True),
+            )
+        if not markdown_path:
+            markdown_path = click.prompt(
+                "Enter path to to Trestle markdown files",
+                type=click.Path(exists=True),
+            )
+        if not branch:
+            branch = click.prompt(
+                "Enter branch name to push changes to",
+            )
+        if not committer_email:
+            committer_email = click.prompt(
+                "Enter email for committer",
+            )
+        if not committer_name:
+            committer_name = click.prompt(
+                "Enter name of committer",
+            )
+
+    ctx.trestle_args = argparse.Namespace(
+        working_dir=working_dir,
+        markdown_path=markdown_path,
+        skip_items=skip_items,
+        skip_assemble=skip_assemble,
+        skip_regenerate=skip_regenerate,
+        version=version,
+        patterns=comma_sep_to_list(file_patterns),
+        branch=branch,
+        commit_message=commit_message,
+        committer_name=committer_name,
+        committer_email=committer_email,
+        author_name=author_name,
+        author_email=author_email,
+        # target_branch=target_branch,
+        # pull_request_title=pull_request_title,
+        dry_run=dry_run,
+    )
+
+
+@autosync_cmd.command("ssp")
+@click.pass_context
+@click.option("--ssp-index-path", help="Path to ssp index file", type=click.File("r"))
+def autosync_ssp_cmd(ctx: click.Context, ssp_index_path: str) -> None:
+    if not ssp_index_path:
+        ssp_index_path = click.prompt(
+            "Enter path to ssp index file",
+            type=click.Path(exists=True),
+        )
+    run("ssp", ctx.parent.trestle_args, ssp_index_path)
+
+
+@autosync_cmd.command("compdef")
+@click.pass_context
+def autosync_compdef_cmd(ctx: click.Context) -> None:
+    run("compdef", ctx.parent.trestle_args)
+
+
+@autosync_cmd.command("catalog")
+@click.pass_context
+def autosync_catalog_cmd(ctx: click.Context) -> None:
+    run("catalog", ctx.parent.trestle_args)
+
+
+@autosync_cmd.command("profile")
+@click.pass_context
+def autosync_profile_cmd(ctx: click.Context) -> None:
+    run("profile", ctx.parent.trestle_args)