Merge ~gabrielcocenza/juju-lint:bug/1979542 into juju-lint:master

[Gabriel Cocenza]

unit tests to check if rules file on contrib folder load correctly.

- fixed broken rules

Closes-Bug: #1979542

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

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

[Eric Chen (eric-chen)]

LGTM, but let's merge it after Martin's big unit test MR

[Eric Chen (eric-chen)]

review: Approve

[Eric Chen (eric-chen)]

Last thing: Please rebase and provide the log of lint/unit/func test, thanks!

review: Needs Information

[Gabriel Cocenza (gabrielcocenza)]

Rebased and here is the pastebin for lint, unit and func tests [0]

[0] https://pastebin.canonical.com/p/K8T2VwmDzQ/

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

Change successfully merged at revision 03479fa387c011076bdfaa39227f837f6e48fd89

diff --git a/contrib/includes/operations/bionic.yaml b/contrib/includes/operations/bionic.yaml
index a6baf9e..1e37975 100644
--- a/contrib/includes/operations/bionic.yaml
+++ b/contrib/includes/operations/bionic.yaml
@@ -1,2 +1,5 @@
 operations openstack mandatory series: &operations-openstack-mandatory-series
  - prometheus-ceph-exporter
+# compatability with new fields of fcb rules
+operations openstack mandatory release: &operations-openstack-mandatory-release []
+openstack loadbalancer: &openstack-loadbalancer []
diff --git a/contrib/includes/operations/focal.yaml b/contrib/includes/operations/focal.yaml
index d658661..f7b3f73 100644
--- a/contrib/includes/operations/focal.yaml
+++ b/contrib/includes/operations/focal.yaml
@@ -1 +1,5 @@
 operations openstack mandatory series: &operations-openstack-mandatory-series []
+# compatability with new fields of fcb rules
+operations openstack mandatory release: &operations-openstack-mandatory-release []
+openstack loadbalancer: &openstack-loadbalancer
+  - openstack-loadbalancer
diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py
index d82193d..a70ef63 100644
--- a/tests/unit/conftest.py
+++ b/tests/unit/conftest.py
@@ -10,6 +10,7 @@
 
 import os
 import sys
+from pathlib import Path
 from unittest.mock import MagicMock
 
 import mock
@@ -220,3 +221,11 @@ def patch_cloud_init(mocker):
     mocker.patch.object(cloud, "Logger")
     mocker.patch.object(cloud, "Connection")
     mocker.patch.object(cloud.socket, "getfqdn", return_value="localhost")
+
+
[e-mail]
+def rules_files():
+    """Get all standard rules files that comes with the snap."""
+    return [
+        str(rule.resolve()) for rule in Path("./contrib").iterdir() if rule.is_file()
+    ]
diff --git a/tests/unit/test_jujulint.py b/tests/unit/test_jujulint.py
index 6c611f6..4394835 100644
--- a/tests/unit/test_jujulint.py
+++ b/tests/unit/test_jujulint.py
@@ -5,6 +5,7 @@ from datetime import datetime, timezone
 from unittest import mock
 
 import pytest
+import yaml
 
 from jujulint import check_spaces, lint
 
@@ -874,6 +875,26 @@ applications:
         assert linter.lint_rules == {"key": "value"}
         assert result
 
+    def test_snap_rules_files(self, rules_files, linter):
+        """Ensure that all standard rules in the snap is loading correctly."""
+        for rule_file in rules_files:
+            try:
+                linter.filename = rule_file
+                linter.read_rules()
+            except yaml.YAMLError:
+                pytest.fail(f"File: {rule_file} not loading")
+
+    def test_wrong_rule_file_raise_error(self, rules_files, linter, mocker):
+        """Test that bad formatted rules raise YAMLError."""
+        rules_file = rules_files[0]
+        linter.filename = rules_file
+        mocker.patch(
+            "jujulint.lint.Linter._process_includes_in_rules",
+            side_effect=yaml.YAMLError,
+        )
+        with pytest.raises(yaml.YAMLError):
+            linter.read_rules()
+
     def test_read_rules_include(self, linter, tmp_path):
         """Test that rules YAML with an include is imported as expected."""
         include_path = tmp_path / "include.yaml"