Check if optional license is in available values (#215)

Author: Guts

geotribu_cli/constants.py

@@ -75,6 +75,15 @@ class YamlHeaderMandatoryKeys(ExtendedEnum):
     TITLE = "title"
 
 
+class YamlHeaderAvailableLicense(ExtendedEnum):
+    """Licences disponibles pour les contenus publiés sur Geotribu."""
+
+    BEERWARE = "beerware"
+    CC4_BY_SA = "cc4_by-sa"
+    CC4_BY_BC_SA = "cc4_by-nc-sa"
+    DEFAULT = "default"
+
+
 @dataclass
 class GeotribuDefaults:
     """Defaults settings for Geotribu."""

geotribu_cli/content/header_check.py

@@ -5,7 +5,11 @@
 
 import frontmatter
 
-from geotribu_cli.constants import GeotribuDefaults, YamlHeaderMandatoryKeys
+from geotribu_cli.constants import (
+    GeotribuDefaults,
+    YamlHeaderAvailableLicense,
+    YamlHeaderMandatoryKeys,
+)
 from geotribu_cli.json.json_client import JsonFeedClient
 from geotribu_cli.utils.check_image_size import get_image_dimensions_by_url
 from geotribu_cli.utils.check_path import check_path
@@ -14,6 +18,7 @@
 logger = logging.getLogger(__name__)
 defaults_settings = GeotribuDefaults()
 
+
 # ############################################################################
 # ########## CLI #################
 # ################################
@@ -144,6 +149,18 @@ def check_missing_mandatory_keys(keys: list[str]) -> tuple[bool, set[str]]:
     return len(missing) == 0, missing
 
 
+def check_license(license_id: str) -> bool:
+    """Vérifie que la licence choisie fait partie de celles disponibles.
+
+    Args:
+        license: identifiant de la licence.
+
+    Returns:
+        True si la licence est l'une de celles disponibles.
+    """
+    return YamlHeaderAvailableLicense.has_value(license_id)
+
+
 def run(args: argparse.Namespace) -> None:
     """Run the sub command logic.
 
@@ -232,3 +249,14 @@ def run(args: argparse.Namespace) -> None:
                     raise ValueError(msg)
             else:
                 logger.info("Clés de l'entête ok")
+
+            # check that license (if present) is in available licenses
+            if "license" in yaml_meta:
+                license_ok = check_license(yaml_meta["license"])
+                if not license_ok:
+                    msg = f"La licence ('{yaml_meta['license']}') n'est pas dans celles disponibles ({','.join([l.value for l in YamlHeaderAvailableLicense])})"
+                    logger.error(msg)
+                    if args.raise_exceptions:
+                        raise ValueError(msg)
+                else:
+                    logger.info("licence ok")

tests/fixtures/content/2044-04-01_article_futur.md

@@ -8,6 +8,7 @@ categories:
 comments: true
 date: 2044-04-01
 icon: octicons/server-16
+license: gnu-gpl-3
 robots: index, follow
 tags:
     - Fromage

tests/test_yaml_header_check.py

@@ -7,6 +7,7 @@
 from geotribu_cli.content.header_check import (
     check_author_md,
     check_existing_tags,
+    check_license,
     check_missing_mandatory_keys,
     check_tags_order,
 )
@@ -66,8 +67,7 @@ def test_future_mandatory_keys(self):
             self.future_yaml_meta.keys()
         )
         self.assertFalse(all_present)
-        self.assertEqual(len(missing), 2)
-        self.assertIn("license", missing)
+        self.assertEqual(len(missing), 1)
         self.assertIn("description", missing)
 
     def test_author_md_ok(self):
@@ -78,3 +78,9 @@ def test_author_md_ok(self):
         self.assertTrue(check_author_md("Jàne Döé", TEAM_FOLDER))
         self.assertTrue(check_author_md("Jàne D'öé", TEAM_FOLDER))
         self.assertFalse(check_author_md("JaneDoe", TEAM_FOLDER))
+
+    def test_license_ok(self):
+        self.assertTrue(check_license(self.past_yaml_meta["license"]))
+
+    def test_license_nok(self):
+        self.assertFalse(check_license(self.future_yaml_meta["license"]))