CR#31629 Teamscale CLI precommit and listing findings not working in Gerrit setup (#29)

* CR#31629 Resolve current revision to Teamscale ID before retrieving all findings

Co-authored-by: Juan Manuel Florez <florez@cqse.eu>
Co-authored-by: Thomas Kinnen <kinnen@cqse.eu>

Author: 3 people

.github/workflows/actions.yml

@@ -25,7 +25,7 @@ jobs:
     - name: Create binary
       run: |
         pip install .
-        python -m nuitka --assume-yes-for-downloads --standalone --onefile --linux-onefile-icon /usr/share/pixmaps/python3.xpm teamscale_precommit_client/precommit_client.py
+        python -m nuitka --assume-yes-for-downloads --standalone --onefile --linux-onefile-icon=/usr/share/pixmaps/python3.xpm teamscale_precommit_client/precommit_client.py
         mv precommit_client.bin teamscale-cli
     - name: 'Upload Artifact'
       if: ${{ always() }}

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="teamscale-cli",
-    version="7.1.0",
+    version="7.1.1",
     author="Thomas Kinnen - CQSE GmbH",
     author_email="kinnen@cqse.eu",
     description=("Client for performing precommit analysis with Teamscale."),
@@ -20,7 +20,7 @@
         ]
     },
     install_requires=[
-        'teamscale-client==6.7.1',
+        'teamscale-client==7.1.1',
         'gitpython==2.1.15',
 
         # Required for gitpython, build fails without specifying a fixed version.
@@ -29,7 +29,7 @@
         'gitdb2==2.0.6',
 
         # Required to compile to a native binary
-        'nuitka==0.6.14.7'
+        'nuitka==1.1.5'
     ],
     tests_require=[
         'teamscale-client',

teamscale_precommit_client/git_utils.py

@@ -26,6 +26,18 @@ def get_current_branch(path_to_repository):
     return repo.active_branch.name
 
 
+def get_current_commit_sha(path_to_repository):
+    """Get the commit SHA (ID) of the current commit
+
+        Args:
+            path_to_repository (str): Path to the Git repository
+
+        Returns:
+            str: SHA of current commit.
+    """
+    return Repo(path_to_repository).active_branch.commit.hexsha
+
+
 def get_repo_root_from_file_in_repo(path_to_file_in_repo):
     """Get the repository root for the given path in the repository."""
     try:

teamscale_precommit_client/precommit_client.py

@@ -14,7 +14,7 @@
 from teamscale_precommit_client.client_configuration_utils import get_teamscale_client_configuration
 from teamscale_precommit_client.data import PreCommitUploadData
 from teamscale_precommit_client.git_utils import get_changed_files_and_content, get_deleted_files
-from teamscale_precommit_client.git_utils import get_current_branch, get_current_timestamp
+from teamscale_precommit_client.git_utils import get_current_branch, get_current_timestamp, get_current_commit_sha
 from teamscale_precommit_client.git_utils import get_repo_root_from_file_in_repo
 
 # Filename of the precommit configuration. The client expects this config file at the root of the repository.
@@ -205,7 +205,8 @@ def _get_existing_findings(self):
         uniform_path = os.path.join(self.path_prefix, uniform_path)
         if self.fetch_all_findings:
             uniform_path = ''
-        self.existing_findings = self.teamscale_client.get_findings(uniform_path=uniform_path, timestamp=None)
+        self.existing_findings = self.teamscale_client.get_findings(uniform_path=uniform_path, timestamp=None,
+                                                                    revision_id=self._get_commit_hash())
         self._remove_precommit_findings_from_existing_findings()
 
     def _remove_precommit_findings_from_existing_findings(self):
@@ -264,6 +265,10 @@ def _get_finding_severity_message(finding):
         """Formats the given finding's assessment as severity."""
         return 'error' if finding.assessment == 'RED' else 'warning'
 
+    def _get_commit_hash(self):
+        """Obtains the current commit SHA"""
+        return get_current_commit_sha(self.repository_path)
+
 
 def _parse_args():
     """Parses the precommit client command line arguments."""

tests/precommit_test.py

@@ -29,6 +29,7 @@
 ANALYZED_FILE_PATH = REPO_PATH + ANALYZED_FILE_NAME
 DELETED_FILE_NAME = 'deletedFile.ext'
 CURRENT_BRANCH = 'my_feature_branch'
+REVISION = 'mockRevision'
 
 
 class PrecommitClientTest(TestCase):
@@ -271,6 +272,10 @@ def mock_existing_findings(branch, existing_findings=None, path_prefix=DEFAULT_P
         Findings can be provided as list of integers each of which represents a finding instance."""
         existing_findings_from_current_branch = to_json(
             PrecommitClientTest._get_findings_as_dicts(existing_findings, path_prefix))
+        responses.add(responses.GET,
+                      PrecommitClientTest.get_project_service_mock('repository-timestamp-by-revision', REVISION),
+                      body=to_json([{'branchName': branch, 'timestamp': 'HEAD'}]), status=200,
+                      content_type='application/json')
         responses.add(responses.GET, PrecommitClientTest.get_project_service_mock('findings', branch),
                       body=existing_findings_from_current_branch, status=200,
                       content_type="application/json", )
@@ -307,6 +312,7 @@ def _get_precommit_client(changed_files, deleted_files, path_prefix=DEFAULT_PATH
         precommit_client.changed_files = changed_files
         precommit_client.deleted_files = deleted_files
         PrecommitClient.PRECOMMIT_WAITING_TIME_IN_SECONDS = 0
+        precommit_client._get_commit_hash = Mock(return_value=REVISION)
 
         return precommit_client