feat: generate build spec into a purl-based path in the output directory

Author: Trong Nhan Mai

src/macaron/__main__.py

@@ -16,7 +16,7 @@
 import macaron
 from macaron.build_spec_generator.build_spec_generator import (
     BuildSpecFormat,
-    gen_build_spec_str,
+    gen_build_spec_for_purl,
 )
 from macaron.config.defaults import create_defaults, load_defaults
 from macaron.config.global_config import global_config
@@ -273,36 +273,13 @@ def gen_build_spec(gen_build_spec_args: argparse.Namespace) -> int:
         gen_build_spec_args.database,
     )
 
-    build_spec_content = gen_build_spec_str(
+    return gen_build_spec_for_purl(
         purl=purl,
         database_path=gen_build_spec_args.database,
         build_spec_format=build_spec_format,
+        output_path=global_config.output_path,
     )
 
-    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."""

src/macaron/build_spec_generator/build_spec_generator.py

@@ -4,6 +4,7 @@
 """This module contains the functions used for generating build specs from the Macaron database."""
 
 import logging
+import os
 from collections.abc import Mapping
 from enum import Enum
 
@@ -13,6 +14,7 @@
 
 from macaron.build_spec_generator.build_command_patcher import PatchCommandBuildTool, PatchValueType
 from macaron.build_spec_generator.reproducible_central.reproducible_central import gen_reproducible_central_build_spec
+from macaron.path_utils.purl_based_path import get_purl_based_dir
 
 logger: logging.Logger = logging.getLogger(__name__)
 
@@ -63,11 +65,12 @@ class BuildSpecFormat(str, Enum):
 }
 
 
-def gen_build_spec_str(
+def gen_build_spec_for_purl(
     purl: PackageURL,
     database_path: str,
     build_spec_format: BuildSpecFormat,
-) -> str | None:
+    output_path: str,
+) -> int:
     """Return the content of a build spec file from a given PURL.
 
     Parameters
@@ -81,16 +84,59 @@ def gen_build_spec_str(
 
     Returns
     -------
-    str | None
-        The build spec content as a string, or None if there is an error.
+    int
+        The exit code for this function. ``os.EX_OK`` if everything is fine, ``os.EX_OSERR`` if the
+        buildspec file cannot be created in the local filesystem, ``os.EX_DATAERR`` if there was an
+        error in generate the content for the buildspec file.
     """
     db_engine = create_engine(f"sqlite+pysqlite:///{database_path}", echo=False)
 
     with Session(db_engine) as session, session.begin():
+        build_spec_content = None
         match build_spec_format:
             case BuildSpecFormat.REPRODUCIBLE_CENTRAL:
-                return gen_reproducible_central_build_spec(
+                build_spec_content = gen_reproducible_central_build_spec(
                     purl=purl,
                     session=session,
                     patches=CLI_COMMAND_PATCHES,
                 )
+
+        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(
+            output_path,
+            "buildspec",
+            get_purl_based_dir(
+                purl_name=purl.name,
+                purl_namespace=purl.namespace,
+                purl_type=purl.type,
+            ),
+            "macaron.buildspec",
+        )
+
+        os.makedirs(
+            name=os.path.dirname(build_spec_filepath),
+            exist_ok=True,
+        )
+
+        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_OSERR
+
+        return os.EX_OK

tests/integration/cases/behnazh-w_example-maven-app_gen_rc_build_spec/test.yaml

@@ -29,5 +29,5 @@ steps:
   kind: compare
   options:
     kind: rc_build_spec
-    result: ./output/macaron.buildspec
+    result: ./output/buildspec/github/behnazh-w/example-maven-app/macaron.buildspec
     expected: expected_macaron.buildspec

tests/integration/cases/micronaut-projects_micronaut-core/test.yaml

@@ -44,5 +44,5 @@ steps:
   kind: compare
   options:
     kind: rc_build_spec
-    result: ./output/macaron.buildspec
+    result: ./output/buildspec/maven/io_micronaut/micronaut-core/macaron.buildspec
     expected: expected_macaron.buildspec