Merge ~jslarraz/review-tools:minor-improvements into review-tools:master

[Jorge Sancho Larraz]

adds some missing documentation and cleans up some unused environment variable and leftovers from https://git.launchpad.net/review-tools/commit/?id=f2c630c4f9025a91435ee9a60d93b382756c13e4

[Alex Murray (alexmurray)]

LGTM - thanks @jslarraz

review: Approve

diff --git a/bin/dump-tool b/bin/dump-tool
index 4a9658b..d42d8f0 100755
--- a/bin/dump-tool
+++ b/bin/dump-tool
@@ -146,7 +146,6 @@ def _write_json_db(db, fn, stdout=False):
 
 
 def main():
-    common.REPORT_OUTPUT = "console"
     parser = argparse.ArgumentParser(
         prog="dump-tool",
         formatter_class=argparse.RawDescriptionHelpFormatter,
diff --git a/bin/rock-check-notices b/bin/rock-check-notices
index 2b7303c..a550b1a 100755
--- a/bin/rock-check-notices
+++ b/bin/rock-check-notices
@@ -20,7 +20,6 @@ import os
 import sys
 from reviewtools import logger
 
-import reviewtools.common as common
 from reviewtools.common import (
     cmd,
     fetch_usn_db,
@@ -53,8 +52,6 @@ def main():
     )
     (args, argv) = parser.parse_known_args()
 
-    common.REPORT_OUTPUT = "console"
-
     # initialize variables
     initialize_environment_variables()
 
diff --git a/bin/rock-updates-available b/bin/rock-updates-available
index a6f12bf..1ec395d 100755
--- a/bin/rock-updates-available
+++ b/bin/rock-updates-available
@@ -43,12 +43,10 @@ import textwrap
 
 import reviewtools.available as available
 
-import reviewtools.common as common
 from reviewtools import logger
 
 
 def main():
-    common.REPORT_OUTPUT = "console"
     parser = argparse.ArgumentParser(
         prog="rock-updates-available",
         formatter_class=argparse.RawDescriptionHelpFormatter,
diff --git a/bin/snap-check-notices b/bin/snap-check-notices
index 81f2bc0..05535fb 100755
--- a/bin/snap-check-notices
+++ b/bin/snap-check-notices
@@ -20,7 +20,6 @@ import os
 import sys
 
 from reviewtools import logger
-import reviewtools.common as common
 from reviewtools.common import (
     cmd,
     fetch_usn_db,
@@ -52,8 +51,6 @@ def main():
     )
     (args, argv) = parser.parse_known_args()
 
-    common.REPORT_OUTPUT = "console"
-
     # initialize variables
     initialize_environment_variables()
 
diff --git a/bin/snap-updates-available b/bin/snap-updates-available
index 98e888a..27888ff 100755
--- a/bin/snap-updates-available
+++ b/bin/snap-updates-available
@@ -44,12 +44,10 @@ import textwrap
 
 import reviewtools.available as available
 
-import reviewtools.common as common
 from reviewtools import logger
 
 
 def main():
-    common.REPORT_OUTPUT = "console"
     parser = argparse.ArgumentParser(
         prog="snap-updates-available",
         formatter_class=argparse.RawDescriptionHelpFormatter,
diff --git a/bin/store-query b/bin/store-query
index 8d2d6fe..f971ab4 100755
--- a/bin/store-query
+++ b/bin/store-query
@@ -34,7 +34,6 @@ import re
 import requests
 import yaml
 
-import reviewtools.common as common
 from reviewtools import logger
 
 from reviewtools.sr_common import SnapReview
@@ -320,7 +319,6 @@ def _get_all_snap_declarations_by_id(snap_id):
 
 
 def main():
-    common.REPORT_OUTPUT = "console"
     parser = argparse.ArgumentParser(
         prog="store-query",
         formatter_class=argparse.RawDescriptionHelpFormatter,
diff --git a/reviewtools/common.py b/reviewtools/common.py
index 2b8472e..5de33ee 100644
--- a/reviewtools/common.py
+++ b/reviewtools/common.py
@@ -37,12 +37,8 @@ import yaml
 from reviewtools.overrides import common_external_symlink_override
 from reviewtools.report import Report
 
-REPORT_OUTPUT = "json"
-RESULT_TYPES = ["info", "warn", "error"]
-TMP_DIR = None
 MKDTEMP_PREFIX = "review-tools-"
 MKDTEMP_DIR = None
-VALID_SYSCALL = r"^[a-z0-9_]{2,64}$"
 # This needs to match up with snapcraft. Note, 'xz' is still the default
 # compression algorithm, and support for lzo has been added, but others
 # may be supported
@@ -77,9 +73,6 @@ UNSQUASHFS_IGNORED_ERRORS = [
 # under LXC
 AA_PROFILE_NAME_MAXLEN = 230  # 245 minus a bit for child profiles
 AA_PROFILE_NAME_ADVLEN = 100
-# Store enforces this length for snap v2
-STORE_PKGNAME_SNAPV2_MINLEN = 2
-STORE_PKGNAME_SNAPV2_MAXLEN = 40
 # Per noise: "07:33 < noise> jdstrand: yeah, i think 5GB compressed would be a
 # good/reasonable limit for now
 # https://forum.snapcraft.io/t/max-snap-size-and-getting-software-to-consumers/2913/2
diff --git a/reviewtools/containers/base_container.py b/reviewtools/containers/base_container.py
index 0759469..77853f8 100644
--- a/reviewtools/containers/base_container.py
+++ b/reviewtools/containers/base_container.py
@@ -7,7 +7,6 @@ from tempfile import mkdtemp
 
 from reviewtools.common import (
     MKDTEMP_PREFIX,
-    MKDTEMP_DIR,
     recursive_rm,
 )
 
@@ -75,7 +74,21 @@ class BaseContainer:
     _bin_files = None
 
     def __init__(self, fn):
-        self.tmp_dir = mkdtemp(prefix=MKDTEMP_PREFIX, dir=MKDTEMP_DIR)
+        """
+        Note:
+            This object will create a temporary copy of the provided container file.
+            Automatically created temporary files will be automatically cleaned up
+            on container object deletion.
+
+        Args:
+            fn (str): relative or absolute path to the container file.
+
+        Raises:
+            ContainerException: Calling this method will raise an exception
+                if the provided path does not exist or its basename does not
+                include an appropriate extension.
+        """
+        self.tmp_dir = mkdtemp(prefix=MKDTEMP_PREFIX)
         if os.path.isfile(fn):
             if os.path.basename(fn).count(".") == 0:
                 raise ContainerException("container filename must include an extension")
diff --git a/reviewtools/containers/squashfs_container.py b/reviewtools/containers/squashfs_container.py
index 9ebd26d..c113499 100644
--- a/reviewtools/containers/squashfs_container.py
+++ b/reviewtools/containers/squashfs_container.py
@@ -21,7 +21,7 @@ class SquashfsContainer(BaseContainer):
 
         Raises:
             ContainerException: This method will raise an exception if the
-            container file is not a squashfs container.
+                container file is not a squashfs container.
         """
         with open(self.filename, "rb") as f:
             header = f.read(10)
@@ -59,6 +59,8 @@ class SquashfsContainer(BaseContainer):
         the newly unpacked directory.
 
         Args:
+            items (list[str], optional): If not empty, it will only unpack files
+                included in the list.
             force (bool, optional): If ``True``, the unpack_dir will be overwritten
                 if it already exists. Defaults to ``False``