Define a ZenML Bundle (#2)

* Add ZenML bundle

Author: RafalSiwek

CONTRIBUTING.md

@@ -31,11 +31,9 @@ source .tox/unit/bin/activate
 
 ### Testing
 
-**Unit and integration tests are coming soon!**
-
 ```shell
 tox -e lint          # code style
-tox                  # runs 'lint' and 'fmt' environments
+tox                  # runs 'lint', 'fmt' and 'unit' environments
 ```
 
 ## Build Charm

metadata.yaml

@@ -1,9 +1,9 @@
 name: zenml-server
 description: |
-  zenml is a Kubernetes charm bundle for ZenML Server. This bundle automates the deployment and operation of ZenML Server on any Kubernetes cluster.
+  zenml-server is a Kubernetes charm bundle for ZenML Server. This bundle automates the deployment and operation of ZenML Server on Kubernetes cluster.
 summary: |
   A charm which provides a Kubernetes installation of the ZenML (https://www.zenml.io/) server.
-docs: https://github.com/RafalSiwek/zenml-operator
+docs:
 containers:
   zenml-server:
     resource: oci-image

releases/README.md

@@ -0,0 +1,15 @@
+# MLflow Operators
+
+## Introduction
+
+Charmed ZenML is a full set of Kubernetes operators to deliver the [ZenML](https://www.zenml.io/), for easy operations on a Kubernetes cluster.
+
+A charm is a software package that includes an operator together with metadata that supports the integration of many operators in a coherent aggregated system.
+
+This technology leverages the Juju Operator Lifecycle Manager to provide day-0 to day-2 operations of Kubeflow.
+
+## Documentation
+
+Read the [Start with Charmed ZenML guide][docs] for more information.
+
+[docs]: https://github.com/RafalSiwek/zenml-server-operator

releases/latest/edge/zenml/bundle.yaml

@@ -0,0 +1,18 @@
+bundle: kubernetes
+name: zenml
+docs:
+applications:
+  zenml-mysql:
+    charm: mysql-k8s
+    channel: 8.0/stable
+    scale: 1
+    trust: true
+    _github_repo_name: mysql-k8s-operator
+  zenml-server:
+    charm: zenml-server
+    channel: latest/edge
+    scale: 1
+    trust: true
+    _github_repo_name: RafalSiwek/zenml-server-operator
+relations:
+  - [zenml-server, zenml-mysql]

releases/latest/edge/zenml/charmcraft.yaml

@@ -0,0 +1 @@
+type: bundle

requirements-integration.txt

@@ -2,7 +2,7 @@ aiohttp
 jinja2
 # Pinning to <4.0 due to compatibility with the 3.1 controller version
 juju<4.0
-zenml==0.52.0
 pytest-operator
 requests
+zenml==0.52.0
 -r requirements.txt

tests/integration/test_bundle.py

@@ -0,0 +1,35 @@
+import logging
+import subprocess
+
+import pytest
+from pytest_operator.plugin import OpsTest
+
+BUNDLE_PATH = "./releases/latest/edge/zenml/bundle.yaml"
+ZENML_APP_NAME = "zenml-server"
+
+logger = logging.getLogger(__name__)
+
+
+class TestCharm:
+    @pytest.mark.abort_on_fail
+    async def test_deploy_bundle_works_and_test_connection(self, ops_test: OpsTest):
+        subprocess.Popen(["juju", "deploy", f"{BUNDLE_PATH}", "--trust"])
+        await ops_test.model.wait_for_idle(
+            apps=[ZENML_APP_NAME],
+            status="active",
+            raise_on_blocked=False,
+            raise_on_error=False,
+            timeout=1500,
+        )
+        assert ops_test.model.applications[ZENML_APP_NAME].units[0].workload_status == "active"
+
+        config = await ops_test.model.applications[ZENML_APP_NAME].get_config()
+        zenml_nodeport = config["zenml_nodeport"]["value"]
+        zenml_url = f"http://localhost:{zenml_nodeport}"
+        zenml_subprocess = subprocess.run(
+            ["zenml", "connect", "--url", zenml_url, "--username", "default", "--password", ""]
+        )
+        logger.info(f"ZenML command stdout: {zenml_subprocess.stdout}")
+        if zenml_subprocess.stderr:
+            logger.info(f"ZenML command stderr: {zenml_subprocess.stderr}")
+        assert zenml_subprocess.returncode == 0

tox.ini

@@ -4,7 +4,7 @@ max-line-length = 100
 [tox]
 skipsdist = True
 skip_missing_interpreters = True
-envlist = fmt, lint, unit, integration
+envlist = fmt, lint, unit
 
 [vars]
 all_path = {[vars]src_path} {[vars]tst_path}
@@ -22,14 +22,6 @@ setenv =
     PYTHONBREAKPOINT=ipdb.set_trace
     PY_COLORS=1
 
-[testenv:fmt]
-commands =
-    isort {[vars]all_path}
-    black {[vars]all_path}
-deps =
-    -r requirements-fmt.txt
-description = Apply coding style standards to code
-
 [testenv:lint]
 commands =
     # uncomment the following line if this charm owns a lib
@@ -61,4 +53,15 @@ commands =
     pytest -v --tb native --asyncio-mode=auto {[vars]tst_path}integration/test_charm.py --log-cli-level=INFO -s {posargs}
 deps =
     -r requirements-integration.txt
-description = Run integration tests
+description = Run integration tests
+
+[testenv:bundle-test]
+commands =
+    pytest -v --tb native --asyncio-mode=auto {[vars]tst_path}integration/test_bundle.py --keep-models --log-cli-level=INFO -s {posargs}
+deps = 
+    aiohttp
+    pytest-operator
+    ops>=2.3.0
+    juju==3.0.4
+    zenml==0.52.0
+description = Run bundle test