Merge ~mthaddon/charm-k8s-discourse/+git/charm-k8s-discourse:tox into charm-k8s-discourse:master

[Tom Haddon]

Add tox and black, along with initial unit test

Add tox and black, along with initial unit test

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Stuart Bishop (stub)]

Yup. Inline comments, same as last MP.

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change cannot be self approved, setting status to needs review.

[Jay Kuri (jk0ne)]

LGTM.

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 36e8e36547e6b6e2dca17c0cadab09c04b975ef2

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..490cc43
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,6 @@
+*~
+*.charm
+.tox
+.coverage
+__pycache__
+build
diff --git a/.gitmodules b/.gitmodules
index 75335ec..d3eb83f 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -3,4 +3,4 @@
 	url = https://github.com/canonical/operator
 [submodule "mod/resource-oci-image"]
 	path = mod/resource-oci-image
-	url = [e-mail]:johnsca/resource-oci-image.git
+	url = https://github.com/johnsca/resource-oci-image
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..78822d3
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,23 @@
+blacken:
+	@echo "Normalising python layout with black."
+	@tox -e black
+
+lint: blacken
+	@echo "Running flake8"
+	@tox -e lint
+
+# We actually use the build directory created by charmcraft,
+# but the .charm file makes a much more convenient sentinel.
+unittest: discourse-charm.charm
+	@tox -e unit
+
+test: lint unittest
+
+clean:
+	@echo "Cleaning files"
+	@git clean -fXd
+
+discourse-charm.charm: src/*.py requirements.txt
+	charmcraft build
+
+.PHONY: lint test unittest clean
diff --git a/pyproject.toml b/pyproject.toml
new file mode 100644
index 0000000..d2f23b9
--- /dev/null
+++ b/pyproject.toml
@@ -0,0 +1,3 @@
+[tool.black]
+skip-string-normalization = true
+line-length = 120
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..2d81d3b
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1 @@
+ops
diff --git a/src/charm.py b/src/charm.py
index 29db945..75f4d26 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
 
 import sys
-sys.path.append('lib')
+
+sys.path.append('lib')  # noqa: E402
 
 from ops.charm import CharmBase
 from ops.framework import StoredState
@@ -10,8 +11,6 @@ from ops.model import (
     ActiveStatus,
     BlockedStatus,
     MaintenanceStatus,
-    ModelError,
-    WaitingStatus,
 )
 
 
@@ -42,20 +41,10 @@ def create_ingress_config(app_name, config):
             "rules": [
                 {
                     "host": config['external_hostname'],
-                    "http": {
-                        "paths": [
-                            {
-                                "path": "/",
-                                "backend": {
-                                    "serviceName": app_name,
-                                    "servicePort": 3000
-                                }
-                            }
-                        ]
-                    }
+                    "http": {"paths": [{"path": "/", "backend": {"serviceName": app_name, "servicePort": 3000}}]},
                 }
             ]
-        }
+        },
     }
     return ingressResource
 
@@ -63,29 +52,17 @@ def create_ingress_config(app_name, config):
 def get_pod_spec(app_name, config):
     pod_spec = {
         "version": 3,
-        "containers": [{
-            "name": app_name, 
-            "imageDetails": {"imagePath": config['discourse_image']},
-            "imagePullPolicy": "IfNotPresent",
-            "ports": [{
-                "containerPort": 3000,
-                "protocol": "TCP",
-            }],
-            "envConfig": create_discourse_pod_config(config),
-            "kubernetes": {
-                "readinessProbe": {
-                    "httpGet": {
-                        "path": "/srv/status",
-                        "port": 3000,
-                    }
-                }
-            },
-        }],
-        "kubernetesResources": {
-            "ingressResources": [
-                create_ingress_config(app_name, config)
-            ]
-        }
+        "containers": [
+            {
+                "name": app_name,
+                "imageDetails": {"imagePath": config['discourse_image']},
+                "imagePullPolicy": "IfNotPresent",
+                "ports": [{"containerPort": 3000, "protocol": "TCP",}],
+                "envConfig": create_discourse_pod_config(config),
+                "kubernetes": {"readinessProbe": {"httpGet": {"path": "/srv/status", "port": 3000}}},
+            }
+        ],
+        "kubernetesResources": {"ingressResources": [create_ingress_config(app_name, config)]},
     }
     # This handles when we are trying to get an image from a private
     # registry.
@@ -109,8 +86,7 @@ def check_for_config_problems(config):
 def check_for_missing_config_fields(config):
     missing_fields = []
 
-    needed_fields = ['db_user', 'db_password', 'db_host', 'db_name', 'smtp_address',
-                     'redis_host']
+    needed_fields = ['db_user', 'db_password', 'db_host', 'db_name', 'smtp_address', 'redis_host']
     for key in needed_fields:
         if len(config[key]) == 0:
             missing_fields.append(key)
@@ -163,8 +139,7 @@ class DiscourseCharm(CharmBase):
         if not self.state.is_started:
             return event.defer()
 
-        event.client.serve(hosts=[event.client.ingress_address],
-                           port=self.model.config['http_port'])
+        event.client.serve(hosts=[event.client.ingress_address], port=self.model.config['http_port'])
 
 
 if __name__ == '__main__':
diff --git a/tests/unit/requirements.txt b/tests/unit/requirements.txt
new file mode 100644
index 0000000..65431fc
--- /dev/null
+++ b/tests/unit/requirements.txt
@@ -0,0 +1,4 @@
+mock
+pytest
+pytest-cov
+pyyaml
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
new file mode 100644
index 0000000..56bd348
--- /dev/null
+++ b/tests/unit/test_charm.py
@@ -0,0 +1,25 @@
+import unittest
+import sys
+
+sys.path.append('src')  # noqa: E402
+
+from charm import create_ingress_config
+
+
+class TestDiscourseCharm(unittest.TestCase):
+    def test_create_ingress_config(self):
+        config = {
+            "external_hostname": "testhost",
+        }
+        expected = {
+            "name": "test-app-ingress",
+            "spec": {
+                "rules": [
+                    {
+                        "host": "testhost",
+                        "http": {"paths": [{"path": "/", "backend": {"serviceName": "test-app", "servicePort": 3000}}]},
+                    }
+                ]
+            },
+        }
+        self.assertEqual(create_ingress_config("test-app", config), expected)
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..0997650
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,48 @@
+[tox]
+skipsdist=True
+envlist = unit, functional
+
+[testenv]
+basepython = python3
+setenv =
+  PYTHONPATH = {toxinidir}/build/lib:{toxinidir}/build/venv
+
+[testenv:unit]
+commands =
+    pytest --ignore mod --ignore {toxinidir}/tests/functional \
+      {posargs:-v  --cov=src --cov-report=term-missing --cov-branch}
+deps = -r{toxinidir}/tests/unit/requirements.txt
+       -r{toxinidir}/requirements.txt
+setenv =
+  PYTHONPATH={toxinidir}/src:{toxinidir}/build/lib:{toxinidir}/build/venv
+  TZ=UTC
+
+[testenv:functional]
+passenv =
+  HOME
+  JUJU_REPOSITORY
+  PATH
+commands =
+	pytest -v --ignore mod --ignore {toxinidir}/tests/unit {posargs}
+deps = -r{toxinidir}/tests/functional/requirements.txt
+       -r{toxinidir}/requirements.txt
+
+[testenv:black]
+commands = black src/ tests/
+deps = black
+
+[testenv:lint]
+commands = flake8 src/ tests/
+# Pin flake8 to 3.7.9 to match focal
+deps =
+    flake8==3.7.9
+
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    .tox,
+# Ignore E231 because using black creates errors with this
+ignore = E231
+max-line-length = 120
+max-complexity = 10