Merge pull request #19 from cqse/project_subpath_option

Project Subpath Option

Author: AnonymFx

teamscale_precommit_client/precommit_client.py

@@ -19,6 +19,7 @@
 
 # Filename of the precommit configuration. The client expects this config file at the root of the repository.
 PRECOMMIT_CONFIG_FILENAME = '.teamscale-precommit.config'
+DEFAULT_PROJECT_SUBPATH = ''
 DEFAULT_PATH_PREFIX = ''
 
 
@@ -27,17 +28,20 @@ class PrecommitClient:
     # Number of seconds the client waits until fetching precommit results from the server.
     PRECOMMIT_WAITING_TIME_IN_SECONDS = 2
 
-    def __init__(self, teamscale_config, repository_path, path_prefix=DEFAULT_PATH_PREFIX, analyzed_file=None,
-                 verify=True,
-                 omit_links_to_findings=False, exclude_findings_in_changed_code=False, fetch_existing_findings=False,
-                 fetch_all_findings=False, fetch_existing_findings_in_changes=False, fail_on_red_findings=False,
-                 log_to_stderr=False):
+    def __init__(self, teamscale_config, repository_path, path_prefix=DEFAULT_PATH_PREFIX, project_subpath='',
+                 analyzed_file=None,
+                 verify=True, omit_links_to_findings=False, exclude_findings_in_changed_code=False,
+                 fetch_existing_findings=False, fetch_all_findings=False, fetch_existing_findings_in_changes=False,
+                 fail_on_red_findings=False, log_to_stderr=False):
         """Constructor"""
         self.teamscale_client = TeamscaleClient(teamscale_config.url, teamscale_config.username,
                                                 teamscale_config.access_token, teamscale_config.project_id, verify)
         self.repository_path = repository_path
+
         # calling os.path.join ensures a tailing '/'
         self.path_prefix = os.path.join(path_prefix, '')
+        self.project_subpath = os.path.join(project_subpath, '')
+
         self.analyzed_file = analyzed_file
         self.omit_links_to_findings = omit_links_to_findings
         self.exclude_findings_in_changed_code = exclude_findings_in_changed_code
@@ -110,21 +114,36 @@ def _upload_precommit_data(self):
         self.teamscale_client.branch = self.current_branch
 
         print("Uploading changes on branch '%s' in '%s'..." % (self.current_branch, self.repository_path))
-        changed_files_with_path_prefix = self._apply_path_prefix_to_changed_files()
-        deleted_files_with_path_prefix = self._apply_path_prefix_to_deleted_files()
+
+        changed_files_in_project = self._filter_changed_files_in_project_subpath(self.changed_files)
+        deleted_files_in_project = self._filter_deleted_files_in_project_subpath(self.deleted_files)
+
+        changed_files_with_path_prefix = self._apply_path_prefix_to_changed_files(changed_files_in_project)
+        deleted_files_with_path_prefix = self._apply_path_prefix_to_deleted_files(deleted_files_in_project)
+
         precommit_data = PreCommitUploadData(uniformPathToContentMap=changed_files_with_path_prefix,
                                              deletedUniformPaths=deleted_files_with_path_prefix)
         self.teamscale_client.upload_files_for_precommit_analysis(
             datetime.datetime.fromtimestamp(self.parent_commit_timestamp), precommit_data)
 
-    def _apply_path_prefix_to_changed_files(self):
+    def _filter_changed_files_in_project_subpath(self, uniform_path_content_map):
+        project_files_map = {}
+        for key in uniform_path_content_map.keys():
+            if key.startswith(self.project_subpath):
+                project_files_map[key] = uniform_path_content_map[key]
+        return project_files_map
+
+    def _filter_deleted_files_in_project_subpath(self, deleted_files):
+        return list(filter(lambda path: path.startswith(self.project_subpath), deleted_files))
+
+    def _apply_path_prefix_to_changed_files(self, changed_files):
         map_with_prefixes = {}
