Merge ~axino/mojo/+git/subordinates:axino into ~mojo-maintainers/mojo/+git/subordinates:master

[Junien F]

utils/juju.py : make already_related() properly detect a relation if the subordinate application name is different than the charm name

For example if telegraf is deployed as lp-telegraf and related

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

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

[Tom Haddon (mthaddon)]

One minor comment inline

[Tom Haddon (mthaddon)]

LGTM, thx.

review: Approve

diff --git a/add-relations b/add-relations
index 5bcd553..e71bc88 100755
--- a/add-relations
+++ b/add-relations
@@ -33,8 +33,6 @@ def main():
 
     applications = utils.juju.applications(applications_status, exclude)
 
-    nrpe_subordinates = utils.juju.nrpe_subordinates(applications_status)
-
     command = ['juju', 'relate']
 
     utils.relations.process_charms_to_relate(args, command, applications, applications_status)
diff --git a/tests/test_juju.py b/tests/test_juju.py
index d3a5e7d..4a84526 100644
--- a/tests/test_juju.py
+++ b/tests/test_juju.py
@@ -20,7 +20,8 @@ class TestUtilsJuju(unittest.TestCase):
                     'message': 'Ready',
                     'current': 'active'
                 },
-                'relations': {'nrpe-external-master': ['nrpe']},
+                'relations': {'nrpe-external-master': ['nrpe'],
+                              'juju-info': ['lp-telegraf']},
                 'units': {
                     'lp-mergebot/0': {
                         'juju-status': {
@@ -76,7 +77,24 @@ class TestUtilsJuju(unittest.TestCase):
                 'exposed': False,
                 'charm-rev': 0,
                 'series': 'xenial'
-            }
+            },
+            'lp-telegraf': {
+              'charm': 'cs:telegraf-41',
+              'series': 'focal',
+              'os': 'ubuntu',
+              'charm-origin': 'jujucharms',
+              'charm-name': 'telegraf',
+              'charm-rev': 41,
+              'charm-version': 'dec0633',
+              'exposed': False,
+              'application-status': {
+                  'current': 'active',
+                  'message': 'Monitoring fw-pc1/0 (source version/commit dec0633)',
+                  'since': '26 Apr 2021 20:58:50Z'
+              },
+              'relations': {'juju-info': ['lp-mergebot']},
+              'subordinate-to': ['lp-mergebot'],
+            },
         }
         self.juju2_2_4_landscape_livepatch_json_applications_status = {
             'nrpe': {
@@ -277,6 +295,9 @@ class TestUtilsJuju(unittest.TestCase):
                                                     'lp-mergebot', 'canonical-livepatch', 'juju-info'))
         self.assertFalse(utils.juju.already_related(self.juju2_2_3_no_landscape_livepatch_json_applications_status,
                                                     'lp-mergebot', 'landscape-client', 'juju-info'))
+        # Telegraf is related, but through a different application name
+        self.assertTrue(utils.juju.already_related(self.juju2_2_3_no_landscape_livepatch_json_applications_status,
+                                                    'lp-mergebot', 'telegraf', 'juju-info'))
 
 
 if __name__ == "__main__":
