Convert project to build with uv (#148)

* Convert project to build with uv

* Pin back to pytest_async<0.23

* Remove ubuntu 20.04 tests

* bump setuptools

* publish on tags starting with 'v'

* Set fetch-tags

Author: Adam Dyess

.github/workflows/publish.yaml

@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+    - name: Install tox
+      run: |-
+        pip install tox-uv
+    - name: Build a binary wheel and a source tarball
+      run: |-
+        tox -e build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+        Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pytest-operator
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/tests.yaml

@@ -14,6 +14,7 @@ jobs:
     name: Lint Unit
     uses: charmed-kubernetes/workflows/.github/workflows/lint-unit.yaml@main
     with:
+      with-uv: true
       python: "['3.8', '3.9', '3.10', '3.11', '3.12']"
     needs:
       - call-inclusive-naming-check
@@ -64,7 +65,7 @@ jobs:
     timeout-minutes: 40
     strategy:
       matrix:
-        ubuntu: ['20.04', '22.04', '24.04']
+        ubuntu: ['22.04', '24.04']
         juju: ['3.1', '3']
     steps:
     - name: Check out code

lint-requirements.txt

@@ -0,0 +1,99 @@
+[build-system]
+requires = ["setuptools>=70.3.0", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_scheme = "guess-next-dev"
+local_scheme = "node-and-date"
+
+[project]
+name = "pytest-operator"
+dynamic = ["version"]
+description = "Fixtures for Charmed Operators"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "Apache" }
+authors = [
+  {name="Adam Dyess",   email="adam.dyess@canonical.com"},
+  {name="Mateo Florido", email="mateo.florido@canonical.com"}
+]
+dependencies = [
+  "ipdb",
+  "pytest",
+  "pytest-asyncio<0.23",
+  "pyyaml",
+  "juju",
+  "jinja2",
+]
+keywords = [
+  "pytest",
+  "py.test",
+  "operators",
+  "ops",
+]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12"
+]
+
+[project.entry-points.pytest11]
+pytest-operator = "pytest_operator.plugin"
+
+
+[project.urls]
+"Homepage" = "https://github.com/charmed-kubernetes/pytest-operator"
+"Bug Tracker" = "https://github.com/charmed-kubernetes/pytest-operator/issues"
+
+[tool.isort]
+line_length = 88
+profile = "black"
+
+[tool.mypy]
+explicit_package_bases = true
+namespace_packages = true
+
+[tool.pytest.ini_options]
+asyncio_default_fixture_loop_scope = "module"
+
+[tool.setuptools]
+zip-safe = true
+
+[tool.setuptools.packages.find]
+namespaces = true
+
+[tool.ruff]
+line-length = 88
+extend-exclude = ["__pycache__", "*.egg_info"]
+
+[[tool.mypy.overrides]]
+module = [
+  "charms",
+  "charms.reactive",
+  "ipdb",
+  "kubernetes.*",
+]
+ignore_missing_imports = true
+
+[dependency-groups]
+format = ["ruff"]
+lint = [
+  "mypy",
+  "types-PyYAML",
+  "types-setuptools",
+  "ops",
+  {include-group = "format"},
+  {include-group = "unit"},
+]
+publish = [
+  "twine"
+]
+unit = [
+  "pytest>=8.3.4",
+  "pytest-cov>=5.0.0",
+  "pytest-html",
+]

pyproject.toml

