use unified positional-arg option for 'connector' input

Author: aaronsteers

airbyte_cdk/cli/airbyte_cdk/_connector.py

@@ -101,15 +101,11 @@ def connector_cli_group() -> None:
 
 
 @connector_cli_group.command()
-@click.option(
-    "--connector-name",
+@click.argument(
+    "connector",
+    required=False,
     type=str,
-    help="Name of the connector to test. Ignored if --connector-directory is provided.",
-)
-@click.option(
-    "--connector-directory",
-    type=click.Path(exists=True, file_okay=False, path_type=Path),
-    help="Path to the connector directory.",
+    metavar="[CONNECTOR]",
 )
 @click.option(
     "--collect-only",
@@ -118,15 +114,17 @@ def connector_cli_group() -> None:
     help="Only collect tests, do not run them.",
 )
 def test(
-    connector_name: str | None = None,
-    connector_directory: Path | None = None,
+    connector: str | Path | None = None,
     *,
     collect_only: bool = False,
 ) -> None:
     """Run connector tests.
 
     This command runs the standard connector tests for a specific connector.
 
+    [CONNECTOR] can be a connector name (e.g. 'source-pokeapi'), a path to a connector directory, or omitted to use the current working directory.
+    If a string containing '/' is provided, it is treated as a path. Otherwise, it is treated as a connector name.
+
     If no connector name or directory is provided, we will look within the current working
     directory. If the current working directory is not a connector directory (e.g. starting
     with 'source-') and no connector name or path is provided, the process will fail.
@@ -136,10 +134,7 @@ def test(
             "pytest is not installed. Please install pytest to run the connector tests."
         )
     click.echo("Connector test command executed.")
-    connector_name, connector_directory = resolve_connector_name_and_directory(
-        connector_name=connector_name,
-        connector_directory=connector_directory,
-    )
+    connector_name, connector_directory = resolve_connector_name_and_directory(connector)
 
     connector_test_suite = create_connector_test_suite(
         connector_name=connector_name if not connector_directory else None,

airbyte_cdk/cli/airbyte_cdk/_image.py

@@ -59,22 +59,7 @@ def build(
         )
         sys.exit(1)
 
-    connector_name = None
-    connector_directory = None
-    if connector is None:
-        # Use cwd logic in resolve_connector_name_and_directory
-        pass
-    elif "/" in connector or "\\" in connector:
-        # Assume it's a path to a connector directory
-        connector_directory = Path(connector)
-    else:
-        # Otherwise, assume it's a connector name
-        connector_name = connector
-
-    connector_name, connector_directory = resolve_connector_name_and_directory(
-        connector_name=connector_name,
-        connector_directory=connector_directory,
-    )
+    connector_name, connector_directory = resolve_connector_name_and_directory(connector)
 
     metadata_file_path: Path = connector_directory / "metadata.yaml"
     try:

airbyte_cdk/cli/airbyte_cdk/_secrets.py

@@ -73,15 +73,11 @@ def secrets_cli_group() -> None:
 
 
 @secrets_cli_group.command()
-@click.option(
-    "--connector-name",
+@click.argument(
+    "connector",
+    required=False,
     type=str,
-    help="Name of the connector to fetch secrets for. Ignored if --connector-directory is provided.",
-)
-@click.option(
-    "--connector-directory",
-    type=click.Path(exists=True, file_okay=False, path_type=Path),
-    help="Path to the connector directory.",
+    metavar="[CONNECTOR]",
 )
 @click.option(
     "--gcp-project-id",
@@ -97,8 +93,7 @@ def secrets_cli_group() -> None:
     default=False,
 )
 def fetch(
-    connector_name: str | None = None,
-    connector_directory: Path | None = None,
+    connector: str | Path | None = None,
     gcp_project_id: str = AIRBYTE_INTERNAL_GCP_PROJECT,
     print_ci_secrets_masks: bool = False,
 ) -> None:
@@ -107,24 +102,24 @@ def fetch(
     This command fetches secrets for a connector from Google Secret Manager and writes them
     to the connector's secrets directory.
 
+    [CONNECTOR] can be a connector name (e.g. 'source-pokeapi'), a path to a connector directory, or omitted to use the current working directory.
+    If a string containing '/' is provided, it is treated as a path. Otherwise, it is treated as a connector name.
+
     If no connector name or directory is provided, we will look within the current working
     directory. If the current working directory is not a connector directory (e.g. starting
     with 'source-') and no connector name or path is provided, the process will fail.
 
     The `--print-ci-secrets-masks` option will print the GitHub CI mask for the secrets.
     This is useful for masking secrets in CI logs.
 
-    WARNING: This action causes the secrets to be printed in clear text to `STDOUT`. For security
-    reasons, this function will only execute if the `CI` environment variable is set. Otherwise,
-    masks will not be printed.
+    WARNING: The `--print-ci-secrets-masks` option causes the secrets to be printed in clear text to
+    `STDOUT`. For security reasons, this argument will be ignored if the `CI` environment
+    variable is not set.
     """
     click.echo("Fetching secrets...", err=True)
 
     client = _get_gsm_secrets_client()
-    connector_name, connector_directory = resolve_connector_name_and_directory(
-        connector_name=connector_name,
-        connector_directory=connector_directory,
-    )
+    connector_name, connector_directory = resolve_connector_name_and_directory(connector)
     secrets_dir = _get_secrets_dir(
         connector_directory=connector_directory,
         connector_name=connector_name,
@@ -289,21 +284,7 @@ def _get_secrets_dir(
     connector_name: str,
     ensure_exists: bool = True,
 ) -> Path:
-    try:
-        connector_name, connector_directory = resolve_connector_name_and_directory(
-            connector_name=connector_name,
-            connector_directory=connector_directory,
-        )
-    except FileNotFoundError as e:
-        raise FileNotFoundError(
-            f"Could not find connector directory for '{connector_name}'. "
-            "Please provide the --connector-directory option with the path to the connector. "
-            "Note: This command requires either running from within a connector directory, "
-            "being in the airbyte monorepo, or explicitly providing the connector directory path."
-        ) from e
-    except ValueError as e:
-        raise ValueError(str(e))
-
+    _ = connector_name  # Unused, but it may be used in the future for logging
     secrets_dir = connector_directory / "secrets"
     if ensure_exists:
         secrets_dir.mkdir(parents=True, exist_ok=True)

airbyte_cdk/utils/connector_paths.py

@@ -77,17 +77,43 @@ def _find_in_adjacent_dirs(current_dir: Path) -> Path | None:
 
 
 def resolve_connector_name_and_directory(
-    connector_name: str | None = None,
+    connector_ref: str | Path | None = None,
+    *,
     connector_directory: Path | None = None,
 ) -> tuple[str, Path]:
     """Resolve the connector name and directory.
 
     This function will resolve the connector name and directory based on the provided
-    arguments. If no connector name or directory is provided, it will look within the
+    reference. If no input ref is provided, it will look within the
     current working directory. If the current working directory is not a connector
     directory (e.g. starting with 'source-') and no connector name or path is provided,
     the process will fail.
+    If ref is sent as a string containing "/" or "\\", it will be treated as a path to the
+    connector directory.
+
+    raises:
+        ValueError: If the connector name or directory cannot be resolved.
+        FileNotFoundError: If the connector directory does not exist or cannot be found.
     """
+    connector_name: str | None = None
+
+    # Resolve connector_ref to connector_name or connector_directory (if provided)
+    if connector_ref:
+        if isinstance(connector_ref, str):
+            if "/" in connector_ref or "\\" in connector_ref:
+                # If the connector name is a path, treat it as a directory
+                connector_directory = Path(connector_ref)
+            else:
+                # Otherwise, treat it as a connector name
+                connector_name = connector_ref
+        elif isinstance(connector_ref, Path):
+            connector_directory = connector_ref
+        else:
+            raise ValueError(
+                "connector_ref must be a string or Path. "
+                f"Received type '{type(connector_ref).__name__}': {connector_ref!r}",
+            )
+
     if not connector_directory:
         if connector_name:
             connector_directory = find_connector_root_from_name(connector_name)
@@ -97,8 +123,9 @@ def resolve_connector_name_and_directory(
                 connector_directory = cwd
             else:
                 raise ValueError(
-                    "Either connector_name or connector_directory must be provided if not "
-                    "running from a connector directory."
+                    "The 'connector' input must be provided if not "
+                    "running from a connector directory. "
+                    f"Could not infer connector directory from: {cwd}"
                 )
 
     if not connector_name:
@@ -109,7 +136,9 @@ def resolve_connector_name_and_directory(
     elif connector_name:
         connector_directory = find_connector_root_from_name(connector_name)
     else:
-        raise ValueError("Either connector_name or connector_directory must be provided.")
+        raise ValueError(
+            f"Could not infer connector_name or connector_directory from input ref: {connector}",
+        )
 
     return connector_name, connector_directory