-        for key in self.changed_files.keys():
-            map_with_prefixes[self.path_prefix + key] = self.changed_files[key]
+        for key in changed_files.keys():
+            map_with_prefixes[self.path_prefix + key] = changed_files[key]
         return map_with_prefixes
 
-    def _apply_path_prefix_to_deleted_files(self):
-        return list(map(lambda path: self.path_prefix + path, self.deleted_files))
+    def _apply_path_prefix_to_deleted_files(self, deleted_files):
+        return list(map(lambda path: self.path_prefix + path, deleted_files))
 
     def _wait_and_get_precommit_result(self):
         """Gets the current precommit results. Waits synchronously until server is ready. """
@@ -143,9 +162,18 @@ def _print_findings(self, message, findings, branch):
 
         self._print('', log_to_stderr)
         self._print(message, log_to_stderr)
-        for formatted_finding in self._format_findings(findings, branch):
+
+        findings_without_path_prefix = list(
+            map(lambda finding: self._copy_finding_without_path_prefix(finding), findings))
+
+        findings_in_project = self._remove_findings_outside_project_subpath(findings_without_path_prefix)
+
+        for formatted_finding in self._format_findings(findings_in_project, branch):
             self._print(formatted_finding, log_to_stderr)
 
+    def _remove_findings_outside_project_subpath(self, findings):
+        return list(filter(lambda finding: finding.uniformPath.startswith(self.project_subpath), findings))
+
     @staticmethod
     def _print(message, print_to_err=False):
         if print_to_err:
@@ -199,9 +227,7 @@ def _format_findings(self, findings, branch):
         if len(findings) == 0:
             return ['> No findings.']
 
-        findings_without_path_prefix = list(
-            map(lambda finding: self._copy_finding_without_path_prefix(finding), findings))
-        sorted_findings = sorted(findings_without_path_prefix)
+        sorted_findings = sorted(findings)
         return [self._format_message(finding) for finding in sorted_findings]
 
     def _format_message(self, finding):
@@ -271,6 +297,9 @@ def _parse_args():
     parser.add_argument('--log-to-stderr', dest='log_to_stderr', action='store_true',
                         help='When this option is set, any finding will be logged to stderr instead of stdout: '
                              '(default: False)')
