🐙 octavia-cli: list connectors (airbytehq#9546)

octavia-cli/README.md

@@ -20,11 +20,11 @@ SUB_BUILD=OCTAVIA_CLI ./gradlew build #from the root of the repo
 ```
 2. Run the CLI from docker:
 ```bash
-docker run octavia-cli:dev 
+docker run airbyte/octavia-cli:dev 
 ````
 3. Create an `octavia` alias in your `.bashrc` or `.zshrc`: 
 ````bash
-echo 'alias octavia="docker run octavia-cli:dev"'  >> ~/.zshrc
+echo 'alias octavia="docker run airbyte/octavia-cli:dev"'  >> ~/.zshrc
 source ~/.zshrc
 octavia
 ````
@@ -38,7 +38,8 @@ We welcome community contributions!
 
 | Date       | Milestone                           |
 |------------|-------------------------------------|
-| 2022-01-06 | Generate an API Python client from our Open API spec |
+| 2022-01-17 | Implement `octavia list connectors source` and `octavia list connectors destinations`|
+| 2022-01-17 | Generate an API Python client from our Open API spec |
 | 2021-12-22 | Bootstrapping the project's code base |
 
 # Developing locally
@@ -48,7 +49,7 @@ We welcome community contributions!
 4. Install dev dependencies: `pip install -e .\[dev\]`
 5. Install `pre-commit` hooks: `pre-commit install`
 6. Run the test suite: `pytest --cov=octavia_cli unit_tests`
-7. Iterate; please check the [Contributing](#contributing) for instructions on contributing.
+7. Iterate: please check the [Contributing](#contributing) for instructions on contributing.
 
 # Contributing
 1. Please sign up to [Airbyte's Slack workspace](https://slack.airbyte.io/) and join the `#octavia-cli`. We'll sync up community efforts in this channel.

octavia-cli/octavia_cli/entrypoint.py

@@ -2,10 +2,16 @@
 # Copyright (c) 2021 Airbyte, Inc., all rights reserved.
 #
 
+from typing import List
+
 import airbyte_api_client
 import click
 from airbyte_api_client.api import workspace_api
 
+from .list import commands as list_commands
+
+AVAILABLE_COMMANDS: List[click.Command] = [list_commands._list]
+
 
 @click.group()
 @click.option("--airbyte-url", envvar="AIRBYTE_URL", default="http://localhost:8000", help="The URL of your Airbyte instance.")
@@ -27,14 +33,14 @@ def octavia(ctx: click.Context, airbyte_url: str) -> None:
     ctx.obj["WORKSPACE_ID"] = workspace_id
 
 
-@octavia.command(help="Scaffolds a local project directories.")
-def init() -> None:
-    raise click.ClickException("The init command is not yet implemented.")
+def add_commands_to_octavia():
+    for command in AVAILABLE_COMMANDS:
+        octavia.add_command(command)
 
 
-@octavia.command(name="list", help="List existing resources on the Airbyte instance.")
-def _list() -> None:
-    raise click.ClickException("The list command is not yet implemented.")
+@octavia.command(help="Scaffolds a local project directories.")
+def init():
+    raise click.ClickException("The init command is not yet implemented.")
 
 
 @octavia.command(name="import", help="Import an existing resources from the Airbyte instance.")
@@ -55,3 +61,6 @@ def apply() -> None:
 @octavia.command(help="Delete resources")
 def delete() -> None:
     raise click.ClickException("The delete command is not yet implemented.")
+
+
+add_commands_to_octavia()

octavia-cli/octavia_cli/list/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#

octavia-cli/octavia_cli/list/commands.py

@@ -0,0 +1,48 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#
+
+from typing import List
+
+import click
+
+from .connectors_definitions import DestinationConnectorsDefinitions, SourceConnectorsDefinitions
+
+
+@click.group("list", help="List existing Airbyte resources.")
+@click.pass_context
+def _list(ctx: click.Context):  # pragma: no cover
+    pass
+
+
+@click.group("connectors", help="Latest information on supported sources and destinations connectors.")
+@click.pass_context
+def connectors(ctx: click.Context):  # pragma: no cover
+    pass
+
+
+@connectors.command(help="Latest information on supported sources.")
+@click.pass_context
+def sources(ctx: click.Context):
+    api_client = ctx.obj["API_CLIENT"]
+    definitions = SourceConnectorsDefinitions(api_client)
+    click.echo(definitions)
+
+
+@connectors.command(help="Latest information on supported destinations.")
+@click.pass_context
+def destinations(ctx: click.Context):
+    api_client = ctx.obj["API_CLIENT"]
+    definitions = DestinationConnectorsDefinitions(api_client)
+    click.echo(definitions)
+
+
+AVAILABLE_COMMANDS: List[click.Command] = [connectors]
+
+
+def add_commands_to_list():
+    for command in AVAILABLE_COMMANDS:
+        _list.add_command(command)
+
+
+add_commands_to_list()

octavia-cli/octavia_cli/list/connectors_definitions.py

@@ -0,0 +1,121 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#
+
+import abc
+from enum import Enum
+from typing import Callable, List, Union
+
+import airbyte_api_client
+from airbyte_api_client.api import destination_definition_api, source_definition_api
+
+
+class DefinitionType(Enum):
+    SOURCE = "source"
+    DESTINATION = "destination"
+
+
+class ConnectorsDefinitions(abc.ABC):
+    LIST_LATEST_DEFINITIONS_KWARGS = {"_check_return_type": False}
+
+    @property
+    @abc.abstractmethod
+    def api(
+        self,
+    ) -> Union[source_definition_api.SourceDefinitionApi, destination_definition_api.DestinationDefinitionApi]:  # pragma: no cover
+        pass
+
+    def __init__(self, definition_type: DefinitionType, api_client: airbyte_api_client.ApiClient, list_latest_definitions: Callable):
+        self.definition_type = definition_type
+        self.api_instance = self.api(api_client)
+        self.list_latest_definitions = list_latest_definitions
+
+    @property
+    def fields_to_display(self) -> List[str]:
+        return ["name", "dockerRepository", "dockerImageTag", f"{self.definition_type.value}DefinitionId"]
+
+    @property
+    def response_definition_list_field(self) -> str:
+        return f"{self.definition_type.value}_definitions"
+
+    def _parse_response(self, api_response) -> List[List[str]]:
+        definitions = [
+            [definition[field] for field in self.fields_to_display] for definition in api_response[self.response_definition_list_field]
+        ]
+        return definitions
+
+    @property
+    def latest_definitions(self) -> List[List[str]]:
+        api_response = self.list_latest_definitions(self.api_instance, **self.LIST_LATEST_DEFINITIONS_KWARGS)
+        return self._parse_response(api_response)
+
+    # TODO alafanechere: declare in a specific formatting module because it will probably be reused
+    @staticmethod
+    def _compute_col_width(data: List[List[str]], padding: int = 2) -> int:
+        """Compute column width for display purposes:
+        Find largest column size, add a padding of two characters.
+        Returns:
+            data (List[List[str]]): Tabular data containing rows and columns.
+            padding (int): Number of character to adds to create space between columns.
+        Returns:
+            col_width (int): The computed column width according to input data.
+        """
+        col_width = max(len(col) for row in data for col in row) + padding
+        return col_width
+
+    # TODO alafanechere: declare in a specific formatting module because it will probably be reused
+    @staticmethod
+    def _camelcased_to_uppercased_spaced(camelcased: str) -> str:
+        """Util function to transform a camelCase string to a UPPERCASED SPACED string
+        e.g: dockerImageName -> DOCKER IMAGE NAME
+        Args:
+            camelcased (str): The camel cased string to convert.
+
+        Returns:
+            (str): The converted UPPERCASED SPACED string
+        """
+        return "".join(map(lambda x: x if x.islower() else " " + x, camelcased)).upper()
+
+    # TODO alafanechere: declare in a specific formatting module because it will probably be reused
+    @staticmethod
+    def _display_as_table(data: List[List[str]]) -> str:
+        """Formats tabular input data into a displayable table with columns.
+        Args:
+            data (List[List[str]]): Tabular data containing rows and columns.
+        Returns:
+            table (str): String representation of input tabular data.
+        """
+        col_width = ConnectorsDefinitions._compute_col_width(data)
+        table = "\n".join(["".join(col.ljust(col_width) for col in row) for row in data])
+        return table
+
+    # TODO alafanechere: declare in a specific formatting module because it will probably be reused
+    @staticmethod
+    def _format_column_names(camelcased_column_names: List[str]) -> List[str]:
+        """Format camel cased column names to uppercased spaced column names
+
+        Args:
+            camelcased_column_names (List[str]): Column names in camel case.
+
+        Returns:
+            (List[str]): Column names in uppercase with spaces.
+        """
+        return [ConnectorsDefinitions._camelcased_to_uppercased_spaced(column_name) for column_name in camelcased_column_names]
+
+    def __repr__(self):
+        definitions = [self._format_column_names(self.fields_to_display)] + self.latest_definitions
+        return self._display_as_table(definitions)
+
+
+class SourceConnectorsDefinitions(ConnectorsDefinitions):
+    api = source_definition_api.SourceDefinitionApi
+
+    def __init__(self, api_client: airbyte_api_client.ApiClient):
+        super().__init__(DefinitionType.SOURCE, api_client, self.api.list_latest_source_definitions)
+
+
+class DestinationConnectorsDefinitions(ConnectorsDefinitions):
+    api = destination_definition_api.DestinationDefinitionApi
+
+    def __init__(self, api_client: airbyte_api_client.ApiClient):
+        super().__init__(DefinitionType.DESTINATION, api_client, self.api.list_latest_destination_definitions)

octavia-cli/unit_tests/test_entrypoint.py

@@ -36,12 +36,22 @@ def test_octavia(mocker):
     assert result.exit_code == 0
 
 
+def test_commands_in_octavia_group():
+    octavia_commands = entrypoint.octavia.commands.values()
+    for command in entrypoint.AVAILABLE_COMMANDS:
+        assert command in octavia_commands
+
+
 @pytest.mark.parametrize(
     "command",
-    [entrypoint.init, entrypoint.apply, entrypoint.create, entrypoint.delete, entrypoint._list, entrypoint._import],
+    [entrypoint.init, entrypoint.apply, entrypoint.create, entrypoint.delete, entrypoint._import],
 )
 def test_not_implemented_commands(command):
     runner = CliRunner()
     result = runner.invoke(command)
     assert result.exit_code == 1
     assert result.output.endswith("not yet implemented.\n")
+
+
+def test_available_commands():
+    assert entrypoint.AVAILABLE_COMMANDS == [entrypoint.list_commands._list]

octavia-cli/unit_tests/test_list/test_commands.py

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
+#
+
+from click.testing import CliRunner
+from octavia_cli.list import commands
+
+
+def test_available_commands():
+    assert commands.AVAILABLE_COMMANDS == [commands.connectors]
+
+
+def test_commands_in_list_group():
+    list_commands = commands._list.commands.values()
+    for command in commands.AVAILABLE_COMMANDS:
+        assert command in list_commands
+
+
+def test_connectors_sources(mocker):
+    mocker.patch.object(commands, "SourceConnectorsDefinitions", mocker.Mock(return_value="SourceConnectorsDefinitionsRepr"))
+    context_object = {"API_CLIENT": mocker.Mock()}
+    runner = CliRunner()
+    result = runner.invoke((commands.sources), obj=context_object)
+    commands.SourceConnectorsDefinitions.assert_called_with(context_object["API_CLIENT"])
+    assert result.output == "SourceConnectorsDefinitionsRepr\n"
+
+
+def test_connectors_destinations(mocker):
+    mocker.patch.object(commands, "DestinationConnectorsDefinitions", mocker.Mock(return_value="DestinationConnectorsDefinitionsRepr"))
+    context_object = {"API_CLIENT": mocker.Mock()}
+    runner = CliRunner()
+    result = runner.invoke((commands.destinations), obj=context_object)
+    commands.DestinationConnectorsDefinitions.assert_called_with(context_object["API_CLIENT"])
+    assert result.output == "DestinationConnectorsDefinitionsRepr\n"