Support optional glob match in client ls

plus some testing improvements

Author: meatballhat

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- client: glob-style filtering by name or image alias in `ls` command
+
 ### Changed
 ### Deprecated
 ### Removed

fuzzbucket_client/__main__.py

@@ -254,9 +254,10 @@ def main(sysargs: list[str] = sys.argv[:]) -> int:
     parser_list = subparsers.add_parser(
         "ls",
         aliases=["l", "list"],
-        help="list your boxes",
+        help="list matching boxes",
         formatter_class=CustomHelpFormatter,
     )
+    parser_list.add_argument("box_match", nargs="?")
     parser_list.set_defaults(func=client.ls)
 
     parser_update = subparsers.add_parser(
@@ -710,11 +711,20 @@ def logout(self, *_):
         return True
 
     @_command
-    def ls(self, *_):
+    def ls(self, known_args: argparse.Namespace, _):
         log.debug(f"fetching boxes for user={self._user!r}")
-        boxes = self._list_boxes()
-        log.info(f"fetched boxes for user={self._user!r} count={len(boxes)}")
-        print(self._format_boxes(boxes), end="")
+
+        matching_boxes = self._find_boxes(known_args.box_match)
+
+        if matching_boxes is None:
+            log.error(f"no boxes found matching {known_args.box_match!r}")
+
+            return False
+
+        log.info(f"fetched boxes for user={self._user!r} count={len(matching_boxes)}")
+
+        print(self._format_boxes(matching_boxes), end="")
+
         return True
 
     @_command
@@ -1091,27 +1101,40 @@ def whoami(self, *_):
 
     def _find_box(self, box_search):
         results = self._find_boxes(box_search)
+
         if results is None:
             return None
+
         return results[0]
 
     def _find_boxes(self, box_search):
         boxes = self._list_boxes()
+
+        if box_search is None:
+            return boxes
+
         results = []
+
         for box in boxes:
             log.debug(f"finding box_search={box_search!r} considering box={box!r}")
+
             if box.get("name") is not None and fnmatch.fnmatchcase(
                 box["name"], box_search
             ):
                 results.append(box)
+
                 continue
+
             if box.get("image_alias") is not None and fnmatch.fnmatchcase(
                 box["image_alias"], box_search
             ):
                 results.append(box)
+
                 continue
+
         if len(results) == 0:
             return None
+
         return results
 
     def _list_boxes(self):

justfile

@@ -2,7 +2,8 @@ set shell := ["bash", "-c"]
 
 default:
   hatch run lint
-  hatch run test
+  FUZZBUCKET_AUTH_PROVIDER=github-oauth hatch run test
+  FUZZBUCKET_AUTH_PROVIDER=oauth hatch run test --cov-append
 
 deps:
   hatch run yarn install

pyproject.toml

@@ -71,7 +71,7 @@ lint = [
   "black --check --diff {root}",
   "pytest -m mypy --no-cov"
 ]
-test = "pytest --cov-fail-under=89"
+test = "pytest --cov-fail-under=89 {args}"
 fmt = [
   "isort {root}",
   "black {root}"

tests/test_fuzzbucket_client.py

@@ -51,6 +51,13 @@ def config_setup(tmpdir, monkeypatch):
     os.environ.pop("FUZZBUCKET_CREDENTIALS", None)
 
 
+def test_trinary_behavior():
+    assert str(fuzzbucket_client.__main__._TrinaryBehavior.ALWAYS) == "always"
+
+    with pytest.raises(ValueError):
+        fuzzbucket_client.__main__._TrinaryBehavior("boguster")
+
+
 def test_default_client():
     assert fuzzbucket_client.__main__.default_client() is not None
 
@@ -279,13 +286,15 @@ def test_client_failing_func(monkeypatch):
 
 
 @pytest.mark.parametrize(
-    ("args",),
+    ("args", "returning"),
     [
-        pytest.param(("ls",), id="empty"),
-        pytest.param(("-j", "list"), id="output_json"),
+        pytest.param(("ls",), 0, id="empty"),
+        pytest.param(("-j", "list"), 0, id="output_json"),
+        pytest.param(("list", "spark*"), 0, id="matching"),
+        pytest.param(("list", "*giraffes*"), 86, id="not_matching"),
     ],
 )
-def test_client_list(monkeypatch, args):
+def test_client_ls(monkeypatch, args, returning):
     client = fuzzbucket_client.__main__.Client()
     monkeypatch.setattr(fuzzbucket_client.__main__, "default_client", lambda: client)
     monkeypatch.setattr(
@@ -298,7 +307,7 @@ def test_client_list(monkeypatch, args):
         ),
     )
     ret = fuzzbucket_client.__main__.main(["fuzzbucket-client"] + list(args))
-    assert ret == 0
+    assert ret == returning
 
 
 @pytest.mark.parametrize(
@@ -1351,6 +1360,30 @@ def test_client_delete_key(monkeypatch, caplog):
     assert "deleted key" in caplog.text
 
 
+@pytest.mark.parametrize(
+    ("args", "response", "out_match", "returning"),
+    [
+        pytest.param(("whoami",), '{"you":"castleface"}', "castleface", 0),
+        pytest.param(("-j", "whoami"), '{"you":"castleface"}', "castleface", 0),
+        pytest.param(("whoami",), "{}", None, 86),
+    ],
+)
+def test_client_whoami(args, response, out_match, returning, monkeypatch, capsys):
+    client = fuzzbucket_client.__main__.Client()
+    monkeypatch.setattr(fuzzbucket_client.__main__, "default_client", lambda: client)
+
+    monkeypatch.setattr(
+        client,
+        "_urlopen",
+        gen_fake_urlopen(io.StringIO(response)),
+    )
+
+    ret = fuzzbucket_client.__main__.main(["fuzzbucket-client"] + list(args))
+    assert ret == returning
+    if out_match is not None:
+        assert out_match in capsys.readouterr().out
+
+
 @pytest.mark.parametrize(
     (
         "env_credentials",