feat: tool to print out the diff between netplan and networkv2 schema

[catmsred]

Proposed Commit Message

feat: tool to print out the diff between netplan and networkv2 schema

Since netplan contains many keys that do not exist in the cloud-init
networkv2 schema.  This change adds a tools script that print the
difference between netplan's examples (since they do not have a
schema as such) and the cloud-init networkv2 schema.

Checklist

• My code follows the process laid out in the documentation
• I have updated or added any unit tests accordingly -- no unit tests for tools
• I have updated or added any documentation accordingly -- see docstring which will print as --help

Merge type

• Squash merge using "Proposed Commit Message"
• Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

[catmsred]

Still TODO: current code assumes (a) the user is running from the cloudinit top level directory and (b) has netplan repo cloned into ../netplan, neither of which are reasonable assumptions and should be fixed

[TheRealFalcon]

Script overall looks good to me.

Can we not depend on click though? For such a small tool I don't think there's really any value add for requiring another dependency...though I'll be completely honest in saying that I never think there's a value add with click 😉

Using argparse instead would look something like:

diff --git a/tools/netplan_schema_check.py b/tools/netplan_schema_check.py
index 2dddff358..d85a7985a 100644
--- a/tools/netplan_schema_check.py
+++ b/tools/netplan_schema_check.py
@@ -1,17 +1,10 @@
-import click
+import argparse
 import os
 import yaml
 
 from jsonschema import Draft4Validator
 
 
-@click.command()
-@click.option(
-    "--schema_file", required=True, help="path to network v2 schema file"
-)
-@click.option(
-    "--netplan_examples", required=True, help="path to netplan examples"
-)
 def validate_netplan_against_networkv2(schema_file, netplan_examples):
     """
     This script validates netplan example files against the cloud-init
@@ -65,6 +58,23 @@ def validate_netplan_against_networkv2(schema_file, netplan_examples):
     print(yaml.dump(error_obj))
 
 
-# pylint: disable=no-value-for-parameter
+def parse_args() -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="Validate netplan examples against networkv2 schema"
+    )
+    parser.add_argument(
+        "--schema-file",
+        required=True,
+        help="path to network v2 schema file",
+    )
+    parser.add_argument(
+        "--netplan-examples",
+        required=True,
+        help="path to netplan examples",
+    )
+    return parser.parse_args()
+
+
 if __name__ == "__main__":
-    validate_netplan_against_networkv2()
+    args = parse_args()
+    validate_netplan_against_networkv2(args.schema_file, args.netplan_examples)

[catmsred]

@TheRealFalcon I have no real attachment to click; updated with argparse

[TheRealFalcon]

LGTM!