mirror of
https://github.com/conan-io/conan-center-index.git
synced 2025-08-15 11:08:38 +00:00
0a9a6f0e1b
* docs: rename patch field "backport" to "bugfix" to avoid confusion The description of this field does not match the normative convention of who it could be used to mean "this came from the project" and not the "this changes source code" which is the written definition here. This should hopefully reduce the incorrect usage and encourage contributors to pick more descriptive options and fill in the `patch_source` that we offer * linter: match new docs
83 lines
2.7 KiB
Python
83 lines
2.7 KiB
Python
import argparse
|
|
from strictyaml import (
|
|
load,
|
|
Map,
|
|
Str,
|
|
YAMLValidationError,
|
|
MapPattern,
|
|
Optional,
|
|
Seq,
|
|
Enum,
|
|
Any,
|
|
)
|
|
from yaml_linting import file_path
|
|
|
|
|
|
def main():
|
|
parser = argparse.ArgumentParser(
|
|
description="Validate Conan's 'conandata.yaml' file to ConanCenterIndex's requirements."
|
|
)
|
|
parser.add_argument(
|
|
"path",
|
|
nargs="?",
|
|
type=file_path,
|
|
help="file to validate.",
|
|
)
|
|
args = parser.parse_args()
|
|
|
|
patch_fields = Map(
|
|
{
|
|
"patch_file": Str(),
|
|
"patch_description": Str(),
|
|
"patch_type": Enum(
|
|
["official", "conan", "portability", "backport", "vulnerability"]
|
|
),
|
|
Optional("patch_source"): Str(),
|
|
Optional("sha256"): Str(), # Really uncommon
|
|
# No longer required for v2 recipes with layouts
|
|
Optional("base_path"): Str(),
|
|
}
|
|
)
|
|
schema = Map(
|
|
{
|
|
"sources": MapPattern(Str(), Any(), minimum_keys=1),
|
|
Optional("patches"): MapPattern(Str(), Seq(patch_fields), minimum_keys=1),
|
|
}
|
|
)
|
|
|
|
with open(args.path) as f:
|
|
content = f.read()
|
|
|
|
try:
|
|
parsed = load(content, schema)
|
|
|
|
if "patches" in parsed:
|
|
for version in parsed["patches"]:
|
|
patches = parsed["patches"][version]
|
|
for i, patch in enumerate(patches):
|
|
type = parsed["patches"][version][i]["patch_type"]
|
|
if (
|
|
type in ["official", "bugfix", "vulnerability"]
|
|
and not "patch_source" in patch
|
|
):
|
|
print(
|
|
f"::warning file={args.path},line={type.start_line},endline={type.end_line},"
|
|
f"title=conandata.yml schema warning"
|
|
"::'patch_type' should have 'patch_source' as per https://github.com/conan-io/conan-center-index/blob/master/docs/conandata_yml_format.md#patches-fields"
|
|
" it is expected to have a source (e.g. a URL) to where it originates from to help with reviewing and consumers to evaluate patches\n"
|
|
)
|
|
except YAMLValidationError as error:
|
|
e = error.__str__().replace("\n", "%0A")
|
|
print(
|
|
f"::error file={args.path},line={error.context_mark.line},endline={error.problem_mark.line},"
|
|
f"title=conandata.yml schema error"
|
|
f"::{e}\n"
|
|
)
|
|
except BaseException as error:
|
|
e = error.__str__().replace("\n", "%0A")
|
|
print(f"::error ::{e}")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|