Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-112302: Point core developers to SBOM devguide on errors #113490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hugovk merged 3 commits into from
Jan 10, 2024
Merged

gh-112302: Point core developers to SBOM devguide on errors #113490

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc699a0
Point core developers to SBOM devguide on errors
sethmlarson Dec 26, 2023
ba6192f
Flip error_if() to be easier to read
sethmlarson Jan 10, 2024
c81fd8d
Use devguide
sethmlarson Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Flip error_if() to be easier to read
  • Loading branch information
@sethmlarson
sethmlarson committed Jan 10, 2024
commit ba6192fb34199078c2e3751bad7f192c1d8e3547
38 changes: 19 additions & 19 deletions Tools/build/generate_sbom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,9 @@ def spdx_id(value: str) -> str:
return re.sub(r"[^a-zA-Z0-9.\-]+", "-", value)


def error_if_not(value: bool, error_message: str) -> None:
"""Prints an error if a value isn't true along with a link to the Dev Guide"""
if not value:
def error_if(value: bool, error_message: str) -> None:
"""Prints an error if a comparison fails along with a link to the Dev Guide"""
Comment thread
sethmlarson marked this conversation as resolved.
Outdated
if value:
print(error_message)
print("See 'https://devguide.python.org/developer-workflow/sbom' for more information.")
sys.exit(1)
Expand Down Expand Up @@ -214,35 +214,35 @@ def main() -> None:
discover_pip_sbom_package(sbom_data)

# Ensure all packages in this tool are represented also in the SBOM file.
error_if_not(
{package["name"] for package in sbom_data["packages"]} == set(PACKAGE_TO_FILES),
error_if(
{package["name"] for package in sbom_data["packages"]} != set(PACKAGE_TO_FILES),
"Packages defined in SBOM tool don't match those defined in SBOM file.",
)

# Make a bunch of assertions about the SBOM data to ensure it's consistent.
for package in sbom_data["packages"]:
# Properties and ID must be properly formed.
error_if_not(
"name" in package,
error_if(
"name" not in package,
"Package is missing the 'name' field"
)
error_if_not(
set(package.keys()) == REQUIRED_PROPERTIES_PACKAGE,
error_if(
set(package.keys()) != REQUIRED_PROPERTIES_PACKAGE,
f"Package '{package['name']}' is missing required fields",
)
error_if_not(
package["SPDXID"] == spdx_id(f"SPDXRef-PACKAGE-{package['name']}"),
error_if(
package["SPDXID"] != spdx_id(f"SPDXRef-PACKAGE-{package['name']}"),
f"Package '{package['name']}' has a malformed SPDXID",
)

# Version must be in the download and external references.
version = package["versionInfo"]
error_if_not(
version in package["downloadLocation"],
error_if(
version not in package["downloadLocation"],
f"Version '{version}' for package '{package['name']} not in 'downloadLocation' field",
)
error_if_not(
all(version in ref["referenceLocator"] for ref in package["externalRefs"]),
error_if(
any(version not in ref["referenceLocator"] for ref in package["externalRefs"]),
(
f"Version '{version}' for package '{package['name']} not in "
f"all 'externalRefs[].referenceLocator' fields"
Expand All @@ -251,8 +251,8 @@ def main() -> None:

# License must be on the approved list for SPDX.
license_concluded = package["licenseConcluded"]
error_if_not(
license_concluded in ALLOWED_LICENSE_EXPRESSIONS,
error_if(
license_concluded not in ALLOWED_LICENSE_EXPRESSIONS,
f"License identifier '{license_concluded}' not in SBOM tool allowlist"
)

Expand All @@ -268,8 +268,8 @@ def main() -> None:
# Find all the paths and then filter them through .gitignore.
paths = glob.glob(include, root_dir=CPYTHON_ROOT_DIR, recursive=True)
paths = filter_gitignored_paths(paths)
error_if_not(
len(paths) > 0,
error_if(
len(paths) == 0,
f"No valid paths found at path '{include}' for package '{name}",
)

Expand Down