Skip to content

Commit

Permalink
[issue-373, review] refactoring using dictionaries
Browse files Browse the repository at this point in the history 
Signed-off-by: Armin Tänzer <armin.taenzer@tngtech.com>
  • Loading branch information
@armintaenzertng
armintaenzertng committed Jan 25, 2023
1 parent 0f86691 commit 6b3899f
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 58 deletions.
9 changes: 8 additions & 1 deletion src/spdx/model/package.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
from dataclasses import field
from datetime import datetime
from enum import Enum, auto
from typing import Optional, Union, List
from typing import Optional, Union, List, Dict

from spdx.model.actor import Actor
from spdx.model.checksum import Checksum
Expand Down Expand Up @@ -54,6 +54,13 @@ class ExternalPackageRefCategory(Enum):
OTHER = auto()


CATEGORY_TO_EXTERNAL_PACKAGE_REF_TYPES: Dict[ExternalPackageRefCategory, List[str]] = {
ExternalPackageRefCategory.SECURITY : ["cpe22Type", "cpe23Type", "advisory", "fix", "url", "swid"],
ExternalPackageRefCategory.PACKAGE_MANAGER : ["maven-central", "npm", "nuget", "bower", "purl"],
ExternalPackageRefCategory.PERSISTENT_ID : ["swh", "gitoid"]
}


@dataclass_with_properties
class ExternalPackageRef:
category: ExternalPackageRefCategory
Expand Down
89 changes: 36 additions & 53 deletions src/spdx/validation/external_package_ref_validator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import re
from typing import List
from typing import List, Dict

from spdx.model.package import ExternalPackageRef, ExternalPackageRefCategory
from spdx.model.package import ExternalPackageRef, ExternalPackageRefCategory, CATEGORY_TO_EXTERNAL_PACKAGE_REF_TYPES
from spdx.validation.uri_validators import validate_url, validate_uri
from spdx.validation.validation_message import ValidationMessage, ValidationContext, SpdxElementType

Expand All @@ -25,6 +25,18 @@
SWH_REGEX = r'^swh:1:(snp|rel|rev|dir|cnt):[0-9a-fA-F]{40}$'
GITOID_REGEX = r'^gitoid:(blob|tree|commit|tag):(sha1:[0-9a-fA-F]{40}|sha256:[0-9a-fA-F]{64})$'

TYPE_TO_REGEX: Dict[str, str] = {
"cpe22Type": CPE22TYPE_REGEX,
"cpe23Type": CPE23TYPE_REGEX,
"maven-central": MAVEN_CENTRAL_REGEX,
"npm": NPM_REGEX,
"nuget": NUGET_REGEX,
"bower": BOWER_REGEX,
"purl": PURL_REGEX,
"swh": SWH_REGEX,
"gitoid": GITOID_REGEX
}


