Adding Support for Nexus to the CLI #140

jordlay · 2024-02-02T15:41:01Z

This PR includes:

Splitting VNF handlers class into Core and Nexus subclasses
Adding new input config class + generalising artifact.py upload config type to be NFD instead of VNF (to include both vnf types)
Adding a nexus flag to the commands
Adding functionality to NexusArmBuildProcessor (which was previously not implemented)
Creating a Nexus image input and processor object
Error handling for build and publish inputs (in case users run the command and forget the flag, it gives a sensible error)
Added conditions to vnf manifest and definition templates to handle both VNF types
Added new nexus base bicep template
Added nfvi type to nsds for nfvi type in nsdv

Extra Changes:

Moving 2 functions into common/utils from base handler: get_template_path and render_definition_bicep_contents
Generalising all render bicep functions to just one

UNIT TESTS PENDING!

This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

About Extension Publish

There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update src/index.json automatically.
You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify src/index.json.

…ndition for calling each arm processor

… fixed mistakes in armprocessor

…use one

…ype (if forgot to put nexus flag case); tidied nexus inputs

…or image versions

…nder bicep

Cyclam

The main theme here is reducing duplication in the code. Happy to discuss and/or brainstorm solutions if you want.

src/aosm/azext_aosm/cli_handlers/onboarding_base_handler.py

src/aosm/azext_aosm/cli_handlers/onboarding_core_vnf_handler.py

src/aosm/azext_aosm/build_processors/arm_processor.py

src/aosm/azext_aosm/inputs/nexus_image_input.py

src/aosm/azext_aosm/_params.py

src/aosm/azext_aosm/custom.py

… processor works

src/aosm/azext_aosm/cli_handlers/onboarding_vnf_handler.py

src/aosm/azext_aosm/common/constants.py

src/aosm/azext_aosm/_params.py

src/aosm/azext_aosm/build_processors/arm_processor.py

Cyclam · 2024-02-12T11:57:51Z

src/aosm/azext_aosm/build_processors/nexus_image_processor.py

+        super().__init__(name, input_artifact)
+        self.input_artifact: NexusImageFileInput = input_artifact
+
+    def get_artifact_manifest_list(self) -> List[ManifestArtifactFormat]:


This is almost identical to the VHDProcessor. Feels like it could be deduplicated.

Cyclam · 2024-02-12T11:59:37Z

src/aosm/azext_aosm/build_processors/nexus_image_processor.py

+        )
+        return artifacts, file_builders
+
+    def generate_nf_application(self) -> AzureOperatorNexusNetworkFunctionImageApplication:


Almost identical to VHDProcessor. Worth deduplicating?

src/aosm/azext_aosm/build_processors/nexus_image_processor.py

src/aosm/azext_aosm/cli_handlers/onboarding_core_vnf_handler.py

Cyclam · 2024-02-12T12:19:20Z

src/aosm/azext_aosm/cli_handlers/onboarding_core_vnf_handler.py

