feat(#45): require full rsc pin name

Author: machow

.env.dev

@@ -1,3 +1,7 @@
+# This allows the unit tests to run, while not using
+# the full <user_name>/<pin_name> format.
+PINS_ALLOW_RSC_SHORT_NAME=1
+
 # Pins optional config ----
 #PINS_CACHE_DIR=.pins_cache
 #PINS_DATA_DIR=.pins_data

.github/workflows/ci.yml

@@ -8,6 +8,9 @@ on:
   release:
     types: [published]
 
+env:
+  PINS_ALLOW_RSC_SHORT_NAME: 1
+
 jobs:
   tests:
     name: "Tests"

pins/boards.py

@@ -16,6 +16,7 @@
 from .errors import PinsError
 from .drivers import load_data, save_data, default_title
 from .utils import inform
+from .config import get_allow_rsc_short_name
 
 
 _log = logging.getLogger(__name__)
@@ -776,6 +777,16 @@ def pin_versions_prune(self, *args, **kwargs):
         super().pin_versions_prune(*args, **kwargs)
 
     def validate_pin_name(self, name) -> None:
+        # this should be the default behavior, expecting a full pin name.
+        # but because the tests use short names, we allow it to be disabled via config
+        if not get_allow_rsc_short_name() and name.count("/") != 1:
+            raise ValueError(
+                f"Invalid pin name: {name}"
+                "\nRStudio Connect pin names must include user name. E.g. "
+                "\nsome_user/mtcars, for the user some_user."
+            )
+
+        # less strict test, that allows no slash: e.g. "mtcars"
         if name.count("/") > 1 or name.lstrip().startswith("/"):
             raise ValueError(f"Invalid pin name: {name}")
 

pins/config.py

@@ -7,10 +7,24 @@
 PINS_ENV_DATA_DIR = "PINS_DATA_DIR"
 PINS_ENV_CACHE_DIR = "PINS_CACHE_DIR"
 PINS_ENV_INSECURE_READ = "PINS_ALLOW_PICKLE_READ"
+PINS_ENV_ALLOW_RSC_SHORT_NAME = "PINS_ALLOW_RSC_SHORT_NAME"
 
 pins_options = SimpleNamespace(quiet=False)
 
 
+def _interpret_int(env_var_name):
+    env_var = os.environ.get(env_var_name, "0")
+    try:
+        env_int = int(env_var)
+    except ValueError:
+        raise ValueError(
+            f"{env_var_name} must be '0' or '1', but was set to " f"{repr(env_var)}."
+        )
+
+    flag = bool(env_int)
+    return flag
+
+
 def get_data_dir():
     return os.environ.get(PINS_ENV_DATA_DIR, appdirs.user_data_dir(PINS_NAME))
 
@@ -21,15 +35,10 @@ def get_cache_dir():
 
 def get_allow_pickle_read(flag):
     if flag is None:
-        env_var = os.environ.get(PINS_ENV_INSECURE_READ, "0")
-        try:
-            env_int = int(env_var)
-        except ValueError:
-            raise ValueError(
-                f"{PINS_ENV_INSECURE_READ} must be '0' or '1', but was set to "
-                f"{repr(env_var)}."
-            )
-
-        flag = bool(env_int)
+        return _interpret_int(PINS_ENV_INSECURE_READ)
 
     return flag
+
+
+def get_allow_rsc_short_name():
+    return _interpret_int(PINS_ENV_ALLOW_RSC_SHORT_NAME)

pins/tests/test_boards.py

@@ -396,6 +396,26 @@ def test_board_rsc_path_to_pin_safe(board_short):
     assert board_short.path_to_pin("me/some_pin") == "me/some_pin"
 
 
+@pytest.mark.fs_rsc
+def test_board_rsc_require_full_pin_name(board_short):
+    # the tests set the special env var below to allow short pin names,
+    # but here we test this is not what should happen by default.
+    # we test that full names work with the RSC board above, so these two
+    # things should cover us.
+    from pins.config import PINS_ENV_ALLOW_RSC_SHORT_NAME
+
+    with rm_env(PINS_ENV_ALLOW_RSC_SHORT_NAME):
+        with pytest.raises(ValueError) as exc_info:
+            board_short.validate_pin_name("mtcars")
+
+        assert "Invalid pin name" in exc_info.value.args[0]
+
+        with pytest.raises(ValueError) as exc_info:
+            board_short.path_to_pin("mtcars")
+
+        assert "Invalid pin name" in exc_info.value.args[0]
+
+
 # Manual Board Specific =======================================================
 
 from pins.boards import BoardManual  # noqa