vdk-data-sources: add sources command

projects/vdk-plugins/vdk-data-sources/setup.py

@@ -17,7 +17,11 @@
     description="Enables Versatile Data Kit (VDK) to integrate with various data sources by providing a unified interface for data ingestion and management.",
     long_description=pathlib.Path("README.md").read_text(),
     long_description_content_type="text/markdown",
-    install_requires=["vdk-core", "toml"],
+    install_requires=[
+        "vdk-core",
+        "toml",
+        "vdk-control-cli",
+    ],  # vdk-control-cli is becasue of output printer
     package_dir={"": "src"},
     packages=setuptools.find_namespace_packages(where="src"),
     # This is the only vdk plugin specifc part

projects/vdk-plugins/vdk-data-sources/src/vdk/plugin/data_sources/plugin_entry.py

@@ -2,6 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 from typing import List
 
+import click
 from vdk.api.plugin.hook_markers import hookimpl
 from vdk.api.plugin.plugin_registry import IPluginRegistry
 from vdk.internal.core.config import ConfigurationBuilder
@@ -49,3 +50,10 @@ def vdk_start(plugin_registry: IPluginRegistry, command_line_args: List):
     plugin_registry.hook().vdk_data_sources_register.call_historic(
         kwargs=dict(data_source_factory=SingletonDataSourceFactory())
     )
+
+
+@hookimpl
+def vdk_command_line(root_command: click.Group):
+    from vdk.plugin.data_sources.sources_command import data_sources
+
+    root_command.add_command(data_sources)

projects/vdk-plugins/vdk-data-sources/src/vdk/plugin/data_sources/sources_command.py

@@ -0,0 +1,79 @@
+# Copyright 2021-2023 VMware, Inc.
+# SPDX-License-Identifier: Apache-2.0
+from typing import Dict
+from typing import List
+
+import click
+from vdk.internal.control.utils import cli_utils
+from vdk.internal.control.utils import output_printer
+from vdk.plugin.data_sources.config import ConfigClassMetadata
+from vdk.plugin.data_sources.factory import SingletonDataSourceFactory
+
+
+def list_data_sources() -> List[Dict]:
+    result = []
+    for source in SingletonDataSourceFactory().list():
+        item = {
+            "name": source.name,
+            "description": ConfigClassMetadata(source.config_class).get_description(),
+        }
+
+        result.append(item)
+    return result
+
+
+def list_config_options(data_source_name: str) -> List[Dict]:
+    result = []
+    sources = [
+        s for s in SingletonDataSourceFactory().list() if s.name == data_source_name
+    ]
+    if sources:
+        source = sources[0]
+        for field in ConfigClassMetadata(source.config_class).get_config_fields():
+            result.append(
+                dict(
+                    name=field.name(),
+                    description=field.description()
+                    + (
+                        f" (default: {field.default()})"
+                        if field.default() is not None
+                        else ""
+                    ),
+                )
+            )
+    return result
+
+
+# TODO using ConfigClassMetadata fields you can create prompt to automatically ask config options
+# and generate data flow file out of that. `vdk sources --interactive`
+
+
+@click.command(
+    name="data-sources",
+    help="Explore VDK data sources ."
+    """This command all registered data sources
+
+     Example:
+     # To list all data sources, run:
+     `vdk data-sources --list`
+
+     # To show config options for give data source
+     vdk data-sources --config csv
+     """,
+)
+@click.option(
+    "--list", is_flag=True, help="List registered data sources that can be used. "
+)
+@click.option(
+    "--config",
+    type=click.STRING,
+    help="List configuration options for the data source ",
+)
+@click.pass_context
+@cli_utils.output_option()
+def data_sources(ctx: click.Context, list: bool, config: str, output: str):
+    if list:
+        listed_sources = list_data_sources()
+        output_printer.create_printer(output).print_table(listed_sources)
+    if config:
+        output_printer.create_printer(output).print_table(list_config_options(config))

projects/vdk-plugins/vdk-data-sources/tests/test_sources_command.py

@@ -0,0 +1,33 @@
+# Copyright 2021-2023 VMware, Inc.
+# SPDX-License-Identifier: Apache-2.0
+import json
+
+from click.testing import Result
+from vdk.plugin.data_sources import plugin_entry
+from vdk.plugin.test_utils.util_funcs import cli_assert_equal
+from vdk.plugin.test_utils.util_funcs import CliEntryBasedTestRunner
+
+
+def test_sources_command_list():
+    runner = CliEntryBasedTestRunner(plugin_entry)
+
+    result: Result = runner.invoke(["data-sources", "--list", "-o", "json"])
+
+    cli_assert_equal(0, result)
+    assert json.loads(result.stdout) == [
+        {
+            "description": "Configuration for Auto generated data source",
+            "name": "auto-generated-data",
+        }
+    ]
+
+
+def test_sources_command_config():
+    runner = CliEntryBasedTestRunner(plugin_entry)
+
+    result: Result = runner.invoke(
+        ["data-sources", "--config", "auto-generated-data", "-o", "json"]
+    )
+
+    cli_assert_equal(0, result)
+    assert len(json.loads(result.stdout)) == 3