Rename --collection-path/TDP_COLLECTION_PATH to --collection/TDP_COLLECTIONS

README.md

@@ -37,7 +37,7 @@ poetry install
 
 Export the following environment variables:
 
-- `TDP_COLLECTION_PATH`: path(s) to the collection(s). [`tdp-collection`](https://github.com/TOSIT-IO/tdp-collection) is mandatory. Other collections can be added, separated by a colon `:` (such as [`tdp-collection-extras`](https://github.com/TOSIT-IO/tdp-collection-extras), [`tdp-observability`](https://github.com/TOSIT-IO/tdp-observability)).
+- `TDP_COLLECTIONS`: path(s) to the collection(s). [`tdp-collection`](https://github.com/TOSIT-IO/tdp-collection) is mandatory. Other collections can be added, separated by a colon `:` (such as [`tdp-collection-extras`](https://github.com/TOSIT-IO/tdp-collection-extras), [`tdp-observability`](https://github.com/TOSIT-IO/tdp-observability)).
 - `TDP_RUN_DIRECTORY`: path to the working directory of TDP deployment (where `ansible.cfg`, `inventory.ini` and `topology.ini` are located).
 - `TDP_DATABASE_DSN`: DSN of the database to use.
 - `TDP_VARS`: path to the folder containing the variables.

docs/source/developer/cli/developer_quick_start.rst

@@ -15,13 +15,13 @@ Developer Quick Start (sqlite backend)
    .. code-block:: shell
 
      # this folder is local repo of tdp-collection
-     user@yourmachine:export TDP_COLLECTION_PATH=~/tdp-collection
+     user@yourmachine:export TDP_COLLECTIONS=~/tdp-collection
      # this folder is working directory of tdp deployment in which you put ansible.cfg, inventory.ini and topology.ini.
      user@yourmachine:export TDP_RUN_DIRECTORY=~/working-dir
      # this folder is to store sqlite db file
      user@yourmachine:export TDP_DATABASE_DSN=sqlite:////data/sqlite-data/tdp.db
-     # this folder is to store tdp service configuration, please find default values at $TDP_COLLECTION_PATH/tdp_vars_defaults
-     # you must NOT set TDP_VARS to $TDP_COLLECTION_PATH/tdp_vars_defaults
+     # this folder is to store tdp service configuration, please find default values at $TDP_COLLECTIONS/tdp_vars_defaults
+     # you must NOT set TDP_VARS to $TDP_COLLECTIONS/tdp_vars_defaults
      # the path must contain the string `tdp_vars`
      user@yourmachine:export TDP_VARS=~/tdp_vars
 

tdp/cli/commands/plan/test_dag.py

@@ -12,7 +12,7 @@
 
 def test_tdp_plan_dag(collection_path: Path, database_dsn_path: str, vars: Path):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/plan/test_ops.py

@@ -11,7 +11,7 @@
 
 def test_tdp_plan_run(collection_path: Path, database_dsn_path: str, vars: Path):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/plan/test_reconfigure.py

@@ -13,7 +13,7 @@ def test_tdp_plan_reconfigure(
     collection_path: Path, database_dsn_path: str, vars: Path
 ):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/plan/test_resume.py

@@ -14,7 +14,7 @@ def test_tdp_plan_resume_nothing_to_resume(
     collection_path: Path, database_dsn_path: str, vars: Path
 ):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/status/test_edit.py

@@ -11,7 +11,7 @@
 
 def test_tdp_status_edit(collection_path: Path, database_dsn_path: str, vars: Path):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/status/test_generate_stales.py

@@ -11,7 +11,7 @@
 
 def test_tdp_status_edit(collection_path: Path, database_dsn_path: str, vars: Path):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/status/test_show.py

@@ -11,7 +11,7 @@
 
 def test_tdp_status_edit(collection_path: Path, database_dsn_path: str, vars: Path):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/test_default_diff.py

@@ -10,7 +10,7 @@
 
 def test_tdp_default_diff(collection_path: Path, vars: Path):
     args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--vars",
         vars,

tdp/cli/commands/test_deploy.py

@@ -14,7 +14,7 @@ def test_tdp_deploy_mock(
     collection_path: Path, database_dsn_path: str, vars: Path, tmp_path: Path
 ):
     base_args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn_path,

tdp/cli/commands/test_init.py

@@ -11,7 +11,7 @@
 
 def test_tdp_init(collection_path: Path, database_dsn: str, vars: Path):
     args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         database_dsn,
@@ -26,7 +26,7 @@ def test_tdp_init(collection_path: Path, database_dsn: str, vars: Path):
 def test_tdp_init_db_is_created(collection_path: Path, vars: Path, tmp_path: Path):
     db_path = tmp_path / "sqlite.db"
     args = [
-        "--collection-path",
+        "--collection",
         collection_path,
         "--database-dsn",
         "sqlite:///" + str(db_path),

tdp/cli/commands/test_operations.py

@@ -9,7 +9,7 @@
 
 
 def test_tdp_nodes(collection_path: Path):
-    args = ["--collection-path", collection_path]
+    args = ["--collection", collection_path]
     runner = CliRunner()
     result = runner.invoke(ops, args)
     assert result.exit_code == 0, result.output

tdp/cli/commands/test_playbooks.py

@@ -9,7 +9,7 @@
 
 
 def test_tdp_playbooks(collection_path: Path, tmp_path: Path):
-    args = ["--collection-path", collection_path, "--output-dir", tmp_path]
+    args = ["--collection", collection_path, "--output-dir", tmp_path]
     runner = CliRunner()
     result = runner.invoke(playbooks, args)
     assert result.exit_code == 0, result.output

tdp/cli/commands/test_validate.py

@@ -9,7 +9,7 @@
 
 
 def test_tdp_validate(collection_path: Path, vars: Path):
-    args = ["--collection-path", collection_path, "--vars", vars]
+    args = ["--collection", collection_path, "--vars", vars]
     runner = CliRunner()
     result = runner.invoke(validate, args)
     assert result.exit_code == 0, result.output

tdp/cli/utils.py

@@ -74,9 +74,9 @@ def check_services_cleanliness(cluster_variables: ClusterVariables) -> None:
 
 def collections(func: FC) -> FC:
     return click.option(
-        "--collection-path",
+        "--collection",
         "collections",
-        envvar="TDP_COLLECTION_PATH",
+        envvar="TDP_COLLECTIONS",
         required=True,
         callback=_collections_from_paths,
         help=f"List of paths separated by your os' path separator ({os.pathsep})",