Add config profile option

This allows to select different profiles from the config file to load a
different set of default values. The default profile is the one with the
section name "cli". Other profiles can be provided by adding sections
with names like "cli-<profile>". The profile "cli-sandbox" e.g. can be
selected with "pulp --profile sandbox <...>".

[noissue]

CHANGES/145.feature

@@ -0,0 +1 @@
+Added the ability to include multiple server profiles into the pulp cli config.

pulpcore/cli/common/__init__.py

@@ -17,19 +17,37 @@
 # Main entry point
 
 
+PROFILE_KEY = f"{__name__}.profile"
+
+
+def _config_profile_callback(ctx: click.Context, param: Any, value: Optional[str]) -> Optional[str]:
+    if value is not None:
+        ctx.meta[PROFILE_KEY] = value
+    return value
+
+
 def _config_callback(ctx: click.Context, param: Any, value: Optional[str]) -> None:
     if ctx.default_map:
         return
 
     if value:
-        ctx.default_map = toml.load(value)["cli"]
+        config = toml.load(value)
     else:
         default_config_path = os.path.join(click.utils.get_app_dir("pulp"), "settings.toml")
 
         try:
-            ctx.default_map = toml.load(default_config_path)["cli"]
+            config = toml.load(default_config_path)
         except FileNotFoundError:
-            pass
+            # No config, but also none requested
+            return
+
+    profile: str = "cli"
+    if PROFILE_KEY in ctx.meta:
+        profile = "cli-" + ctx.meta[PROFILE_KEY]
+    try:
+        ctx.default_map = config[profile]
+    except KeyError:
+        raise click.ClickException("Profile named '{}' not found.".format(profile))
 
 
 CONFIG_OPTIONS = [
@@ -58,7 +76,15 @@ def config_options(command: Callable[..., Any]) -> Callable[..., Any]:
 
 
 @click.group()
-@click.version_option(prog_name="pulp3 command line interface")
+@click.version_option(prog_name=_("pulp3 command line interface"))
+@click.option(
+    "--profile",
+    "-p",
+    help=_("Config profile to use"),
+    callback=_config_profile_callback,
+    expose_value=False,
+    is_eager=True,
+)
 @click.option(
     "--config",
     type=click.Path(resolve_path=True),

tests/scripts/pulpcore/test_config.sh → tests/scripts/test_config.sh

@@ -1,10 +1,11 @@
 #!/bin/sh
 
 # shellcheck source=tests/scripts/config.source
-. "$(dirname "$(dirname "$(realpath "$0")")")"/config.source
+. "$(dirname "$(realpath "$0")")"/config.source
 
 good_settings="${XDG_CONFIG_HOME}/pulp/settings.toml"
 bad_settings="bad_settings.toml"
+profile_settings="profile_settings.toml"
 test_settings="test.toml"
 
 export XDG_CONFIG_HOME=/nowhere
@@ -29,6 +30,14 @@ expect_fail pulp --username test --password test --client "/some/path" status
 expect_fail pulp --key "/some/path" file remote list
 
 
+# CONFIG PROFILE
+
+cp "$bad_settings" "$profile_settings"
+sed -e 's/\[cli\]/[cli-profile1]/' "$good_settings" >> "$profile_settings"
+
+expect_fail pulp --config "$profile_settings" file repository list
+expect_succ pulp --config "$profile_settings" --profile profile1 file repository list
+
 # CONFIG COMMAND
 
 expect_fail pulp config edit --location $test_settings

tests/scripts/pulpcore/test_debug_api.sh → tests/scripts/test_debug_api.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 # shellcheck source=tests/scripts/config.source
-. "$(dirname "$(dirname "$(realpath "$0")")")"/config.source
+. "$(dirname "$(realpath "$0")")"/config.source
 
 expect_succ pulp -v status
 

tests/scripts/pulpcore/test_output.sh → tests/scripts/test_output.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # shellcheck source=tests/scripts/config.source
-. "$(dirname "$(dirname "$(realpath "$0")")")"/config.source
+. "$(dirname "$(realpath "$0")")"/config.source
 
 # skip this test if pygments is not installed
 pip show pygments > /dev/null || exit 3

tests/test_scripts.py

@@ -6,7 +6,7 @@
 TEST_SCRIPTS = [
     pytest.param(
         path.resolve(),
-        id=path.stem,
+        id=("" if path.parent.name == "scripts" else path.parent.name + ".") + path.stem,
         marks=[] if path.parent.name == "scripts" else getattr(pytest.mark, path.parent.name),
     )
     for path in Path("tests/scripts").glob("**/test_*.sh")