added validate-compose to cli

Author: btr1975

pod_porter/pod_porter.py

@@ -7,13 +7,14 @@
 import json
 import os
 from yaml import safe_load, safe_dump
-from jsonschema import validate, Draft202012Validator
+from jsonschema import validate, Draft202012Validator, ValidationError
 from pod_porter.render.render import Render
 from pod_porter.util.directories import create_temp_working_directory, delete_temp_working_directory
 from pod_porter.util.file_read_write import write_file, extract_tar_gz_file
 from pod_porter.util.schemas import MapSchema
 
 JSON_SCHEMA_FORMAT_CHECKERS = Draft202012Validator.FORMAT_CHECKER
+COMPOSE_SPEC: Path = Path(__file__).parent.joinpath("render").joinpath("compose_spec").joinpath("compose-spec.json")
 
 
 class _PorterMap:  # pylint: disable=too-many-instance-attributes
@@ -72,7 +73,8 @@ def __repr__(self) -> str:
         """
         return f'PorterMap(path="{self._path}", release_name="{self._release_name}")'
 
-    def validate_value_json_schema(self, values_data: dict, values_path: str) -> None:
+    @staticmethod
+    def validate_value_json_schema(values_data: dict, values_path: str) -> None:
         """Validate data against a JSON schema.
 
         :type values_data: dict
@@ -341,8 +343,6 @@ class PorterMapsRunner:  # pylint: disable=too-many-instance-attributes
     :returns: Nothing
     """
 
-    COMPOSE_SPEC: Path = Path(__file__).parent.joinpath("render").joinpath("compose_spec").joinpath("compose-spec.json")
-
     def __init__(self, path: str, release_name: Optional[str] = None, values_override: Optional[str] = None) -> None:
         self._path = path
         self._release_name = release_name or "release-name"
@@ -421,22 +421,32 @@ def _collect_maps(self) -> List[Dict]:
 
         return maps
 
-    def validate_compose_json_schema(self, compose_data: dict) -> None:
+    @staticmethod
+    def validate_compose_json_schema(compose_data: dict) -> None:
         """Validate the created compose data against the compose spec JSON schema
+        https://github.com/compose-spec/compose-spec/blob/main/schema/compose-spec.json
 
         :type compose_data: dict
         :param compose_data: The compose data
 
         :rtype: None
         :returns: Nothing it validates the JSON data against the JSON schema
         """
-        if not self.COMPOSE_SPEC.is_file():
-            raise FileNotFoundError(f"compose file json spec not found {self.COMPOSE_SPEC.as_posix()}")
+        if not COMPOSE_SPEC.is_file():
+            raise FileNotFoundError(f"compose file json spec not found {COMPOSE_SPEC.as_posix()}")
 
-        with open(self.COMPOSE_SPEC.as_posix(), "r", encoding="utf-8") as compose_schema_file:
+        with open(COMPOSE_SPEC.as_posix(), "r", encoding="utf-8") as compose_schema_file:
             compose_json_schema = json.load(compose_schema_file)
 
-        validate(instance=compose_data, schema=compose_json_schema, format_checker=JSON_SCHEMA_FORMAT_CHECKERS)
+        try:
+            validate(instance=compose_data, schema=compose_json_schema, format_checker=JSON_SCHEMA_FORMAT_CHECKERS)
+
+        except ValidationError as err:
+            readable_error = (
+                f"Error in validating compose file!\nArgument Error: {err.args}\n"
+                f"In Schema Path: {'.'.join(err.absolute_path)}"
+            )
+            raise ValueError(readable_error)
 
     def render_compose(self) -> str:
         """Render the compose file

pod_porter/pod_porter_cli.py

@@ -4,6 +4,9 @@
 
 from argparse import ArgumentParser
 from importlib.metadata import version
+
+from jsonschema import ValidationError
+from yaml import safe_load
 from pod_porter.pod_porter import PorterMapsRunner
 from pod_porter.util.file_read_write import write_file, create_tar_gz_file, extract_tar_gz_file, create_new_map
 
@@ -95,6 +98,11 @@ def cli_argument_parser() -> ArgumentParser:
     arg_parser_map_create.set_defaults(which_sub="create")
     common_sub_parser_map_arguments(sub_arg_parser=arg_parser_map_create)
 
+    # This is the sub parser to create a new map
+    arg_parser_validate_compose = subparsers.add_parser("validate-compose", help="Validate a compose file")
+    arg_parser_validate_compose.set_defaults(which_sub="validate-compose")
+    arg_parser_validate_compose.add_argument("-f", "--file", required=True, help="Path to the compose file")
+
     return arg_parser
 
 
@@ -134,6 +142,16 @@ def cli() -> None:  # pragma: no cover
         if args.which_sub == "create":
             create_new_map(map_name_and_path=args.map)
 
+        if args.which_sub == "validate-compose":
+            with open(args.file, "r", encoding="utf-8") as file:
+                data = safe_load(file.read())
+
+            try:
+                PorterMapsRunner.validate_compose_json_schema(compose_data=data)
+
+            except ValueError as error:
+                print(error)
+
     except AttributeError as error:
         print(f"\n !!! {error} !!! \n")
         arg_parser.print_help()

pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "pod-porter"
 dynamic = ["readme"]
-version = "0.2.3"
+version = "1.0.0"
 requires-python = ">=3.10"
 description = "Like Helm but for Container Compose Files"
 keywords = [