Add Helm template validation to the build method in the CLI #136

patrykkulik-microsoft · 2024-01-22T11:59:10Z

This PR is for [Turtle 2Wk09 (Jan 14 - Jan 27) Taskboard - Boards (azure.com)](https://dev.azure.com/msazuredev/AzureForOperators/_sprints/taskboard/Turtle/AzureForOperators/Germanium/CY24Q1/2Wk/2Wk09%20(Jan%2014%20-%20Jan%2027)?workitem=1085387)

This feature adds a pre_validate() step to the build method of the CLI which validates the helm chart used in build by running a subprocess step with the helm template command.

Changes:

added pre_validate() function to the build step
added a skip flag for the helm template step to skip the validation
Modified the HelmChartInput class to take in a config path instead of a dictionary. This is because I needed to use the path to the chart in the Helm chart input. I instead do the processing of the path to a dict in the HelmChartInput class.
in the pre_validate() function I added a separate _validate_helm_template function to perform the helm template validation for each of the charts. If there is an error in the validation I create an error file in the current working directory of the user using a jinja 2 template. I decided to do it in the current working directory because of the additional complexity that would have to be added if we were to create the folder in the build output folder or in a separate folder
added a function to check if the helm tool is installed
changed the path_to_mappings property to default_values . Functionally this property is the same, but Jacob thought it would be good to change the name and the description of it
I added a new error MissingDependency. I also noticed that none of our other custom exceptions inherit from errors like UserFault which is something that is recommended in the CLI. Should I change that in this PR?
I added a unit test - I rarely write unit tests so feedback on it welcome
I added a mock invalid helm chart to test functionality of my function in the unit test (This is the nf-agent-cnf-invalid folder and it doesn’t need a review

…and vhd processors

…atus-commands

Add publisher command group to CLI

…onfig; added instructions for completing publish/delete

…s into cli-redesign

…hart-processor

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

…ython wheel

Markups from publish PR --------- Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com> Co-authored-by: Jordan <jordan.layton@metaswitch.com> Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

Cyclam · 2024-01-22T15:48:56Z

Could you update history.rst, please? This matters now, because we need to tell Mavenir about all changes we introduce between shipments.
E.g., we've changed path_to_mappings to default_values

Cyclam · 2024-01-22T15:49:55Z

"I also noticed that none of our other custom exceptions inherit from errors like UserFault which is something that is recommended in the CLI. Should I change that in this PR?"

We have a follow-on story to sort out exceptions. Could you add that point to that story, please? (Jordan should know where the story is.)

src/aosm/azext_aosm/cli_handlers/onboarding_base_handler.py

src/aosm/azext_aosm/cli_handlers/onboarding_cnf_handler.py

src/aosm/azext_aosm/inputs/base_input.py

src/aosm/azext_aosm/inputs/helm_chart_input.py

Jordan and others added 30 commits November 27, 2023 16:53

added empty template parser

260c1d7

Initial scaffolding of some new classes

8f2f08d

added utils, added base builder + reader + their children, added nfd …

1c3e3cf

…and vhd processors

moved utils to common folder + added local file builder

17da2a3

Add some basic implementations

ee6f565

Merge branch 'Azure:main' into cli-redesign

bfdcb80

add new commands and restructure command groups

d0b2003

better naming for command groups

38729e5

revert addition on the onboard command group

e347e09

update HISTORY.rst

adf9f71

fix style issue

6c7b4de

fix linting issues

e389165

added empty vhd and nfd processors; moved client factory from old repo

1c54a2f

Merge remote-tracking branch 'origin/cli-redesign' into jdarby/add-st…

6ee1f84

…atus-commands

Merge pull request #123 from jddarby/jdarby/add-status-commands

7581bca

Add publisher command group to CLI

Add template parser interface (BaseParser)

5d31127

Add parameters to BaseParser

39d24b5

Make defaults_path optional in base_parser

0d78d45

defaults_path defaults to None in base_parser

acc0dc0

add helm chart parser class and common exceptions

a0ef8e1

add missing doc strings

c6592ca

Change parser class to input template class

0abc904

added all input config params + comments; added common arm template c…

3485ac2

…onfig; added instructions for completing publish/delete

Merge branch 'cli-redesign' of github.com:jddarby/azure-cli-extension…

648524e

…s into cli-redesign

add typing to base processor and add copyright statement to new files

364217c

fix conflicts

2307e7f

fixed formatting on input configs

7b224ff

fixed nsd input config + tidied other input config files

1bdb3c8

Merge remote-tracking branch 'origin/cli-redesign' into jdarby/helm-c…

e404652

…hart-processor

added comments for images; general formatting

4cba6db

jordlay and others added 16 commits January 17, 2024 16:39

edited input file (#133)

d6b9ffb

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

Add skip step

628d29f

fixed getparamsconfig for vnf/nsd; added fixes for building correct p…

b36d7fc

…ython wheel

Achurchard/publish (#130)

9459197

Markups from publish PR --------- Co-authored-by: Andy Churchard <andy.churchard@metaswitch.com> Co-authored-by: Jordan <jordan.layton@metaswitch.com> Co-authored-by: jordlay <72226943+jordlay@users.noreply.github.com>

bug fixes for chart with subcharts

896918e

added ruamel

6e29c0d

Use safe yaml loading

8fe1299

Move code out of import list

a00b844

Merge branch 'jl/build_markups' into temp_mavenir_wheel

267916a

Fix errant config line bug

d22bfb9

fixed deployparams error (#134)

e9cf042

Co-authored-by: Jordan <jordan.layton@metaswitch.com>

fixed yaml load error

d569bab

Merge temp_mavenir_wheel

a056a36

Change "path_to_mappings" to "default_values"

09f1a91

Add unit tests

04aac62

Merge branch 'main' into pk5/parse_helm_images

fa5cff2

patrykkulik-microsoft requested a review from sunnycarter as a code owner January 22, 2024 11:59

patrykkulik-microsoft added 3 commits January 22, 2024 13:53

remove the merge mistake

7b67ae8

Delete a file

b355e60

Minor error fix

a43686e

Cyclam reviewed Jan 22, 2024

View reviewed changes

patrykkulik-microsoft added 4 commits January 23, 2024 10:59

First round of markups

13b6cdb

Markups round 2

6e72896

Comment out unit tests which are not working

dfcaf76

Updating changelog

fbf1560

Cyclam reviewed Jan 23, 2024

View reviewed changes

src/aosm/azext_aosm/inputs/helm_chart_input.py Outdated Show resolved Hide resolved

Remove the temporary helm_template file

c62c472

patrykkulik-microsoft merged commit bd0e37b into main Jan 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Helm template validation to the build method in the CLI #136

Add Helm template validation to the build method in the CLI #136

patrykkulik-microsoft commented Jan 22, 2024 •

edited

Loading

Cyclam commented Jan 22, 2024

Cyclam commented Jan 22, 2024

Add Helm template validation to the build method in the CLI #136

Add Helm template validation to the build method in the CLI #136

Conversation

patrykkulik-microsoft commented Jan 22, 2024 • edited Loading

Cyclam commented Jan 22, 2024

Cyclam commented Jan 22, 2024

patrykkulik-microsoft commented Jan 22, 2024 •

edited

Loading