feat: expose macaron gen-build-spec cli command

Signed-off-by: Trong Nhan Mai <[email protected]>

Author: Trong Nhan Mai

src/macaron/__main__.py

@@ -14,6 +14,10 @@
 from packageurl import PackageURL
 
 import macaron
+from macaron.build_spec_generator.build_spec_generator import (
+    BuildSpecFormat,
+    gen_build_spec_str,
+)
 from macaron.config.defaults import create_defaults, load_defaults
 from macaron.config.global_config import global_config
 from macaron.errors import ConfigurationError
@@ -236,6 +240,63 @@ def verify_policy(verify_policy_args: argparse.Namespace) -> int:
     return os.EX_USAGE
 
 
+def gen_build_spec(gen_build_spec_args: argparse.Namespace) -> int:
+    """Generate a build spec containing the build information discovered by Macaron.
+
+    Returns
+    -------
+    int
+        Returns os.EX_OK if successful or the corresponding error code on failure.
+    """
+    if not os.path.isfile(gen_build_spec_args.database):
+        logger.critical("The database file does not exist.")
+        return os.EX_OSFILE
+
+    output_format = gen_build_spec_args.output_format
+
+    try:
+        build_spec_format = BuildSpecFormat(output_format)
+    except ValueError:
+        logger.error("The output format %s is not supported.", output_format)
+        return os.EX_USAGE
+
+    try:
+        purl = PackageURL.from_string(gen_build_spec_args.package_url)
+    except ValueError as error:
+        logger.error("Cannot parse purl %s. Error %s", gen_build_spec_args.package_url, error)
+        return os.EX_USAGE
+
+    build_spec_content = gen_build_spec_str(
+        purl=purl,
+        database_path=gen_build_spec_args.database,
+        build_spec_format=build_spec_format,
+    )
+
+    if not build_spec_content:
+        logger.error("Error while generate reproducible central build spec.")
+        return os.EX_DATAERR
+
+    logger.debug("Build spec content: \n%s", build_spec_content)
+    build_spec_filepath = os.path.join(global_config.output_path, "macaron.buildspec")
+    try:
+        with open(build_spec_filepath, mode="w", encoding="utf-8") as file:
+            logger.info(
+                "Generating the %s format build spec to %s.",
+                build_spec_format.value,
+                os.path.relpath(build_spec_filepath, os.getcwd()),
+            )
+            file.write(build_spec_content)
+    except OSError as error:
+        logger.error(
+            "Could not generate the Buildspec to %s. Error: %s",
+            os.path.relpath(build_spec_filepath, os.getcwd()),
+            error,
+        )
+        return os.EX_DATAERR
+
+    return os.EX_OK
+
+
 def find_source(find_args: argparse.Namespace) -> int:
     """Perform repo and commit finding for a passed PURL, or commit finding for a passed PURL and repo."""
     if repo_finder.find_source(find_args.package_url, find_args.repo_path or None):
@@ -284,6 +345,9 @@ def perform_action(action_args: argparse.Namespace) -> None:
 
             find_source(action_args)
 
+        case "gen-build-spec":
+            sys.exit(gen_build_spec(action_args))
+
         case _:
             logger.error("Macaron does not support command option %s.", action_args.action)
             sys.exit(os.EX_USAGE)
@@ -523,6 +587,30 @@ def main(argv: list[str] | None = None) -> None:
         ),
     )
 
+    # Generate a build spec containing rebuild information for a software component.
+    gen_build_spec_parser = sub_parser.add_parser(name="gen-build-spec")
+
+    gen_build_spec_parser.add_argument(
+        "-purl",
+        "--package-url",
+        required=True,
+        type=str,
+        help=("The PURL string of the software component to generate build spec for."),
+    )
+
+    gen_build_spec_parser.add_argument(
+        "--database",
+        help="Path to the database.",
+        required=True,
+    )
+
+    gen_build_spec_parser.add_argument(
+        "--output-format",
+        type=str,
+        help=('The output format. Can be rc-buildspec (Reproducible-central build spec) (default "rc-buildspec")'),
+        default="rc-buildspec",
+    )
+
     args = main_parser.parse_args(argv)
 
     if not args.action: