Added instrument parameter to coverage methods (#224)

* added rebuild argument to client container coverage method

* added rebuild arg to server

* implemented instrument flag in container coverage method

Author: ChrisTimperley

bugzoo/client/container.py

@@ -182,12 +182,23 @@ def test(self,
         self.__api.handle_erroneous_response(r)
 
     def coverage(self,
-                 container: Container
+                 container: Container,
+                 *,
+                 instrument: bool = True
                  ) -> TestSuiteCoverage:
+        """
+        Computes complete test suite coverage for a given container.
+
+        Parameters:
+            container: the container for which coverage should be computed.
+            rebuild: if set to True, the program will be rebuilt before
+                coverage is computed.
+        """
         uid = container.uid
         logger.info("Fetching coverage information for container: %s",
                     uid)
-        r = self.__api.post('containers/{}/coverage'.format(uid))
+        r = self.__api.post('containers/{}/coverage'.format(uid),
+                            params={'instrument': instrument})
         if r.status_code == 200:
             jsn = r.json()
             coverage = TestSuiteCoverage.from_dict(jsn)  # type: ignore

bugzoo/mgr/container.py

@@ -340,6 +340,8 @@ def coverage(self,
                  container: Container,
                  tests: Optional[List[TestCase]] = None,
                  files_to_instrument: List[str] = None,
+                 *,
+                 instrument: bool =  True
                  ) -> TestSuiteCoverage:
         """
         Computes line coverage information over a provided set of tests for
@@ -348,7 +350,8 @@ def coverage(self,
         mgr = self.__installation.coverage
         return mgr.coverage(container,
                             tests,
-                            files_to_instrument=files_to_instrument)
+                            files_to_instrument=files_to_instrument,
+                            instrument=True)
 
     def execute(self,
                 container: Container,

bugzoo/mgr/coverage.py

@@ -135,6 +135,8 @@ def coverage(self,
                  container: Container,
                  tests: Optional[List[TestCase]] = None,
                  files_to_instrument: List[str] = None,
+                 *,
+                 instrument: bool = True
                  ) -> TestSuiteCoverage:
         """
         Uses a provided container to compute line coverage information for a
@@ -149,8 +151,9 @@ def coverage(self,
             _tests = tests
 
         try:
-            self.instrument(container,
-                            files_to_instrument=files_to_instrument)
+            if instrument:
+                self.instrument(container,
+                                files_to_instrument=files_to_instrument)
         except Exception:
             raise FailedToComputeCoverage("failed to instrument container.")
 

bugzoo/server/__init__.py

@@ -227,8 +227,13 @@ def coverage_container(id_container: str):
     except KeyError:
         return BugNotFound(container.bug), 500
 
+    instrument = \
+        flask.request.args.get('instrument', 'True').lower() == 'yes'
+
     try:
-        coverage = daemon.containers.coverage(container)
+        # FIXME implement
+        coverage = daemon.containers.coverage(container,
+                                              instrument=instrument)
     except Exception as err:
         logger.exception("failed to compute coverage for container [%s]: %s",
                      id_container, err)