jubilant 0.0.0__tar.gz

jubilant-0.0.0/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: jubilant
+Version: 0.0.0
+Summary: Juju CLI wrapper for charm integration testing
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Jubilant, the joyful library for integration-testing Juju charms
+
+Jubilant is a Python library that wraps the [Juju](https://juju.is/) CLI for use in charm integration tests. It provides methods that map 1:1 to Juju CLI commands, but with a type-annotated, Pythonic interface.
+
+**NOTE:** Jubilant is in very early stages of development. This is pre-alpha code. Our intention is to release a 1.0.0 version early to mid 2025.

jubilant-0.0.0/README.md

@@ -0,0 +1,5 @@
+# Jubilant, the joyful library for integration-testing Juju charms
+
+Jubilant is a Python library that wraps the [Juju](https://juju.is/) CLI for use in charm integration tests. It provides methods that map 1:1 to Juju CLI commands, but with a type-annotated, Pythonic interface.
+
+**NOTE:** Jubilant is in very early stages of development. This is pre-alpha code. Our intention is to release a 1.0.0 version early to mid 2025.

jubilant-0.0.0/jubilant/__init__.py

@@ -0,0 +1,143 @@
+"""Jubilant is a Pythonic wrapper around the Juju CLI for integration testing."""
+
+import json
+import subprocess
+import time
+import typing
+
+from ._types import Status
+
+__all__ = [
+    'Juju',
+    'Status',
+]
+
+__version__ = '0.0.1'
+
+
+class Juju:
+    """TODO."""
+
+    def __init__(self, *, model: str | None = None):
+        self.model = model
+
+    def __repr__(self):
+        args = []
+        if self.model is not None:
+            args.append(f'model={self.model!r}')
+        return f'Juju({", ".join(args)})'
+
+    def cli(self, *args: str) -> str:
+        """TODO."""
+        # TODO: good error handling and include stderr in exception
+        process = subprocess.run(
+            ['juju', *args], check=True, capture_output=True, encoding='UTF-8'
+        )
+        return process.stdout
+
+    def add_model(
+        self,
+        model_name: str,  # TODO: should this use self.model if set, and set it if not?
+        *,
+        controller: str | None = None,
+        config: dict[str, typing.Any] | None = None,  # TODO: is Any correct here?
+    ) -> None:
+        """TODO."""
+        args = ['add-model', model_name]
+
+        if controller is not None:
+            args.extend(['--controller', controller])
+        if config is not None:
+            for k, v in config.items():
+                args.extend(['--config', f'{k}={v}'])
+
+        self.cli(*args)
+
+    def destroy_model(
+        self,
+        model_name: str,
+        *,
+        force=False,
+    ):
+        """TODO."""
+        args = ['destroy-model', model_name, '--no-prompt']
+        if force:
+            args.append('--force')
+        self.cli(*args)
+
+    def deploy(
+        self,
+        charm_name: str,
+        application_name: str | None = None,
+        *,
+        model: str | None = None,
+        config: dict[str, typing.Any] | None = None,  # TODO: is Any correct here?
+        num_units: int = 1,
+        resources: dict[str, str] | None = None,
+        trust: bool = False,
+        # TODO: include all the arguments we think people we use
+    ) -> None:
+        """TODO."""
+        args = ['deploy', charm_name]
+        if application_name is not None:
+            args.append(application_name)
+
+        if model is None:
+            model = self.model
+        if model is not None:
+            args.extend(['--model', model])
+        if config is not None:
+            for k, v in config.items():
+                args.extend(['--config', f'{k}={v}'])
+        if num_units != 1:
+            args.extend(['--num-units', str(num_units)])
+        if resources is not None:
+            for k, v in resources.items():
+                args.extend(['--resource', f'{k}={v}'])
+        if trust:
+            args.append('--trust')
+
+        self.cli(*args)
+
+    def status(
+        self,
+        *,
+        model: str | None = None,
+    ) -> Status:
+        """TODO."""
+        args = ['status', '--format', 'json']
+
+        if model is None:
+            model = self.model
+        if model is not None:
+            args.extend(['--model', model])
+
+        stdout = self.cli(*args)
+        result = json.loads(stdout)
+        return Status.from_dict(result)
+
+    def wait_status(
+        self,
+        ready_func: typing.Callable[[Status], bool],
+        *,
+        model: str | None = None,
+        timeout: float = 10 * 60,
+        delay: float = 1,
+        successes: int = 3,
+    ) -> Status:
+        """TODO."""
+        start = time.time()
+        success_count = 0
+        this_status = None
+        while time.time() - start < timeout:
+            this_status = self.status(model=model)
+            #        logger.info('wait_status: %s', this_status)  # TODO: ensure better debugging
+            print('TODO wait_status', this_status)
+            if ready_func(this_status):
+                success_count += 1
+                if success_count >= successes:
+                    return this_status
+            else:
+                success_count = 0
+            time.sleep(delay)
+        raise Exception(f'timed out after {timeout}, last status:\n{this_status}')

jubilant-0.0.0/jubilant/_types.py

@@ -0,0 +1,43 @@
+import dataclasses
+
+
+@dataclasses.dataclass
+class StatusInfoContents:
+    current: str | None = None
+    message: str | None = None
+
+    @classmethod
+    def from_dict(cls, d):
+        self = cls()
+        self.current = d.get('current')
+        self.message = d.get('message')
+        return self
+
+
+@dataclasses.dataclass
+class ApplicationStatus:
+    application_status: StatusInfoContents = dataclasses.field(default_factory=StatusInfoContents)
+
+    @classmethod
+    def from_dict(cls, d):
+        self = cls()
+        self.application_status = StatusInfoContents.from_dict(d.get('application-status') or {})
+        return self
+
+
+@dataclasses.dataclass
+class Status:
+    # TODO: Ideally we can generate the list of fields from the Go source in Juju:
+    # cmd/juju/status/formatted.go
+    applications: dict[str, ApplicationStatus] = dataclasses.field(default_factory=dict)
+
+    @classmethod
+    def from_dict(cls, d):
+        self = cls()
+        applications = d.get('applications') or {}
+        self.applications = {
+            name: ApplicationStatus.from_dict(status) for name, status in applications.items()
+        }
+        return self
+
+    # TODO: helper methods

jubilant-0.0.0/jubilant.egg-info/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.1
+Name: jubilant
+Version: 0.0.0
+Summary: Juju CLI wrapper for charm integration testing
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# Jubilant, the joyful library for integration-testing Juju charms
+
+Jubilant is a Python library that wraps the [Juju](https://juju.is/) CLI for use in charm integration tests. It provides methods that map 1:1 to Juju CLI commands, but with a type-annotated, Pythonic interface.
+
+**NOTE:** Jubilant is in very early stages of development. This is pre-alpha code. Our intention is to release a 1.0.0 version early to mid 2025.

jubilant-0.0.0/jubilant.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+pyproject.toml
+jubilant/__init__.py
+jubilant/_types.py
+jubilant.egg-info/PKG-INFO
+jubilant.egg-info/SOURCES.txt
+jubilant.egg-info/dependency_links.txt
+jubilant.egg-info/top_level.txt

jubilant-0.0.0/jubilant.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

jubilant-0.0.0/jubilant.egg-info/top_level.txt

@@ -0,0 +1 @@
+jubilant

jubilant-0.0.0/pyproject.toml

@@ -0,0 +1,116 @@
+[project]
+name = "jubilant"
+description = "Juju CLI wrapper for charm integration testing"
+readme = "README.md"
+requires-python = ">=3.12"
+dynamic = ["version"]
+
+[dependency-groups]
+dev = [
+    "pyright==1.1.390",
+    "pytest==8.3.4",
+    "ruff==0.8.1",
+]
+
+# Linting tools configuration
+[tool.ruff]
+line-length = 99
+target-version = "py312"
+
+# Ruff formatter configuration
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint]
+select = [
+    # Pyflakes
+    "F",
+    # Pycodestyle
+    "E",
+    "W",
+    # isort
+    "I001",
+    # pep8-naming
+    "N",
+    # flake8-builtins
+    "A",
+    # pyupgrade
+    "UP",
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-simplify
+    "SIM",
+    # Ruff specific
+    "RUF",
+    # Perflint
+    "PERF",
+    # pyflakes-docstrings
+    "D",
+]
+ignore = [
+    # Use of `assert` detected
+    "S101",
+    # Do not `assert False`
+    "B011",
+    # `pickle`, `cPickle`, `dill`, and `shelve` modules are possibly insecure
+    "S403",
+    # `subprocess` module is possibly insecure
+    "S404",
+
+    # No explicit `stacklevel` keyword argument found
+    "B028",
+
+    # Return condition directly, prefer readability.
+    "SIM103",
+    # Use contextlib.suppress() instead of try/except: pass
+    "SIM105",
+    # Use a single `with` statement with multiple contexts instead of nested `with` statements
+    "SIM117",
+
+    # Missing docstring in magic method
+    "D105",
+    # Missing docstring in `__init__`
+    "D107",
+
+    # Manual dict comprehension.
+    "PERF403",
+
+    # Convert {} from `TypedDict` functional to class syntax
+    # Note that since we have some `TypedDict`s that cannot use the class
+    # syntax, we're currently choosing to be consistent in syntax even though
+    # some can be moved to the class syntax.
+    "UP013",
+
+    ## Likely worth doing, but later.
+
+    # `subprocess` call: check for execution of untrusted input
+    "S603",
+    # Starting a process with a partial executable path
+    "S607",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.flake8-builtins]
+builtins-ignorelist = ["id", "min", "map", "range", "type", "input", "format"]
+
+[tool.ruff.lint.per-file-ignores]
+"test/*" = [
+    # All documentation linting.
+    "D",
+]
+
+[tool.pyright]
+include = ["jubilant/*.py"]
+pythonVersion = "3.12"
+pythonPlatform = "All"
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "."
+]

jubilant-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+