Skip to content

Commit

Permalink
test(clouddriver): Add tests to verify the failure cases of Montiored…
Browse files Browse the repository at this point in the history
…DeployTask and 'getRetrofitLogMessage()'

This commit sets the stage for forthcoming changes currently in progress under PR : spinnaker#4614 . The primary goal is to compare the behaviour before and after enhancements by introducing test cases for the ‘MonitoredDeployTask’ and the ‘getRetrofitLogMessage()’ method.

For ‘MonitoredDeployTask’:
- Test Case to simulate networkError and observe behaviour
- Test Case to simulate httpError and observe behaviour
- Test Case to simulate unexpectedError and observe behaviour
- Test Case to simulate conversionError and observe behaviour

For ‘getRetrofitLogMessage()’:
- Test Cases to verify behaviour during HTTP error details parsing when exceptions occur

Additionally, a Mockito dependency ('org.mockito:mockito-inline:2.13.0') has been added to support spying/mocking on the final class 'retrofit.client.Response'. This resolves the issue encountered during testing where Mockito couldn't mock/spy the final class, preventing the following error:  org.mockito.exceptions.base.MockitoException:
Cannot mock/spy class retrofit.client.Response
Mockito cannot mock/spy because :
 - final class
	at com.netflix.spinnaker.orca.clouddriver.tasks.monitoreddeploy.MonitoredDeployBaseTaskTest.shouldReturnOnlyStatusWhenExceptionThrownWhileParsingHttpErrorBody(MonitoredDeployBaseTaskTest.java:217)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:568)
	at org.junit.platform.commons.util.ReflectionUtils.invokeMethod(ReflectionUtils.java:688)
	at org.junit.jupiter.engine.execution.MethodInvocation.proceed(MethodInvocation.java:60)
	at org.junit.jupiter.engine.execution.InvocationInterceptorChain.proceed(InvocationInterceptorChain.java:131)
  • Loading branch information
