Add Helm template validation to the build method in the CLI

src/aosm/HISTORY.rst

@@ -6,6 +6,8 @@ Release History
 Unreleased
 ++++++++
 * Add `publisher` command group for management of publisher resources.
+* Changed the name of the `path_to_mappings` parameter in the CNF input file to `default_values`
+* Added a `helm template` validation step to the `az aosm nfd build` command for the `cnf` definition type
 
 1.0.0b4
 ++++++++

src/aosm/azext_aosm/_params.py

@@ -6,7 +6,14 @@
 from argcomplete.completers import FilesCompleter
 from azure.cli.core import AzCommandsLoader
 
-from .common.constants import CNF, VNF, BICEP_PUBLISH, ARTIFACT_UPLOAD, IMAGE_UPLOAD
+from .common.constants import (
+    CNF,
+    VNF,
+    BICEP_PUBLISH,
+    ARTIFACT_UPLOAD,
+    IMAGE_UPLOAD,
+    HELM_TEMPLATE,
+)
 
 
 def load_arguments(self: AzCommandsLoader, _):
@@ -17,7 +24,9 @@ def load_arguments(self: AzCommandsLoader, _):
     )
 
     definition_type = get_enum_type([VNF, CNF])
-    nf_skip_steps = get_enum_type([BICEP_PUBLISH, ARTIFACT_UPLOAD, IMAGE_UPLOAD])
+    nf_skip_steps = get_enum_type(
+        [BICEP_PUBLISH, ARTIFACT_UPLOAD, IMAGE_UPLOAD, HELM_TEMPLATE]
+    )
     ns_skip_steps = get_enum_type([BICEP_PUBLISH, ARTIFACT_UPLOAD])
 
     # Set the argument context so these options are only available when this specific command
@@ -53,18 +62,19 @@ def load_arguments(self: AzCommandsLoader, _):
             options_list=["--build-output-folder", "-b"],
             type=file_type,
             completer=FilesCompleter(allowednames="*.json"),
-            help=(
-                "Path to the folder to publish, created by the build command."
-            ),
+            help=("Path to the folder to publish, created by the build command."),
         )
+        # This will only ever output one string and will fail if more than one
+        # skip steps are provided. It might be good to change that.
         c.argument(
             "skip",
             arg_type=nf_skip_steps,
             help=(
                 "Optional skip steps. 'bicep-publish' will skip deploying the bicep "
                 "template; 'artifact-upload' will skip uploading any artifacts; "
                 "'image-upload' will skip uploading the VHD image (for VNFs) or the "
-                "container images (for CNFs)."
+                "container images (for CNFs); 'helm-template' will skip templating the "
+                "helm charts (for CNFs)."
             ),
         )
         c.argument(

src/aosm/azext_aosm/cli_handlers/onboarding_base_handler.py

@@ -21,11 +21,13 @@
 )
 from azext_aosm.definition_folder.reader.definition_folder import DefinitionFolder
 from azext_aosm.common.command_context import CommandContext
-from azext_aosm.configuration_models.common_parameters_config import \
-    BaseCommonParametersConfig
+from azext_aosm.configuration_models.common_parameters_config import (
+    BaseCommonParametersConfig,
+)
 from azext_aosm.common.local_file_builder import LocalFileBuilder
 from azext_aosm.vendored_sdks import HybridNetworkManagementClient
 from azext_aosm.common.constants import DEPLOYMENT_PARAMETERS_FILENAME
+
 logger = get_logger(__name__)
 
 
@@ -36,17 +38,19 @@ def __init__(
         self,
         provided_input_path: Optional[Path] = None,
         aosm_client: Optional[HybridNetworkManagementClient] = None,
+        skip: str = None,
     ):
         """Initialize the CLI handler."""
         self.aosm_client = aosm_client
+        self.skip = skip
         # If config file provided (for build, publish and delete)
         if provided_input_path:
             provided_input_path = Path(provided_input_path)
             # If config file is the input.jsonc for build command
             if provided_input_path.suffix == ".jsonc":
                 config_dict = self._read_input_config_from_file(provided_input_path)
                 self.config = self._get_input_config(config_dict)
