Skip to content

Commit

Permalink
Ajout du préfixe "v" devant le numéro de version + intégration de "ch…
Browse files Browse the repository at this point in the history
…ecks" automatisés (#58)

* Add checks

This is a test for:
- datagouv/datapackage-template#1

* Fix check by adding "v" in front of version
  • Loading branch information
thbar authored Apr 4, 2024
1 parent 92bff45 commit 801d198
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 2 deletions.
64 changes: 64 additions & 0 deletions .github/workflows/assert_version.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
import json
import re
import os

pattern = r"v?\d+\.\d+\.\d+"


def check(obj, version, parents=""):
"""
This functions recursively parses all fields in the schema looking for
version names that would not be the same as the one mentionned
in the 'version' field
"""
errors = []
# if field is a string, we check for a potential version
if isinstance(obj, str):
tmp = re.search(pattern, obj)
if tmp and tmp[0] != version:
errors += [(parents, tmp[0])]
# if field is a list, we check every item
elif isinstance(obj, list):
for idx, k in enumerate(obj):
errors += check(k, version, parents=parents + f"[{str(idx)}]")
# if field is a dict, we check every value
elif isinstance(obj, dict):
for k in obj:
# not checking the fields
if k != "fields":
errors += check(
obj[k],
version,
parents=parents + "." + k if parents else k
)
return errors


to_check = []

if "schema.json" in os.listdir():
to_check.append("schema.json")

elif "datapackage.json" in os.listdir():
with open("datapackage.json", "r") as f:
datapackage = json.load(f)
for r in datapackage["resources"]:
to_check.append(r["schema"])

else:
raise Exception("No required file found")

for schema_path in to_check:
with open(schema_path, "r") as f:
schema = json.load(f)
version = schema["version"]

errors = check(schema, version)
if errors:
message = (
f"Versions are mismatched within the schema '{schema['name']}', "
f"expected version '{version}' but:"
)
for e in errors:
message += f"\n- {e[0]} has version '{e[1]}'"
raise Exception(message)
19 changes: 19 additions & 0 deletions .github/workflows/assert_version.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Vérification de la cohérence des versions dans tous les champs du schéma

on:
push:

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout Repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"

- run: python .github/workflows/assert_version.py
2 changes: 1 addition & 1 deletion dynamique/schema-dynamique.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
],
"created": "2022-10-28",
"lastModified": "2024-01-16",
"version": "2.3.0",
"version": "v2.3.0",
"contributors": [
{
"title": "Geoffrey Aldebert",
Expand Down
2 changes: 1 addition & 1 deletion statique/schema-statique.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
],
"created": "2018-06-29",
"lastModified": "2022-10-10",
"version": "2.3.0",
"version": "v2.3.0",
"contributors": [
{
"title": "Alexandre Bulté",
Expand Down

0 comments on commit 801d198

Please sign in to comment.