Skip to content

Commit

Permalink
Use plural forms of valid_meta_*
Browse files Browse the repository at this point in the history
  • Loading branch information
tomschr committed Jul 1, 2024
1 parent 39539dc commit d6cbbe3
Show file tree
Hide file tree
Showing 12 changed files with 40 additions and 40 deletions.
6 changes: 3 additions & 3 deletions python-scripts/metadatavalidator/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,12 @@ The following values are recognized:

* :var:`require_meta_architecture`: Requires a ``<meta name="architecture">`` tag or not.

* :var:`valid_meta_architecture`: Lists the valid architecture names for ``<meta name="architecture">/<phrase>``.
* :var:`valid_meta_architectures`: Lists the valid architecture names for ``<meta name="architecture">/<phrase>``.

* :var:`require_meta_category`: Requires a ``<meta name="category">`` tag or not.

* :var:`valid_meta_category`: Lists the valid category names for ``<meta name="category">/<phrase>``.
* :var:`valid_meta_categories`: Lists the valid category names for ``<meta name="category">/<phrase>``.

* :var:`require_meta_task`: Requires a ``<meta name="task">`` tag or not.

* :var:`valid_meta_task`: Lists the valid task names for ``<meta name="task">/<phrase>``.
* :var:`valid_meta_tasks`: Lists the valid task names for ``<meta name="task">/<phrase>``.
2 changes: 1 addition & 1 deletion python-scripts/metadatavalidator/metadatavalidator.ini
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ require_meta_platform = off

# <meta name="architecture">
require_meta_architecture = off
valid_meta_architecture = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE
valid_meta_architectures = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE

# <meta name="task">
require_meta_task = off
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ def check_meta_architecture(tree: etree._ElementTree,

valid_archs = [
x.strip() for x in config.get("metadata", {}
).get("valid_meta_architecture", [])
).get("valid_meta_architectures", [])
if x
]

Expand Down Expand Up @@ -203,7 +203,7 @@ def check_meta_category(tree: etree._ElementTree,

valid_cats = [
x.strip() for x in config.get("metadata", {}
).get("valid_meta_category", [])
).get("valid_meta_categories", [])
if x
]

Expand Down Expand Up @@ -249,7 +249,7 @@ def check_meta_task(tree: etree._ElementTree,

valid_tasks = [
x.strip() for x in config.get("metadata", {}
).get("valid_meta_task", [])
).get("valid_meta_tasks", [])
if x
]

Expand Down
24 changes: 12 additions & 12 deletions python-scripts/metadatavalidator/src/metadatavalidator/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,40 +149,40 @@ def validate_valid_meta_series(config: dict) -> list[str]:
]


def validate_valid_meta_architecture(config: dict) -> list[str]:
def validate_valid_meta_architectures(config: dict) -> list[str]:
"""Validate the meta architecture
:param config: the configuration object
:return: a list of valid meta architecture
"""
return [x.strip() for x in re.split(r"[;,]",
config.get("metadata", {}).get("valid_meta_architecture", "")
config.get("metadata", {}).get("valid_meta_architectures", "")
)
if x
]


def validate_valid_meta_category(config: dict) -> list[str]:
def validate_valid_meta_categories(config: dict) -> list[str]:
"""Validate the meta category
:param config: the configuration object
:return: a list of valid meta category
"""
return [x.strip() for x in re.split(r"[;,]",
config.get("metadata", {}).get("valid_meta_category", "")
config.get("metadata", {}).get("valid_meta_categories", "")
)
if x
]


def validate_valid_meta_task(config: dict) -> list[str]:
def validate_valid_meta_tasks(config: dict) -> list[str]:
"""Validate the meta task
:param config: the configuration object
:return: a list of valid meta task
"""
return [x.strip() for x in re.split(r"[;,]",
config.get("metadata", {}).get("valid_meta_task", "")
config.get("metadata", {}).get("valid_meta_tasks", "")
)
if x
]
Expand Down Expand Up @@ -242,8 +242,8 @@ def validate_and_convert_config(config: configparser.ConfigParser) -> dict[t.Any
] = truefalse(theconfig.get("metadata", {}).get("require_meta_architecture",
False))
theconfig.setdefault("metadata", {})[
"valid_meta_architecture"
] = validate_valid_meta_architecture(theconfig)
"valid_meta_architectures"
] = validate_valid_meta_architectures(theconfig)

# <meta name="techpartner">
require_meta_techpartner = truefalse(
Expand All @@ -263,16 +263,16 @@ def validate_and_convert_config(config: configparser.ConfigParser) -> dict[t.Any
"require_meta_category"
] = truefalse(theconfig.get("metadata", {}).get("require_meta_category", False))
theconfig.setdefault("metadata", {})[
"valid_meta_category"
] = validate_valid_meta_category(theconfig)
"valid_meta_categories"
] = validate_valid_meta_categories(theconfig)

# <meta name="task">
theconfig.setdefault("metadata", {})[
"require_meta_task"
] = truefalse(theconfig.get("metadata", {}).get("require_meta_task", False))
theconfig.setdefault("metadata", {})[
"valid_meta_task"
] = validate_valid_meta_task(theconfig)
"valid_meta_tasks"
] = validate_valid_meta_tasks(theconfig)

