fix(gitlab): remove custom author when commit signing is enabled

Author: Lujeni

docs/configuration.md

@@ -6,22 +6,11 @@ To configure the application, set the following environment variables:
 
 | Environment Variable            | Description                                        | Default Value                 |
 | ------------------------------- | -------------------------------------------------- | ----------------------------- |
-| `ENV`                           | The environment the application is running in      | `production`                  |
-| `SENTRY_DSN`                    | Sentry DSN for monitoring                          | `http://default.sentry.com`   |
-| `SENTRY_ENV`                    | Sentry environment name                            | `production`                  |
-| `SENTRY_ORG_SLUG`               | Organization slug for Sentry                       | `default_org`                 |
-| `SENTRY_TOKEN`                  | Authentication token for Sentry                    | `default-token`               |
-| `SENTRY_URL`                    | Base URL for Sentry service                        | `http://default-sentry-url`   |
-| `DSN_MR_CONTENT`                | Merge request content for DSN                      | Custom template (see code)    |
 | `DSN_BRANCH_NAME`               | Branch name for DSN changes                        | `auto_add_sentry_dsn`         |
-| `DSN_MR_TITLE`                  | Title for DSN-related merge request                | `[gitlab2sentry] Merge me...` |
+| `DSN_MR_CONTENT`                | Merge request content for DSN                      | Custom template (see code)    |
 | `DSN_MR_DESCRIPTION`            | Description for DSN-related merge request          | Custom template (see code)    |
-| `SENTRYCLIRC_MR_CONTENT`        | Merge request content for Sentry CLI configuration | Custom template (see code)    |
-| `SENTRYCLIRC_BRANCH_NAME`       | Branch name for Sentry CLI configuration changes   | `auto_add_sentry`             |
-| `SENTRYCLIRC_MR_TITLE`          | Title for Sentry CLI configuration MR              | `[gitlab2sentry] Merge me...` |
-| `SENTRYCLIRC_FILEPATH`          | Filepath for `.sentryclirc` configuration          | `.sentryclirc`                |
-| `SENTRYCLIRC_COM_MSG`           | Commit message for `.sentryclirc` update           | `Update .sentryclirc`         |
-| `SENTRYCLIRC_MR_DESCRIPTION`    | Description for Sentry CLI configuration MR        | Custom template (see code)    |
+| `DSN_MR_TITLE`                  | Title for DSN-related merge request                | `[gitlab2sentry] Merge me...` |
+| `ENV`                           | The environment the application is running in      | `production`                  |
 | `GITLAB_AUTHOR_EMAIL`           | GitLab author email for merge requests             | `[email protected]`   |
 | `GITLAB_AUTHOR_NAME`            | GitLab author name for merge requests              | `Default Author`              |
 | `GITLAB_GRAPHQL_PAGE_LENGTH`    | Page length for GitLab GraphQL queries             | `0`                           |
@@ -34,9 +23,20 @@ To configure the application, set the following environment variables:
 | `GITLAB_MR_LABEL_LIST`          | Labels to assign to GitLab merge requests          | `['sentry']`                  |
 | `GITLAB_PROJECT_CREATION_LIMIT` | Limit for creating GitLab projects                 | `30`                          |
 | `GITLAB_RMV_SRC_BRANCH`         | Remove source branch after merge request           | `True`                        |
+| `GITLAB_SIGNED_COMMIT`          | Whether to use signed commits in GitLab            | `False`                       |
 | `GITLAB_TOKEN`                  | GitLab access token                                | `default-token`               |
 | `GITLAB_URL`                    | Base URL for GitLab service                        | `http://default-gitlab-url`   |
-| `GITLAB_SIGNED_COMMIT`          | Whether to use signed commits in GitLab            | `False`                       |
+| `SENTRYCLIRC_BRANCH_NAME`       | Branch name for Sentry CLI configuration changes   | `auto_add_sentry`             |
+| `SENTRYCLIRC_COM_MSG`           | Commit message for `.sentryclirc` update           | `Update .sentryclirc`         |
+| `SENTRYCLIRC_FILEPATH`          | Filepath for `.sentryclirc` configuration          | `.sentryclirc`                |
+| `SENTRYCLIRC_MR_CONTENT`        | Merge request content for Sentry CLI configuration | Custom template (see code)    |
+| `SENTRYCLIRC_MR_DESCRIPTION`    | Description for Sentry CLI configuration MR        | Custom template (see code)    |
+| `SENTRYCLIRC_MR_TITLE`          | Title for Sentry CLI configuration MR              | `[gitlab2sentry] Merge me...` |
+| `SENTRY_DSN`                    | Sentry DSN for monitoring                          | `http://default.sentry.com`   |
+| `SENTRY_ENV`                    | Sentry environment name                            | `production`                  |
+| `SENTRY_ORG_SLUG`               | Organization slug for Sentry                       | `default_org`                 |
+| `SENTRY_TOKEN`                  | Authentication token for Sentry                    | `default-token`               |
+| `SENTRY_URL`                    | Base URL for Sentry service                        | `http://default-sentry-url`   |
 
 To override any configuration, simply set the respective environment variable before running the application. For instance:
 

