feat: multi build tool detection #179

timyarkov · 2023-04-23T08:16:46Z

Basic multiple build tool detection (essentially converting the tool part of BuildSpec to a list)

TODO before final PR:

Double triple check nothing was missed
Rebase to staging (+squash commits)
Update unit tests to multi-build tool
Do general system testing to see if everything works as expected (did very quick test and at the very least it doesn't crash when ran on https://github.com/timyarkov/GuardianEmailClient)

oracle-contributor-agreement · 2023-04-23T08:16:50Z

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

PR author: @timyarkov
timdyarkov@gmail.com (@timyarkov)

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

behnazh-w · 2023-04-24T05:04:00Z

src/macaron/slsa_analyzer/analyzer.py

-        if not build_tool or isinstance(build_tool, NoneBuildTool):
-            logger.info("Unable to find a valid build tool.")
+        build_tools = main_ctx.dynamic_data["build_spec"]["tools"]
+        if len(build_tools) == 0:


You can just use if build_tools in Python to check if a list is empty or not, no need to check the length.

behnazh-w · 2023-04-24T05:09:34Z

src/macaron/slsa_analyzer/analyzer.py

                break

-        if not analyze_ctx.dynamic_data["build_spec"].get("tool"):
+        if len(analyze_ctx.dynamic_data["build_spec"].get("tools")) == 0:


Same comment about checking lists.

behnazh-w · 2023-04-24T05:16:42Z

src/macaron/slsa_analyzer/checks/build_as_code_check.py

+        # Get the build tool identified by the mcn_version_control_system_1, which we depend on.
+        build_tools = ctx.dynamic_data["build_spec"].get("tools")
+
+        if len(build_tools) == 0:


Same comment about lists.

behnazh-w · 2023-04-24T05:19:42Z

src/macaron/slsa_analyzer/checks/build_as_code_check.py

-        return CheckResultType.FAILED
+        ci_services = ctx.dynamic_data["ci_services"]
+
+        # Check for each build tool if its built as code


Suggested change

# Check for each build tool if its built as code

Check if "build as code" holds for each build tool.

behnazh-w · 2023-04-24T05:22:02Z

src/macaron/slsa_analyzer/checks/build_as_code_check.py

-    def run_check(self, ctx: AnalyzeContext, check_result: CheckResult) -> CheckResultType:
-        """Implement the check in this method.
+
+    def _tool_check(


Suggested change

def _tool_check(

def _check_build_tool(

behnazh-w · 2023-04-24T05:22:38Z

src/macaron/slsa_analyzer/checks/build_as_code_check.py

+            check_result: CheckResult
+        ) -> CheckResultType | None:
+        """
+        Run the check for a single build tool.


Can you add why we need to do that?

behnazh-w · 2023-04-24T05:23:30Z

src/macaron/slsa_analyzer/checks/build_service_check.py

-                            ctx.commit_sha,
-                            ci_service.api_client.get_relative_path_of_workflow(os.path.basename(bash_cmd["CI_path"])),
+
+    def _build_tool_check(


Suggested change

def _build_tool_check(

def _check_build_tool(

behnazh-w · 2023-04-24T05:23:44Z

src/macaron/slsa_analyzer/checks/build_service_check.py

+            ctx: AnalyzeContext, 
+            check_result: CheckResult, 
+            ci_services: list[CIInfo]
+        ) -> CheckResultType | None:


Add docstring.

tromai · 2023-05-23T04:22:54Z

src/macaron/slsa_analyzer/checks/build_as_code_check.py

+            res = self._check_build_tool(tool, ctx, ci_services, check_result)
+
+            # Divide up build tool outputs
+            check_result["justification"].append("\n")


I don't think we need to add a "\n" character to divide up the outputs. The content of each element of check_result["justification"] is not used for rendering the reports. So if you add "\n" here, the string "\n" will appear instead of a new line.
Furthermore, in the HTML reports each element in check_result["justification"] is rendered as a separated bullet point in the justification column.

src/macaron/slsa_analyzer/checks/build_script_check.py

src/macaron/slsa_analyzer/checks/build_service_check.py

oracle-contributor-agreement · 2023-06-18T12:02:50Z

Thank you for your pull request and welcome to our community! To contribute, please sign the Oracle Contributor Agreement (OCA).
The following contributors of this PR have not signed the OCA:

testing@example.com (@Testing11223344)

To sign the OCA, please create an Oracle account and sign the OCA in Oracle's Contributor Agreement Application.

When signing the OCA, please provide your GitHub username. After signing the OCA and getting an OCA approval from Oracle, this PR will be automatically updated.

If you are an Oracle employee, please make sure that you are a member of the main Oracle GitHub organization, and your membership in this organization is public.

behnazh-w · 2023-06-18T20:25:11Z

src/macaron/resources/.gitignore

@@ -3,7 +3,7 @@

 # Ignore Gradle project-specific cache directory
 .gradle
-gradle-*
+.gradle-*


Suggested change

.gradle-*

gradle-*

behnazh-w · 2023-06-18T20:27:58Z

tests/e2e/expected_results/micronaut-core/caffeine.json

These updates can be reverted as they don't change the expected results anymore.

Same comment for micronaut-core.json and sl4j.sjon.

Signed-off-by: Tim Yarkov <timdyarkov@gmail.com>

oracle-contributor-agreement bot added the OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. label Apr 23, 2023

timyarkov changed the title ~~Multi build tool detection~~ feat: multi build tool detection Apr 23, 2023

behnazh-w reviewed Apr 24, 2023

View reviewed changes

timyarkov force-pushed the multi_build_tool branch from 4244d5e to 2d1c840 Compare April 30, 2023 03:40

oracle-contributor-agreement bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels May 2, 2023

timyarkov force-pushed the multi_build_tool branch 7 times, most recently from 0719624 to fe20e75 Compare May 21, 2023 08:55

tromai reviewed May 23, 2023

View reviewed changes

timyarkov force-pushed the multi_build_tool branch from fe20e75 to 8003e8e Compare May 29, 2023 08:12

timyarkov force-pushed the multi_build_tool branch 4 times, most recently from fc50afb to d87d970 Compare June 17, 2023 04:55

oracle-contributor-agreement bot added OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. and removed OCA Verified All contributors have signed the Oracle Contributor Agreement. labels Jun 18, 2023

timyarkov force-pushed the multi_build_tool branch from 53073e1 to c21963e Compare June 18, 2023 12:04

oracle-contributor-agreement bot added OCA Verified All contributors have signed the Oracle Contributor Agreement. and removed OCA Required At least one contributor does not have an approved Oracle Contributor Agreement. labels Jun 18, 2023

behnazh-w reviewed Jun 18, 2023

View reviewed changes

timyarkov force-pushed the multi_build_tool branch from c21963e to d643898 Compare June 18, 2023 21:13

timyarkov marked this pull request as ready for review June 18, 2023 23:06

timyarkov force-pushed the multi_build_tool branch from d643898 to e3f72af Compare June 19, 2023 08:54

feat: multi build tool detection

875164b

Signed-off-by: Tim Yarkov <timdyarkov@gmail.com>

timyarkov force-pushed the multi_build_tool branch from e3f72af to 875164b Compare June 19, 2023 23:28

behnazh-w approved these changes Jun 19, 2023

View reviewed changes

tromai approved these changes Jun 20, 2023

View reviewed changes

behnazh-w merged commit 615a96a into oracle:staging Jun 20, 2023

art1f1c3R pushed a commit that referenced this pull request Nov 29, 2024

feat: multi build tool detection (#179)

81da279

Signed-off-by: Tim Yarkov <timdyarkov@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: multi build tool detection #179

feat: multi build tool detection #179

Uh oh!

timyarkov commented Apr 23, 2023 •

edited

Loading

Uh oh!

oracle-contributor-agreement bot commented Apr 23, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

behnazh-w Apr 24, 2023

Uh oh!

tromai May 23, 2023

Uh oh!

Uh oh!

Uh oh!

oracle-contributor-agreement bot commented Jun 18, 2023

Uh oh!

behnazh-w Jun 18, 2023

Uh oh!

behnazh-w Jun 18, 2023

Uh oh!

Uh oh!

	# Check for each build tool if its built as code
	Check if "build as code" holds for each build tool.

feat: multi build tool detection #179

feat: multi build tool detection #179

Uh oh!

Conversation

timyarkov commented Apr 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oracle-contributor-agreement bot commented Apr 23, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

oracle-contributor-agreement bot commented Jun 18, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timyarkov commented Apr 23, 2023 •

edited

Loading