def validate_external_package_refs(external_package_refs: List[ExternalPackageRef], parent_id: str) -> List[
ValidationMessage]:
Expand All @@ -43,69 +55,40 @@ def validate_external_package_ref(external_package_ref: ExternalPackageRef, pare
locator = external_package_ref.locator
reference_type = external_package_ref.reference_type

if category == ExternalPackageRefCategory.SECURITY:
if reference_type == "cpe22Type":
return validate_against_regex(locator, CPE22TYPE_REGEX, "cpe22Type", context)
if reference_type == "cpe23Type":
return validate_against_regex(locator, CPE23TYPE_REGEX, "cpe23Type", context)
if reference_type in ["advisory", "fix", "url"]:
if validate_url(locator):
return [ValidationMessage(
f'externalPackageRef locator of type "{reference_type}" must be a valid URL, but is: {locator}',
context)]
return []
if reference_type == "swid":
if validate_uri(locator) or not locator.startswith("swid"):
return [ValidationMessage(
f'externalPackageRef locator of type "swid" must be a valid URI with scheme swid, but is: {locator}',
context)]
return []

return [ValidationMessage(
f"externalPackageRef type in category SECURITY must be one of [cpe22Type, cpe23Type, advisory, fix, url, swid], but is: {reference_type}",
context)]

if category == ExternalPackageRefCategory.PACKAGE_MANAGER:
if reference_type == "maven-central":
return validate_against_regex(locator, MAVEN_CENTRAL_REGEX, "maven-central", context)
if reference_type == "npm":
return validate_against_regex(locator, NPM_REGEX, "npm", context)
if reference_type == "nuget":
return validate_against_regex(locator, NUGET_REGEX, "nuget", context)
if reference_type == "bower":
return validate_against_regex(locator, BOWER_REGEX, "bower", context)
if reference_type == "purl":
return validate_against_regex(locator, PURL_REGEX, "purl", context)
if category == ExternalPackageRefCategory.OTHER:
if " " in locator:
return [ValidationMessage(
f"externalPackageRef locator in category OTHER must contain no spaces, but is: {locator}",
context)]
return []

if reference_type not in CATEGORY_TO_EXTERNAL_PACKAGE_REF_TYPES[category]:
return [ValidationMessage(
f"externalPackageRef type in category PACKAGE_MANAGER must be one of [maven-central, npm, nuget, bower, purl], but is: {reference_type}",
f"externalPackageRef type in category {category.name} must be one of {CATEGORY_TO_EXTERNAL_PACKAGE_REF_TYPES[category]}, but is: {reference_type}",
context)]

if category == ExternalPackageRefCategory.PERSISTENT_ID:
if reference_type == "swh":
return validate_against_regex(locator, SWH_REGEX, "swh", context)
if reference_type == "gitoid":
return validate_against_regex(locator, GITOID_REGEX, "gitoid", context)

return [ValidationMessage(
f"externalPackageRef type in category PERSISTENT_ID must be one of [swh, gitoid], but is: {reference_type}",
context)]
if reference_type in ["advisory", "fix", "url"]:
if validate_url(locator):
return [ValidationMessage(
f'externalPackageRef locator of type "{reference_type}" must be a valid URL, but is: {locator}',
context)]
return []

if category == ExternalPackageRefCategory.OTHER:
if " " in locator:
if reference_type == "swid":
if validate_uri(locator) or not locator.startswith("swid"):
return [ValidationMessage(
f"externalPackageRef type in category OTHER must contain no spaces, but is: {locator}",
f'externalPackageRef locator of type "swid" must be a valid URI with scheme swid, but is: {locator}',
context)]
return []

return validate_against_regex(locator, reference_type, context)


def validate_against_regex(string_to_validate: str, regex: str, type_name: str, context: ValidationContext) -> List[
def validate_against_regex(string_to_validate: str, reference_type: str, context: ValidationContext) -> List[
ValidationMessage]:
regex = TYPE_TO_REGEX[reference_type]
if not re.match(regex, string_to_validate):
return [ValidationMessage(
f'externalPackageRef locator of type "{type_name}" must conform with the regex {regex}, but is: {string_to_validate}',
context)
]

f'externalPackageRef locator of type "{reference_type}" must conform with the regex {regex}, but is: {string_to_validate}',
context)]
return []
8 changes: 4 additions & 4 deletions tests/spdx/validation/test_external_package_ref_validator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ def test_valid_external_package_ref(category, reference_type, locator):
@pytest.mark.parametrize("category, reference_type, locator, expected_message",
[(
ExternalPackageRefCategory.SECURITY, "cpe22Typo", "cpe:/o:canonical:ubuntu_linux:10.04:-:lts",
"externalPackageRef type in category SECURITY must be one of [cpe22Type, cpe23Type, advisory, fix, url, swid], but is: cpe22Typo"),
"externalPackageRef type in category SECURITY must be one of ['cpe22Type', 'cpe23Type', 'advisory', 'fix', 'url', 'swid'], but is: cpe22Typo"),
(ExternalPackageRefCategory.PACKAGE_MANAGER, "nugat",
"cpe:/o:canonical:ubuntu_linux:10.04:-:lts",
"externalPackageRef type in category PACKAGE_MANAGER must be one of [maven-central, npm, nuget, bower, purl], but is: nugat"),
"externalPackageRef type in category PACKAGE_MANAGER must be one of ['maven-central', 'npm', 'nuget', 'bower', 'purl'], but is: nugat"),
(ExternalPackageRefCategory.PERSISTENT_ID, "git-oid",
"cpe:/o:canonical:ubuntu_linux:10.04:-:lts",
"externalPackageRef type in category PERSISTENT_ID must be one of [swh, gitoid], but is: git-oid")
"externalPackageRef type in category PERSISTENT_ID must be one of ['swh', 'gitoid'], but is: git-oid")
])
def test_invalid_external_package_ref_types(category, reference_type, locator, expected_message):
external_package_ref = ExternalPackageRef(category, reference_type, locator, "externalPackageRef comment")
Expand Down Expand Up @@ -140,7 +140,7 @@ def test_invalid_external_package_ref_types(category, reference_type, locator, e
"gitoid:blob:sha256:261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64",
f'externalPackageRef locator of type "gitoid" must conform with the regex {GITOID_REGEX}, but is: gitoid:blob:sha256:261eeb9e9f8b2b4b0d119366dda99c6fd7d35c64'),
(ExternalPackageRefCategory.OTHER, "id string", "locator string",
"externalPackageRef type in category OTHER must contain no spaces, but is: locator string"),
"externalPackageRef locator in category OTHER must contain no spaces, but is: locator string"),
])
def test_invalid_external_package_ref_locators(category, reference_type, locator, expected_message):
external_package_ref = ExternalPackageRef(category, reference_type, locator, "externalPackageRef comment")
Expand Down

0 comments on commit 6b3899f

Please sign in to comment.