Add unit test

Author: lgarber-akamai

linodecli/cli.py

@@ -49,11 +49,13 @@ def __init__(self, version, base_url, skip_config=False):
         self.config = CLIConfig(self.base_url, skip_config=skip_config)
         self.load_baked()
 
-    def bake(self, spec_location: str):
+    def bake(self, spec_location: str, save: bool = True):
         """
         Generates ops and bakes them to a pickle.
 
         :param spec_location: The URL or file path of the OpenAPI spec to parse.
+        :param save: Whether the pickled operations should be saved to a file.
+                     This is primarily intended for unit testing.
         """
 
         try:
@@ -74,10 +76,6 @@ def bake(self, spec_location: str):
 
         for path in spec.paths.values():
             command = path.extensions.get(ext["command"], None)
-            if command is None:
-                raise KeyError(
-                    f"Path {path} is missing {ext['command']} extension"
-                )
 
             for m in METHODS:
                 operation = getattr(path, m)
@@ -94,12 +92,19 @@ def bake(self, spec_location: str):
 
                 if ext["skip"] in operation.extensions:
                     logger.debug(
-                        "%s: Skipping operation due to %s extension",
+                        "%s: Skipping operation due to x-%s extension",
                         operation_log_fmt,
                         ext["skip"],
                     )
                     continue
 
+                # We don't do this in the parent loop because certain paths
+                # may only have skipped operations
+                if command is None:
+                    raise KeyError(
+                        f"{operation_log_fmt}: Missing x-{ext['command']} extension"
+                    )
+
                 action = operation.extensions.get(ext["action"], None)
 
                 if action is None:
@@ -150,7 +155,8 @@ def bake(self, spec_location: str):
 
         # finish the baking
         data_file = self._get_data_file()
-        with open(data_file, "wb") as f:
+
+        with open(data_file, "wb") if save else os.devnull as f:
             pickle.dump(self.ops, f)
 
     def load_baked(self):

tests/fixtures/cli_test_bake_missing_cmd_ext.yaml

@@ -0,0 +1,64 @@
+openapi: 3.0.1
+info:
+  title: API Specification
+  version: 1.0.0
+servers:
+  - url: http://localhost/v4
+paths:
+  /foo/bar:
+    get:
+      summary: get info
+      operationId: fooBarGet
+      description: This is description
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/OpenAPIResponseAttr'
+                  page:
+                    $ref: '#/components/schemas/PaginationEnvelope/properties/page'
+                  pages:
+                    $ref: '#/components/schemas/PaginationEnvelope/properties/pages'
+                  results:
+                    $ref: '#/components/schemas/PaginationEnvelope/properties/results'
+
+components:
+  schemas:
+    OpenAPIResponseAttr:
+      type: object
+      properties:
+        filterable_result:
+          x-linode-filterable: true
+          type: string
+          description: Filterable result value
+        filterable_list_result:
+          x-linode-filterable: true
+          type: array
+          items:
+            type: string
+          description: Filterable result value
+    PaginationEnvelope:
+      type: object
+      properties:
+        pages:
+          type: integer
+          readOnly: true
+          description: The total number of pages.
+          example: 1
+        page:
+          type: integer
+          readOnly: true
+          description: The current page.
+          example: 1
+        results:
+          type: integer
+          readOnly: true
+          description: The total number of results.
+          example: 1

tests/unit/test_cli.py

@@ -122,6 +122,24 @@ def test_load_openapi_spec_yaml(self):
             assert m.call_count == 1
             assert parsed_json_http.raw_element == parsed_json_local.raw_element
 
+    def test_bake_missing_cmd_ext(self, mock_cli: CLI):
+        try:
+            mock_cli.bake(
+                str(
+                    os.path.join(
+                        FIXTURES_PATH, "cli_test_bake_missing_cmd_ext.yaml"
+                    )
+                ),
+                save=False,
+            )
+        except KeyError as err:
+            assert (
+                str(err)
+                == "'GET /foo/bar: Missing x-linode-cli-command extension'"
+            )
+        else:
+            raise AssertionError("Expected a KeyError exception")
+
 
 def test_get_all_pages(
     mock_cli: CLI, list_operation: OpenAPIOperation, monkeypatch: MonkeyPatch