-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add test to verify the `WebhookJob` request is as expected. Specifically, it verifies the `Host` header in the webhook configuration is respected
- Loading branch information
Showing
1 changed file
with
116 additions
and
0 deletions.
There are no files selected for viewing
116 changes: 116 additions & 0 deletions
116
deploy-service/common/src/test/java/com/pinterest/deployservice/handler/WebhookJobTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
/** | ||
* Copyright (c) 2024 Pinterest, Inc. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package com.pinterest.deployservice.handler; | ||
|
||
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; | ||
import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
||
import com.google.common.collect.ImmutableList; | ||
import com.pinterest.deployservice.bean.DeployBean; | ||
import com.pinterest.deployservice.bean.DeployState; | ||
import com.pinterest.deployservice.bean.WebHookBean; | ||
import java.util.List; | ||
import okhttp3.mockwebserver.Dispatcher; | ||
import okhttp3.mockwebserver.MockResponse; | ||
import okhttp3.mockwebserver.MockWebServer; | ||
import okhttp3.mockwebserver.RecordedRequest; | ||
import org.junit.jupiter.api.AfterEach; | ||
import org.junit.jupiter.api.BeforeEach; | ||
import org.junit.jupiter.api.Test; | ||
|
||
class WebhookJobTest { | ||
private static final String TEST_PATH = "/testPath?testKey1=testVal1&testKey2=testVal2"; | ||
private static final String TEST_DEPLOY_ID = "testDeployId"; | ||
private static final DeployState TEST_DEPLOY_STATE = DeployState.SUCCEEDING; | ||
private static final Long TEST_DEPLOY_START_DATE = 5L; | ||
private static MockWebServer mockWebServer; | ||
|
||
private WebhookJob sut; | ||
|
||
@BeforeEach | ||
public void setUpEach() throws Exception { | ||
mockWebServer = new MockWebServer(); | ||
mockWebServer.start(); | ||
|
||
// Create test DeployBean | ||
DeployBean deployBean = new DeployBean(); | ||
deployBean.setDeploy_id(TEST_DEPLOY_ID); | ||
deployBean.setState(TEST_DEPLOY_STATE); | ||
deployBean.setStart_date(TEST_DEPLOY_START_DATE); | ||
|
||
// Create test WebHookBean | ||
WebHookBean webhook = new WebHookBean(); | ||
webhook.setMethod("PUT"); | ||
webhook.setUrl(mockWebServer.url(TEST_PATH).toString()); | ||
webhook.setHeaders("Host:example.com; Accept: text/plain"); | ||
webhook.setVersion("1.1"); | ||
webhook.setBody("{\"testBodyKey\": \"testBodyValue\"}"); | ||
|
||
List<WebHookBean> webhooks = ImmutableList.of(webhook); | ||
sut = new WebhookJob(webhooks, deployBean); | ||
} | ||
|
||
@AfterEach | ||
public void tearDown() throws Exception { | ||
mockWebServer.shutdown(); | ||
} | ||
|
||
@Test | ||
void testWebhookOk() throws InterruptedException { | ||
mockWebServer.enqueue(new MockResponse()); | ||
|
||
assertDoesNotThrow( | ||
() -> { | ||
sut.call(); | ||
}); | ||
|
||
assertEquals(1, mockWebServer.getRequestCount()); | ||
RecordedRequest request = mockWebServer.takeRequest(); | ||
assertEquals(TEST_PATH, request.getPath()); | ||
assertEquals(ImmutableList.of("example.com"), request.getHeaders().values("Host")); | ||
assertEquals(ImmutableList.of("text/plain"), request.getHeaders().values("Accept")); | ||
} | ||
|
||
@Test | ||
void testWebhookClientError() { | ||
mockWebServer.enqueue(new MockResponse().setResponseCode(404)); | ||
|
||
assertDoesNotThrow( | ||
() -> { | ||
sut.call(); | ||
}); | ||
|
||
assertEquals(1, mockWebServer.getRequestCount()); | ||
} | ||
|
||
@Test | ||
void testWebhookServerError() { | ||
mockWebServer.setDispatcher(new ServerErrorDispatcher()); | ||
|
||
assertDoesNotThrow( | ||
() -> { | ||
sut.call(); | ||
}); | ||
assertEquals(3, mockWebServer.getRequestCount()); | ||
} | ||
|
||
static class ServerErrorDispatcher extends Dispatcher { | ||
@Override | ||
public MockResponse dispatch(RecordedRequest request) { | ||
return new MockResponse().setResponseCode(500); | ||
} | ||
} | ||
} |