Merge ~jfguedez/juju-lint:bug/1897262 into juju-lint:master

[Jose Guedez]

Add support for CMR applications (SAAS)

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

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

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

Change successfully merged at revision 4c8331f73b5fdc1927b30a265be8c88ac0e07426

diff --git a/contrib/canonical-rules.yaml b/contrib/canonical-rules.yaml
index 74b7c21..6c1a101 100644
--- a/contrib/canonical-rules.yaml
+++ b/contrib/canonical-rules.yaml
@@ -260,3 +260,11 @@ known charms:
  - *openstack-charms
  - *operations-charms
  - *kubernetes-charms
+
+saas:
+ - elasticsearch
+ - grafana
+ - graylog
+ - landscape-server
+ - nagios
+ - prometheus2
diff --git a/jujulint/lint.py b/jujulint/lint.py
index 5328723..6564ab3 100755
--- a/jujulint/lint.py
+++ b/jujulint/lint.py
@@ -63,6 +63,7 @@ class ModelInfo(object):
     """Represent information obtained from juju status data."""
 
     charms = attrib(default=attr.Factory(set))
+    cmr_apps = attrib(default=attr.Factory(set))
     app_to_charm = attrib(default=attr.Factory(dict))
     subs_on_machines = attrib(default=attr.Factory(dict))
     apps_on_machines = attrib(default=attr.Factory(dict))
@@ -668,6 +669,31 @@ class Linter:
             if not self.model.extraneous_subs[sub]:
                 del self.model.extraneous_subs[sub]
 
+    def check_charms_ops_mandatory(self, charm):
+        """
+        Check if a mandatory ops charms is present in the model.
+
+        First check if the charm is installed in the model, if not
+        then check the CMRs. If no errors, returns None
+        """
+        if charm in self.model.charms:
+            return None
+
+        rules_saas = self.lint_rules.get("saas", {})
+        for cmr_app in self.model.cmr_apps:
+            # the remote might not be called exactly as the charm, e.g. prometheus
+            # or prometheus2, so we naively check the beginning for a start.
+            if charm in rules_saas and charm.startswith(cmr_app):
+                return None
+
+        return {
+            "id": "ops-charm-missing",
+            "tags": ["missing", "ops", "charm", "mandatory", "principal"],
+            "description": "An Ops charm is missing",
+            "charm": charm,
+            "message": "Ops charm '{}' is missing".format(charm),
+        }
+
     def check_charms(self):
         """Check we recognise the charms which are in the model."""
         for charm in self.model.charms:
@@ -683,16 +709,9 @@ class Linter:
                 )
         # Then look for charms we require
         for charm in self.lint_rules["operations mandatory"]:
-            if charm not in self.model.charms:
-                self.handle_error(
-                    {
-                        "id": "ops-charm-missing",
-                        "tags": ["missing", "ops", "charm", "mandatory", "principal"],
-                        "description": "An Ops charm is missing",
-                        "charm": charm,
-                        "message": "Ops charm '{}' is missing".format(charm),
-                    }
-                )
+            error = self.check_charms_ops_mandatory(charm)
+            if error:
+                self.handle_error(error)
         if self.cloud_type == "openstack":
             for charm in self.lint_rules["openstack mandatory"]:
                 if charm not in self.model.charms:
@@ -861,6 +880,24 @@ class Linter:
                     }
                 )
 
+    def parse_cmr_apps(self, parsed_yaml):
+        """Parse the apps from cross-model relations."""
+        cmr_keys = (
+            "saas",  # Pattern used by juju export-bundle
+            "application-endpoints",  # Pattern used by jsfy
+            "remote-applications",  # Pattern used by libjuju (charm-lint-juju)
+        )
+
+        for key in cmr_keys:
+            if key in parsed_yaml:
+                for name in parsed_yaml[key]:
+                    self.model.cmr_apps.add(name)
+
+                    # Handle the special case of dependencies for graylog
+                    if name.startswith("graylog"):
+                        self.model.cmr_apps.add("elasticsearch")
+                return
+
     def map_machines_to_az(self, machines):
         """Map machines in the model to their availability zone."""
         for machine in machines:
