Merge ~barryprice/charm-k8s-discourse/+git/charm-k8s-discourse:v2.8.0.beta7-20.04 into charm-k8s-discourse:master

[Barry Price]

Run charmcraft fetch-lib to update our redis_k8s library, and add its missing path to our tests

Unmerged commits

28e3d00... by Barry Price on 2021-10-29

Run charmcraft fetch-lib to update our redis_k8s library, and add its missing path to our tests

7b1f859... by Barry Price on 2021-10-29

Add the libssl-dev dependency to our image, and explicitly install the bundler gem before attempting to use it (for all image types)

Reviewed-on: https://code.launchpad.net/~barryprice/charm-k8s-discourse/+git/charm-k8s-discourse/+merge/410992
Reviewed-by: Haw Loeung <email address hidden>

05c5a4d... by Barry Price on 2021-10-29

Add the libssl-dev dependency to our image, and explicitly install the bundler gem before attempting to use it (for all image types)

diff --git a/image/Dockerfile b/image/Dockerfile
index 24fb59a..8ae09bc 100644
--- a/image/Dockerfile
+++ b/image/Dockerfile
@@ -77,7 +77,7 @@ RUN cd ${CONTAINER_APP_ROOT}/app/plugins && git clone https://github.com/canonic
 RUN chown -R ${CONTAINER_APP_USERNAME}:${CONTAINER_APP_GROUP} ${CONTAINER_APP_ROOT}/app/plugins
 # Have to determine the gems needed and install them now, otherwise Discourse will
 # try to install them at runtime, which may not work due to network access issues.