@@ -24,6 +24,7 @@
 from typing import (
     Any,
     Dict,
+    Generic,
     Generator,
     Iterable,
     List,
@@ -69,8 +70,7 @@ def pytest_addoption(parser: Parser):
     parser.addoption(
         "--controller",
         action="store",
-        help="Juju controller to use; if not provided, "
-        "will use the current controller",
+        help="Juju controller to use; if not provided, will use the current controller",
     )
     parser.addoption(
         "--model-alias",
@@ -172,10 +172,9 @@ def pytest_configure(config: Config):
     config.addinivalue_line("markers", "abort_on_fail")
     config.addinivalue_line("markers", "skip_if_deployed")
 
-    if config.option.basetemp is None:
-        tox_dir = os.environ.get("TOX_ENV_DIR")
-        if tox_dir:
-            config.option.basetemp = Path(tox_dir) / "tmp/pytest"
+    if tox_dir := os.environ.get("TOX_ENV_DIR"):
+        config.option.basetemp = Path(tox_dir) / "tmp/pytest"
+    log.info("Using basetemp: %s", config.option.basetemp)
 
 
 def pytest_runtest_setup(item):
@@ -211,16 +210,16 @@ def event_loop():
 
 
 # Plugin load order can't be set, replace asyncio directly
-pytest_asyncio.plugin.event_loop = event_loop
+pytest_asyncio.plugin.event_loop = event_loop  # type: ignore
 
 
 def pytest_collection_modifyitems(session, config, items):
-    """Automatically apply the "asyncio" marker to any async test items."""
+    """Automatically apply the "pytest.mark.asyncio" marker to any async testitems."""
     for item in items:
         is_async = inspect.iscoroutinefunction(getattr(item, "function", None))
         has_marker = item.get_closest_marker("asyncio")
         if is_async and not has_marker:
-            item.add_marker("asyncio")
+            item.add_marker(pytest.mark.asyncio)
 
 
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
@@ -442,12 +441,12 @@ def _connect_kwds(request) -> Dict[str, Any]:
 
 
 @dataclasses.dataclass
-class ModelState:
+class ModelState(Generic[Timeout]):
     model: Model
     keep: bool
     destroy_storage: bool
     controller_name: str
-    cloud_name: Optional[str]
+    cloud_name: str
     model_name: str
     config: Optional[dict] = None
     tmp_path: Optional[Path] = None
@@ -459,7 +458,7 @@ def full_name(self) -> str:
 
 
 @dataclasses.dataclass
-class CloudState:
+class CloudState(Generic[Timeout]):
     cloud_name: str
     models: List[str] = dataclasses.field(default_factory=list)
     timeout: Optional[Timeout] = None
@@ -520,7 +519,7 @@ def juju_download_args(self):
                 if field.default is not dataclasses.MISSING
             ]
 
-    def __init__(self, request, tmp_path_factory):
+    def __init__(self, request, tmp_path_factory) -> None:
         self.request = request
         self._tmp_path_factory = tmp_path_factory
         self._global_tmp_path = None
@@ -558,7 +557,7 @@ def __init__(self, request, tmp_path_factory):
 
         # maintains a set of all models connected by this fixture
         # use an OrderedDict so that the first model made is destroyed last.
-        self._current_alias = None
+        self._current_alias: Optional[str] = None
         self._models: MutableMapping[str, ModelState] = OrderedDict()
         self._clouds: MutableMapping[str, CloudState] = OrderedDict()
 
@@ -575,9 +574,18 @@ def model_context(self, alias: str) -> Generator[Model, None, None]:
             # if the there's a failure after yielding, don't fail to
             # switch back to the prior alias but still raise whatever
             # error condition occurred through the context
-            self._switch(prior, raise_not_found=False)
+            if isinstance(prior, str):
+                self._switch(prior, raise_not_found=False)
+
+    @overload
+    def _switch(self, alias: str, raise_not_found: Literal[True] = True) -> Model: ...
 
-    def _switch(self, alias: str, raise_not_found=True) -> Model:
+    @overload
+    def _switch(
+        self, alias: str, raise_not_found: Literal[False] = False
+    ) -> Optional[Model]: ...
+
+    def _switch(self, alias: str, raise_not_found=True) -> Optional[Model]:
         if alias in self._models:
             self._current_alias = alias
         elif not raise_not_found:
@@ -777,6 +785,8 @@ async def _model_exists(self, model_name: str) -> bool:
         """
         returns True when the model_name exists in the model.
         """
+        if not self._controller:
+            return False
         all_models = await self._controller.list_models()
         return model_name in all_models
 
@@ -790,13 +800,16 @@ async def _connect_to_model(
         """
         model = Model()
         state = ModelState(
-            model, keep, destroy_storage, controller_name, None, model_name
+            model, keep, destroy_storage, controller_name, "", model_name
         )
         log.info(
             "Connecting to existing model %s on unspecified cloud", state.full_name
         )
         await model.connect(state.full_name, **connect_kwargs)
         state.config = await model.get_config()
+        controller = await model.get_controller()
+        state.cloud_name = await controller.get_cloud()
+
         return state
 
     @staticmethod
@@ -920,13 +933,13 @@ async def track_model(
                 **self._juju_connect_kwds,
             )
         else:
-            cloud_name = cloud_name or self.cloud_name
+            cloud_name = cloud_name or self.cloud_name or ""
             model_name = model_name or self._generate_name(kind="model")
             model_state = await self._add_model(
                 cloud_name, model_name, keep_val, destroy_storage_val, **kwargs
             )
         self._models[alias] = model_state
-        if ops_cloud := self._clouds.get(cloud_name):
+        if ops_cloud := self._clouds.get(model_state.cloud_name):
             ops_cloud.models.append(alias)
         return model_state.model
 
@@ -986,7 +999,7 @@ async def forget_model(
         if not alias:
             alias = self.current_alias
 
-        if alias not in self.models:
+        if not alias or alias not in self.models:
             raise ModelNotFoundError(f"{alias} not found")
 
         model_state: ModelState = self._models[alias]
@@ -1127,7 +1140,7 @@ async def build_charm(
     async def build_charm(
         self,
         charm_path,
-        bases_index: int = None,
+        bases_index: Optional[int] = None,
         verbosity: Optional[
             Literal["quiet", "brief", "verbose", "debug", "trace"]
         ] = None,
@@ -1736,6 +1749,9 @@ async def add_k8s(
             juju_cloud_config["operator-storage"] = storage_class
 
         controller = self._controller
+        if not controller:
+            raise RuntimeError("No controller currently set.")
+
         cloud_name = cloud_name or self._generate_name("k8s-cloud")
         log.info(f"Adding k8s cloud {cloud_name}")
 
@@ -1790,5 +1806,6 @@ async def forget_cloud(self, cloud_name: str):
         for model in reversed(self._clouds[cloud_name].models):
             await self.forget_model(model, destroy_storage=True)
         log.info(f"Forgetting cloud: {cloud_name}...")
-        await self._controller.remove_cloud(cloud_name)
+        if self._controller:
+            await self._controller.remove_cloud(cloud_name)
         del self._clouds[cloud_name]