Merge ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:line-length-library into charm-k8s-ingress:master

[Tom Haddon]

Switch line length to 99 to match charmcraft defaults to make library imports less noisy for other projects

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

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

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

A CI job is currently in progress. A follow up comment will be added when it completes.

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

FAILED: Continuous integration, rev:ec6db29bf8ec86ded0e1224838a9f96839ee1471
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/43/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/is/job/lp-charm-test/83/
    None: https://jenkins.canonical.com/is/job/lp-update-mp/117731/

Click here to trigger a rebuild:
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/43//rebuild

review: Needs Fixing (continuous-integration)

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

Change successfully merged at revision 2beb4a6e66ac2dc2842f5c6e627afdea18d9b8f2

diff --git a/.flake8 b/.flake8
index 41512a8..8ef84fc 100644
--- a/.flake8
+++ b/.flake8
@@ -1,5 +1,5 @@
 [flake8]
-max-line-length = 120
+max-line-length = 99
 select: E,W,F,C,N
 exclude:
   venv
diff --git a/lib/charms/nginx_ingress_integrator/v0/ingress.py b/lib/charms/nginx_ingress_integrator/v0/ingress.py
index 066b257..688a77c 100644
--- a/lib/charms/nginx_ingress_integrator/v0/ingress.py
+++ b/lib/charms/nginx_ingress_integrator/v0/ingress.py
@@ -19,7 +19,8 @@ Import `IngressRequires` in your charm, with two required options:
     - session-cookie-max-age
     - tls-secret-name
 
