Merge ~ec0/juju-lint:fix-snap-and-better-errors into juju-lint:master

[James Hebden]

Fix the snap, as it was not including the actual juju-lint library.
Also add more and better error handling around running juju-lint without a configuration file.
Support both absolute and config-relative paths for lint rules.

[🤖 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 0a72707edef77d9e82b20fb36199a7baf43261c1

diff --git a/jujulint/cli.py b/jujulint/cli.py
index a75a7c3..68e7bb2 100755
--- a/jujulint/cli.py
+++ b/jujulint/cli.py
@@ -21,8 +21,10 @@ from jujulint.config import Config
 from jujulint.lint import Linter
 from jujulint.logging import Logger
 from jujulint.openstack import OpenStack
+import os.path
 import pkg_resources
 import yaml
+import sys
 
 
 class Cli:
@@ -35,9 +37,16 @@ class Cli:
         self.config = Config()
         self.logger = Logger(self.config["logging"]["loglevel"].get())
         self.version = pkg_resources.require("jujulint")[0].version
-        self.lint_rules = "{}/{}".format(
-            self.config.config_dir(), self.config["rules"]["file"].get()
-        )
+        rules_file = self.config["rules"]["file"].get()
+        # handle absolute path provided
+        if os.path.isfile(rules_file):
+            self.lint_rules = rules_file
+        elif os.path.isfile("{}/{}".format(self.config.config_dir(), rules_file)):
+            # default to relative path
+            self.lint_rules = "{}/{}".format(self.config.config_dir(), rules_file)
+        else:
+            self.logger.error("Cloud not locate rules file {}".format(rules_file))
+            sys.exit(1)
 
     def startup_message(self):
         """Print startup message to log."""
@@ -45,14 +54,20 @@ class Cli:
             (
                 "juju-lint version {} starting...\n"
                 "\t* Config directory: {}\n"
+                "\t* Rules file: {}\n"
                 "\t* Log level: {}\n"
             ).format(
                 self.version,
                 self.config.config_dir(),
+                self.lint_rules,
                 self.config["logging"]["loglevel"].get(),
             )
         )
 
+    def usage(self):
+        """Print program usage."""
+        self.config.parser.print_help()
+
     def audit_file(self, filename, cloud_type=None):
         """Directly audit a YAML file."""
         self.logger.debug("Starting audit of file {}".format(filename))
@@ -132,5 +147,7 @@ def main():
             cli.audit_file(manual_file, cloud_type=manual_type)
         else:
             cli.audit_file(manual_file)
-    else:
+    elif "clouds" in cli.config:
         cli.audit_all()
+    else:
+        cli.usage()
diff --git a/jujulint/config.py b/jujulint/config.py
index b4d1e1c..fb5497a 100644
--- a/jujulint/config.py
+++ b/jujulint/config.py
@@ -29,8 +29,8 @@ class Config(Configuration):
         """Wrap the initialisation of confuse's Configuration object providing defaults for our application."""
         super().__init__("juju-lint", __name__)
 
-        parser = ArgumentParser(description="Sanity check one or more Juju models")
-        parser.add_argument(
+        self.parser = ArgumentParser(description="Sanity check one or more Juju models")
+        self.parser.add_argument(
             "-l",
             "--log-level",
             type=str,
@@ -39,7 +39,7 @@ class Config(Configuration):
             help="The default log level, valid options are info, warn, error or debug",
             dest="logging.loglevel",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "-d",
             "--output-dir",
             type=str,
@@ -48,7 +48,7 @@ class Config(Configuration):
             help="The folder to use when saving gathered cloud data and lint reports.",
             dest="output.folder",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "--dump-state",
             type=str,
             help=(
@@ -57,14 +57,14 @@ class Config(Configuration):
             ),
             dest="output.dump",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "-c",
             "--config",
             default="lint-rules.yaml",
             help="File to read lint rules from. Defaults to `lint-rules.yaml`",
             dest="rules.file",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "manual-file",
             metavar="manual-file",
             nargs='?',
@@ -75,7 +75,7 @@ class Config(Configuration):
                 "Setting this disables collection of data from remote or local clouds configured via config.yaml."
             ),
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "-t",
             "--cloud-type",
             help=(
@@ -83,13 +83,13 @@ class Config(Configuration):
             ),
             dest="manual-type",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "-o",
             "--override-subordinate",
             dest="override.subordinate",
             help="override lint-rules.yaml, e.g. -o canonical-livepatch:all",
         )
