Add list test

Author: lgarber-akamai

linodecli/documentation/template_data.py

@@ -309,11 +309,7 @@ def from_openapi(cls, operation: OpenAPIOperation) -> Self:
 
         result = cls(
             command=operation.command,
-            action=(
-                operation.action
-                if isinstance(operation.action, list)
-                else [operation.action]
-            ),
+            action=[operation.action] + (operation.action_aliases or []),
             summary=_markdown_to_rst(operation.summary),
             description=(
                 _markdown_to_rst(operation.description)
@@ -322,7 +318,8 @@ def from_openapi(cls, operation: OpenAPIOperation) -> Self:
             ),
             usage=cls._get_usage(operation),
             api_documentation_url=operation.docs_url,
-            deprecated=operation.deprecated,
+            deprecated=operation.deprecated is not None
+            and operation.deprecated,
         )
 
         if operation.samples:

tests/unit/test_documentation_template.py

@@ -3,6 +3,7 @@
 from linodecli.documentation.template_data import (
     Action,
     Argument,
+    Param,
     ResponseAttribute,
     Root,
 )
@@ -28,6 +29,59 @@ def test_data_group(self, mock_cli_with_parsed_template):
         assert group.pretty_name == "Test Resource"
         assert len(group.actions) == 4
 
+    def test_data_action_view(self, mock_cli_with_parsed_template):
+        cli, tmpl_data = mock_cli_with_parsed_template
+
+        group = get_first(tmpl_data.groups, lambda v: v.name == "test-resource")
+        action = get_first(group.actions, lambda v: v.action[0] == "view")
+
+        assert action.command == "test-resource"
+        assert action.action == ["view"]
+
+        assert "linode-cli test-resource view [-h]" in action.usage
+        assert "resourceId" in action.usage
+
+        assert "Get information about a test resource." == action.summary
+        assert "Get information about a test resource." == action.description
+        assert "https://linode.com" == action.api_documentation_url
+        assert not action.deprecated
+
+        assert len(action.argument_sections) == 0
+        assert len(action.filterable_attributes) == 0
+
+        self._validate_resource_parameters(action)
+        self._validate_resource_response_attributes(action)
+
+    def test_data_action_list(self, mock_cli_with_parsed_template):
+        cli, tmpl_data = mock_cli_with_parsed_template
+
+        group = get_first(tmpl_data.groups, lambda v: v.name == "test-resource")
+        action = get_first(group.actions, lambda v: v.action[0] == "list")
+
+        assert action.command == "test-resource"
+        assert action.action == ["list", "ls"]
+
+        assert "linode-cli test-resource list [-h]" in action.usage
+
+        assert "List test resources." == action.summary
+        assert "List test resources." == action.description
+        assert "https://linode.com" == action.api_documentation_url
+        assert not action.deprecated
+
+        assert len(action.argument_sections) == 0
+        assert len(action.parameters) == 0
+
+        assert action.filterable_attributes == [
+            ResponseAttribute(
+                name="boolean_field",
+                type="bool",
+                description="An arbitrary boolean.",
+                example="true",
+            )
+        ]
+
+        self._validate_resource_response_attributes(action)
+
     def test_data_action_create(self, mock_cli_with_parsed_template):
         cli, tmpl_data = mock_cli_with_parsed_template
 
@@ -41,7 +95,7 @@ def test_data_action_create(self, mock_cli_with_parsed_template):
         assert "Create a new test resource." == action.summary
         assert "Create a new test resource." == action.description
         assert "https://linode.com" == action.api_documentation_url
-        assert action.deprecated is None
+        assert not action.deprecated
 
         assert len(action.parameters) == 0
         assert len(action.samples) == 0
@@ -129,6 +183,16 @@ def test_data_action_create(self, mock_cli_with_parsed_template):
             ),
         ]
 
+    @staticmethod
+    def _validate_resource_parameters(action: Action):
+        assert action.parameters == [
+            Param(
+                name="resourceId",
+                type="int",
+                description="The ID of the resource.",
+            )
+        ]
+
     @staticmethod
     def _validate_resource_response_attributes(
         action: Action,