first attempt, adding warnings in place

Author: kieranmanning

.envrc

@@ -18,9 +18,22 @@ if [ -d ".venv" ]; then
   fi
 fi
 
-python -m uv venv .venv --python $PYTHON_VERSION
-python -m uv pip install -U pip uv
-python -m uv pip install -e .
+if [ ! -d ".venv" ]
+then
+  # System python doesn't like us installing packages into it
+  # Test if uv is already installed (via brew or other package manager  etc.)
+  # and use that if available. Otherwise fall back to previous behvaiour
+  if command -v uv
+  then
+     uv venv .venv --python $PYTHON_VERSION
+     uv pip install -U pip uv
+     uv pip install -e .
+  else
+     python -m uv venv .venv --python $PYTHON_VERSION
+     python -m uv pip install -U pip uv
+     python -m uv pip install -e .
+  fi
+fi
 
 source ./.venv/bin/activate
 

cloudsmith_cli/cli/commands/repos.py

@@ -101,6 +101,9 @@ def get(ctx, opts, owner_repo, page, page_size):
 
     click.echo("Getting list of repositories ... ", nl=False, err=use_stderr)
 
+    repo = None
+    owner = None
+
     if isinstance(owner_repo, list):
         if len(owner_repo) == 1:
             owner = owner_repo[0]

cloudsmith_cli/cli/config.py

@@ -77,6 +77,7 @@ class ConfigReader(ConfigFileReader):
     config_name = "standard"
     config_searchpath = list(_CFG_SEARCH_PATHS)
     config_section_schemas = [ConfigSchema.Default, ConfigSchema.Profile]
+    config_warning_issued = False
 
     @classmethod
     def select_config_schema_for(cls, section_name):
@@ -148,7 +149,20 @@ def has_default_file(cls):
         return False
 
     @classmethod
-    def load_config(cls, opts, path=None, profile=None):
+    def config_already_warned(cls):
+        """
+        Check if a configuration file warning has been issued.
+        This is required as configs are gathered at the root of the
+        command chain as well as for command verbs
+        """
+        if cls.config_warning_issued:
+            return True
+
+        cls.config_warning_issued = True
+        return False
+
+    @classmethod
+    def load_config(cls, opts, path=None, profile=None, no_warn=False):
         """Load a configuration file into an options object."""
         if path and os.path.exists(path):
             if os.path.isdir(path):
@@ -160,9 +174,36 @@ def load_config(cls, opts, path=None, profile=None):
         values = config.get("default", {})
         cls._load_values_into_opts(opts, values)
 
-        if profile and profile != "default":
-            values = config.get("profile:%s" % profile, {})
-            cls._load_values_into_opts(opts, values)
+        warn = not no_warn and not cls.config_already_warned()
+
+        if profile and profile != "default" and warn:
+            try:
+                values = config["profile:%s" % profile]
+                cls._load_values_into_opts(opts, values)
+            except KeyError:
+                if warn:
+                    click.secho(
+                        f"Warning: profile {profile} not found in config files {cls.config_files}",
+                        fg="yellow",
+                    )
+
+        existing_config_paths = {
+            path: os.path.exists(path) for path in cls.config_files
+        }
+        if not any(existing_config_paths.values()) and warn:
+            click.secho(
+                "Warning: No config files found in search paths. Tried the following:",
+                fg="yellow",
+            )
+            for tested_path, exists in existing_config_paths.items():
+                if exists:
+                    click.secho(f"{tested_path} - file exists", fg="green")
+                else:
+                    click.secho(f"{tested_path} - file does not exist", fg="yellow")
+            click.secho(
+                "You may need to run `cloudsmith login` to authenticate and create a config file.",
+                fg="yellow",
+            )
 
         return values
 
@@ -206,7 +247,31 @@ class CredentialsReader(ConfigReader):
     config_searchpath = list(_CFG_SEARCH_PATHS)
     config_section_schemas = [CredentialsSchema.Default, CredentialsSchema.Profile]
 
+    @classmethod
+    def load_config(cls, opts, path=None, profile=None, no_warn=False):
+        """
+        Load a credentials configuration file into an options object.
+        We overload the load_config command in CredentialsReader as
+        credentials files have their own specific default functionality.
+        """
+        if path and os.path.exists(path):
+            if os.path.isdir(path):
+                cls.config_searchpath.insert(0, path)
+            else:
+                cls.config_files.insert(0, path)
+
+        config = cls.read_config()
+        values = config.get("default", {})
+        cls._load_values_into_opts(opts, values)
+
+        if profile and profile != "default":
+            values = config.get("profile:%s" % profile, {})
+            cls._load_values_into_opts(opts, values)
+
+        return values
+
 