Pranav-b-7 committed Dec 12, 2023
1 parent 5009613 commit f04e4ef
Show file tree
Hide file tree
Showing 3 changed files with 302 additions and 1 deletion.
1 change: 1 addition & 0 deletions orca-clouddriver/orca-clouddriver.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ dependencies {
testImplementation("io.strikt:strikt-core")
testImplementation("io.mockk:mockk")
testImplementation("ru.lanwen.wiremock:wiremock-junit5:1.3.1")
testImplementation("org.mockito:mockito-inline")

testCompileOnly("org.projectlombok:lombok")
testAnnotationProcessor("org.projectlombok:lombok")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@

package com.netflix.spinnaker.orca.clouddriver.tasks.monitoreddeploy

import com.fasterxml.jackson.databind.ObjectMapper
import com.netflix.spectator.api.NoopRegistry
import com.netflix.spinnaker.config.DeploymentMonitorDefinition
import com.netflix.spinnaker.orca.api.pipeline.models.ExecutionStatus
import com.netflix.spinnaker.orca.api.pipeline.TaskResult
import com.netflix.spinnaker.orca.clouddriver.MortServiceSpec
import com.netflix.spinnaker.orca.deploymentmonitor.DeploymentMonitorService
import com.netflix.spinnaker.orca.deploymentmonitor.models.DeploymentMonitorStageConfig
import com.netflix.spinnaker.orca.deploymentmonitor.models.DeploymentStep
Expand All @@ -28,9 +30,13 @@ import com.netflix.spinnaker.orca.deploymentmonitor.models.MonitoredDeployIntern
import com.netflix.spinnaker.orca.pipeline.model.PipelineExecutionImpl
import com.netflix.spinnaker.orca.pipeline.model.StageExecutionImpl
import retrofit.RetrofitError
import retrofit.client.Response
import retrofit.converter.ConversionException
import retrofit.converter.JacksonConverter
import spock.lang.Specification
import com.netflix.spinnaker.orca.deploymentmonitor.DeploymentMonitorServiceProvider
import spock.lang.Unroll
import org.springframework.http.HttpStatus

import java.time.Instant
import java.util.concurrent.TimeUnit
Expand All @@ -41,7 +47,7 @@ class EvaluateDeploymentHealthTaskSpec extends Specification {
PipelineExecutionImpl pipe = pipeline {
}

def "should retry retrofit errors"() {
def "should handle retrofit network error and return the task status depending on the scenarios"() {
given:
def monitorServiceStub = Stub(DeploymentMonitorService) {
evaluateHealth(_) >> {
Expand Down Expand Up @@ -198,6 +204,202 @@ class EvaluateDeploymentHealthTaskSpec extends Specification {
false | null || ExecutionStatus.FAILED_CONTINUE
}

def "should handle retrofit http error and return the task status depending on the scenarios"() {

def converter = new JacksonConverter(new ObjectMapper())

Response response =
new Response(
"/deployment/evaluateHealth",
HttpStatus.BAD_REQUEST.value(),
"bad-request",
Collections.emptyList(),
new MortServiceSpec.MockTypedInput(converter, [
accountName: "account",
description: "simple description",
name: "sg1",
region: "region",
type: "openstack"
]))

given:
def monitorServiceStub = Stub(DeploymentMonitorService) {
evaluateHealth(_) >> {
throw RetrofitError.httpError("https://foo.com/deployment/evaluateHealth", response, converter, null)
}
}

def serviceProviderStub = getServiceProviderStub(monitorServiceStub)

def task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())

MonitoredDeployInternalStageData stageData = new MonitoredDeployInternalStageData()
stageData.deploymentMonitor = new DeploymentMonitorStageConfig()
stageData.deploymentMonitor.id = "LogMonitorId"

def stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [application: pipe.application])
stage.startTime = Instant.now().toEpochMilli()

when: 'we can still retry'
TaskResult result = task.execute(stage)

then: 'should retry'
result.status == ExecutionStatus.RUNNING
result.context.deployMonitorHttpRetryCount == 1

when: 'we ran out of retries'
stage.context.deployMonitorHttpRetryCount = MonitoredDeployBaseTask.MAX_RETRY_COUNT
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL

when: 'we ran out of retries and failOnError = false'
serviceProviderStub = getServiceProviderStub(monitorServiceStub, {DeploymentMonitorDefinition dm -> dm.failOnError = false})
task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())
result = task.execute(stage)

then: 'should return fail_continue'
result.status == ExecutionStatus.FAILED_CONTINUE

when: 'we ran out of retries and failOnError = false but there is a stage override for failOnError=true'
stageData.deploymentMonitor.failOnErrorOverride = true
stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [
application: pipe.application,
deployMonitorHttpRetryCount: MonitoredDeployBaseTask.MAX_RETRY_COUNT
])
stage.startTime = Instant.now().toEpochMilli()
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL
}

def "should handle retrofit conversion error and return the task status depending on the scenarios"() {
def converter = new JacksonConverter(new ObjectMapper())

Response response =
new Response(
"/deployment/evaluateHealth",
HttpStatus.BAD_REQUEST.value(),
"bad-request",
Collections.emptyList(),
new MortServiceSpec.MockTypedInput(converter, [
accountName: "account",
description: "simple description",
name: "sg1",
region: "region",
type: "openstack"
]))

given:
def monitorServiceStub = Stub(DeploymentMonitorService) {
evaluateHealth(_) >> {
throw RetrofitError.conversionError("https://foo.com/deployment/evaluateHealth", response, converter, null, new ConversionException("Failed to parse/convert the error response body"))
}
}

def serviceProviderStub = getServiceProviderStub(monitorServiceStub)

def task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())

MonitoredDeployInternalStageData stageData = new MonitoredDeployInternalStageData()
stageData.deploymentMonitor = new DeploymentMonitorStageConfig()
stageData.deploymentMonitor.id = "LogMonitorId"

def stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [application: pipe.application])
stage.startTime = Instant.now().toEpochMilli()

when: 'we can still retry'
TaskResult result = task.execute(stage)

then: 'should retry'
result.status == ExecutionStatus.RUNNING
result.context.deployMonitorHttpRetryCount == 1

when: 'we ran out of retries'
stage.context.deployMonitorHttpRetryCount = MonitoredDeployBaseTask.MAX_RETRY_COUNT
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL

when: 'we ran out of retries and failOnError = false'
serviceProviderStub = getServiceProviderStub(monitorServiceStub, {DeploymentMonitorDefinition dm -> dm.failOnError = false})
task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())
result = task.execute(stage)

then: 'should return fail_continue'
result.status == ExecutionStatus.FAILED_CONTINUE

when: 'we ran out of retries and failOnError = false but there is a stage override for failOnError=true'
stageData.deploymentMonitor.failOnErrorOverride = true
stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [
application: pipe.application,
deployMonitorHttpRetryCount: MonitoredDeployBaseTask.MAX_RETRY_COUNT
])
stage.startTime = Instant.now().toEpochMilli()
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL
}

def "should handle retrofit unexpected error and return the task status depending on the scenarios"() {

given:
def monitorServiceStub = Stub(DeploymentMonitorService) {
evaluateHealth(_) >> {
throw RetrofitError.unexpectedError("url", new IOException())
}
}

def serviceProviderStub = getServiceProviderStub(monitorServiceStub)

def task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())

MonitoredDeployInternalStageData stageData = new MonitoredDeployInternalStageData()
stageData.deploymentMonitor = new DeploymentMonitorStageConfig()
stageData.deploymentMonitor.id = "LogMonitorId"

def stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [application: pipe.application])
stage.startTime = Instant.now().toEpochMilli()

when: 'we can still retry'
TaskResult result = task.execute(stage)

then: 'should retry'
result.status == ExecutionStatus.RUNNING
result.context.deployMonitorHttpRetryCount == 1

when: 'we ran out of retries'
stage.context.deployMonitorHttpRetryCount = MonitoredDeployBaseTask.MAX_RETRY_COUNT
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL

