Added MyPy to CI configuration (addresses #165) (#170)

* added mypy to .travis.yml

* added missing imports flag

* fixed return type in TestSuiteCoverage.restricted_to_files

* add mypy files to gitignore

* added missing -> None for __init__ methods

* fixed Bug.to_dict -- mypy is awesome

* added missing type annotations

* increased Python version to 3.6

* fixed undefined var in FileLineSet.intersection

* fixed issues in fileline that were detected by mypy

* fixed inconsistent types in CLI module

* bug fix: added missing 'self.' in method call

* added missing restricted_to_files method to FileLineSet

* fixed bad type declaration

* fixed bad type declaration

* added missing __contains__ to TestCoverage

* bug fix: unref var

* fixed bad type declaration

* fixed type declarations

* tweaked test data structures

* tweaked Language properties

* suppress type warnings in compiler module

* ignore type warnings in soon-to-be-deprecated compiler module

* fixed bad type declaration

Author: ChrisTimperley

.gitignore

@@ -1,3 +1,4 @@
+.mypy_cache
 *.pyc
 
 .eggs

.travis.yml

@@ -3,9 +3,9 @@ sudo: required
 services:
 - docker
 python:
-- '3.5'
+- '3.6'
 install:
-- pip install sphinx
+- pip install sphinx mypy
 - pip install .
 script:
 - bugzoo -h
@@ -17,6 +17,7 @@ script:
 - bugzoo source list
 - bugzoo bug list
 - python3 test/test_manybugs.py
+- mypy bugzoo --ignore-missing-imports
 before_deploy:
 - "(cd docs && make html && cd _build/html && touch .nojekyll)"
 notifications:

bugzoo/cli/__init__.py

@@ -247,12 +247,12 @@ def launch(bz: 'BugZoo',
            bug_name: str,
            interactive: bool,
            network: Optional[str] = None,
-           tools: Optional[List[str]] = None,
-           volumes: Optional[List[str]] = None,
+           tool_names: Optional[List[str]] = None,
+           volume_args: Optional[List[str]] = None,
            command: Optional[str] = None,
            ) -> None:
-    volumes = __prepare_volumes(volumes)
-    tools = __prepare_tools(bz, tools)
+    volumes = __prepare_volumes(volume_args)
+    tools = __prepare_tools(bz, tool_names)
     bug = bz.bugs[bug_name]
 
     if network is None:

bugzoo/compiler/__init__.py

@@ -47,17 +47,17 @@ def from_dict(d: dict) -> 'Compiler':
         except KeyError:
             raise Exception("unsupported compiler type: {}".format(typ))
 
-        return cls.from_dict(d)
+        return cls.from_dict(d) # type: ignore
 
     def clean(self,
               manager_container,
-              container: 'Container',
+              container: 'Container', # type: ignore
               verbose: bool = False
               ) -> None:
         raise NotImplementedError
 
     def compile(self,
-                container: 'Container',
+                container: 'Container', # type: ignore
                 verbose: bool = False,
                 ) -> CompilationOutcome:
         """
@@ -67,7 +67,7 @@ def compile(self,
         raise NotImplementedError
 
     def compile_with_coverage_instrumentation(self,
-                                              container: 'Container',
+                                              container: 'Container', # type: ignore
                                               verbose: bool = False
                                               ) -> CompilationOutcome:
         """
@@ -122,7 +122,7 @@ def __init__(self,
 
     def __compile(self,
                   manager_container,
-                  container: 'Container',
+                  container: 'Container', # type: ignore
                   command: str,
                   verbose: bool
                   ) -> CompilationOutcome:
@@ -136,7 +136,7 @@ def __compile(self,
 
     def clean(self,
               manager_container,
-              container: 'Container',
+              container: 'Container', # type: ignore
               verbose: bool = False
               ) -> None:
         # if a context isn't given, use the source directory of the bug
@@ -147,19 +147,20 @@ def clean(self,
                                              stderr=True)
 
     # TODO decouple!
-    def compile(self,
+    def compile(self, # type: ignore
                 manager_container,
-                container: 'Container',
+                container: 'Container', # type: ignore
                 verbose: bool = False
                 ) -> CompilationOutcome:
         """
         See `Compiler.compile`
         """
         return self.__compile(manager_container, container, self.__command, verbose)
 
-    def compile_with_coverage_instrumentation(self,
+    def compile_with_coverage_instrumentation(self, # type: ignore
                                               manager_container,
-                                              container: 'Container',
+                                              container: 'Container', # type: ignore
+
                                               verbose: bool = False
                                               ) -> CompilationOutcome:
         """

bugzoo/core/bug.py

@@ -63,9 +63,10 @@ def to_dict(self) -> dict:
         serialised in a JSON or YAML format.
         """
         jsn = {
-            'uid': self.uid,
+            'name': self.name,
+            'image': self.image,
             'program': self.program,
-            'dataset': self.dataset.name if self.dataset else None,
+            'dataset': self.dataset,
             'languages': [l.name for l in self.__languages]
         }
         return jsn

bugzoo/core/build.py

@@ -22,7 +22,8 @@ def __init__(self,
                  filename: str,
                  arguments: Dict[str, str],
                  depends_on: Optional[str],
-                 source: Optional[str]):
+                 source: Optional[str]
+                 ) -> None:
         self.__root = root
         self.__tag = tag
         self.__context = context

bugzoo/core/container.py

@@ -20,7 +20,8 @@ class Container(object):
     def __init__(self,
                  uid: str,
                  bug: Bug,
-                 tools: List[str]):
+                 tools: List[str]
+                 ) -> None:
         """
         Constructs a container for a given bug.
 

bugzoo/core/coverage.py

@@ -40,7 +40,8 @@ def from_dict(d: dict) -> 'TestCoverage':
     def __init__(self,
                  test: str,
                  outcome: TestOutcome,
-                 coverage: FileLineSet):
+                 coverage: FileLineSet
+                 ) -> None:
         self.__test = test
         self.__outcome = outcome
         self.__coverage = coverage
@@ -52,6 +53,9 @@ def __repr__(self) -> str:
         s = "[{}: {}]\n{}".format(self.__test, status, coverage)
         return s
 
+    def __contains__(self, fileline: FileLine) -> bool:
+        return fileline in self.__coverage
+
     @property
     def test(self) -> str:
         """
@@ -80,14 +84,14 @@ def restricted_to_files(self, filenames: List[str]) -> 'TestCoverage':
         Returns a variant of this coverage that is restricted to a given list
         of files.
         """
-        return TestCoverage(test,
-                            outcome,
+        return TestCoverage(self.__test,
+                            self.__outcome,
                             self.__coverage.restricted_to_files(filenames))
 
     def to_dict(self) -> dict:
-        return {'test': self.test,
-                'outcome': self.outcome.to_dict(),
-                'coverage': self.coverage.to_dict()}
+        return {'test': self.__test,
+                'outcome': self.__outcome.to_dict(),
+                'coverage': self.__coverage.to_dict()}
 
 
 class TestSuiteCoverage(object):
@@ -109,7 +113,7 @@ def from_file(fn: str) -> 'TestSuiteCoverage':
             d = yaml.load(f)
             return TestSuiteCoverage.from_dict(d)
 
-    def __init__(self, test_coverage: Dict[str, TestCoverage]):
+    def __init__(self, test_coverage: Dict[str, TestCoverage]) -> None:
         self.__test_coverage = test_coverage
 
     def __repr__(self) -> str:
@@ -156,7 +160,7 @@ def to_dict(self) -> dict:
 
     def restricted_to_files(self,
                             filenames: List[str]
-                            ) -> 'ProjectCoverageMap':
+                            ) -> 'TestSuiteCoverage':
         """
         Returns a variant of this coverage that is restricted to a given list
         of files.
@@ -182,9 +186,9 @@ def passing(self) -> 'TestSuiteCoverage':
         Returns a variant of this coverage report that only contains coverage
         for failing test executions.
         """
-        return ProjectCoverageMap({t: cov \
-                                   for (t, cov) in self.__test_coverage.items() \
-                                   if cov.outcome.passed})
+        return TestSuiteCoverage({t: cov \
+                                  for (t, cov) in self.__test_coverage.items() \
+                                  if cov.outcome.passed})
 
     def __len__(self) -> int:
         """

bugzoo/core/errors.py

@@ -6,15 +6,16 @@ class BadManifestFile(BaseException):
     """
     Thrown when the server fails to parse a manifest file.
     """
-    def __init__(self, reason: str):
+    def __init__(self, reason: str) -> None:
         msg = "bad manifest file: {}".format(reason)
         super().__init__(msg)
 
+
 class UnexpectedStatusCode(BaseException):
     """
     Indicates that the API request produced an unexpected status code.
     """
-    def __init__(self, code: int):
+    def __init__(self, code: int) -> None:
         self.__code = code
         super().__init__("API request produced unexpected status code: {}".format(code))
 
@@ -30,7 +31,7 @@ class BugAlreadyBuilt(BaseException):
     """
     Indicates that the given bug has already been installed on the server.
     """
-    def __init__(self, name: str):
+    def __init__(self, name: str) -> None:
         self.__name = name
         super().__init__("bug already built: {}".format(name))
 
@@ -46,7 +47,7 @@ class BugNotFound(BaseException):
     """
     Indicates that no bug was found that matches the provided identifier.
     """
-    def __init__(self, name: str):
+    def __init__(self, name: str) -> None:
         self.__name = name
         super().__init__("no bug found with name: {}".format(name))
 
@@ -62,7 +63,7 @@ class SourceNotFoundWithURL(BaseException):
     """
     Indicates that no source has been found that matches a provided URL.
     """
-    def __init__(self, url: str):
+    def __init__(self, url: str) -> None:
         self.__url = url
         super().__init__("no source registered with URL: {}".format(url))
 
@@ -75,7 +76,7 @@ class SourceNotFoundWithName(BaseException):
     """
     Indicates that there exists no source registered with a given name.
     """
-    def __init__(self, name: str):
+    def __init__(self, name: str) -> None:
         self.__name = name
         super().__init__("no source registered with name: {}".format(name))
 
@@ -89,7 +90,7 @@ class SourceAlreadyRegisteredWithURL(BaseException):
     Indicates that there exists a source that is already registered with a
     given URL.
     """
-    def __init__(self, url: str):
+    def __init__(self, url: str) -> None:
         self.__url = url
         super().__init__("source already registered with URL: {}".format(url))
 
@@ -102,7 +103,7 @@ class NameInUseError(BaseException):
     """
     Indicates that a given name is already in use by another resource.
     """
-    def __init__(self, name: str):
+    def __init__(self, name: str) -> None:
         self.__name = name
         super().__init__("name already in use: {}".format(name))
 
@@ -115,9 +116,9 @@ class BugNotInstalledError(BaseException):
     """
     Indicates that a given bug hasn't been installed.
     """
-    def __init__(self, name: str):
+    def __init__(self, name: str) -> None:
         self.__name = name
-        super().__init__("bug not installed: {}".format(bug))
+        super().__init__("bug not installed: {}".format(name))
 
     @property
     def name(self) -> str:
@@ -133,7 +134,8 @@ class ImageBuildFailed(BaseException):
     """
     def __init__(self,
                  image_name: str,
-                 log: List[Dict[str, str]]):
+                 log: List[Dict[str, str]]
+                 ) -> None:
         self.__image_name = image_name
         self.__log = copy(log)
         msg = "failed to build image: {}".format(image_name)