+# pylint: disable=too-many-public-methods
 class Options:
     """Options object that holds config for the application."""
 
@@ -227,15 +292,15 @@ def get_creds_reader():
         """Get the credentials config reader class."""
         return CredentialsReader
 
-    def load_config_file(self, path, profile=None):
+    def load_config_file(self, path, profile=None, no_warn=False):
         """Load the standard config file."""
         config_cls = self.get_config_reader()
-        return config_cls.load_config(self, path, profile=profile)
+        return config_cls.load_config(self, path, profile=profile, no_warn=no_warn)
 
-    def load_creds_file(self, path, profile=None):
+    def load_creds_file(self, path, profile=None, no_warn=False):
         """Load the credentials config file."""
         config_cls = self.get_creds_reader()
-        return config_cls.load_config(self, path, profile=profile)
+        return config_cls.load_config(self, path, profile=profile, no_warn=no_warn)
 
     @property
     def api_config(self):
@@ -268,6 +333,16 @@ def api_host(self, value):
         """Set value for API host."""
         self._set_option("api_host", value)
 
+    @property
+    def no_warn(self):
+        """Get value for API host."""
+        return self._get_option("no_warn")
+
+    @no_warn.setter
+    def no_warn(self, value):
+        """Set value for API host."""
+        self._set_option("no_warn", value)
+
     @property
     def api_key(self):
         """Get value for API key."""

cloudsmith_cli/cli/decorators.py

@@ -5,6 +5,7 @@
 import click
 
 from ..core.api.init import initialise_api as _initialise_api
+from ..core.api.user import get_user_brief
 from . import config, utils, validators
 
 
@@ -86,6 +87,12 @@ def common_cli_config_options(f):
         envvar="CLOUDSMITH_PROFILE",
         help="The name of the profile to use for configuration.",
     )
+    @click.option(
+        "--no-warn",
+        is_flag=True,
+        default=None,
+        help="Don't warn on misconfiguration issues",
+    )
     @click.pass_context
     @functools.wraps(f)
     def wrapper(ctx, *args, **kwargs):
@@ -94,8 +101,11 @@ def wrapper(ctx, *args, **kwargs):
         profile = kwargs.pop("profile")
         config_file = kwargs.pop("config_file")
         creds_file = kwargs.pop("credentials_file")
-        opts.load_config_file(path=config_file, profile=profile)
-        opts.load_creds_file(path=creds_file, profile=profile)
+        no_warn = kwargs.pop("no_warn")
+        if no_warn:
+            opts.no_warn = no_warn
+        opts.load_config_file(path=config_file, profile=profile, no_warn=opts.no_warn)
+        opts.load_creds_file(path=creds_file, profile=profile, no_warn=opts.no_warn)
         kwargs["opts"] = opts
         return ctx.invoke(f, *args, **kwargs)
 
@@ -305,6 +315,22 @@ def call_print_rate_limit_info_with_opts(rate_info):
             error_retry_cb=opts.error_retry_cb,
         )
 
+        cloudsmith_host = kwargs["opts"].opts["api_config"].host
+        no_warn = opts.no_warn
+        is_auth, _, _, _ = get_user_brief()
+        if not is_auth and not no_warn:
+            click.secho(
+                "Warning: You are not authenticated with the API. "
+                "Please verify your config files, API key and "
+                "run `cloudsmith login` if necessary to authenticate.",
+                fg="yellow",
+            )
+            click.secho(
+                f"You're currently attempting to connect to Cloudsmith instance {cloudsmith_host}",
+                fg="yellow",
+            )
+            opts.no_warn = True
+
         kwargs["opts"] = opts
         return ctx.invoke(f, *args, **kwargs)
 

cloudsmith_cli/cli/tests/commands/test_main.py

@@ -11,11 +11,9 @@ def test_main_version(self, runner, option):
         """Test the output of `cloudsmith --version`."""
         result = runner.invoke(main, [option])
         assert result.exit_code == 0
-        assert (
-            result.output == "Versions:\n"
-            "CLI Package Version: " + get_version() + "\n"
-            "API Package Version: " + get_api_version() + "\n"
-        )
+
+        assert "CLI Package Version: " + get_version() in result.output
+        assert "API Package Version: " + get_api_version() in result.output
 
     @pytest.mark.parametrize("option", ["-h", "--help"])
     def test_main_help(self, runner, option):