Merge ~guoqiao/juju-lint:argparse into juju-lint:master

[Joe Guo]

jujulint.py: change optparse to argparse and improve

- optparse is deprecated by argparse, replace
- original usage info doesn't include positional args, remove and use argparse auto-generated one
- be explicit that input files should be juju status file other than bundle file
- be explicit that input files can be yaml or json(since json is subset of yaml and PyYAML can load json)
- use FileType for input files so argprarse will ensure files exist and open them
- show default value automatically in help

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

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

[Diko Parvanov (dparv)]

lgtm +1

review: Approve

[Tom Haddon (mthaddon)]

Leaving for other reviewers more actively involved in this project

review: Abstain

[James Hebden (ec0)]

Closing this out, as the configuration and argument parsing has been totally refactored.

review: Disapprove

Unmerged commits

4194653... by Joe Guo on 2020-01-23

jujulint.py: change optparse to argparse and improve

- optparse is deprecated by argparse, replace
- original usage info doesn't include positional args, remove and use argparse auto-generated one
- be explicit that input files should be juju status file other than bundle file
- be explicit that input files can be yaml or json(since json is subset of yaml and PyYAML can load json)
- use FileType for input files so argprarse will ensure files exist and open them
- show default value automatically in help

Signed-off-by: Joe Guo <email address hidden>

diff --git a/jujulint.py b/jujulint.py
index 47806f3..cf22439 100755
--- a/jujulint.py
+++ b/jujulint.py
@@ -20,7 +20,7 @@
 
 import collections
 import logging
-import optparse
+import argparse
 import pprint
 import re
 import sys
@@ -393,11 +393,10 @@ def check_azs(applications, model):
                 model.az_unbalanced_apps[app_name] = [num_units, az_counter]
 
 
-def lint(filename, lint_rules):
+def lint(juju_status_file, lint_rules):
     model = ModelInfo()
 
-    with open(filename, 'r') as infile:
-        j = yaml.safe_load(infile.read())
+    j = yaml.safe_load(juju_status_file.read())
 
     # Handle Juju 2 vs Juju 1
     applications = "applications"
@@ -427,30 +426,30 @@ def lint(filename, lint_rules):
 
 def init():
     """Initalization, including parsing of options."""
-
-    usage = """usage: %prog [OPTIONS]
-    Sanity check a Juju model"""
-    parser = optparse.OptionParser(usage)
-    parser.add_option("-c", "--config", default="lint-rules.yaml",
-                      help="File to read lint rules from. Defaults to `lint-rules.yaml`")
-    parser.add_option("-o", "--override-subordinate",
-                      dest="override",
-                      help="override lint-rules.yaml, e.g. -o canonical-livepatch:all")
-    parser.add_option("--loglevel", "-l", default='INFO',
-                      help="Log level. Defaults to INFO")
-    parser.add_option("--logfile", "-L", default=None,
-                      help="File to log to in addition to stdout")
-    (options, args) = parser.parse_args()
-
-    return (options, args)
+    parser = argparse.ArgumentParser(
+        description='Sanity check a Juju model',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter)
+    parser.add_argument("-c", "--config", default="lint-rules.yaml",
+                        help="File to read lint rules from")
+    parser.add_argument("-o", "--override-subordinate", dest="override",
+                        help="override lint-rules.yaml, e.g. -o canonical-livepatch:all")
+    parser.add_argument("-l", "--loglevel", default='INFO',
+                        help="Log level")
+    parser.add_argument("-L", "--logfile",
+                        help="File to log to in addition to stdout")
+    parser.add_argument("juju_status_files",
+                        metavar='JUJU_STATUS_FILE',
+                        type=argparse.FileType(), nargs='+',
+                        help="juju status file, yaml or json")
+    return parser.parse_args()
 
 
 def main():
-    (options, args) = init()
+    options = init()
     setup_logging(options.loglevel, options.logfile)
     lint_rules = read_rules(options)
-    for filename in args:
-        lint(filename, lint_rules)
+    for juju_status_file in options.juju_status_files:
+        lint(juju_status_file, lint_rules)
 
 
 if __name__ == "__main__":