when: 'we ran out of retries and failOnError = false'
serviceProviderStub = getServiceProviderStub(monitorServiceStub, {DeploymentMonitorDefinition dm -> dm.failOnError = false})
task = new EvaluateDeploymentHealthTask(serviceProviderStub, new NoopRegistry())
result = task.execute(stage)

then: 'should return fail_continue'
result.status == ExecutionStatus.FAILED_CONTINUE

when: 'we ran out of retries and failOnError = false but there is a stage override for failOnError=true'
stageData.deploymentMonitor.failOnErrorOverride = true
stage = new StageExecutionImpl(pipe, "evaluateDeploymentHealth", stageData.toContextMap() + [
application: pipe.application,
deployMonitorHttpRetryCount: MonitoredDeployBaseTask.MAX_RETRY_COUNT
])
stage.startTime = Instant.now().toEpochMilli()
result = task.execute(stage)

then: 'should terminate'
result.status == ExecutionStatus.TERMINAL
}

private getServiceProviderStub(monitorServiceStub) {
return getServiceProviderStub(monitorServiceStub, {})
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,22 @@
import static org.assertj.core.api.Assertions.assertThat;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.io.CharStreams;
import com.netflix.spectator.api.NoopRegistry;
import com.netflix.spinnaker.config.DeploymentMonitorDefinition;
import com.netflix.spinnaker.orca.deploymentmonitor.DeploymentMonitorServiceProvider;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
Expand Down Expand Up @@ -168,6 +173,99 @@ void shouldReturnDefaultLogMsgWhenUnexpectedErrorHasOccurred() {
assertThat(logMessageOnUnexpectedError).isEqualTo("<NO RESPONSE>");
}

@Test
void shouldReturnEmptyHttpErrorDetailsWhenExceptionThrownWhileReadingHttpStatus() {

var converter = new JacksonConverter(objectMapper);
var responseBody = new HashMap<String, String>();

responseBody.put("error", "400 - Bad request, application name cannot be empty");

Response response =
Mockito.spy(
new Response(
"/deployment/evaluateHealth",
HttpStatus.BAD_REQUEST.value(),
HttpStatus.BAD_REQUEST.name(),
Collections.emptyList(),
new MockTypedInput(converter, responseBody)));

Mockito.when(response.getStatus()).thenThrow(IllegalArgumentException.class);

String logMessageOnHttpError = monitoredDeployBaseTask.getRetrofitLogMessage(response);

String status = "";
String body = "";
String headers = "";

assertThat(logMessageOnHttpError)
.isEqualTo(
String.format("status: %s\nheaders: %s\nresponse body: %s", status, headers, body));
}

@Test
void shouldReturnOnlyStatusWhenExceptionThrownWhileParsingHttpErrorBody() {

var converter = new JacksonConverter(objectMapper);
var responseBody = new HashMap<String, String>();

responseBody.put("error", "400 - Bad request, application name cannot be empty");

Response response =
Mockito.spy(
new Response(
"/deployment/evaluateHealth",
HttpStatus.BAD_REQUEST.value(),
HttpStatus.BAD_REQUEST.name(),
Collections.emptyList(),
new MockTypedInput(converter, responseBody)));

Mockito.when(response.getBody()).thenThrow(IllegalArgumentException.class);

String logMessageOnHttpError = monitoredDeployBaseTask.getRetrofitLogMessage(response);

String status = String.format("%d (%s)", response.getStatus(), response.getReason());
String body = "";
String headers = "";

assertThat(logMessageOnHttpError)
.isEqualTo(
String.format("status: %s\nheaders: %s\nresponse body: %s", status, headers, body));
}

@Test
void shouldReturnOnlyStatusAndBodyWhenExceptionThrownWhileReadingHttpHeaders()
throws IOException {

var converter = new JacksonConverter(objectMapper);
var responseBody = new HashMap<String, String>();

responseBody.put("error", "400 - Bad request, application name cannot be empty");

Response response =
Mockito.spy(
new Response(
"/deployment/evaluateHealth",
HttpStatus.BAD_REQUEST.value(),
HttpStatus.BAD_REQUEST.name(),
Collections.emptyList(),
new MockTypedInput(converter, responseBody)));

Mockito.when(response.getHeaders()).thenThrow(IllegalArgumentException.class);

String logMessageOnHttpError = monitoredDeployBaseTask.getRetrofitLogMessage(response);

String status = String.format("%d (%s)", response.getStatus(), response.getReason());
String body =
CharStreams.toString(
new InputStreamReader(response.getBody().in(), StandardCharsets.UTF_8));
String headers = "";

assertThat(logMessageOnHttpError)
.isEqualTo(
String.format("status: %s\nheaders: %s\nresponse body: %s", status, headers, body));
}

static class MockTypedInput implements TypedInput {
private final Converter converter;
private final Object body;
Expand Down

0 comments on commit f04e4ef

Please sign in to comment.