+
+    def build_all_parameters_json(self) -> JSONDefinitionElementBuilder:
+        """Create object for all_parameters.json."""
+        params_content = {


Can you pull out parameters common to Nexus handler to deduplicate?

Cyclam · 2024-02-12T12:21:05Z

src/aosm/azext_aosm/cli_handlers/onboarding_core_vnf_handler.py

+            default_config.update({"image_api_version": vhd.image_api_version})
+        return default_config
+
+    def _generate_type_specific_nf_application(self, processor) -> "tuple[list, list]":


Almost identical to Nexus handler. Can you generalise the method and put it in a parent class to deduplicate?

Cyclam · 2024-02-12T12:31:49Z

src/aosm/azext_aosm/common/artifact.py

@@ -548,12 +547,12 @@ class BaseStorageAccountArtifact(BaseArtifact):

    @abstractmethod
    def upload(
-        self, config: BaseCommonParametersConfig, command_context: CommandContext
+        self, config: NFDCommonParametersConfig, command_context: CommandContext


I don't think mypy will allow this....

changed it back

src/aosm/azext_aosm/common/constants.py

* refactored base handler init to treat inputs from different commands separately; added better validation * fixed error handling in base handler * fixed error typing --------- Co-authored-by: Jordan <jordan.layton@metaswitch.com>

jordlay · 2024-03-11T10:30:39Z

We merged this to a temp branch in order ot deliver to a customer. We then merged that to main, so these changes are in main and we can close this PR.

Jordan added 12 commits January 25, 2024 14:45

added nexus arm processor; added nfvi type to vnfinput.json; added co…

28013e0

…ndition for calling each arm processor

pipe through nfvi type from vnf input to template; added nexus input;…

7f08186

… fixed mistakes in armprocessor

initial commit for children vnf handlers

30979f5

added core and nexus config logic

68f46f2

merged main

5d0f8ea

fixed nexus input and nexus processor; fixed templates

e81e482

generalised render manifest and render definition bicep functions to …

99a713b

…use one

added incorrect config error handling

01100dc

added nexus flag to publish; added error handling for incorrect vnf t…

7196d34

…ype (if forgot to put nexus flag case); tidied nexus inputs

added vnf nexus base bicep; fixed vnf definition template; temp fix f…

53b1ad0

…or image versions

moved render bicep to common/utils; replaced build base bicep with re…

a723cdb

…nder bicep

general tidyup: removed prints, added return types

5e229d5

jordlay requested a review from sunnycarter as a code owner February 2, 2024 15:41

Jordan added 2 commits February 2, 2024 16:13

added nfvi type to nsds

7628817

removed old todos

0b20c58

Cyclam requested changes Feb 5, 2024

View reviewed changes

Jordan added 9 commits February 6, 2024 19:27

refactored nexus handler, moved generate params code into processor

1c20ecb

moved logic to base vnf handler; moved more logic to processor

e2c6d68

fix template name in vnf j2

b1d0575

fixed nexus image file

e3d7b62

added nfvitype to nsd nf template by making new j2 + changing how nfd…

0fe396b

… processor works

added nfvitype to nsd nf template by making new j2 + changing how nfd…

9ffb640

… processor works

minor formatting

3e77347

made vnfnexus a definition type; slight refactor of custom.py

e63ab2f

removed nexus param, removed prints, added commented out test file

9240657

Cyclam reviewed Feb 9, 2024

View reviewed changes

Jordan added 2 commits February 9, 2024 15:25

merge with main; prestylng

797ac3e

fixed flake8 + pylint issues

4fd6404

Cyclam reviewed Feb 12, 2024

View reviewed changes

Base handler treats command inputs separately (#143)

b075d3b

* refactored base handler init to treat inputs from different commands separately; added better validation * fixed error handling in base handler * fixed error typing --------- Co-authored-by: Jordan <jordan.layton@metaswitch.com>

Jordan added 4 commits February 12, 2024 17:53

mypy fixes

17bd37b

fixed customLocation id for vnf nexus

143f3d2

markups from review inc moving build manifest to parent vnf handler

0ff7b3d

added better docstrings

9d3eb7b

jordlay closed this Mar 11, 2024

jordlay deleted the jl/nexus-support branch March 11, 2024 10:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Support for Nexus to the CLI #140

Adding Support for Nexus to the CLI #140

jordlay commented Feb 2, 2024 •

edited

Loading

Cyclam left a comment

Cyclam Feb 12, 2024

Cyclam Feb 12, 2024

Cyclam Feb 12, 2024

Cyclam Feb 12, 2024

Cyclam Feb 12, 2024

jordlay Feb 16, 2024

jordlay commented Mar 11, 2024

Adding Support for Nexus to the CLI #140

Adding Support for Nexus to the CLI #140

Conversation

jordlay commented Feb 2, 2024 • edited Loading

Related command

General Guidelines

About Extension Publish

Cyclam left a comment

Choose a reason for hiding this comment

Cyclam Feb 12, 2024

Choose a reason for hiding this comment

Cyclam Feb 12, 2024

Choose a reason for hiding this comment

Cyclam Feb 12, 2024

Choose a reason for hiding this comment

Cyclam Feb 12, 2024

Choose a reason for hiding this comment

Cyclam Feb 12, 2024

Choose a reason for hiding this comment

jordlay Feb 16, 2024

Choose a reason for hiding this comment

jordlay commented Mar 11, 2024

jordlay commented Feb 2, 2024 •

edited

Loading