diff --git a/tests/testdata/juju2.2.3-no-landscape-livepatch.json b/tests/testdata/juju2.2.3-no-landscape-livepatch.json
index 19e59df..28cc4cf 100644
--- a/tests/testdata/juju2.2.3-no-landscape-livepatch.json
+++ b/tests/testdata/juju2.2.3-no-landscape-livepatch.json
@@ -1 +1 @@
-{"model":{"name":"is-mergebot-22","controller":"jenkins-ci-controller","cloud":"prodstack4.5","region":"bootstack-ps45","version":"2.2.3","model-status":{"current":"available","since":"11 Oct 2017 15:11:10Z"},"sla":"unsupported"},"machines":{"0":{"juju-status":{"current":"started","since":"11 Oct 2017 15:12:48Z","version":"2.2.3"},"dns-name":"10.25.63.217","ip-addresses":["10.25.63.217"],"instance-id":"9bfc2226-b39c-4d8b-94d9-6189f654184e","machine-status":{"current":"running","message":"ACTIVE","since":"11 Oct 2017 15:11:53Z"},"series":"xenial","network-interfaces":{"ens3":{"ip-addresses":["10.25.63.217"],"mac-address":"fa:16:3e:98:75:7f","is-up":true}},"hardware":"arch=amd64 cores=1 mem=2048M root-disk=10240M availability-zone=prodstack-zone-1"}},"applications":{"lp-mergebot":{"charm":"local:xenial/lp-mergebot-0","series":"xenial","os":"ubuntu","charm-origin":"local","charm-name":"lp-mergebot","charm-rev":0,"exposed":false,"application-status":{"current":"active","message":"Ready","since":"11 Oct 2017 15:13:55Z"},"relations":{"nrpe-external-master":["nrpe"]},"units":{"lp-mergebot/0":{"workload-status":{"current":"active","message":"Ready","since":"11 Oct 2017 15:13:55Z"},"juju-status":{"current":"idle","since":"11 Oct 2017 15:14:32Z","version":"2.2.3"},"leader":true,"machine":"0","public-address":"10.25.63.217","subordinates":{"nrpe/0":{"workload-status":{"current":"active","message":"ready","since":"11 Oct 2017 15:14:31Z"},"juju-status":{"current":"idle","since":"11 Oct 2017 15:14:31Z","version":"2.2.3"},"leader":true,"upgrading-from":"local:xenial/nrpe-0","public-address":"10.25.63.217"}}}}},"nrpe":{"charm":"local:xenial/nrpe-0","series":"xenial","os":"ubuntu","charm-origin":"local","charm-name":"nrpe","charm-rev":0,"exposed":false,"application-status":{"current":"active","message":"ready","since":"11 Oct 2017 15:14:31Z"},"relations":{"nrpe-external-master":["lp-mergebot"]},"subordinate-to":["lp-mergebot"]}}}
+{"model":{"name":"is-mergebot-22","controller":"jenkins-ci-controller","cloud":"prodstack4.5","region":"bootstack-ps45","version":"2.2.3","model-status":{"current":"available","since":"11 Oct 2017 15:11:10Z"},"sla":"unsupported"},"machines":{"0":{"juju-status":{"current":"started","since":"11 Oct 2017 15:12:48Z","version":"2.2.3"},"dns-name":"10.25.63.217","ip-addresses":["10.25.63.217"],"instance-id":"9bfc2226-b39c-4d8b-94d9-6189f654184e","machine-status":{"current":"running","message":"ACTIVE","since":"11 Oct 2017 15:11:53Z"},"series":"xenial","network-interfaces":{"ens3":{"ip-addresses":["10.25.63.217"],"mac-address":"fa:16:3e:98:75:7f","is-up":true}},"hardware":"arch=amd64 cores=1 mem=2048M root-disk=10240M availability-zone=prodstack-zone-1"}},"applications":{"lp-mergebot":{"charm":"local:xenial/lp-mergebot-0","series":"xenial","os":"ubuntu","charm-origin":"local","charm-name":"lp-mergebot","charm-rev":0,"exposed":false,"application-status":{"current":"active","message":"Ready","since":"11 Oct 2017 15:13:55Z"},"relations":{"juju-info": ["lp-telegraf"], "nrpe-external-master":["nrpe"]},"units":{"lp-mergebot/0":{"workload-status":{"current":"active","message":"Ready","since":"11 Oct 2017 15:13:55Z"},"juju-status":{"current":"idle","since":"11 Oct 2017 15:14:32Z","version":"2.2.3"},"leader":true,"machine":"0","public-address":"10.25.63.217","subordinates":{"nrpe/0":{"workload-status":{"current":"active","message":"ready","since":"11 Oct 2017 15:14:31Z"},"juju-status":{"current":"idle","since":"11 Oct 2017 15:14:31Z","version":"2.2.3"},"leader":true,"upgrading-from":"local:xenial/nrpe-0","public-address":"10.25.63.217"}}}}},"nrpe":{"charm":"local:xenial/nrpe-0","series":"xenial","os":"ubuntu","charm-origin":"local","charm-name":"nrpe","charm-rev":0,"exposed":false,"application-status":{"current":"active","message":"ready","since":"11 Oct 2017 15:14:31Z"},"relations":{"nrpe-external-master":["lp-mergebot"]},"subordinate-to":["lp-mergebot"]},"lp-telegraf":{"charm": "cs:telegraf-41","series": "focal","os": "ubuntu","charm-origin": "jujucharms","charm-name": "telegraf","charm-rev": 41,"charm-version": "dec0633","exposed": false,"application-status": {"current": "active","message": "Monitoring fw-pc1/0 (source version/commit dec0633)","since": "26 Apr 2021 20:58:50Z"},"relations": {"juju-info": ["lp-mergebot"]},"subordinate-to": ["lp-mergebot"]}}}
diff --git a/utils/juju.py b/utils/juju.py
index 239e09d..083e4f0 100644
--- a/utils/juju.py
+++ b/utils/juju.py
@@ -38,6 +38,12 @@ def nrpe_subordinates(applications_status):
 def already_related(applications_status, application, related_charm, relation):
     try:
         related = related_charm in applications_status[application]['relations'][relation]
+
+        # If the application name differs from the charm name, we need to be a little more clever
+        for related_app in applications_status[application]['relations'][relation]:
+            if related_charm == applications_status[related_app]['charm-name']:
+                related = True
+
     except KeyError:
         related = False
     return related