SONAR-10347 Add search-by-webhook to webhook deliveries search ws.

4 files changed, 61 insertions, 16 deletions

diff --git a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookCallerImplTest.java b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookCallerImplTest.java
index 6a5e5270be4..1e174e6ba54 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookCallerImplTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookCallerImplTest.java
@@ -45,6 +45,7 @@ public class WebhookCallerImplTest {
 
   private static final long NOW = 1_500_000_000_000L;
   private static final String PROJECT_UUID = "P_UUID1";
+  private static final String WEBHOOK_UUID = "WH_UUID1";
   private static final String CE_TASK_UUID = "CE_UUID1";
   private static final String SOME_JSON = "{\"payload\": {}}";
   private static final WebhookPayload PAYLOAD = new WebhookPayload("P1", SOME_JSON);
@@ -59,12 +60,13 @@ public class WebhookCallerImplTest {
 
   @Test
   public void send_posts_payload_to_http_server() throws Exception {
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/ping").toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/ping").toString());
 
     server.enqueue(new MockResponse().setBody("pong").setResponseCode(201));
     WebhookDelivery delivery = newSender().call(webhook, PAYLOAD);
 
     assertThat(delivery.getHttpStatus()).hasValue(201);
+    assertThat(delivery.getWebhook().getUuid()).isEqualTo(WEBHOOK_UUID);
     assertThat(delivery.getDurationInMs().get()).isGreaterThanOrEqualTo(0);
     assertThat(delivery.getError()).isEmpty();
     assertThat(delivery.getAt()).isEqualTo(NOW);
@@ -82,7 +84,7 @@ public class WebhookCallerImplTest {
 
   @Test
   public void silently_catch_error_when_external_server_does_not_answer() throws Exception {
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/ping").toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/ping").toString());
 
     server.shutdown();
     WebhookDelivery delivery = newSender().call(webhook, PAYLOAD);
@@ -98,7 +100,7 @@ public class WebhookCallerImplTest {
 
   @Test
   public void silently_catch_error_when_url_is_incorrect() {
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", "this_is_not_an_url");
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", "this_is_not_an_url");
 
     WebhookDelivery delivery = newSender().call(webhook, PAYLOAD);
 
@@ -116,7 +118,7 @@ public class WebhookCallerImplTest {
    */
   @Test
   public void redirects_should_be_followed_with_POST_method() throws Exception {
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/redirect").toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", server.url("/redirect").toString());
 
     // /redirect redirects to /target
     server.enqueue(new MockResponse().setResponseCode(307).setHeader("Location", server.url("target")));
@@ -138,7 +140,7 @@ public class WebhookCallerImplTest {
   @Test
   public void credentials_are_propagated_to_POST_redirects() throws Exception {
     HttpUrl url = server.url("/redirect").newBuilder().username("theLogin").password("thePassword").build();
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
 
     // /redirect redirects to /target
     server.enqueue(new MockResponse().setResponseCode(307).setHeader("Location", server.url("target")));
@@ -158,7 +160,7 @@ public class WebhookCallerImplTest {
   @Test
   public void redirects_throws_ISE_if_header_Location_is_missing() {
     HttpUrl url = server.url("/redirect");
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
 
     server.enqueue(new MockResponse().setResponseCode(307));
 
@@ -173,7 +175,7 @@ public class WebhookCallerImplTest {
   @Test
   public void redirects_throws_ISE_if_header_Location_does_not_relate_to_a_supported_protocol() {
     HttpUrl url = server.url("/redirect");
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
 
     server.enqueue(new MockResponse().setResponseCode(307).setHeader("Location", "ftp://foo"));
 
@@ -188,7 +190,7 @@ public class WebhookCallerImplTest {
   @Test
   public void send_basic_authentication_header_if_url_contains_credentials() throws Exception {
     HttpUrl url = server.url("/ping").newBuilder().username("theLogin").password("thePassword").build();
-    Webhook webhook = new Webhook(PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
+    Webhook webhook = new Webhook(WEBHOOK_UUID, PROJECT_UUID, CE_TASK_UUID, RandomStringUtils.randomAlphanumeric(40),"my-webhook", url.toString());
     server.enqueue(new MockResponse().setBody("pong"));
 
     WebhookDelivery delivery = newSender().call(webhook, PAYLOAD);
diff --git a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookDeliveryStorageTest.java b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookDeliveryStorageTest.java
index 5f63dc54209..158fdd73002 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookDeliveryStorageTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookDeliveryStorageTest.java
@@ -62,6 +62,7 @@ public class WebhookDeliveryStorageTest {
 
     WebhookDeliveryDto dto = dbClient.webhookDeliveryDao().selectByUuid(dbSession, DELIVERY_UUID).get();
     assertThat(dto.getUuid()).isEqualTo(DELIVERY_UUID);
+    assertThat(dto.getWebhookUuid()).isEqualTo("WEBHOOK_UUID_1");
     assertThat(dto.getComponentUuid()).isEqualTo(delivery.getWebhook().getComponentUuid());
     assertThat(dto.getCeTaskUuid()).isEqualTo(delivery.getWebhook().getCeTaskUuid().get());
     assertThat(dto.getName()).isEqualTo(delivery.getWebhook().getName());
@@ -102,7 +103,7 @@ public class WebhookDeliveryStorageTest {
 
   private static WebhookDelivery.Builder newBuilderTemplate() {
     return new WebhookDelivery.Builder()
-      .setWebhook(new Webhook("COMPONENT1", "TASK1", RandomStringUtils.randomAlphanumeric(40),"Jenkins", "http://jenkins"))
+      .setWebhook(new Webhook("WEBHOOK_UUID_1", "COMPONENT1", "TASK1", RandomStringUtils.randomAlphanumeric(40),"Jenkins", "http://jenkins"))
       .setPayload(new WebhookPayload("my-project", "{json}"))
       .setAt(1_000_000L)
       .setHttpStatus(200)
diff --git a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookTest.java b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookTest.java
index c73aee52cc9..64778c0dfa4 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/webhook/WebhookTest.java
@@ -36,21 +36,21 @@ public class WebhookTest {
   public void constructor_with_null_componentUuid_should_throw_NPE() {
     expectedException.expect(NullPointerException.class);
 
-    new Webhook(null, null, null, randomAlphanumeric(10), randomAlphanumeric(10));
+    new Webhook(randomAlphanumeric(40), null, null, null, randomAlphanumeric(10), randomAlphanumeric(10));
   }
 
   @Test
   public void constructor_with_null_name_should_throw_NPE() {
     expectedException.expect(NullPointerException.class);
 
-    new Webhook(randomAlphanumeric(10), null, null, null, randomAlphanumeric(10));
+    new Webhook(randomAlphanumeric(40), randomAlphanumeric(10), null, null, null, randomAlphanumeric(10));
   }
 
   @Test
   public void constructor_with_null_url_should_throw_NPE() {
     expectedException.expect(NullPointerException.class);
 
-    new Webhook(randomAlphanumeric(10), null, null, randomAlphanumeric(10), null);
+    new Webhook(randomAlphanumeric(40), randomAlphanumeric(10), null, null, randomAlphanumeric(10), null);
   }
 
   @Test
@@ -58,7 +58,7 @@ public class WebhookTest {
     String componentUuid = randomAlphanumeric(10);
     String name = randomAlphanumeric(10);
     String url = randomAlphanumeric(10);
-    Webhook underTest = new Webhook(componentUuid, null, null, name, url);
+    Webhook underTest = new Webhook(randomAlphanumeric(40), componentUuid, null, null, name, url);
 
     assertThat(underTest.getComponentUuid()).isEqualTo(componentUuid);
     assertThat(underTest.getName()).isEqualTo(name);
@@ -68,7 +68,7 @@ public class WebhookTest {
 
     String ceTaskUuid = randomAlphanumeric(10);
     String analysisUuid = randomAlphanumeric(10);
-    underTest = new Webhook(componentUuid, ceTaskUuid, analysisUuid, name, url);
+    underTest = new Webhook(randomAlphanumeric(40), componentUuid, ceTaskUuid, analysisUuid, name, url);
     assertThat(underTest.getComponentUuid()).isEqualTo(componentUuid);
     assertThat(underTest.getName()).isEqualTo(name);
     assertThat(underTest.getUrl()).isEqualTo(url);
diff --git a/server/sonar-server/src/test/java/org/sonar/server/webhook/ws/WebhookDeliveriesActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/webhook/ws/WebhookDeliveriesActionTest.java
index 14d91c65782..e8b9c9c9ca8 100644
--- a/server/sonar-server/src/test/java/org/sonar/server/webhook/ws/WebhookDeliveriesActionTest.java
+++ b/server/sonar-server/src/test/java/org/sonar/server/webhook/ws/WebhookDeliveriesActionTest.java
@@ -68,7 +68,7 @@ public class WebhookDeliveriesActionTest {
 
   @Test
   public void test_definition() {
-    assertThat(ws.getDef().params()).extracting(WebService.Param::key).containsOnly("componentKey", "ceTaskId");
+    assertThat(ws.getDef().params()).extracting(WebService.Param::key).containsExactlyInAnyOrder("componentKey", "ceTaskId", "webhook");
     assertThat(ws.getDef().isPost()).isFalse();
     assertThat(ws.getDef().isInternal()).isFalse();
     assertThat(ws.getDef().responseExampleAsString()).isNotEmpty();
@@ -104,6 +104,17 @@ public class WebhookDeliveriesActionTest {
   }
 
   @Test
+  public void search_by_webhook_and_return_no_records() {
+    userSession.logIn().addProjectPermission(UserRole.ADMIN, project);
+
+    Webhooks.DeliveriesWsResponse response = ws.newRequest()
+      .setParam("webhook", "t1")
+      .executeProtobuf(Webhooks.DeliveriesWsResponse.class);
+
+    assertThat(response.getDeliveriesCount()).isEqualTo(0);
+  }
+
+  @Test
   public void search_by_component_and_return_records_of_example() {
     WebhookDeliveryDto dto = newWebhookDeliveryDto()
       .setUuid("d1")
@@ -146,6 +157,24 @@ public class WebhookDeliveriesActionTest {
   }
 
   @Test
+  public void search_by_webhook_and_return_records() {
+    WebhookDeliveryDto dto1 = newWebhookDeliveryDto().setComponentUuid(project.uuid()).setCeTaskUuid("t1").setWebhookUuid("wh-1-uuid");
+    WebhookDeliveryDto dto2 = newWebhookDeliveryDto().setComponentUuid(project.uuid()).setCeTaskUuid("t1").setWebhookUuid("wh-1-uuid");
+    WebhookDeliveryDto dto3 = newWebhookDeliveryDto().setComponentUuid(project.uuid()).setCeTaskUuid("t2").setWebhookUuid("wh-2-uuid");
+    dbClient.webhookDeliveryDao().insert(db.getSession(), dto1);
+    dbClient.webhookDeliveryDao().insert(db.getSession(), dto2);
+    dbClient.webhookDeliveryDao().insert(db.getSession(), dto3);
+    db.commit();
+    userSession.logIn().addProjectPermission(UserRole.ADMIN, project);
+
+    Webhooks.DeliveriesWsResponse response = ws.newRequest()
+      .setParam("ceTaskId", "t1")
+      .executeProtobuf(Webhooks.DeliveriesWsResponse.class);
+    assertThat(response.getDeliveriesCount()).isEqualTo(2);
+    assertThat(response.getDeliveriesList()).extracting(Webhooks.Delivery::getId).containsOnly(dto1.getUuid(), dto2.getUuid());
+  }
+
+  @Test
   public void search_by_component_and_throw_ForbiddenException_if_not_admin_of_project() {
     WebhookDeliveryDto dto = newWebhookDeliveryDto()
       .setComponentUuid(project.uuid());
@@ -182,11 +211,24 @@ public class WebhookDeliveriesActionTest {
     userSession.logIn();
 
     expectedException.expect(IllegalArgumentException.class);
-    expectedException.expectMessage("Either 'ceTaskId' or 'componentKey' must be provided");
+    expectedException.expectMessage("Either 'ceTaskId' or 'componentKey' or 'webhook' must be provided");
 
     ws.newRequest()
       .setParam("componentKey", project.getDbKey())
       .setParam("ceTaskId", "t1")
       .execute();
   }
+
+  @Test
+  public void throw_IAE_if_both_component_and_webhook_are_set() {
+    userSession.logIn();
+
+    expectedException.expect(IllegalArgumentException.class);
+    expectedException.expectMessage("Either 'ceTaskId' or 'componentKey' or 'webhook' must be provided");
+
+    ws.newRequest()
+      .setParam("componentKey", project.getDbKey())
+      .setParam("webhook", "wh-uuid")
+      .execute();
+  }
 }