diff --git a/CHANGES/239.bugfix b/CHANGES/239.bugfix
new file mode 100644
index 000000000..4758064cc
--- /dev/null
+++ b/CHANGES/239.bugfix
@@ -0,0 +1 @@
+Properly truncate file before saving settings in ``config edit``.
diff --git a/CHANGES/239.feature b/CHANGES/239.feature
new file mode 100644
index 000000000..083991147
--- /dev/null
+++ b/CHANGES/239.feature
@@ -0,0 +1 @@
+Added config validation to ``config create`` and ``config edit``.
diff --git a/pulpcore/cli/common/__init__.py b/pulpcore/cli/common/__init__.py
index ad6e28794..4be3473f2 100644
--- a/pulpcore/cli/common/__init__.py
+++ b/pulpcore/cli/common/__init__.py
@@ -1,13 +1,14 @@
import gettext
import os
import sys
-from typing import Any, Callable, Dict, Optional
+from typing import Any, Optional
import click
import pkg_resources
import toml
from click_shell import make_click_shell
+from pulpcore.cli.common.config import CONFIG_LOCATION, config, config_options, validate_config
from pulpcore.cli.common.context import PulpContext
from pulpcore.cli.common.debug import debug
@@ -20,15 +21,6 @@
PROFILE_KEY = f"{__name__}.profile"
-FORMAT_CHOICES = ["json", "yaml", "none"]
-
-
-def _validate_config(config: Dict[str, Any]) -> bool:
- if "format" in config and config["format"].lower() not in FORMAT_CHOICES:
- raise ValueError(_("'format' is not one of {}").format(FORMAT_CHOICES))
- if "dry_run" in config and not isinstance(config["dry_run"], bool):
- raise ValueError(_("'dry_run' is not a bool"))
- return True
def _config_profile_callback(ctx: click.Context, param: Any, value: Optional[str]) -> Optional[str]:
@@ -45,10 +37,8 @@ def _config_callback(ctx: click.Context, param: Any, value: Optional[str]) -> No
if value:
config = toml.load(value)
else:
- default_config_path = os.path.join(click.utils.get_app_dir("pulp"), "settings.toml")
-
try:
- config = toml.load(default_config_path)
+ config = toml.load(CONFIG_LOCATION)
except FileNotFoundError:
# No config, but also none requested
return
@@ -56,7 +46,7 @@ def _config_callback(ctx: click.Context, param: Any, value: Optional[str]) -> No
if PROFILE_KEY in ctx.meta:
profile = "cli-" + ctx.meta[PROFILE_KEY]
try:
- _validate_config(config[profile])
+ validate_config(config[profile])
ctx.default_map = config[profile]
except KeyError:
raise click.ClickException(
@@ -70,36 +60,6 @@ def _config_callback(ctx: click.Context, param: Any, value: Optional[str]) -> No
raise click.ClickException(_("Aborted."))
-CONFIG_OPTIONS = [
- click.option("--base-url", default="https://localhost", help=_("API base url")),
- click.option("--username", help=_("Username on pulp server")),
- click.option("--password", help=_("Password on pulp server")),
- click.option("--cert", help=_("Path to client certificate")),
- click.option(
- "--key",
- help=_("Path to client private key. Not required if client cert contains this."),
- ),
- click.option("--verify-ssl/--no-verify-ssl", default=True, help=_("Verify SSL connection")),
- click.option(
- "--format",
- type=click.Choice(FORMAT_CHOICES, case_sensitive=False),
- default="json",
- help=_("Format of the response"),
- ),
- click.option(
- "--dry-run/--force",
- is_flag=True,
- help=_("Trace commands without performing any unsafe HTTP calls"),
- ),
-]
-
-
-def config_options(command: Callable[..., Any]) -> Callable[..., Any]:
- for option in reversed(CONFIG_OPTIONS):
- command = option(command)
- return command
-
-
@click.group()
@click.version_option(prog_name=_("pulp3 command line interface"))
@click.option(
@@ -166,6 +126,7 @@ def _debug_callback(level: int, x: str) -> None:
ctx.obj = PulpContext(api_kwargs=api_kwargs, format=format, background_tasks=background)
+main.add_command(config)
main.add_command(debug)
diff --git a/pulpcore/cli/common/config.py b/pulpcore/cli/common/config.py
new file mode 100644
index 000000000..37e22b4c1
--- /dev/null
+++ b/pulpcore/cli/common/config.py
@@ -0,0 +1,188 @@
+import gettext
+from pathlib import Path
+from typing import Any, Callable, Dict, List, MutableMapping
+
+import click
+import toml
+
+_ = gettext.gettext
+
+CONFIG_LOCATION = str(Path(click.utils.get_app_dir("pulp"), "settings.toml"))
+FORMAT_CHOICES = ["json", "yaml", "none"]
+SETTINGS = ["base_url", "username", "password", "cert", "key", "verify_ssl", "format", "dry_run"]
+
+CONFIG_OPTIONS = [
+ click.option("--base-url", default="https://localhost", help=_("API base url")),
+ click.option("--username", default="", help=_("Username on pulp server")),
+ click.option("--password", default="", help=_("Password on pulp server")),
+ click.option("--cert", default="", help=_("Path to client certificate")),
+ click.option(
+ "--key",
+ default="",
+ help=_("Path to client private key. Not required if client cert contains this."),
+ ),
+ click.option("--verify-ssl/--no-verify-ssl", default=True, help=_("Verify SSL connection")),
+ click.option(
+ "--format",
+ type=click.Choice(FORMAT_CHOICES, case_sensitive=False),
+ default="json",
+ help=_("Format of the response"),
+ ),
+ click.option(
+ "--dry-run/--force",
+ default=False,
+ help=_("Trace commands without performing any unsafe HTTP calls"),
+ ),
+]
+
+
+def config_options(command: Callable[..., Any]) -> Callable[..., Any]:
+ for option in reversed(CONFIG_OPTIONS):
+ command = option(command)
+ return command
+
+
+def validate_config(config: Dict[str, Any], strict: bool = False) -> bool:
+ """Validate, that the config provides the proper data types"""
+ errors: List[str] = []
+ if "format" in config and config["format"].lower() not in FORMAT_CHOICES:
+ errors.append(_("'format' is not one of {}").format(FORMAT_CHOICES))
+ if "dry_run" in config and not isinstance(config["dry_run"], bool):
+ errors.append(_("'dry_run' is not a bool"))
+ unknown_settings = set(config.keys()) - set(SETTINGS)
+ if unknown_settings:
+ errors.append(_("Unknown settings: '{}'.").format("','".join(unknown_settings)))
+ if strict:
+ missing_settings = set(SETTINGS) - set(config.keys())
+ if missing_settings:
+ errors.append(_("Missing settings: '{}'.").format("','".join(missing_settings)))
+ if errors:
+ raise ValueError("\n".join(errors))
+ return True
+
+
+def validate_settings(settings: MutableMapping[str, Dict[str, Any]], strict: bool = False) -> bool:
+ errors: List[str] = []
+ if "cli" not in settings:
+ errors.append(_("Could not locate default profile 'cli' setting"))
+
+ for key, profile in settings.items():
+ if key != "cli" and not key.startswith("cli-"):
+ if strict:
+ errors.append(_("Invalid profile '{}'").format(key))
+ continue
+ try:
+ validate_config(profile, strict=strict)
+ except ValueError as e:
+ errors.append(_("Profile {}:").format(key))
+ errors.append(str(e))
+ if errors:
+ raise ValueError("\n".join(errors))
+ return True
+
+
+@click.group(name="config", help=_("Manage pulp-cli config file"))
+def config() -> None:
+ pass
+
+
+@config.command(help=_("Create a pulp-cli config settings file"))
+@config_options
+@click.option("--interactive", "-i", is_flag=True)
+@click.option("--editor", "-e", is_flag=True, help=_("Edit the config file in an editor"))
+@click.option("--overwrite", "-o", is_flag=True, help=_("Overwite any existing config file"))
+@click.option("--location", default=CONFIG_LOCATION, type=click.Path(resolve_path=True))
+@click.pass_context
+def create(
+ ctx: click.Context,
+ interactive: bool,
+ editor: bool,
+ overwrite: bool,
+ location: str,
+ **kwargs: Any,
+) -> None:
+ def _check_location(loc: str) -> None:
+ if not overwrite and Path(loc).exists():
+ raise click.ClickException(
+ f"File '{loc}' already exists. Use --overwite if you want to overwrite it."
+ )
+
+ def prompt_config_option(name: str) -> Any:
+ """Find the option from the root command and prompt."""
+ option = next(p for p in ctx.command.params if p.name == name)
+ if isinstance(option, click.Option) and option.help:
+ help = option.help
+ else:
+ help = option.name
+ return click.prompt(help, default=(option.default), type=option.type)
+
+ settings: MutableMapping[str, Any] = kwargs
+
+ if interactive:
+ location = click.prompt("Config file location", default=location)
+ _check_location(location)
+ for setting in SETTINGS:
+ settings[setting] = prompt_config_option(setting)
+ else:
+ _check_location(location)
+
+ output = toml.dumps({"cli": settings})
+
+ if editor:
+ output = click.edit(output)
+ if not output:
+ raise click.ClickException("No output from editor. Aborting.")
+ try:
+ settings = toml.loads(output)
+ validate_settings(settings)
+ except (ValueError, toml.TomlDecodeError) as e:
+ raise click.ClickException(str(e))
+
+ Path(location).parent.mkdir(parents=True, exist_ok=True)
+ with Path(location).open("w") as sfile:
+ sfile.write(output)
+
+ click.echo(f"Created config file at '{location}'.")
+
+
+@config.command(help=_("Open the settings config file in an editor"))
+@click.option("--location", default=CONFIG_LOCATION, type=click.Path(resolve_path=True))
+def edit(location: str) -> None:
+ if not Path(location).exists():
+ raise click.ClickException(
+ f"File '{location}' does not exists. If you wish to create the file, use the pulp "
+ "create command."
+ )
+
+ with Path(location).open("r") as sfile:
+ output = sfile.read()
+ while True:
+ output = click.edit(output)
+ if not output:
+ raise click.ClickException("No output from editor. Aborting.")
+ try:
+ settings = toml.loads(output)
+ validate_settings(settings)
+ break
+ except (ValueError, toml.TomlDecodeError) as e:
+ click.echo(str(e), err=True)
+ click.confirm(_("Retry"), abort=True)
+ with Path(location).open("w") as sfile:
+ sfile.write(output)
+
+
+@config.command(help=_("Validate a pulp-cli config file"))
+@click.option("--location", default=CONFIG_LOCATION, type=click.Path(resolve_path=True))
+@click.option("--strict", is_flag=True, help=_("Validate that all settings are present"))
+def validate(location: str, strict: bool) -> None:
+ try:
+ settings = toml.load(location)
+ except toml.TomlDecodeError:
+ raise click.ClickException(_("Invalid toml file '{location}'.").format(location=location))
+
+ try:
+ validate_settings(settings, strict)
+ except ValueError as e:
+ raise click.ClickException(str(e))
+
+ click.echo(f"File '{location}' is a valid pulp-cli config.")
diff --git a/pulpcore/cli/core/__init__.py b/pulpcore/cli/core/__init__.py
index 8b90db2eb..b00ae23dc 100644
--- a/pulpcore/cli/core/__init__.py
+++ b/pulpcore/cli/core/__init__.py
@@ -3,7 +3,6 @@
from pulpcore.cli.common import main
from pulpcore.cli.core.access_policy import access_policy
from pulpcore.cli.core.artifact import artifact
-from pulpcore.cli.core.config import config
from pulpcore.cli.core.export import export
from pulpcore.cli.core.exporter import exporter
from pulpcore.cli.core.group import group
@@ -23,7 +22,6 @@
# Register commands with cli
main.add_command(access_policy)
main.add_command(artifact)
-main.add_command(config)
main.add_command(export)
main.add_command(exporter)
main.add_command(group)
diff --git a/pulpcore/cli/core/config.py b/pulpcore/cli/core/config.py
deleted file mode 100644
index 3357f39cf..000000000
--- a/pulpcore/cli/core/config.py
+++ /dev/null
@@ -1,127 +0,0 @@
-import gettext
-from pathlib import Path
-from typing import Any, Optional
-
-import click
-import toml
-
-from pulpcore.cli.common import config_options
-
-_ = gettext.gettext
-
-LOCATION = str(Path(click.utils.get_app_dir("pulp"), "settings.toml"))
-SETTINGS = ["base_url", "username", "password", "cert", "key", "verify_ssl", "format", "dry_run"]
-
-
-@click.group(name="config", help=_("Manage pulp-cli config file"))
-def config() -> None:
- pass
-
-
-@config.command(help=_("Create a pulp-cli config settings file"))
-@config_options
-@click.option("--interactive", "-i", is_flag=True)
-@click.option("--editor", "-e", is_flag=True, help=_("Edit the config file in an editor"))
-@click.option("--overwrite", "-o", is_flag=True, help=_("Overwite any existing config file"))
-@click.option("--location", default=LOCATION, type=click.Path(resolve_path=True))
-@click.pass_context
-def create(
- ctx: click.Context,
- interactive: bool,
- editor: bool,
- overwrite: bool,
- location: str,
- base_url: str,
- username: Optional[str],
- password: Optional[str],
- cert: Optional[str],
- key: Optional[str],
- verify_ssl: bool,
- format: str,
- dry_run: bool,
-) -> None:
- def _check_location(loc: str) -> None:
- if not overwrite and Path(loc).exists():
- raise click.ClickException(
- f"File '{loc}' already exists. Use --overwite if you want to overwrite it."
- )
-
- def prompt_config_option(name: str) -> Any:
- """Find the option from the root command and prompt."""
- option = next(p for p in ctx.command.params if p.name == name)
- if isinstance(option, click.Option) and option.help:
- help = option.help
- else:
- help = option.name
- return click.prompt(help, default=(option.default or ""), type=option.type)
-
- def _default_value(option: Any) -> Any:
- if isinstance(option, bool):
- return False
- return ""
-
- settings = {}
- if interactive:
- location = click.prompt("Config file location", default=LOCATION)
- _check_location(location)
- for setting in SETTINGS:
- settings[setting] = prompt_config_option(setting)
- else:
- _check_location(location)
- for setting in SETTINGS:
- settings[setting] = locals()[setting] or _default_value(locals()[setting])
-
- output = toml.dumps({"cli": settings})
-
- if editor:
- output = click.edit(output)
- if not output:
- raise click.ClickException("No output from editor. Aborting.")
-
- Path(location).parent.mkdir(parents=True, exist_ok=True)
- with Path(location).open("w") as sfile:
- sfile.write(output)
-
- click.echo(f"Created config file at '{location}'.")
-
-
-@config.command(help=_("Open the settings config file in an editor"))
-@click.option("--location", default=LOCATION, type=click.Path(resolve_path=True))
-def edit(location: str) -> None:
- if not Path(location).exists():
- raise click.ClickException(
- f"File '{location}' does not exists. If you wish to create the file, use the pulp "
- "create command."
- )
-
- with Path(location).open("r+") as sfile:
- settings = sfile.read()
- output = click.edit(settings)
- if not output:
- raise click.ClickException("No output from editor. Aborting.")
- sfile.seek(0)
- sfile.write(output)
-
-
-@config.command(help=_("Validate a pulp-cli config file"))
-@click.option("--location", default=LOCATION, type=click.Path(resolve_path=True))
-@click.option("--strict", is_flag=True, help=_("Validate that all settings are present"))
-def validate(location: str, strict: bool) -> None:
- try:
- settings = toml.load(location)
- except toml.TomlDecodeError:
- raise click.ClickException(f"Invalid toml file '{location}'.")
-
- if "cli" not in settings:
- raise click.ClickException(f"Could not locate cli section in '{location}'.")
-
- for setting in settings["cli"]:
- if setting not in SETTINGS:
- raise click.ClickException(f"Detected unknown setting: '{setting}'.")
-
- if strict:
- for setting in SETTINGS:
- if setting not in settings["cli"]:
- raise click.ClickException(f"Missing setting: '{setting}'.")
-
- click.echo(f"File '{location}' is a valid pulp-cli config.")