-See [the config section](https://charmhub.io/nginx-ingress-integrator/configure) for descriptions of each, along with the required type.
+See [the config section](https://charmhub.io/nginx-ingress-integrator/configure) for descriptions
+of each, along with the required type.
 
 As an example, add the following to `src/charm.py`:
 ```
@@ -55,7 +56,7 @@ LIBAPI = 0
 
 # Increment this PATCH version before using `charmcraft publish-lib` or reset
 # to 0 if you are raising the major API version
-LIBPATCH = 4
+LIBPATCH = 5
 
 logger = logging.getLogger(__name__)
 
@@ -104,17 +105,24 @@ class IngressRequires(Object):
         """Check our config dict for errors."""
         blocked_message = "Error in ingress relation, check `juju debug-log`"
         unknown = [
-            x for x in self.config_dict if x not in REQUIRED_INGRESS_RELATION_FIELDS | OPTIONAL_INGRESS_RELATION_FIELDS
+            x
+            for x in self.config_dict
+            if x not in REQUIRED_INGRESS_RELATION_FIELDS | OPTIONAL_INGRESS_RELATION_FIELDS
         ]
         if unknown:
-            logger.error("Ingress relation error, unknown key(s) in config dictionary found: %s", ", ".join(unknown))
+            logger.error(
+                "Ingress relation error, unknown key(s) in config dictionary found: %s",
+                ", ".join(unknown),
+            )
             self.model.unit.status = BlockedStatus(blocked_message)
             return True
         if not update_only:
             missing = [x for x in REQUIRED_INGRESS_RELATION_FIELDS if x not in self.config_dict]
             if missing:
                 logger.error(
-                    "Ingress relation error, missing required key(s) in config dictionary: %s", ", ".join(missing))
+                    "Ingress relation error, missing required key(s) in config dictionary: %s",
+                    ", ".join(missing),
+                )
                 self.model.unit.status = BlockedStatus(blocked_message)
                 return True
         return False
@@ -168,12 +176,22 @@ class IngressProvides(Object):
         }
 
         missing_fields = sorted(
-            [field for field in REQUIRED_INGRESS_RELATION_FIELDS if ingress_data.get(field) is None]
+            [
+                field
+                for field in REQUIRED_INGRESS_RELATION_FIELDS
+                if ingress_data.get(field) is None
+            ]
         )
 
         if missing_fields:
-            logger.error("Missing required data fields for ingress relation: {}".format(", ".join(missing_fields)))
-            self.model.unit.status = BlockedStatus("Missing fields for ingress: {}".format(", ".join(missing_fields)))
+            logger.error(
+                "Missing required data fields for ingress relation: {}".format(
+                    ", ".join(missing_fields)
+                )
+            )
+            self.model.unit.status = BlockedStatus(
+                "Missing fields for ingress: {}".format(", ".join(missing_fields))
+            )
 
         # Create an event that our charm can use to decide it's okay to
         # configure the ingress.
diff --git a/src/charm.py b/src/charm.py
index ff69cea..954ab6e 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -35,7 +35,11 @@ def _fix_lp_1892255():
     """Workaround for lp:1892255."""
     # Remove os.environ.update when lp:1892255 is FIX_RELEASED.
     os.environ.update(
-        dict(e.split("=") for e in Path("/proc/1/environ").read_text().split("\x00") if "KUBERNETES_SERVICE" in e)
+        dict(
+            e.split("=")
+            for e in Path("/proc/1/environ").read_text().split("\x00")
+            if "KUBERNETES_SERVICE" in e
+        )
     )
 
 
@@ -226,7 +230,9 @@ class NginxIngressCharm(CharmBase):
             annotations["nginx.ingress.kubernetes.io/affinity"] = "cookie"
             annotations["nginx.ingress.kubernetes.io/affinity-mode"] = "balanced"
             annotations["nginx.ingress.kubernetes.io/session-cookie-change-on-failure"] = "true"
-            annotations["nginx.ingress.kubernetes.io/session-cookie-max-age"] = self._session_cookie_max_age
+            annotations[
+                "nginx.ingress.kubernetes.io/session-cookie-max-age"
+            ] = self._session_cookie_max_age
             annotations["nginx.ingress.kubernetes.io/session-cookie-name"] = "{}_AFFINITY".format(
                 self._service_name.upper()
             )
@@ -258,7 +264,9 @@ class NginxIngressCharm(CharmBase):
         self.k8s_auth()
         api = _core_v1_api()
         services = api.list_namespaced_service(namespace=self._namespace)
-        return [x.spec.cluster_ip for x in services.items if x.metadata.name == self._k8s_service_name]
+        return [
+            x.spec.cluster_ip for x in services.items if x.metadata.name == self._k8s_service_name
+        ]
 
     def _define_service(self):
         """Create or update a service in kubernetes."""
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index 8c1a286..58bb45a 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -43,7 +43,9 @@ class TestCharm(unittest.TestCase):
         self.assertEqual(_define_ingress.call_count, 1)
         self.assertEqual(_define_service.call_count, 1)
         # Confirm status is as expected.
-        self.assertEqual(self.harness.charm.unit.status, ActiveStatus('Ingress with service IP(s): 10.0.1.12'))
+        self.assertEqual(
+            self.harness.charm.unit.status, ActiveStatus('Ingress with service IP(s): 10.0.1.12')
+        )
         # And now test with leader is False.
         _define_ingress.reset_mock()
         _define_service.reset_mock()
@@ -245,8 +247,8 @@ class TestCharm(unittest.TestCase):
         with self.assertLogs(level="ERROR") as logger:
             self.harness.update_relation_data(relation_id, 'gunicorn', relations_data)
             msg = (
-                "ERROR:charms.nginx_ingress_integrator.v0.ingress:Missing required data fields for "
-                "ingress relation: service-hostname, service-port"
+                "ERROR:charms.nginx_ingress_integrator.v0.ingress:Missing required data fields "
+                "for ingress relation: service-hostname, service-port"
             )
             self.assertEqual(sorted(logger.output), [msg])
             # Confirm blocked status.
@@ -270,7 +272,9 @@ class TestCharm(unittest.TestCase):
     def test_get_k8s_ingress(self):
         """Test getting our definition of a k8s ingress."""
         self.harness.disable_hooks()
-        self.harness.update_config({"service-hostname": "foo.internal", "service-name": "gunicorn", "service-port": 80})
+        self.harness.update_config(
+            {"service-hostname": "foo.internal", "service-name": "gunicorn", "service-port": 80}
+        )
         expected = kubernetes.client.NetworkingV1beta1Ingress(
             api_version="networking.k8s.io/v1beta1",
             kind="Ingress",
@@ -357,7 +361,9 @@ class TestCharm(unittest.TestCase):
                     "nginx.ingress.kubernetes.io/affinity": "cookie",
                     "nginx.ingress.kubernetes.io/affinity-mode": "balanced",
                     "nginx.ingress.kubernetes.io/proxy-body-size": "20m",
-                    "nginx.ingress.kubernetes.io/proxy-next-upstream": "error timeout http_502 http_503",
+                    "nginx.ingress.kubernetes.io/proxy-next-upstream": (
+                        "error timeout http_502 http_503"
+                    ),
                     "nginx.ingress.kubernetes.io/rewrite-target": "/",
                     "nginx.ingress.kubernetes.io/session-cookie-change-on-failure": "true",
                     "nginx.ingress.kubernetes.io/session-cookie-max-age": "3600",
diff --git a/tox.ini b/tox.ini
index 7a39457..fcbf8f0 100644
--- a/tox.ini
+++ b/tox.ini
@@ -29,7 +29,7 @@ deps = -r{toxinidir}/tests/functional/requirements.txt
        -r{toxinidir}/requirements.txt
 
 [testenv:black]
-commands = black --skip-string-normalization --line-length=120 src/ tests/ lib/
+commands = black --skip-string-normalization --line-length=99 src/ tests/ lib/
 deps = black
 
 [testenv:lint]
@@ -45,5 +45,5 @@ exclude =
     .tox,
 # Ignore E231, W503 because using black creates errors with this
 ignore = E231, W503
-max-line-length = 120
+max-line-length = 99
 max-complexity = 10