add tox, pylint, flake8, jshint

Author: Jonathan Esterhazy

.gitignore

@@ -1 +1,3 @@
+__pycache__
+.tox/
 log.txt

.jshintrc

@@ -0,0 +1,3 @@
+{
+  "asi": true
+}

.pylintrc

@@ -0,0 +1,90 @@
+[MASTER]
+
+ignore=
+    tensorflow_serving
+
+[MESSAGES CONTROL]
+
+disable=
+    C, # convention
+    R, # refactor
+    too-many-arguments, # We should fix the offending ones soon.
+    too-many-lines, # Some files are too big, we should fix this too
+    too-few-public-methods,
+    too-many-instance-attributes,
+    too-many-locals,
+    len-as-condition, # Nice to have in the future
+    bad-indentation,
+    line-too-long, # We let Flake8 take care of this
+    logging-format-interpolation,
+    useless-object-inheritance, # We still support python2 so inheriting from object is ok
+    invalid-name,
+    import-error,
+    logging-not-lazy,
+    fixme,
+    no-self-use,
+    attribute-defined-outside-init,
+    protected-access,
+    invalid-all-object,
+    arguments-differ,
+    abstract-method,
+    signature-differs
+
+[REPORTS]
+# Set the output format. Available formats are text, parseable, colorized, msvs
+# (visual studio) and html
+output-format=colorized
+
+# Tells whether to display a full report or only the messages
+# CHANGE: No report.
+reports=no
+
+[FORMAT]
+# Maximum number of characters on a single line.
+max-line-length=100
+# Maximum number of lines in a module
+#max-module-lines=1000
+# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).
+indent-string='  '
+
+[BASIC]
+
+# Required attributes for module, separated by a comma
+#required-attributes=
+# List of builtins function names that should not be used, separated by a comma.
+# XXX: Should we ban map() & filter() for list comprehensions?
+# exit & quit are for the interactive interpreter shell only.
+# https://docs.python.org/3/library/constants.html#constants-added-by-the-site-module
+bad-functions=
+    apply,
+    exit,
+    input,
+    quit,
+
+[SIMILARITIES]
+# Minimum lines number of a similarity.
+min-similarity-lines=5
+# Ignore comments when computing similarities.
+ignore-comments=yes
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
+
+[VARIABLES]
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=_|unused_
+
+# List of additional names supposed to be defined in builtins. Remember that
+# you should avoid to define new builtins when possible.
+#additional-builtins=
+
+[LOGGING]
+# Apply logging string format checks to calls on these modules.
+logging-modules=
+    logging
+
+[TYPECHECK]
+ignored-modules=
+    distutils

README.md

@@ -30,9 +30,10 @@ development machine:
 
 For testing, you will also need:
 
-- [Python 3.5+](https://www.python.org/)
-- [pytest](https://docs.pytest.org/en/latest/)
-- The Python [requests](http://docs.python-requests.org/en/master/) library
+- [Python 3.6](https://www.python.org/)
+- [tox](https://tox.readthedocs.io/en/latest/)
+- [npm](https://npmjs.org/)
+- [jshint](https://jshint.com/about/)
 
 To test GPU images locally, you will also need:
 
@@ -97,11 +98,12 @@ Additional `curl` examples can be found in `./scripts/curl.sh`.
 
 ## Running the tests
 
-The package includes some automated unit and integration tests. These tests use Docker to run
-your image locally, and do not access resources in AWS. You can run them using `pytest`:
+The package includes automated tests and code checks. The tests use Docker to run the container 
+image locally, and do not access resources in AWS. You can run the tests and static code 
+checkers using `tox`:
 
 ```bash
-pytest ./test
+tox
 ```
 
 ## Contributing

container/sagemaker/serve.py

@@ -37,8 +37,8 @@ def __init__(self):
             low = int(parts[0])
             hi = int(parts[1])
             if low + 1 > hi:
-                raise ValueError('not enough ports available in SAGEMAKER_SAFE_PORT_RANGE ({})',
-                                 port_range)
+                raise ValueError('not enough ports available in SAGEMAKER_SAFE_PORT_RANGE ({})'
+                                 .format(port_range))
             self._tfs_grpc_port = str(low)
             self._tfs_rest_port = str(low + 1)
         else:
@@ -76,7 +76,7 @@ def _find_models(self):
         models = []
         for f in self._find_saved_model_files(base_path):
             parts = f.split('/')
-            if len(parts) >= 6 and re.match('^\d+$', parts[-2]):
+            if len(parts) >= 6 and re.match(r'^\d+$', parts[-2]):
                 model_path = '/'.join(parts[0:-2])
                 if model_path not in models:
                     models.append(model_path)
@@ -140,7 +140,7 @@ def _log_version(self, command, message):
         except subprocess.CalledProcessError:
             log.warning('failed to run command: %s', command)
 
-    def _stop(self, *args):
+    def _stop(self, *args):  # pylint: disable=W0613
         self._state = 'stopping'
         log.info('stopping services')
         try:

tox.ini

@@ -0,0 +1,66 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+skipsdist = True
+skip_missing_interpreters = False
+envlist = py36,flake8,pylint,jshint
+
+[flake8]
+max-line-length = 100
+exclude =
+    build/
+    .github/
+    .pytest_cache/
+    .git
+    .tox
+    tests/resources/
+max-complexity = 10
+ignore =
+    FI10,
+    FI12,
+    FI13,
+    FI14,
+    FI15,
+    FI16,
+    FI17,
+    FI50,
+    FI51,
+    FI52,
+    FI53,
+    FI54,
+    FI55,
+    FI56,
+    FI57,
+    W503
+
+require-code = True
+
+[testenv]
+# {posargs} can be passed in by additional arguments specified when invoking tox.
+# Can be used to specify which tests to run, e.g.: tox -- -s
+basepython = python3
+commands =
+    python -m pytest {posargs}
+deps =
+    pytest
+    requests
+
+[testenv:flake8]
+deps =
+    flake8
+commands = flake8 container/
+
+[testenv:pylint]
+deps =
+    pylint
+commands =
+    python -m pylint --rcfile=.pylintrc container/
+
+[testenv:jshint]
+whitelist_externals =
+    jshint
+commands =
+    jshint container/