+    parser.add_argument('--project-subpath', metavar='project-subpath', type=str, default=DEFAULT_PROJECT_SUBPATH,
+                        help='Project path relative to the git repository. '
+                             'Pre-commit analysis will only be performed for files under this path.')
     parser.add_argument('--path-prefix', metavar='PATH_PREFIX', type=str,
                         help='Path prefix on Teamscale as configured with "Prepend repository identifier" or '
                              '"Path prefix transformation". Please use "/" to separate folders.',
@@ -294,7 +323,7 @@ def _configure_precommit_client(parsed_args):
     config_file = os.path.join(repo_path, PRECOMMIT_CONFIG_FILENAME)
     config = get_teamscale_client_configuration(config_file)
     return PrecommitClient(config, repository_path=repo_path, path_prefix=parsed_args.path_prefix,
-                           analyzed_file=path_to_file_in_repo,
+                           project_subpath=parsed_args.project_subpath, analyzed_file=path_to_file_in_repo,
                            verify=parsed_args.verify, omit_links_to_findings=parsed_args.omit_links_to_findings,
                            exclude_findings_in_changed_code=parsed_args.exclude_findings_in_changed_code,
                            fetch_existing_findings=parsed_args.fetch_existing_findings,

tests/precommit_test.py

@@ -1,9 +1,12 @@
+import os
 import re
 import sys
 from io import StringIO
 
 import responses
 
+from teamscale_precommit_client.precommit_client import DEFAULT_PROJECT_SUBPATH
+
 # The mock package is only available from Python 3.3 onwards. Thank you, Python.
 if sys.version_info >= (3, 3):
     from unittest.mock import Mock
@@ -136,6 +139,50 @@ def test_get_added_and_existing_findings_in_changes_for_changes(self):
         self.assert_findings_ids(self.precommit_client.findings_in_changed_code, [])
         self.assert_findings_ids(self.precommit_client.existing_findings, [4, 5, 6, 7])
 
+    @responses.activate
+    def test_only_upload_files_in_project_subpath(self):
+        project_subpath = 'project'
+        path_outside_project = 'another_path'
+
+        changed_file_in_project = os.path.join(project_subpath, ANALYZED_FILE_NAME)
+        changed_file_outside_project = os.path.join(path_outside_project, ANALYZED_FILE_NAME)
+        deleted_file_in_project = os.path.join(project_subpath, DELETED_FILE_NAME)
+        deleted_file_outside_project = os.path.join(path_outside_project, DELETED_FILE_NAME)
+
+        self.precommit_client = self._get_precommit_client(
+            {changed_file_in_project: '',
+             changed_file_outside_project: ''},
+            [deleted_file_in_project, deleted_file_outside_project],
+            project_subpath=project_subpath)
+        self.mock_precommit_findings_churn()
+
+        self.precommit_client.run()
+
+        precommit_request = next(call.request for call in responses.calls if call.request.method == 'PUT')
+
+        self.assertIn(changed_file_in_project, precommit_request.body)
+        self.assertNotIn(changed_file_outside_project, precommit_request.body)
+        self.assertIn(deleted_file_in_project, precommit_request.body)
+        self.assertNotIn(deleted_file_outside_project, precommit_request.body)
+
+    @responses.activate
+    def test_only_print_findings_in_project_subpath(self):
+        project_subpath = 'project'
+
+        self.precommit_client = self._get_precommit_client(self._get_no_changed_files(), self._get_no_deleted_files(),
+                                                           project_subpath=project_subpath, fetch_all_findings=True)
+        # The mocked finding does not have the project sub-path
+        self.mock_existing_findings(CURRENT_BRANCH, [1])
+
+        captured_output = StringIO()
+        sys.stdout = captured_output
+
+        self.precommit_client.run()
+
+        # We only mocked one finding which is not located under the project sub-path,
+        # so we expect it to be removed in the output
+        self.assertNotIn(ANALYZED_FILE_NAME, captured_output.getvalue())
+
     @responses.activate
     def test_adding_path_prefix(self):
         path_prefix = 'prefix'
@@ -202,15 +249,17 @@ def get_project_service_mock(service_id, branch=''):
 
     @staticmethod
     def _get_precommit_client(changed_files, deleted_files, path_prefix=DEFAULT_PATH_PREFIX,
-                              fetch_existing_findings=False,
-                              fetch_existing_findings_in_changes=False):
+                              project_subpath=DEFAULT_PROJECT_SUBPATH, fetch_existing_findings=False,
+                              fetch_existing_findings_in_changes=False, fetch_all_findings=False):
         """Gets a precommit client some of whose methods are mocked out for testing."""
         responses.add(responses.GET, PrecommitClientTest.get_global_service_mock('service-api-info'), status=200,
                       content_type="application/json", body='{"apiVersion": 6}')
         precommit_client = PrecommitClient(PrecommitClientTest._get_precommit_client_config(),
                                            repository_path=REPO_PATH, path_prefix=path_prefix,
-                                           analyzed_file=ANALYZED_FILE_PATH, verify=False,
-                                           omit_links_to_findings=True, fetch_existing_findings=fetch_existing_findings,
+                                           project_subpath=project_subpath, analyzed_file=ANALYZED_FILE_PATH,
+                                           verify=False, omit_links_to_findings=True,
+                                           fetch_all_findings=fetch_all_findings,
+                                           fetch_existing_findings=fetch_existing_findings,
                                            fetch_existing_findings_in_changes=fetch_existing_findings_in_changes)
         precommit_client._calculate_modifications = Mock()
         precommit_client.current_branch = CURRENT_BRANCH