-                # Validate config before getting processor list, 
+                # Validate config before getting processor list,
                 # in case error with input artifacts i.e helm package
                 self.config.validate()
                 self.processors = self._get_processor_list()
@@ -59,7 +63,6 @@ def __init__(
         # If no config file provided (for generate-config)
         else:
             self.config = self._get_input_config()
-
         self.definition_folder_builder = DefinitionFolderBuilder(
             Path.cwd() / self.output_folder_file_name
         )
@@ -89,6 +92,7 @@ def generate_config(self, output_file: str | None = None):
 
     def build(self):
         """Build the definition."""
+        self.pre_validate_build()
         self.definition_folder_builder.add_element(self.build_base_bicep())
         self.definition_folder_builder.add_element(self.build_manifest_bicep())
         self.definition_folder_builder.add_element(self.build_artifact_list())
@@ -98,7 +102,9 @@ def build(self):
 
     def publish(self, command_context: CommandContext):
         """Publish the definition contained in the specified definition folder."""
-        definition_folder = DefinitionFolder(command_context.cli_options["definition_folder"])
+        definition_folder = DefinitionFolder(
+            command_context.cli_options["definition_folder"]
+        )
         definition_folder.deploy(config=self.config, command_context=command_context)
 
     def delete(self, command_context: CommandContext):
@@ -109,6 +115,10 @@ def delete(self, command_context: CommandContext):
         #    - Do element.delete()
         # TODO: Implement
 
+    def pre_validate_build(self):
+        """Perform all validations that need to be done before running the build command."""
+        pass
+
     @abstractmethod
     def build_base_bicep(self):
         """Build bicep file for underlying resources."""
@@ -173,11 +183,7 @@ def _render_base_bicep_contents(self, template_path):
         bicep_contents: str = template.render()
         return bicep_contents
 
-    def _render_definition_bicep_contents(
-        self,
-        template_path: Path,
-        params
-    ):
+    def _render_definition_bicep_contents(self, template_path: Path, params):
         """Write the definition bicep file from given template."""
         with open(template_path, "r", encoding="UTF-8") as f:
             template: Template = Template(

src/aosm/azext_aosm/cli_handlers/onboarding_cnf_handler.py

@@ -5,12 +5,14 @@
 from __future__ import annotations
 
 import json
-import ruamel.yaml
-from ruamel.yaml.error import ReusedAnchorWarning
 import warnings
 from pathlib import Path
+import ruamel.yaml
+from ruamel.yaml.error import ReusedAnchorWarning
+
+from jinja2 import Template
 
-from azure.cli.core.azclierror import UnclassifiedUserFault
+from azure.cli.core.azclierror import ValidationError
 from knack.log import get_logger
 
 from azext_aosm.build_processors.helm_chart_processor import HelmChartProcessor
@@ -31,21 +33,26 @@
 from azext_aosm.definition_folder.builder.json_builder import (
     JSONDefinitionElementBuilder,
 )
-from azext_aosm.common.constants import (ARTIFACT_LIST_FILENAME,
-                                         BASE_FOLDER_NAME,
-                                         CNF_BASE_TEMPLATE_FILENAME,
-                                         CNF_TEMPLATE_FOLDER_NAME,
-                                         CNF_DEFINITION_TEMPLATE_FILENAME,
-                                         CNF_INPUT_FILENAME,
-                                         CNF_MANIFEST_TEMPLATE_FILENAME,
-                                         CNF_OUTPUT_FOLDER_FILENAME,
-                                         MANIFEST_FOLDER_NAME,
-                                         NF_DEFINITION_FOLDER_NAME,
-                                         DEPLOYMENT_PARAMETERS_FILENAME)
+from azext_aosm.common.constants import (
+    ARTIFACT_LIST_FILENAME,
+    BASE_FOLDER_NAME,
+    CNF_BASE_TEMPLATE_FILENAME,
+    CNF_TEMPLATE_FOLDER_NAME,
+    CNF_DEFINITION_TEMPLATE_FILENAME,
+    CNF_HELM_VALIDATION_ERRORS_TEMPLATE_FILENAME,
+    CNF_INPUT_FILENAME,
+    CNF_MANIFEST_TEMPLATE_FILENAME,
+    CNF_OUTPUT_FOLDER_FILENAME,
+    HELM_TEMPLATE,
+    MANIFEST_FOLDER_NAME,
+    NF_DEFINITION_FOLDER_NAME,
+    DEPLOYMENT_PARAMETERS_FILENAME,
+)
 
 from .onboarding_nfd_base_handler import OnboardingNFDBaseCLIHandler
 
 logger = get_logger(__name__)
+yaml_processor = ruamel.yaml.YAML(typ="safe", pure=True)
 warnings.simplefilter("ignore", ReusedAnchorWarning)
 
 
@@ -68,9 +75,7 @@ def _get_input_config(self, input_config: dict = None) -> OnboardingCNFInputConf
             input_config = {}
         return OnboardingCNFInputConfig(**input_config)
 
-    def _get_params_config(
-        self, config_file: Path = None
-    ) -> CNFCommonParametersConfig:
+    def _get_params_config(self, config_file: Path = None) -> CNFCommonParametersConfig:
         """Get the configuration for the command."""
         with open(config_file, "r", encoding="utf-8") as _file:
             params_dict = json.load(_file)
@@ -82,19 +87,22 @@ def _get_processor_list(self) -> [HelmChartProcessor]:
         processor_list = []
         # for each helm package, instantiate helm processor
         for helm_package in self.config.helm_packages:
-            if helm_package.path_to_mappings:
-                if Path(helm_package.path_to_mappings).exists():
-                    yaml = ruamel.yaml.YAML(typ='safe', pure=True)
-                    provided_config = yaml.load(open(helm_package.path_to_mappings))
+            if helm_package.default_values:
+                if Path(helm_package.default_values).exists():
+                    provided_config = yaml_processor.load(
+                        open(helm_package.default_values)
+                    )
                 else:
-                    raise UnclassifiedUserFault(
+                    raise FileNotFoundError(
                         "There is no file at the path provided for the mappings file."
                     )
             else:
                 provided_config = None
 
             helm_input = HelmChartInput.from_chart_path(
-                Path(helm_package.path_to_chart).absolute(), default_config=provided_config
+                Path(helm_package.path_to_chart).absolute(),
+                default_config=provided_config,
+                default_config_path=helm_package.default_values,
             )
             helm_processor = HelmChartProcessor(
                 helm_package.name,
@@ -105,6 +113,53 @@ def _get_processor_list(self) -> [HelmChartProcessor]:
             processor_list.append(helm_processor)
         return processor_list
 
+    def _validate_helm_template(self):
+        """Validate the helm packages."""
+        helm_chart_processors = self._get_processor_list()
+
+        validation_errors = {}
+
+        for helm_processor in helm_chart_processors:
+            validation_output = helm_processor.input_artifact.validate_template()
+
+            if validation_output:
+                validation_errors[
+                    helm_processor.input_artifact.artifact_name
+                ] = validation_output
+
+        if validation_errors:
+            # Create an error file using a j2 template
+            error_output_template_path = self._get_template_path(
+                CNF_TEMPLATE_FOLDER_NAME, CNF_HELM_VALIDATION_ERRORS_TEMPLATE_FILENAME
+            )
+
+            with open(
+                error_output_template_path,
+                "r",
+                encoding="utf-8",
+            ) as file:
+                error_output_template = Template(file.read())
+
+            rendered_error_output_template = error_output_template.render(
+                errors=validation_errors
+            )
+
+            logger.info(rendered_error_output_template)
+
+            error_message = (
+                "Could not validate all the provided Helm charts. "
+                "Please run the CLI command again with the --verbose flag "
+                "to see the validation errors."
+            )
+
+            raise ValidationError(error_message)
+
+    def pre_validate_build(self):
+        """Run all validation functions required before building the cnf."""
+        logger.debug("Pre-validating build")
+        if self.skip != HELM_TEMPLATE:
+            self._validate_helm_template()
+
     def build_base_bicep(self):
         """Build the base bicep file."""
         # Build manifest bicep contents, with j2 template
@@ -203,11 +258,9 @@ def build_resource_bicep(self):
 
         params = {
             "acr_nf_applications": nf_application_list,
-            "deployment_parameters_file": DEPLOYMENT_PARAMETERS_FILENAME
+            "deployment_parameters_file": DEPLOYMENT_PARAMETERS_FILENAME,
         }
-        bicep_contents = self._render_definition_bicep_contents(
-            template_path, params
-        )
+        bicep_contents = self._render_definition_bicep_contents(template_path, params)
 
         # Create a bicep element + add its supporting mapping files
         bicep_file = BicepDefinitionElementBuilder(
@@ -233,7 +286,7 @@ def build_all_parameters_json(self):
             "acrArtifactStoreName": self.config.acr_artifact_store_name,
             "acrManifestName": self.config.acr_artifact_store_name + "-manifest",
             "nfDefinitionGroup": self.config.nf_name,
-            "nfDefinitionVersion": self.config.version
+            "nfDefinitionVersion": self.config.version,
         }
 
         base_file = JSONDefinitionElementBuilder(

src/aosm/azext_aosm/commands.py

@@ -6,6 +6,7 @@
 from azure.cli.core import AzCommandsLoader
 
 from ._client_factory import cf_aosm  # pylint: disable=import-error
+
 # from azext_aosm._client_factory import cf_aosm
 
 

src/aosm/azext_aosm/common/constants.py

@@ -23,12 +23,14 @@ class DeployableResourceTypes(str, Enum):
 BICEP_PUBLISH = "bicep-publish"
 ARTIFACT_UPLOAD = "artifact-upload"
 IMAGE_UPLOAD = "image-upload"
+HELM_TEMPLATE = "helm-template"
 
 
 class SkipSteps(Enum):
     BICEP_PUBLISH = BICEP_PUBLISH
     ARTIFACT_UPLOAD = ARTIFACT_UPLOAD
     IMAGE_UPLOAD = IMAGE_UPLOAD
+    HELM_TEMPLATE = HELM_TEMPLATE
 
 
 class ManifestsExist(str, Enum):
@@ -69,6 +71,7 @@ class ManifestsExist(str, Enum):
 CNF_INPUT_FILENAME = "cnf-input.jsonc"
 CNF_DEFINITION_TEMPLATE_FILENAME = "cnfdefinition.bicep.j2"
 CNF_MANIFEST_TEMPLATE_FILENAME = "cnfartifactmanifest.bicep.j2"
+CNF_HELM_VALIDATION_ERRORS_TEMPLATE_FILENAME = "cnfhelmtemplateerrors.txt.j2"
 CNF_BASE_TEMPLATE_FILENAME = "cnfbase.bicep"
 CNF_VALUES_SCHEMA_FILENAME = "values.schema.json"
 CNF_TEMPLATE_FOLDER_NAME = "cnf"

src/aosm/azext_aosm/common/exceptions.py

@@ -1,7 +1,14 @@
+from azure.cli.core.azclierror import UserFault
+
+
 class InvalidFileTypeError(Exception):
     """Raised when the file type is not supported by the parser"""
 
 
+class MissingDependency(UserFault):
+    """Raised when the required dependency is missing"""
+
+
 class MissingChartDependencyError(Exception):
     """Raised when the chart dependency is missing"""
 

src/aosm/azext_aosm/common/templates/cnf/cnfhelmtemplateerrors.txt.j2

@@ -0,0 +1,14 @@
+Errors were found in the following Helm charts (see below for details). Please fix them and try again.
+
+{% for chart_name in errors.keys() %}
+- {{ chart_name }}
+{% endfor %}
+
+{% for chart_name, error_message in errors.items() %}
+----------------------------------------
+Error in Helm chart: {{ chart_name }}
+----------------------------------------
+
+{{ error_message }}
+
+{% endfor %}