support tags in cli config and init

Author: snopoke

taskbadger/config.py

@@ -1,6 +1,6 @@
 import dataclasses
-import inspect
 import os
+import textwrap
 from pathlib import Path
 
 import tomlkit
@@ -18,6 +18,7 @@ class Config:
     organization_slug: str = None
     project_slug: str = None
     host: str = _TB_HOST
+    tags: dict = None
 
     def is_valid(self):
         return bool(self.token and self.organization_slug and self.project_slug)
@@ -51,18 +52,26 @@ def from_dict(config_dict, **overrides) -> "Config":
             organization_slug=overrides.get("org") or _from_env("ORG", defaults.get("org")),
             project_slug=overrides.get("project") or _from_env("PROJECT", defaults.get("project")),
             host=overrides.get("host") or auth.get("host"),
+            tags=config_dict.get("tags", {}),
         )
 
     def __str__(self):
         host = ""
-        if self.host != _TB_HOST:
-            host = f"\n            Host: {self.host}"
-        return inspect.cleandoc(
-            f"""
+        if self.host and self.host != _TB_HOST:
+            host = f"Host: {self.host or '-'}\n"
+        tags = ""
+        if self.tags:
+            tags = "Tags:\n  " + "\n  ".join(f"{k}: {v}" for k, v in self.tags.items())
+        return (
+            textwrap.dedent(
+                f"""
             Organization slug: {self.organization_slug or "-"}
             Project slug: {self.project_slug or "-"}
-            Auth token: {self.token or "-"}{host}
+            Auth token: {self.token or "-"}
             """
+            )
+            + host
+            + tags
         )
 
 
@@ -79,6 +88,11 @@ def write_config(config):
     )
 
     doc.add("auth", table().add("token", config.token))
+    if config.tags:
+        tags = table()
+        for key, value in config.tags.items():
+            tags.add(key, value)
+        doc.add("tags", tags)
 
     config_path = _get_config_path()
     if not config_path.parent.exists():

taskbadger/mug.py

@@ -124,8 +124,9 @@ def __init__(self, settings_or_mug=None):
         self._session = ReentrantSession()
         self._scope = Scope()
 
-    def bind(self, settings):
+    def bind(self, settings, tags=None):
         self.settings = settings
+        self.scope().tags = tags or {}
 
     def session(self) -> ReentrantSession:
         return self._session

taskbadger/sdk.py

@@ -37,12 +37,13 @@ def init(
     project_slug: str = None,
     token: str = None,
     systems: list[System] = None,
+    tags: dict[str, str] = None,
 ):
     """Initialize Task Badger client
 
     Call this function once per thread
     """
-    _init(_TB_HOST, organization_slug, project_slug, token, systems)
+    _init(_TB_HOST, organization_slug, project_slug, token, systems, tags)
 
 
 def _init(
@@ -51,6 +52,7 @@ def _init(
     project_slug: str = None,
     token: str = None,
     systems: list[System] = None,
+    tags: dict[str, str] = None,
 ):
     host = host or os.environ.get("TASKBADGER_HOST", "https://taskbadger.net")
     organization_slug = organization_slug or os.environ.get("TASKBADGER_ORG")
@@ -66,7 +68,7 @@ def _init(
             project_slug,
             systems={system.identifier: system for system in systems},
         )
-        Badger.current.bind(settings)
+        Badger.current.bind(settings, tags)
     else:
         raise ConfigurationError(
             host=host,

tests/test_cli_config.py

@@ -23,7 +23,12 @@ def mock_config_location():
 
 @pytest.fixture()
 def _mock_config(mock_config_location):
-    config = Config(organization_slug="test_org", project_slug="test_project", token="test_token")
+    config = Config(
+        organization_slug="test_org",
+        project_slug="test_project",
+        token="test_token",
+        tags={"env": "prod", "host": "localhost"},
+    )
     write_config(config)
 
 
@@ -67,7 +72,7 @@ def test_info_args_trump_env():
 @pytest.mark.usefixtures("_mock_config")
 def test_info_config():
     result = runner.invoke(app, ["info"])
-    _check_output(result, "test_org", "test_project", "test_token")
+    _check_output(result, "test_org", "test_project", "test_token", tags={"env": "prod", "host": "localhost"})
 
 
 @mock.patch.dict(
@@ -82,13 +87,13 @@ def test_info_config():
 @pytest.mark.usefixtures("_mock_config")
 def test_info_config_env():
     result = runner.invoke(app, ["info"])
-    _check_output(result, "org2", "project2", "token2")
+    _check_output(result, "org2", "project2", "token2", tags={"env": "prod", "host": "localhost"})
 
 
 @pytest.mark.usefixtures("_mock_config")
 def test_info_config_args():
     result = runner.invoke(app, ["-o", "org1", "-p", "project1", "info"])
-    _check_output(result, "org1", "project1", "test_token")
+    _check_output(result, "org1", "project1", "test_token", tags={"env": "prod", "host": "localhost"})
 
 
 @mock.patch.dict(
@@ -103,7 +108,7 @@ def test_info_config_args():
 @pytest.mark.usefixtures("_mock_config")
 def test_info_config_env_args():
     result = runner.invoke(app, ["-o", "org1", "-p", "project1", "info"])
-    _check_output(result, "org1", "project1", "token2")
+    _check_output(result, "org1", "project1", "token2", tags={"env": "prod", "host": "localhost"})
 
 
 def test_configure(mock_config_location):
@@ -122,8 +127,13 @@ def test_configure(mock_config_location):
     }
 
 
-def _check_output(result, org, project, token):
+def _check_output(result, org, project, token, tags=None):
     assert result.exit_code == 0
     assert f"Organization slug: {org}" in result.stdout
     assert f"Project slug: {project}" in result.stdout
     assert f"Auth token: {token}" in result.stdout
+    if tags:
+        for key, value in tags.items():
+            assert f"{key}: {value}" in result.stdout
+    else:
+        assert "Tags:" not in result.stdout