# Store the configfiles
theconfig["configfiles"] = getattr(config, "configfiles")
Expand Down
4 changes: 2 additions & 2 deletions python-scripts/metadatavalidator/tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ def config() -> ConfigParser:
config.set("metadata", "meta_title_length", "50")
config.set("metadata", "meta_description_length", "150")
#
config.set("metadata", "valid_meta_architecture", "A, B, C")
config.set("metadata", "valid_meta_category", "D, E, F")
config.set("metadata", "valid_meta_architectures", "A, B, C")
config.set("metadata", "valid_meta_categories", "D, E, F")
setattr(config, "configfiles", None)
return config

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ require_meta_description = off
meta_description_length = 150

require_meta_architecture = off
valid_meta_architecture = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE
valid_meta_architectures = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE

# <meta name="category">
require_meta_category = off
valid_meta_category = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
valid_meta_categories = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ require_meta_description = off
meta_description_length = 150

require_meta_architecture = off
valid_meta_architecture = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE
valid_meta_architectures = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE

# <meta name="category">
require_meta_category = off
valid_meta_category = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
valid_meta_categories = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ def test_check_meta_architecture(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_architecture=True,
valid_meta_architecture=["x86_64", "POWER"]))
valid_meta_architectures=["x86_64", "POWER"]))
assert check_meta_architecture(tree, config) is None


Expand Down Expand Up @@ -82,7 +82,7 @@ def test_check_duplicate_child_meta_architecture(tree):

config = dict(metadata=dict(
require_meta_architecture=True,
valid_meta_architecture=["x86_64", "POWER"]))
valid_meta_architectures=["x86_64", "POWER"]))
with pytest.raises(
InvalidValueError, match=r".*Duplicate architectures found in meta.*"
):
Expand All @@ -109,7 +109,7 @@ def test_check_unknown_child_meta_architecture(tree):
config = dict(
metadata=dict(
require_meta_architecture=True,
valid_meta_architecture=["x86_64", "POWER"],
valid_meta_architectures=["x86_64", "POWER"],
)
)
with pytest.raises(InvalidValueError,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def test_meta_category(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_category=True,
valid_meta_category=["Systems Management"]))
valid_meta_categories=["Systems Management"]))
assert check_meta_category(tree, config) is None


Expand Down Expand Up @@ -101,7 +101,7 @@ def test_unknown_category_meta_category(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_category=True,
valid_meta_category=["Systems Management"]))
valid_meta_categories=["Systems Management"]))
with pytest.raises(InvalidValueError,
match=r".*Unknown category.*"):
check_meta_category(tree, config)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ def test_meta_task(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_task=True,
valid_meta_task=["Configuration"]))
valid_meta_tasks=["Configuration"]))
assert check_meta_task(tree, config) is None


Expand All @@ -36,7 +36,7 @@ def test_missing_required_meta_task(tree):
# </info>
# </article>"""
config = dict(metadata=dict(require_meta_task=True,
valid_meta_task=["Configuration"]))
valid_meta_tasks=["Configuration"]))
with pytest.raises(InvalidValueError,
match=r".*Couldn't find required meta\[@name='task'\].*"):
check_meta_task(tree, config)
Expand All @@ -53,7 +53,7 @@ def test_missing_child_meta_task(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_task=True),
valid_meta_task=["Configuration"])
valid_meta_tasks=["Configuration"])
with pytest.raises(InvalidValueError,
match=r".*Couldn't find any child elements in meta.*"):
check_meta_task(tree, config)
Expand All @@ -76,7 +76,7 @@ def test_duplicate_child_meta_task(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_task=True),
valid_meta_task=["Configuration"])
valid_meta_tasks=["Configuration"])
with pytest.raises(InvalidValueError,
match=r".*Duplicate tasks found in meta.*"):
check_meta_task(tree, config)
Expand All @@ -99,7 +99,7 @@ def test_unknown_child_meta_task(tree):
appendnode(tree, meta)

config = dict(metadata=dict(require_meta_task=True,
valid_meta_task=["Configuration"]))
valid_meta_tasks=["Configuration"]))
with pytest.raises(InvalidValueError,
match=r".*Unknown task\(s\) \{'Unknown'\}.*"):
check_meta_task(tree, config)
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ require_meta_platform = off

# <meta name="architecture">
require_meta_architecture = off
valid_meta_architecture = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE
valid_meta_architectures = Arm, AMD64/Intel\u00a064, POWER, IBM LinuxONE

require_meta_category = off
valid_meta_category = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
valid_meta_categories = 3rd Party, Cloud, Containerization, Developer Tools, High Availability, Tuning & Performance, SAP, Security, Storage, Systems Management, Virtualization
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
truefalse,
validate_check_root_elements,
validate_and_convert_config,
validate_valid_meta_architecture,
validate_valid_meta_architectures,
)
from metadatavalidator.exceptions import (
MissingKeyError,
Expand Down Expand Up @@ -120,5 +120,5 @@ def test_validate_check_root_elements_missing_key(dict_config):
with pytest.raises(MissingKeyError, match=".*validator.check_root_elements.*"):
validate_check_root_elements(dict_config)

def test_validate_valid_meta_architecture(dict_config):
assert validate_valid_meta_architecture(dict_config) == ["A", "B", "C"]
def test_validate_valid_meta_architectures(dict_config):
assert validate_valid_meta_architectures(dict_config) == ["A", "B", "C"]

0 comments on commit d6cbbe3

Please sign in to comment.