gitlab2sentry/__init__.py

@@ -6,7 +6,13 @@
 from slugify import slugify
 
 from gitlab2sentry.exceptions import SentryProjectCreationFailed
-from gitlab2sentry.resources import settings, G2SProject, G2S_STATS, GRAPHQL_LIST_PROJECTS_QUERY, GRAPHQL_FETCH_PROJECT_QUERY
+from gitlab2sentry.resources import (
+    G2S_STATS,
+    GRAPHQL_FETCH_PROJECT_QUERY,
+    GRAPHQL_LIST_PROJECTS_QUERY,
+    G2SProject,
+    settings,
+)
 from gitlab2sentry.utils import GitlabProvider, SentryProvider
 
 logging.basicConfig(
@@ -31,7 +37,9 @@ def _get_gitlab_provider(self) -> GitlabProvider:
         return GitlabProvider(settings.gitlab_url, settings.gitlab_token)
 
     def _get_sentry_provider(self) -> SentryProvider:
-        return SentryProvider(settings.sentry_url, settings.sentry_token, settings.sentry_org_slug)
+        return SentryProvider(
+            settings.sentry_url, settings.sentry_token, settings.sentry_org_slug
+        )
 
     def _ensure_sentry_group(self, name: str) -> None:
         if name not in self.sentry_groups:
@@ -108,7 +116,9 @@ def _get_mr_states(
                 ):
                     if not (sentryclirc_mr_state and sentryclirc_mr_state == "opened"):
                         sentryclirc_mr_state = mr["state"]
-                elif mr["title"] == settings.dsn_mr_title.format(project_name=project_name):
+                elif mr["title"] == settings.dsn_mr_title.format(
+                    project_name=project_name
+                ):
                     if not (dsn_mr_state and dsn_mr_state == "opened"):
                         dsn_mr_state = mr["state"]
                 else:
@@ -230,7 +240,7 @@ def _create_sentry_project(
         full_path: str,
         sentry_group_name: str,
         sentry_project_name: str,
-        sentry_project_slug: str
+        sentry_project_slug: str,
     ) -> Optional[Dict[str, Any]]:
         try:
             return self.sentry_provider.get_or_create_project(
@@ -256,7 +266,7 @@ def _handle_g2s_project(
         self,
         g2s_project: G2SProject,
         sentry_group_name: str,
-        custom_name: Optional[str] = None
+        custom_name: Optional[str] = None,
     ) -> bool:
         """
         Creates sentry project for all given gitlab projects. It
@@ -304,7 +314,7 @@ def _handle_g2s_project(
                     g2s_project.full_path,
                     sentry_group_name,
                     sentry_project_name,
-                    sentry_project_slug
+                    sentry_project_slug,
                 )
 
                 # If Sentry fails to create project skip
@@ -348,9 +358,7 @@ def _handle_g2s_project(
         return False
 
     def update(
-        self,
-        full_path: Optional[str] = None,
-        custom_name: Optional[str] = None
+        self, full_path: Optional[str] = None, custom_name: Optional[str] = None
     ) -> None:
         """
         args: full_path
@@ -372,7 +380,7 @@ def update(
             if g2s_project:
                 sentry_group_name = g2s_project.group.split("/")[0].strip()
                 self._handle_g2s_project(
-                    g2s_project, sentry_group_name, custom_name # type: ignore
+                    g2s_project, sentry_group_name, custom_name  # type: ignore
                 )
             else:
                 logging.info(

gitlab2sentry/resources.py

@@ -1,11 +1,10 @@
 from collections import namedtuple
 from typing import List, Tuple
+
 from pydantic import Field
 from pydantic_settings import BaseSettings
 
 
-
-
 class Settings(BaseSettings):
     dsn_branch_name: str = Field("auto_add_sentry_dsn")
     dsn_mr_content: str = Field(
@@ -36,6 +35,7 @@ class Settings(BaseSettings):
     gitlab_mr_label_list: List[str] = Field(["sentry"])
     gitlab_project_creation_limit: int = Field(30)
     gitlab_rmv_src_branch: bool = Field(True)
+    gitlab_signed_commit: bool = Field(False)
     gitlab_token: str = Field("default-token")
     gitlab_url: str = Field("http://default-gitlab-url")
     sentry_dsn: str = Field("http://default.sentry.com")

gitlab2sentry/utils/gitlab_provider.py

@@ -16,7 +16,9 @@
 
 class GraphQLClient:
     def __init__(
-        self, url: Optional[str] = settings.gitlab_url, token: Optional[str] = settings.gitlab_token
+        self,
+        url: Optional[str] = settings.gitlab_url,
+        token: Optional[str] = settings.gitlab_token,
     ):
         self._client = Client(
             transport=self._get_transport(url, token),
@@ -81,7 +83,9 @@ def project_list_query(
 
 class GitlabProvider:
     def __init__(
-        self, url: Optional[str] = settings.gitlab_url, token: Optional[str] = settings.gitlab_token
+        self,
+        url: Optional[str] = settings.gitlab_url,
+        token: Optional[str] = settings.gitlab_token,
     ) -> None:
         self.gitlab = self._get_gitlab(url, token)
         self._gql_client = GraphQLClient(url, token)
@@ -98,7 +102,9 @@ def _get_gitlab(self, url: Optional[str], token: Optional[str]) -> Gitlab:
 
     def _get_update_limit(self) -> Optional[datetime]:
         if settings.gitlab_project_creation_limit:
-            return datetime.now() - timedelta(days=settings.gitlab_project_creation_limit)
+            return datetime.now() - timedelta(
+                days=settings.gitlab_project_creation_limit
+            )
         else:
             return None
 
@@ -181,16 +187,21 @@ def _get_or_create_sentryclirc(
                     full_path,
                 )
             )
-            f = project.files.create(
-                {
-                    "author_email": settings.gitlab_author_email,
-                    "author_name": settings.gitlab_author_name,
-                    "branch": branch_name,
-                    "commit_message": settings.sentryclirc_com_msg,
-                    "content": content,
-                    "file_path": file_path,
-                }
-            )
+            data = {
+                "author_email": settings.gitlab_author_email,
+                "author_name": settings.gitlab_author_name,
+                "branch": branch_name,
+                "commit_message": settings.sentryclirc_com_msg,
+                "content": content,
+                "file_path": file_path,
+            }
+            # When commit signing is enabled in GitLab (e.g. via pre-hook),
+            # commit requires that the author information matches the signer identity
+            # https://gitlab.com/gitlab-org/gitlab/-/merge_requests/150855
+            if settings.gitlab_signed_commit:
+                data.pop("author_email")
+                data.pop("author_name")
+            f = project.files.create(data=data)
 
     def _get_default_mentions(self, project: Project) -> str:
         return ", ".join(

tests/conftest.py

@@ -5,10 +5,6 @@
 
 from gitlab2sentry import Gitlab2Sentry
 from gitlab2sentry.resources import G2SProject, settings
-from gitlab2sentry.resources import (
-    settings,
-    G2SProject,
-)
 from gitlab2sentry.utils.gitlab_provider import GitlabProvider, GraphQLClient
 from gitlab2sentry.utils.sentry_provider import SentryProvider
 
@@ -23,6 +19,7 @@
     "%Y-%m-%dT%H:%M:%SZ",
 )
 
+
 @pytest.fixture
 def g2s_fixture():
     yield Gitlab2Sentry()
@@ -109,11 +106,7 @@ def create_graphql_json_object(**kwargs):
                 "rawTextBlob": settings.dsn_mr_content.format(
                     sentry_url=settings.sentry_url,
                     dsn=settings.sentry_dsn,
-<<<<<<< HEAD
                     project_slug=TEST_PROJECT_NAME,
-=======
-                    project_slug=TEST_PROJECT_NAME
->>>>>>> 438fae9 (refactor: use pydandic settings to handle configuration)
                 ),
             }
         else:
@@ -138,13 +131,9 @@ def create_graphql_json_object(**kwargs):
     if kwargs["dsn_mr_state"]:
         dsn_mr = {
             "id": "gid://gitlab/MergeRequest/0001",
-<<<<<<< HEAD
             "title": settings.dsn_mr_title.format(
                 project_name=response_dict["node"]["name"]
             ),
-=======
-            "title": settings.dsn_mr_title.format(project_name=response_dict["node"]["name"]),
->>>>>>> 438fae9 (refactor: use pydandic settings to handle configuration)
             "state": kwargs["dsn_mr_state"],
         }
         response_dict["node"]["mergeRequests"]["nodes"].append(dsn_mr)
@@ -361,3 +350,37 @@ def payload_sentry_project():
         sentryclirc_mr_state="merged",
         dsn_mr_state="merged",
     )
+
+GRAPHQL_TEST_QUERY = {
+    "name": "TEST_QUERY",
+    "instance": "projects",
+    "body": """
+{
+    project(fullPath: "none") {
+        id
+        fullPath
+        name
+        createdAt
+        mergeRequestsEnabled
+        group {
+            name
+        }
+        repository {
+            blobs {
+                nodes {
+                    name
+                    rawTextBlob
+                }
+            }
+        }
+        mergeRequests {
+            nodes {
+                id
+                title
+                state
+            }
+        }
+    }
+}
+""",
+}

tests/test_gitlab_provider.py

@@ -64,7 +64,8 @@ def test_project_list_query(gql_client_fixture, payload_new_project, mocker):
 
 def test_get_gitlab(gitlab_provider_fixture):
     assert isinstance(
-        gitlab_provider_fixture._get_gitlab(settings.gitlab_url, settings.gitlab_token), Gitlab
+        gitlab_provider_fixture._get_gitlab(settings.gitlab_url, settings.gitlab_token),
+        Gitlab,
     )