SONAR-26524 Audit logs - generate audit traces for Jira project binding

Author: CristianAmbrosini

server/sonar-db-dao/src/main/java/org/sonar/db/audit/AuditPersister.java

@@ -28,6 +28,7 @@
 import org.sonar.db.audit.model.DevOpsPermissionsMappingNewValue;
 import org.sonar.db.audit.model.GroupPermissionNewValue;
 import org.sonar.db.audit.model.JiraOrganizationBindingNewValue;
+import org.sonar.db.audit.model.JiraProjectBindingNewValue;
 import org.sonar.db.audit.model.LicenseNewValue;
 import org.sonar.db.audit.model.PermissionTemplateNewValue;
 import org.sonar.db.audit.model.PersonalAccessTokenNewValue;
@@ -172,4 +173,10 @@ public interface AuditPersister {
 
   void jiraOrganizationBindingDelete(DbSession dbSession, JiraOrganizationBindingNewValue newValue);
 
+  void jiraProjectBindingAdd(DbSession dbSession, JiraProjectBindingNewValue newValue);
+
+  void jiraProjectBindingUpdate(DbSession dbSession, JiraProjectBindingNewValue newValue);
+
+  void jiraProjectBindingDelete(DbSession dbSession, JiraProjectBindingNewValue newValue);
+
 }

server/sonar-db-dao/src/main/java/org/sonar/db/audit/NoOpAuditPersister.java

@@ -28,6 +28,7 @@
 import org.sonar.db.audit.model.DevOpsPermissionsMappingNewValue;
 import org.sonar.db.audit.model.GroupPermissionNewValue;
 import org.sonar.db.audit.model.JiraOrganizationBindingNewValue;
+import org.sonar.db.audit.model.JiraProjectBindingNewValue;
 import org.sonar.db.audit.model.LicenseNewValue;
 import org.sonar.db.audit.model.PermissionTemplateNewValue;
 import org.sonar.db.audit.model.PersonalAccessTokenNewValue;
@@ -362,4 +363,19 @@ public void jiraOrganizationBindingUpdate(DbSession dbSession, JiraOrganizationB
   public void jiraOrganizationBindingDelete(DbSession dbSession, JiraOrganizationBindingNewValue newValue) {
     // no op
   }
+
+  @Override
+  public void jiraProjectBindingAdd(DbSession dbSession, JiraProjectBindingNewValue newValue) {
+    // no op
+  }
+
+  @Override
+  public void jiraProjectBindingUpdate(DbSession dbSession, JiraProjectBindingNewValue newValue) {
+    // no op
+  }
+
+  @Override
+  public void jiraProjectBindingDelete(DbSession dbSession, JiraProjectBindingNewValue newValue) {
+    // no op
+  }
 }

server/sonar-db-dao/src/main/java/org/sonar/db/audit/model/JiraProjectBindingNewValue.java

@@ -0,0 +1,77 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.db.audit.model;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nullable;
+
+public class JiraProjectBindingNewValue extends NewValue {
+
+  @Nullable
+  private String bindingId;
+
+  @Nullable
+  private String sonarProjectId;
+
+  @Nullable
+  private String jiraOrganizationBindingId;
+
+  @Nullable
+  private String jiraProjectKey;
+
+  public JiraProjectBindingNewValue(String bindingId, String sonarProjectId, String jiraOrganizationBindingId, String jiraProjectKey) {
+    this.bindingId = bindingId;
+    this.sonarProjectId = sonarProjectId;
+    this.jiraOrganizationBindingId = jiraOrganizationBindingId;
+    this.jiraProjectKey = jiraProjectKey;
+  }
+
+  @CheckForNull
+  public String getBindingId() {
+    return this.bindingId;
+  }
+
+  @CheckForNull
+  public String getSonarProjectId() {
+    return this.sonarProjectId;
+  }
+
+  @CheckForNull
+  public String getJiraOrganizationBindingId() {
+    return this.jiraOrganizationBindingId;
+  }
+
+  @CheckForNull
+  public String getJiraProjectKey() {
+    return this.jiraProjectKey;
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder("{");
+    addField(sb, "\"bindingId\": ", this.bindingId, true);
+    addField(sb, "\"sonarProjectId\": ", this.sonarProjectId, true);
+    addField(sb, "\"jiraOrganizationBindingId\": ", this.jiraOrganizationBindingId, true);
+    addField(sb, "\"jiraProjectKey\": ", this.jiraProjectKey, true);
+    endString(sb);
+    return sb.toString();
+  }
+}
+

server/sonar-db-dao/src/main/java/org/sonar/db/jira/dao/JiraProjectBindingDao.java

@@ -61,8 +61,8 @@ public Optional<JiraProjectBindingDto> selectBySonarProjectId(DbSession dbSessio
     return Optional.ofNullable(getMapper(dbSession).selectBySonarProjectId(sonarProjectId));
   }
 
-  public void deleteBySonarProjectId(DbSession dbSession, String sonarProjectId) {
-    getMapper(dbSession).deleteBySonarProjectId(sonarProjectId);
+  public int deleteBySonarProjectId(DbSession dbSession, String sonarProjectId) {
+    return getMapper(dbSession).deleteBySonarProjectId(sonarProjectId);
   }
 
   public int countAll(DbSession dbSession) {

server/sonar-db-dao/src/test/java/org/sonar/db/audit/model/JiraProjectBindingNewValueTest.java

@@ -0,0 +1,55 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.db.audit.model;
+
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class JiraProjectBindingNewValueTest {
+
+  private static final String BINDING_ID = "binding-id-123";
+  private static final String SONAR_PROJECT_ID = "sonar-project-id-456";
+  private static final String JIRA_ORG_BINDING_ID = "00000000-0000-0000-0000-000000000001";
+  private static final String JIRA_PROJECT_KEY = "JIRA-123";
+
+  @Test
+  void toString_shouldFormatAllFieldsCorrectly() {
+    var result = new JiraProjectBindingNewValue(
+      BINDING_ID,
+      SONAR_PROJECT_ID,
+      JIRA_ORG_BINDING_ID,
+      JIRA_PROJECT_KEY
+    ).toString();
+
+    assertThat(result).isEqualTo("{\"bindingId\": \"binding-id-123\", \"sonarProjectId\": \"sonar-project-id-456\", \"jiraOrganizationBindingId\": \"00000000-0000-0000-0000-000000000001\", \"jiraProjectKey\": \"JIRA-123\" }");
+  }
+
+  @Test
+  void getters_shouldReturnCorrectValues() {
+    var newValue = new JiraProjectBindingNewValue(BINDING_ID, SONAR_PROJECT_ID, JIRA_ORG_BINDING_ID, JIRA_PROJECT_KEY);
+
+    assertThat(newValue.getBindingId()).isEqualTo(BINDING_ID);
+    assertThat(newValue.getSonarProjectId()).isEqualTo(SONAR_PROJECT_ID);
+    assertThat(newValue.getJiraOrganizationBindingId()).isEqualTo(JIRA_ORG_BINDING_ID);
+    assertThat(newValue.getJiraProjectKey()).isEqualTo(JIRA_PROJECT_KEY);
+  }
+}
+