Merge ~jslarraz/review-tools:remove-error-function-from-checks into review-tools:master

[Jorge Sancho Larraz]

Remove calls to common.error in favor of using exceptions. Those exceptions, if not handled earlier, will be catch by snap-review and added as runtime errors to the report. It allows us to generate the output in a more consistent format

[Alex Murray (alexmurray)]

LGTM - thanks @jslarraz

review: Approve

diff --git a/reviewtools/sr_common.py b/reviewtools/sr_common.py
index d4f74e7..f63b62d 100644
--- a/reviewtools/sr_common.py
+++ b/reviewtools/sr_common.py
@@ -21,13 +21,12 @@ import re
 from reviewtools.common import (
     ReviewBase,
     ReviewException,
-    error,
     read_snapd_base_declaration,
     unsquashfs_lln,
     unsquashfs_lln_parse,
     verify_type,
 )
-from reviewtools.containers.snap_container import SnapContainer, ContainerException
+from reviewtools.containers.snap_container import SnapContainer
 from reviewtools.overrides import interfaces_attribs_addons
 
 
@@ -394,23 +393,20 @@ class SnapReview(ReviewBase):
             return
         ReviewBase.__init__(self, review_type, overrides=overrides)
 
-        try:
-            self.snap = SnapContainer(fn)
-        except ContainerException as e:
-            error(str(e))
-
-        try:
-            self.snap_yaml = self.snap.get_file_as_yaml(
-                "meta/snap.yaml", yaml_version="1.1"
+        # Initialize the container class
+        self.snap = SnapContainer(fn)
+
+        # Get required files
+        self.snap_yaml = self.snap.get_file_as_yaml(
+            "meta/snap.yaml", yaml_version="1.1"
+        )
+        self.snap_manifest_yaml = {}
+        if "snap/manifest.yaml" in self.snap.files:
+            self.snap_manifest_yaml = self.snap.get_file_as_yaml(
+                "snap/manifest.yaml", yaml_version="1.1"
             )
-            self.snap_manifest_yaml = {}
-            if "snap/manifest.yaml" in self.snap.files:
-                self.snap_manifest_yaml = self.snap.get_file_as_yaml(
-                    "snap/manifest.yaml", yaml_version="1.1"
-                )
-        except ContainerException as e:
-            error(str(e))
 
+        # Read base declarations
         (
             self.base_declaration_series,
             self.base_declaration,
@@ -489,7 +485,7 @@ class SnapReview(ReviewBase):
             for iface in self.snap_yaml[k]:
                 if not isinstance(self.snap_yaml[k], dict):
                     # eg, top-level "plugs: [ content ]"
-                    error(
+                    raise Exception(
                         "Invalid top-level '%s' " "(not a dict)" % k
                     )  # pragma: nocover
                 if self.snap_yaml[k][iface] is None:
@@ -502,7 +498,7 @@ class SnapReview(ReviewBase):
         """Run unsquashfs -lln on a snap package"""
         (rc, out) = unsquashfs_lln(snap_pkg)
         if rc != 0:
-            error("Could not unsquashfs -lln failed")
+            raise Exception("Could not unsquashfs -lln failed")
         hdr, entries = unsquashfs_lln_parse(out)
         return hdr, entries
 
diff --git a/tests/test.sh.expected b/tests/test.sh.expected
index 36b209b..047537c 100644
--- a/tests/test.sh.expected
+++ b/tests/test.sh.expected
@@ -3229,31 +3229,23 @@ glance_ocata_amd64.snap: pass
 }
 
 =  hello-world_1.0.6_all.snap =
-{
-  "runtime-errors": {
-    "error": {
-      "msg": {
-        "manual_review": true,
-        "text": "Unsupported package format (not squashfs)"
-      }
-    },
-    "info": {},
-    "warn": {}
-  }
-}
+Errors
+------
+ - msg
+	Unsupported package format (not squashfs)
+hello-world_1.0.6_all.snap: RUNTIME ERROR
 
 = --sdk hello-world_1.0.6_all.snap =
+= runtime-errors =
 {
-  "runtime-errors": {
-    "error": {
-      "msg": {
-        "manual_review": true,
-        "text": "Unsupported package format (not squashfs)"
-      }
-    },
-    "info": {},
-    "warn": {}
-  }
+  "error": {
+    "msg": {
+      "manual_review": true,
+      "text": "Unsupported package format (not squashfs)"
+    }
+  },
+  "info": {},
+  "warn": {}
 }
 
 = --json hello-world_1.0.6_all.snap =
@@ -18017,31 +18009,23 @@ test-bad-desktop-file_1_all.snap: FAIL
 }
 
 =  test-bad-plugs_0_all.snap =
-{
-  "runtime-errors": {
-    "error": {
-      "msg": {
-        "manual_review": true,
-        "text": "Invalid top-level 'plugs' (not a dict)"
-      }
-    },
-    "info": {},
-    "warn": {}
-  }
-}
+Errors
+------
+ - msg
+	Invalid top-level 'plugs' (not a dict)
+test-bad-plugs_0_all.snap: RUNTIME ERROR
 
 = --sdk test-bad-plugs_0_all.snap =
+= runtime-errors =
 {
-  "runtime-errors": {
-    "error": {
-      "msg": {
-        "manual_review": true,
-        "text": "Invalid top-level 'plugs' (not a dict)"
-      }
-    },
-    "info": {},
-    "warn": {}
-  }
+  "error": {
+    "msg": {
+      "manual_review": true,
+      "text": "Invalid top-level 'plugs' (not a dict)"
+    }
+  },
+  "info": {},
+  "warn": {}
 }
 
 = --json test-bad-plugs_0_all.snap =