-RUN cd ${CONTAINER_APP_ROOT}/app/plugins/discourse-saml && mkdir -p gems && chown ${CONTAINER_APP_USERNAME} gems && echo 'source "https://rubygems.org"' > Gemfile ; grep -e ^gem plugin.rb >> Gemfile && su -s /bin/bash -c '${CONTAINER_APP_ROOT}/app/bin/bundle install --gemfile=Gemfile --path=${CONTAINER_APP_ROOT}/app/plugins/discourse-saml/gems' ${CONTAINER_APP_USERNAME} && cd gems && ln -s ruby/* ./
+RUN cd ${CONTAINER_APP_ROOT}/app/plugins/discourse-saml && mkdir -p gems && chown ${CONTAINER_APP_USERNAME} gems && echo 'source "https://rubygems.org"' > Gemfile ; grep -e ^gem plugin.rb >> Gemfile && su -s /bin/bash -c 'gem install bundler' ${CONTAINER_APP_USERNAME} && su -s /bin/bash -c '${CONTAINER_APP_ROOT}/app/bin/bundle install --gemfile=Gemfile --path=${CONTAINER_APP_ROOT}/app/plugins/discourse-saml/gems' ${CONTAINER_APP_USERNAME} && cd gems && ln -s ruby/* ./
 RUN cd ${CONTAINER_APP_ROOT}/app && su -s /bin/bash -c 'bin/bundle install' ${CONTAINER_APP_USERNAME}
 
 RUN echo "markdown-saml image complete"
@@ -91,7 +91,7 @@ RUN cd ${CONTAINER_APP_ROOT}/app/plugins && git clone https://github.com/canonic
 RUN chown -R ${CONTAINER_APP_USERNAME}:${CONTAINER_APP_GROUP} ${CONTAINER_APP_ROOT}/app/plugins
 # Have to determine the gems needed and install them now, otherwise Discourse will
 # try to install them at runtime, which may not work due to network access issues.
-RUN cd ${CONTAINER_APP_ROOT}/app/plugins/discourse-saml && mkdir -p gems && chown ${CONTAINER_APP_USERNAME} gems && echo 'source "https://rubygems.org"' > Gemfile ; grep -e ^gem plugin.rb >> Gemfile && su -s /bin/bash -c '${CONTAINER_APP_ROOT}/app/bin/bundle install --gemfile=Gemfile --path=${CONTAINER_APP_ROOT}/app/plugins/discourse-saml/gems' ${CONTAINER_APP_USERNAME} && cd gems && ln -s ruby/* ./
+RUN cd ${CONTAINER_APP_ROOT}/app/plugins/discourse-saml && mkdir -p gems && chown ${CONTAINER_APP_USERNAME} gems && echo 'source "https://rubygems.org"' > Gemfile ; grep -e ^gem plugin.rb >> Gemfile && su -s /bin/bash -c 'gem install bundler' ${CONTAINER_APP_USERNAME} && su -s /bin/bash -c '${CONTAINER_APP_ROOT}/app/bin/bundle install --gemfile=Gemfile --path=${CONTAINER_APP_ROOT}/app/plugins/discourse-saml/gems' ${CONTAINER_APP_USERNAME} && cd gems && ln -s ruby/* ./
 RUN cd ${CONTAINER_APP_ROOT}/app && su -s /bin/bash -c 'bin/bundle install' ${CONTAINER_APP_USERNAME}
 
 RUN echo "markdown-saml-solved image complete"
diff --git a/image/build_scripts/build_app b/image/build_scripts/build_app
index d217f17..cb0f0e0 100755
--- a/image/build_scripts/build_app
+++ b/image/build_scripts/build_app
@@ -24,6 +24,7 @@ cd ${CONTAINER_APP_ROOT}/app
 
 # This must be done as the discourse user in order to avoid permission 
 # problems later.
+su -s /bin/bash -c 'gem install bundler' ${CONTAINER_APP_USERNAME} 
 su -s /bin/bash -c 'bin/bundle install' ${CONTAINER_APP_USERNAME} 
 
 # If intermediate files are generated by the build process or other files are
diff --git a/image/build_scripts/get_app_dependencies b/image/build_scripts/get_app_dependencies
index 65b267a..0c78012 100755
--- a/image/build_scripts/get_app_dependencies
+++ b/image/build_scripts/get_app_dependencies
@@ -12,6 +12,7 @@ apt-get install -y brotli \
                    jpegoptim \
                    libjpeg-turbo-progs \
                    libpq-dev \
+                   libssl-dev \
                    libxml2-dev \
                    libxslt1-dev \
                    libz-dev \
diff --git a/lib/charms/redis_k8s/v0/redis.py b/lib/charms/redis_k8s/v0/redis.py
index 70787b6..5360ce0 100644
--- a/lib/charms/redis_k8s/v0/redis.py
+++ b/lib/charms/redis_k8s/v0/redis.py
@@ -6,15 +6,29 @@ redis interface.
 Import `RedisRequires` in your charm by adding the following to `src/charm.py`:
 ```
 from charms.redis_k8s.v0.redis import RedisRequires
-
-# In your charm's `__init__` method.
+```
+And then in your charm's `__init__` method:
+```
+# Make sure you set redis_relation in StoredState. Assuming you refer to this
+# as `self._stored`:
+self._stored.set_default(redis_relation={})
 self.redis = RedisRequires(self, self._stored)
 ```
-And then wherever you need to reference the relation data:
+And then wherever you need to reference the relation data it will be available
+via StoredState:
 ```
+redis_hosts = []
 for redis_unit in self._stored.redis_relation:
-    redis_host = self._stored.redis_relation[redis_unit]["hostname"]
-    redis_port = self._stored.redis_relation[redis_unit]["port"]
+    redis_hosts.append({
+        "redis-host": self._stored.redis_relation[redis_unit]["hostname"],
+        "redis-port": self._stored.redis_relation[redis_unit]["port"],
+    })
+```
+You will also need to add the following to `metadata.yaml`:
+```
+requires:
+  redis:
+    interface: redis
 ```
 """
 import logging
@@ -22,30 +36,31 @@ import logging
 from ops.charm import CharmEvents
 from ops.framework import EventBase, EventSource, Object
 
-# The unique Charmhub library identifier, never change it
+# The unique Charmhub library identifier, never change it.
 LIBID = "fe18a608cec5465fa5153e419abcad7b"
 
-# Increment this major API version when introducing breaking changes
+# Increment this major API version when introducing breaking changes.
 LIBAPI = 0
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
-# to 0 if you are raising the major API version
-LIBPATCH = 1
+# to 0 if you are raising the major API version.
+LIBPATCH = 2
 
 logger = logging.getLogger(__name__)
 
 
 class RedisRelationUpdatedEvent(EventBase):
-    pass
+    """An event for the redis relation having been updated."""
 
 
 class RedisRelationCharmEvents(CharmEvents):
+    """A class to carry custom charm events so requires can react to relation changes."""
     redis_relation_updated = EventSource(RedisRelationUpdatedEvent)
 
 
 class RedisRequires(Object):
     def __init__(self, charm, _stored):
-        # Define a constructor that takes the charm and it's StoredState
+        """A class implementing the redis requires relation."""
         super().__init__(charm, "redis")
         self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
         self.framework.observe(charm.on.redis_relation_broken, self._on_relation_broken)
@@ -53,19 +68,20 @@ class RedisRequires(Object):
         self.charm = charm
 
     def _on_relation_changed(self, event):
+        """Handle the relation changed event."""
         if not event.unit:
             return
 
         hostname = event.relation.data[event.unit].get("hostname")
         port = event.relation.data[event.unit].get("port")
-        # Store some data from the relation in local state
         self._stored.redis_relation[event.relation.id] = {"hostname": hostname, "port": port}
 
         # Trigger an event that our charm can react to.
         self.charm.on.redis_relation_updated.emit()
 
     def _on_relation_broken(self, event):
-        # Remove the unit data from local state
+        """Handle the relation broken event."""
+        # Remove the unit data from local state.
         self._stored.redis_relation.pop(event.relation.id, None)
 
         # Trigger an event that our charm can react to.
@@ -74,23 +90,26 @@ class RedisRequires(Object):
 
 class RedisProvides(Object):
     def __init__(self, charm, port):
+        """A class implementing the redis provides relation."""
         super().__init__(charm, "redis")
         self.framework.observe(charm.on.redis_relation_changed, self._on_relation_changed)
         self._port = port
 
     def _on_relation_changed(self, event):
+        """Handle the relation changed event."""
         if not self.model.unit.is_leader():
             logger.debug("Relation changes ignored by non-leader")
             return
 
         event.relation.data[self.model.unit]['hostname'] = str(self._bind_address(event))
         event.relation.data[self.model.unit]['port'] = str(self._port)
-        # The reactive Redis charm exposes also 'password'. When tackling
+        # The reactive Redis charm also exposes 'password'. When tackling
         # https://github.com/canonical/redis-operator/issues/7 add 'password'
         # field so that it matches the exposed interface information from it.
         # event.relation.data[self.unit]['password'] = ''
 
     def _bind_address(self, event):
+        """Convenience function for getting the unit address."""
         relation = self.model.get_relation(event.relation.name, event.relation.id)
         if address := self.model.get_binding(relation).network.bind_address:
             return address
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index 2012479..95f8691 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -7,9 +7,12 @@ import copy
 import glob
 import mock
 import os
+import sys
 import unittest
 import yaml
 
+sys.path.insert(0, 'lib')
+
 from types import SimpleNamespace
 
 from charm import (