chore: improve pip build tool detection

Signed-off-by: behnazh-w <behnaz.hassanshahi@oracle.com>

Author: behnazh-w

docs/source/pages/tutorials/rebuild_third_party_artifacts.rst

@@ -120,7 +120,9 @@ By default we generate the buildspec in JSON format as follows:
         "ecosystem": "maven",
         "purl": "pkg:maven/org.apache.hugegraph/computer-k8s@1.0.0",
         "language": "java",
-        "build_tool": "maven",
+        "build_tools": [
+            "maven"
+        ],
         "build_commands": [
             [
             "mvn",

src/macaron/build_spec_generator/common_spec/base_spec.py

@@ -25,8 +25,8 @@ class BaseBuildSpecDict(TypedDict, total=False):
     #: The programming language, e.g., 'java', 'python', 'javascript'.
     language: Required[str]
 
-    #: The build tool or package manager, e.g., 'maven', 'gradle', 'pip', 'poetry', 'npm', 'yarn'.
-    build_tool: Required[str]
+    #: The build tools or package managers, e.g., 'maven', 'gradle', 'pip', 'poetry', 'npm', 'yarn'.
+    build_tools: Required[list[str]]
 
     #: The version of Macaron used for generating the spec.
     macaron_version: Required[str]
@@ -94,21 +94,21 @@ def resolve_fields(self, purl: PackageURL) -> None:
         """
 
     @abstractmethod
-    def get_default_build_command(
+    def get_default_build_commands(
         self,
-        build_tool_name: str,
-    ) -> list[str]:
-        """Return a default build command for the build tool.
+        build_tool_names: list[str],
+    ) -> list[list[str]]:
+        """Return the default build commands for the build tools.
 
         Parameters
         ----------
-        build_tool_name: str
-            The build tool to get the default build command.
+        build_tool_names: list[str]
+            The build tools to get the default build command.
 
         Returns
         -------
-        list[str]
-            The build command as a list[str].
+        list[list[str]]
+            The build command as a list[list[str]].
 
         Raises
         ------

src/macaron/build_spec_generator/common_spec/core.py

@@ -120,18 +120,14 @@ def compose_shell_commands(cmds_sequence: list[list[str]]) -> str:
     return result
 
 
-def get_macaron_build_tool_name(
+def get_macaron_build_tool_names(
     build_tool_facts: Sequence[BuildToolFacts], target_language: str
-) -> MacaronBuildToolName | None:
+) -> list[MacaronBuildToolName] | None:
     """
-    Retrieve the Macaron build tool name for supported projects from the database facts.
+    Retrieve the Macaron build tool names for supported projects from the database facts.
 
-    Iterates over the provided build tool facts and returns the first valid `MacaronBuildToolName`
-    for a supported language. If no valid build tool name is found, returns None.
-
-    .. note::
-        If multiple build tools are present in the database, only the first valid one encountered
-        in the sequence is returned.
+    Iterates over the provided build tool facts and returns the list of valid `MacaronBuildToolName`
+    for a supported language.
 
     Parameters
     ----------
@@ -142,31 +138,27 @@ def get_macaron_build_tool_name(
 
     Returns
     -------
-    MacaronBuildToolName or None
-        The corresponding Macaron build tool name if found, otherwise None.
+    list[MacaronBuildToolName]
+        The corresponding Macaron build tool names.
     """
+    build_tool_names = []
     for fact in build_tool_facts:
         if fact.language.lower() == target_language:
             try:
-                macaron_build_tool_name = MacaronBuildToolName(fact.build_tool_name)
+                build_tool_names.append(MacaronBuildToolName(fact.build_tool_name))
             except ValueError:
                 continue
 
-            # TODO: What happen if we report multiple build tools in the database?
-            return macaron_build_tool_name
-
-    return None
+    return build_tool_names
 
 
-def get_build_tool_name(
+def get_build_tool_names(
     component_id: int, session: sqlalchemy.orm.Session, target_language: str
-) -> MacaronBuildToolName | None:
-    """
-    Retrieve the Macaron build tool name for a given component.
+) -> list[MacaronBuildToolName] | None:
+    """Retrieve the Macaron build tool names for a given component.
 
-    Queries the database for build tool facts associated with the specified component ID
-    and returns the corresponding `MacaronBuildToolName` if found. If no valid build tool
-    information is available or an error occurs during the query, returns None.
+    Queries the database for build tool facts associated with the specified component ID.
+    It returns the corresponding list of `MacaronBuildToolName` if found.
 
     Parameters
     ----------
@@ -179,7 +171,7 @@ def get_build_tool_name(
 
     Returns
     -------
-    MacaronBuildToolName or None
+    list[MacaronBuildToolName] | None
         The corresponding build tool name for the component if available, otherwise None.
     """
     try:
@@ -206,7 +198,7 @@ def get_build_tool_name(
         [(fact.build_tool_name, fact.language) for fact in build_tool_facts],
     )
 
-    return get_macaron_build_tool_name(build_tool_facts, target_language)
+    return get_macaron_build_tool_names(build_tool_facts, target_language)
 
 
 def get_build_command_info(
@@ -348,10 +340,10 @@ def gen_generic_build_spec(
         latest_component_repository.commit_sha,
     )
 
-    build_tool_name = get_build_tool_name(
+    build_tool_names = get_build_tool_names(
         component_id=latest_component.id, session=session, target_language=target_language
     )
-    if not build_tool_name:
+    if not build_tool_names:
         raise GenerateBuildSpecError(f"Failed to determine build tool for {purl}.")
 
     build_command_info = get_build_command_info(
@@ -380,7 +372,7 @@ def gen_generic_build_spec(
             "ecosystem": purl.type,
             "purl": str(purl),
             "language": target_language,
-            "build_tool": build_tool_name.value,
+            "build_tools": [build_tool.value for build_tool in build_tool_names],
             "build_commands": [selected_build_command],
         }
     )

src/macaron/build_spec_generator/common_spec/maven_spec.py

@@ -31,45 +31,47 @@ def __init__(self, data: BaseBuildSpecDict):
         """
         self.data = data
 
-    def get_default_build_command(
+    def get_default_build_commands(
         self,
-        build_tool_name: str,
-    ) -> list[str]:
-        """Return a default build command for the build tool.
+        build_tool_names: list[str],
+    ) -> list[list[str]]:
+        """Return the default build commands for the build tools.
 
         Parameters
         ----------
-        build_tool_name: str
-            The build tool to get the default build command.
+        build_tool_names: list[str]
+            The build tools to get the default build command.
 
         Returns
         -------
-        list[str]
-            The build command as a list[str].
+        list[list[str]]
+            The build command as a list[list[str]].
 
         Raises
         ------
         GenerateBuildSpecError
             If there is no default build command available for the specified build tool.
         """
-        default_build_command = None
+        default_build_commands = []
 
-        match build_tool_name:
-            case "maven":
-                default_build_command = "mvn clean package".split()
-            case "gradle":
-                default_build_command = "./gradlew clean assemble publishToMavenLocal".split()
-            case _:
-                pass
+        for build_tool_name in build_tool_names:
 
-        if not default_build_command:
+            match build_tool_name:
+                case "maven":
+                    default_build_commands.append("mvn clean package".split())
+                case "gradle":
+                    default_build_commands.append("./gradlew clean assemble publishToMavenLocal".split())
+                case _:
+                    pass
+
+        if not default_build_commands:
             logger.critical(
-                "There is no default build command available for the build tool %s.",
-                build_tool_name,
+                "There is no default build command available for the build tools %s.",
+                build_tool_names,
             )
             raise GenerateBuildSpecError("Unable to find a default build command.")
 
-        return default_build_command
+        return default_build_commands
 
     def resolve_fields(self, purl: PackageURL) -> None:
         """
@@ -113,9 +115,9 @@ def resolve_fields(self, purl: PackageURL) -> None:
         self.data["language_version"] = [major_jdk_version]
 
         # Resolve and patch build commands.
-        selected_build_commands = self.data["build_commands"] or [
-            self.get_default_build_command(self.data["build_tool"])
-        ]
+        selected_build_commands = self.data["build_commands"] or self.get_default_build_commands(
+            self.data["build_tools"]
+        )
 
         patched_build_commands = patch_commands(
             cmds_sequence=selected_build_commands,

src/macaron/build_spec_generator/common_spec/pypi_spec.py

@@ -39,51 +39,53 @@ def __init__(self, data: BaseBuildSpecDict):
         """
         self.data = data
 
-    def get_default_build_command(
+    def get_default_build_commands(
         self,
-        build_tool_name: str,
-    ) -> list[str]:
-        """Return a default build command for the build tool.
+        build_tool_names: list[str],
+    ) -> list[list[str]]:
+        """Return the default build commands for the build tools.
 
         Parameters
         ----------
-        build_tool_name: str
-            The build tool to get the default build command.
+        build_tool_names: list[str]
+            The build tools to get the default build command.
 
         Returns
         -------
-        list[str]
-            The build command as a list[str].
+        list[list[str]]
+            The build command as a list[list[str]].
 
         Raises
         ------
         GenerateBuildSpecError
             If there is no default build command available for the specified build tool.
         """
-        default_build_command = None
-
-        match build_tool_name:
-            case "pip":
-                default_build_command = "python -m build".split()
-            case "poetry":
-                default_build_command = "poetry build".split()
-            case "flit":
-                default_build_command = "flit build".split()
-            case "hatch":
-                default_build_command = "hatch build".split()
-            case "conda":
-                default_build_command = "conda build".split()
-            case _:
-                pass
-
-        if not default_build_command:
+        default_build_commands = []
+
+        for build_tool_name in build_tool_names:
+
+            match build_tool_name:
+                case "pip":
+                    default_build_commands.append("python -m build".split())
+                case "poetry":
+                    default_build_commands.append("poetry build".split())
+                case "flit":
+                    default_build_commands.append("flit build".split())
+                case "hatch":
+                    default_build_commands.append("hatch build".split())
+                case "conda":
+                    default_build_commands.append("conda build".split())
+                case _:
+                    pass
+
+        if not default_build_commands:
             logger.critical(
-                "There is no default build command available for the build tool %s.",
-                build_tool_name,
+                "There is no default build command available for the build tools %s.",
+                build_tool_names,
             )
             raise GenerateBuildSpecError("Unable to find a default build command.")
 
-        return default_build_command
+        return default_build_commands
 
     def resolve_fields(self, purl: PackageURL) -> None:
         """
@@ -202,13 +204,14 @@ def resolve_fields(self, purl: PackageURL) -> None:
 
                 # Use the default build command for pure Python packages.
                 if "any" in wheel_name_platforms:
-                    patched_build_commands = [self.get_default_build_command(self.data["build_tool"])]
+                    patched_build_commands = self.get_default_build_commands(self.data["build_tools"])
 
             if not patched_build_commands:
                 # Resolve and patch build commands.
-                selected_build_commands = self.data["build_commands"] or [
-                    self.get_default_build_command(self.data["build_tool"])
-                ]
+                selected_build_commands = self.data["build_commands"] or self.get_default_build_commands(
+                    self.data["build_tools"]
+                )
+
                 patched_build_commands = (
                     patch_commands(
                         cmds_sequence=selected_build_commands,

src/macaron/build_spec_generator/reproducible_central/reproducible_central.py

@@ -77,9 +77,9 @@ def gen_reproducible_central_build_spec(build_spec: BaseBuildSpecDict) -> str |
     GenerateBuildSpecError
         Raised if generation of the build spec fails.
     """
-    if build_spec["build_tool"].upper() not in (e.name for e in ReproducibleCentralBuildTool):
+    if build_spec["build_tools"][0].upper() not in (e.name for e in ReproducibleCentralBuildTool):
         raise GenerateBuildSpecError(
-            f"Build tool {build_spec['build_tool']} is not supported by Reproducible Central. "
+            f"Build tool {build_spec['build_tools'][0]} is not supported by Reproducible Central. "
             f"Supported build tools: {[build.name for build in ReproducibleCentralBuildTool]}"
         )
     if build_spec["group_id"] is None:
@@ -92,7 +92,7 @@ def gen_reproducible_central_build_spec(build_spec: BaseBuildSpecDict) -> str |
         "version": build_spec["version"],
         "git_repo": build_spec["git_repo"],
         "git_tag": build_spec["git_tag"],
-        "tool": ReproducibleCentralBuildTool[build_spec["build_tool"].upper()].value,
+        "tool": ReproducibleCentralBuildTool[build_spec["build_tools"][0].upper()].value,
         "newline": build_spec["newline"],
         "buildinfo": f"target/{build_spec['artifact_id']}-{build_spec['version']}.buildinfo",
         "jdk": build_spec["language_version"][0],

src/macaron/config/defaults.ini

@@ -290,16 +290,14 @@ build_configs =
     pyproject.toml
 packager =
     pip
-    pip3
-    flit
-    conda
-    hatch
+    build
 publisher =
     twine
-    flit
-    conda
-    tox
-    hatch
+# build-system information.
+build_requires =
+    setuptools
+build_backend =
+    setuptools.build_meta
 # These are the Python interpreters that may be used to load modules.
 interpreter =
     python