-        parser.add_argument(
+        self.parser.add_argument(
             "--logfile",
             "-L",
             default=None,
@@ -97,5 +97,5 @@ class Config(Configuration):
             dest="logging.file",
         )
 
-        args = parser.parse_args()
+        args = self.parser.parse_args()
         self.set_args(args, dots=True)
diff --git a/jujulint/config_default.yaml b/jujulint/config_default.yaml
index 19cbe91..662df79 100644
--- a/jujulint/config_default.yaml
+++ b/jujulint/config_default.yaml
@@ -1,30 +1,24 @@
 ---
-clouds:
-  # an example local Juju-deployed OpenStack
-  cloud1:
-    type: openstack
-    access: local
+# clouds:
+#  an example local Juju-deployed OpenStack
+#  cloud1:
+#   type: openstack
+#   access: local
 
-  # an example remote Juju-deployed OpenStack
-  cloud2:
-    type: openstack
-    access: ssh
-    host: '[e-mail]'
+# an example remote Juju-deployed OpenStack
+#  cloud2:
+#   type: openstack
+#   access: ssh
+#   host: '[e-mail]'
 
-  # an exported bundle
-  yamlfile:
-    type: openstack
-    access: dump
-    file: 'export.yaml'
-
-  # an example remote Juju-deployed OpenStack where
-  # Juju controllers are registered under user 'juju-user
-  # in this example cloud, so we sudo to that user
-  cloud3:
-    type: openstack
-    access: ssh
-    host: '[e-mail]'
-    sudo: 'juju-user'
+# an example remote Juju-deployed OpenStack where
+# Juju controllers are registered under user 'juju-user
+# in this example cloud, so we sudo to that user
+#  cloud3:
+#   type: openstack
+#   access: ssh
+#   host: '[e-mail]'
+#   sudo: 'juju-user'
 
 logging:
   level: INFO
diff --git a/jujulint/lint.py b/jujulint/lint.py
index 92e56d6..a132541 100755
--- a/jujulint/lint.py
+++ b/jujulint/lint.py
@@ -19,6 +19,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 """Lint operations and rule processing engine."""
 import collections
+import os.path
 import pprint
 import re
 
@@ -84,30 +85,34 @@ class Linter:
 
     def read_rules(self):
         """Read and parse rules from YAML, optionally processing provided overrides."""
-        with open(self.filename, "r") as yaml_file:
-            self.lint_rules = yaml.safe_load(yaml_file)
-        if self.overrides:
-            for override in self.overrides.split("#"):
-                (name, where) = override.split(":")
-                self.logger.info(
-                    "[{}] [{}/{}] Overriding {} with {}".format(
-                        self.cloud_name,
-                        self.controller_name,
-                        self.model_name,
-                        name,
-                        where,
+        if os.path.isfile(self.filename):
+            with open(self.filename, "r") as yaml_file:
+                self.lint_rules = yaml.safe_load(yaml_file)
+            if self.overrides:
+                for override in self.overrides.split("#"):
+                    (name, where) = override.split(":")
+                    self.logger.info(
+                        "[{}] [{}/{}] Overriding {} with {}".format(
+                            self.cloud_name,
+                            self.controller_name,
+                            self.model_name,
+                            name,
+                            where,
+                        )
                     )
+                    self.lint_rules["subordinates"][name] = dict(where=where)
+            self.lint_rules["known charms"] = flatten_list(self.lint_rules["known charms"])
+            self.logger.debug(
+                "[{}] [{}/{}] Lint Rules: {}".format(
+                    self.cloud_name,
+                    self.controller_name,
+                    self.model_name,
+                    pprint.pformat(self.lint_rules),
                 )
-                self.lint_rules["subordinates"][name] = dict(where=where)
-        self.lint_rules["known charms"] = flatten_list(self.lint_rules["known charms"])
-        self.logger.debug(
-            "[{}] [{}/{}] Lint Rules: {}".format(
-                self.cloud_name,
-                self.controller_name,
-                self.model_name,
-                pprint.pformat(self.lint_rules),
             )
-        )
+            return True
+        self.logger.error("Rules file {} does not exist.".format(self.filename))
+        return False
 
     def process_subordinates(self, app_d, app_name):
         """Iterate over subordinates and run subordinate checks."""
diff --git a/setup.py b/setup.py
index 4190e7a..b6b3dc9 100644
--- a/setup.py
+++ b/setup.py
@@ -17,7 +17,6 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 """Setuptools packaging metadata for juju-lint."""
 
-import re
 import setuptools
 import warnings
 
@@ -28,9 +27,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name="jujulint",
-    use_scm_version={
-            "local_scheme": "node-and-date",
-    },
+    use_scm_version={"local_scheme": "node-and-date"},
     author="Canonical",
     author_email="[e-mail]",
     description="Linter for Juju models to compare deployments with configurable policy",
@@ -45,7 +42,7 @@ setuptools.setup(
         "Intended Audience :: System Administrators",
     ],
     python_requires=">=3.4",
-    py_modules=["jujulint"],
+    packages=["jujulint"],
     entry_points={"console_scripts": ["juju-lint=jujulint.cli:main"]},
     setup_requires=["setuptools_scm"],
 )
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
index b8bd6da..9ec50ef 100644
--- a/snap/snapcraft.yaml
+++ b/snap/snapcraft.yaml
@@ -22,6 +22,7 @@ parts:
     requirements:
       - requirements.txt
     source: .
+    source-type: git
     override-build: |
         snapcraftctl build
         echo "Version: $(python3 setup.py --version)"