@@ -1076,6 +1113,9 @@ class Linter:
             # Build a list of deployed charms and mapping of charms <-> applications
             self.map_charms(parsed_yaml[applications])
 
+            # Parse SAAS / remote-applications
+            self.parse_cmr_apps(parsed_yaml)
+
             # Check configuration
             self.check_configuration(parsed_yaml[applications])
 
diff --git a/tests/test_jujulint.py b/tests/test_jujulint.py
index cd41c58..78555ce 100644
--- a/tests/test_jujulint.py
+++ b/tests/test_jujulint.py
@@ -353,3 +353,75 @@ class TestLinter:
         assert errors[0]["id"] == "config-isset-check-true"
         assert errors[0]["application"] == "ubuntu"
         assert errors[0]["rule"] == "fake-opt"
+
+    def test_parse_cmr_apps_export_bundle(self, linter):
+        """Test the charm CMR parsing for bundles."""
+        parsed_yaml = {
+            "saas": {
+                "grafana": {"url": "foundations-maas:admin/lma.grafana"},
+                "nagios": {"url": "foundations-maas:admin/lma.nagios-monitors"},
+            }
+        }
+        linter.parse_cmr_apps(parsed_yaml)
+        assert linter.model.cmr_apps == {"grafana", "nagios"}
+
+    def test_parse_cmr_apps_jsfy(self, linter):
+        """Test the charm CMR parsing for juju status."""
+        parsed_yaml = {
+            "application-endpoints": {
+                "grafana": {"url": "foundations-maas:admin/lma.grafana"},
+                "nagios": {"url": "foundations-maas:admin/lma.nagios-monitors"},
+            }
+        }
+        linter.parse_cmr_apps(parsed_yaml)
+        assert linter.model.cmr_apps == {"grafana", "nagios"}
+
+    def test_parse_cmr_apps_libjuju(self, linter):
+        """Test the charm CMR parsing for libjuju."""
+        parsed_yaml = {
+            "remote-applications": {
+                "grafana": {"url": "foundations-maas:admin/lma.grafana"},
+                "nagios": {"url": "foundations-maas:admin/lma.nagios-monitors"},
+            }
+        }
+        linter.parse_cmr_apps(parsed_yaml)
+        assert linter.model.cmr_apps == {"grafana", "nagios"}
+
+    def test_check_charms_ops_mandatory_crm_success(self, linter):
+        """
+        Test the logic for checking ops mandatory charms provided via CMR.
+
+        The app is in the saas rules and has a CMR, no error is expected
+        """
+        linter.lint_rules["saas"] = ["grafana"]
+        linter.model.cmr_apps.add("grafana")
+        error = linter.check_charms_ops_mandatory("grafana")
+
+        assert error is None
+
+    def test_check_charms_ops_mandatory_crm_fail1(self, linter):
+        """
+        Test the logic for checking ops mandatory charms provided via CMR.
+
+        The app is not in the saas rules, should report an error
+        """
+        linter.model.cmr_apps.add("grafana")
+        error = linter.check_charms_ops_mandatory("grafana")
+
+        # The app is not in the rules, should report an error
+        assert error is not None
+        assert error["id"] == "ops-charm-missing"
+        assert error["charm"] == "grafana"
+
+    def test_check_charms_ops_mandatory_crm_fail2(self, linter):
+        """
+        Test the logic for checking ops mandatory charms provided via CMR.
+
+        The app is in the saas rules, but no CMR in place, should report error
+        """
+        linter.lint_rules["saas"] = ["grafana"]
+        error = linter.check_charms_ops_mandatory("grafana")
+
+        assert error is not None
+        assert error["id"] == "ops-charm-missing"
+        assert error["charm"] == "grafana"