fix: update new tests for dataflow analysis changes

Narrow pylint suppression for bashparser model definitions and add
explanatory comment.
Suppress sphinx warning caused by forward references.
Regenerated docs.

Signed-off-by: Nicholas Allen <[email protected]>

Author: nicallen

docs/source/conf.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 - 2024, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2022 - 2025, Oracle and/or its affiliates. All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
 
 # Configuration file for the Sphinx documentation builder.
@@ -76,6 +76,10 @@
     "<class 'macaron.parsers.github_workflow_model.Workflow'>",
 ]
 
+suppress_warnings = [
+    "sphinx_autodoc_typehints.forward_reference",  # Sphinx has issues with resolving forward references.
+]
+
 
 # We add the docstrings for class constructors in the `__init__` methods.
 def skip(app, what, name, obj, would_skip, options):

docs/source/pages/developers_guide/apidoc/macaron.build_spec_generator.dockerfile.rst

@@ -0,0 +1,26 @@
+macaron.build\_spec\_generator.dockerfile package
+=================================================
+
+.. automodule:: macaron.build_spec_generator.dockerfile
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+macaron.build\_spec\_generator.dockerfile.dockerfile\_output module
+-------------------------------------------------------------------
+
+.. automodule:: macaron.build_spec_generator.dockerfile.dockerfile_output
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+macaron.build\_spec\_generator.dockerfile.pypi\_dockerfile\_output module
+-------------------------------------------------------------------------
+
+.. automodule:: macaron.build_spec_generator.dockerfile.pypi_dockerfile_output
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/source/pages/developers_guide/apidoc/macaron.build_spec_generator.rst

@@ -14,6 +14,7 @@ Subpackages
 
    macaron.build_spec_generator.cli_command_parser
    macaron.build_spec_generator.common_spec
+   macaron.build_spec_generator.dockerfile
    macaron.build_spec_generator.reproducible_central
 
 Submodules

docs/source/pages/developers_guide/apidoc/macaron.repo_finder.rst

@@ -57,6 +57,14 @@ macaron.repo\_finder.repo\_finder\_java module
    :show-inheritance:
    :undoc-members:
 
+macaron.repo\_finder.repo\_finder\_npm module
+---------------------------------------------
+
+.. automodule:: macaron.repo_finder.repo_finder_npm
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 macaron.repo\_finder.repo\_finder\_pypi module
 ----------------------------------------------
 

docs/source/pages/developers_guide/apidoc/macaron.slsa_analyzer.build_tool.rst

@@ -17,6 +17,14 @@ macaron.slsa\_analyzer.build\_tool.base\_build\_tool module
    :show-inheritance:
    :undoc-members:
 
+macaron.slsa\_analyzer.build\_tool.conda module
+-----------------------------------------------
+
+.. automodule:: macaron.slsa_analyzer.build_tool.conda
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 macaron.slsa\_analyzer.build\_tool.docker module
 ------------------------------------------------
 
@@ -25,6 +33,14 @@ macaron.slsa\_analyzer.build\_tool.docker module
    :show-inheritance:
    :undoc-members:
 
+macaron.slsa\_analyzer.build\_tool.flit module
+----------------------------------------------
+
+.. automodule:: macaron.slsa_analyzer.build_tool.flit
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 macaron.slsa\_analyzer.build\_tool.go module
 --------------------------------------------
 
@@ -41,6 +57,14 @@ macaron.slsa\_analyzer.build\_tool.gradle module
    :show-inheritance:
    :undoc-members:
 
+macaron.slsa\_analyzer.build\_tool.hatch module
+-----------------------------------------------
+
+.. automodule:: macaron.slsa_analyzer.build_tool.hatch
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 macaron.slsa\_analyzer.build\_tool.language module
 --------------------------------------------------
 
@@ -81,6 +105,14 @@ macaron.slsa\_analyzer.build\_tool.poetry module
    :show-inheritance:
    :undoc-members:
 
+macaron.slsa\_analyzer.build\_tool.pyproject module
+---------------------------------------------------
+
+.. automodule:: macaron.slsa_analyzer.build_tool.pyproject
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 macaron.slsa\_analyzer.build\_tool.yarn module
 ----------------------------------------------
 

src/macaron/parsers/bashparser_model.py

@@ -1,15 +1,27 @@
 # Copyright (c) 2024 - 2025, Oracle and/or its affiliates. All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
-# Licensed under the Universal Permissive License v 1.0 as shown at https:#oss.oracle.com/licenses/upl/.
-# pylint: skip-file
-# flake8: noqa
 
-# Type definitions for Bash AST as produced (and json-serialised) by the "mvdan.cc/sh/v3/syntax" bash parser
+"""Type definitions for Bash AST as produced (and json-serialised) by the "mvdan.cc/sh/v3/syntax" bash parser."""
+
+# Suppress warnings about non-ALL_CAPS names (that reference the original names and so are not ours to change).
+# pylint: disable=invalid-name
+
+# Suppress false positive warnings caused by a field with the same name as its type (again, not our names to change)
+# pylint: disable=used-before-assignment
+
+# Refer to original definitions in codebase for description, no need to comment here.
+# pylint: disable=missing-class-docstring,missing-function-docstring
+
+# Forward-referencing union type defs are not expressible with "|" until python 3.12 type statement syntax is available.
+# pylint: disable=consider-alternative-union-syntax
+
+# Suppress all flake8 warnings for the same reasons as above (it does not allow selective disabling at file level).
+# flake8: noqa
 
 from __future__ import annotations
 
 from enum import Enum
-from typing import Any, Literal, NotRequired, Optional, TypedDict, TypeGuard, Union
+from typing import Literal, NotRequired, TypedDict, TypeGuard, Union
 
 
 class Pos(TypedDict):

tests/slsa_analyzer/build_tool/test_conda.py

@@ -7,7 +7,6 @@
 
 import pytest
 
-from macaron.code_analyzer.call_graph import BaseNode
 from macaron.slsa_analyzer.build_tool.base_build_tool import BuildToolCommand
 from macaron.slsa_analyzer.build_tool.conda import Conda
 from macaron.slsa_analyzer.build_tool.language import BuildLanguage
@@ -120,7 +119,7 @@ def test_is_conda_deploy_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),
@@ -220,7 +219,7 @@ def test_is_conda_package_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),

tests/slsa_analyzer/build_tool/test_flit.py

@@ -7,7 +7,6 @@
 
 import pytest
 
-from macaron.code_analyzer.call_graph import BaseNode
 from macaron.slsa_analyzer.build_tool.base_build_tool import BuildToolCommand
 from macaron.slsa_analyzer.build_tool.flit import Flit
 from macaron.slsa_analyzer.build_tool.language import BuildLanguage
@@ -120,7 +119,7 @@ def test_is_flit_deploy_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),
@@ -220,7 +219,7 @@ def test_is_flit_package_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),

tests/slsa_analyzer/build_tool/test_hatch.py

@@ -7,7 +7,6 @@
 
 import pytest
 
-from macaron.code_analyzer.call_graph import BaseNode
 from macaron.slsa_analyzer.build_tool.base_build_tool import BuildToolCommand
 from macaron.slsa_analyzer.build_tool.hatch import Hatch
 from macaron.slsa_analyzer.build_tool.language import BuildLanguage
@@ -120,7 +119,7 @@ def test_is_hatch_deploy_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),
@@ -220,7 +219,7 @@ def test_is_hatch_package_command(
             language_distributions=language_distributions,
             language_url=None,
             ci_path=ci_path,
-            step_node=BaseNode(),
+            step_node=None,
             reachable_secrets=reachable_secrets,
             events=events,
         ),