Merge ~woutervb/snap-store-proxy-charm:SN-482 into snap-store-proxy-charm:master

[Wouter van Bommel]

Expose the port so the service is externally reachable

Fixes lp:1960762

diff --git a/src/charm.py b/src/charm.py
index 65eeb23..500e623 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -18,7 +18,7 @@ from ops.main import main
 from ops.model import ActiveStatus, BlockedStatus, MaintenanceStatus, ModelError
 
 from exceptions import ConfigException
-from helpers import all_config_options, configure_proxy, default_values
+from helpers import all_config_options, configure_proxy, default_values, open_port
 from optionvalidation import OptionValidation
 from resource_helpers import (
     create_database,
@@ -358,6 +358,9 @@ class SnapstoreProxyCharm(CharmBase):
             )
             return
 
+        # We are in a proper state, let's open the port
+        open_port(ssl=False)
+
         self.unit.status = ActiveStatus()
 
     def _on_update_status(self, _):
diff --git a/src/helpers.py b/src/helpers.py
index 07cf19c..7b440e6 100644
--- a/src/helpers.py
+++ b/src/helpers.py
@@ -3,7 +3,7 @@
 #
 import logging
 from pathlib import Path
-from subprocess import run
+from subprocess import check_call, run
 
 import yaml
 
@@ -57,4 +57,16 @@ def config_options():
     return type_dict, default_value
 
 
+def open_port(ssl=False):
+    # Based on charm-helpers open_port function, as this is not provided by
+    # the charm framework
+    if ssl:
+        port = 443
+    else:
+        port = 80
+
+    # Don't catch exceptions, just lett them pass on
+    check_call(["open-port", f"{port}/tcp"])
+
+
 all_config_options, default_values = config_options()
diff --git a/tests/test_charm.py b/tests/test_charm.py
index 6dc62f1..69f0ba6 100644
--- a/tests/test_charm.py
+++ b/tests/test_charm.py
@@ -390,7 +390,8 @@ class TestStatus(CharmTest):
         self.harness.charm._stored.password = "minions password"
         self.harness.charm._stored.registered = True
 
-        self.harness.charm.evaluate_status()
+        with patch("charm.open_port"):
+            self.harness.charm.evaluate_status()
 
         assert self.harness.charm.unit.status.message == ""
 
@@ -616,7 +617,7 @@ class TestSanity(CharmTest):
         self.harness.charm._stored.db_uri = "postgresql://user@host/database"
 
         # Since valid values will be pushed on to the proxy, we need to stub that here
-        with patch("charm.configure_proxy"):
+        with patch("charm.configure_proxy"), patch("charm.open_port"):
             # This should not result in a change, as none is not possible to be passed on
             self.harness.update_config({"username": None})
 
@@ -630,7 +631,7 @@ class TestSanity(CharmTest):
         self.harness.charm._stored.db_uri = "postgresql://user@host/database"
 
         # Since valid values will be pushed on to the proxy, we need to stub that here
-        with patch("charm.configure_proxy"):
+        with patch("charm.configure_proxy"), patch("charm.open_port"):
             self.harness.update_config({"password": None})
 
         assert self.harness.charm._stored.password == "Some value"
@@ -644,7 +645,7 @@ class TestSanity(CharmTest):
         self.harness.charm._stored.db_uri = "postgresql://user@host/database"
 
         # Since valid values will be pushed on to the proxy, we need to stub that here
-        with patch("charm.configure_proxy"):
+        with patch("charm.configure_proxy"), patch("charm.open_port"):
             self.harness.update_config({"domain": "http://my.super.domain"})
 
         assert self.harness.charm._stored.domain == "Some value"
diff --git a/tests/test_helpers.py b/tests/test_helpers.py
index 1e61b15..a62308c 100644
--- a/tests/test_helpers.py
+++ b/tests/test_helpers.py
@@ -1,5 +1,7 @@
 from unittest import mock
 
+import pytest
+
 import helpers
 
 
@@ -54,3 +56,11 @@ def test_config_options():
 
     for default_value_key in default_values.keys():
         assert default_value_key in [key for key in all_options.keys()]
+
+
[e-mail]("ssl,port", [(True, 443), (False, 80)])
+def test_open_port(ssl, port):
+    with mock.patch("helpers.check_call") as mocked_call:
+        helpers.open_port(ssl)
+
+    mocked_call.assert_called_once_with(["open-port", f"{port}/tcp"])