Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(retrofit): Replace RetrofitError catch blocks and add spinnakerE… #6015

Merged
merged 14 commits into from
Sep 22, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion clouddriver-appengine/clouddriver-appengine.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ dependencies {
implementation "io.spinnaker.kork:kork-config"
implementation "io.spinnaker.kork:kork-cloud-config-server"
implementation "io.spinnaker.kork:kork-moniker"
implementation "io.spinnaker.kork:kork-retrofit"
implementation "com.netflix.spectator:spectator-api"
implementation "com.squareup.okhttp:okhttp"
implementation "com.squareup.retrofit:retrofit"
dbyron-sf marked this conversation as resolved.
Show resolved Hide resolved
implementation "commons-io:commons-io"
implementation "org.apache.commons:commons-compress:1.21"
implementation "org.codehaus.groovy:groovy"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import com.fasterxml.jackson.databind.ObjectMapper;
import com.netflix.spinnaker.clouddriver.appengine.AppengineJobExecutor;
import com.netflix.spinnaker.clouddriver.googlecommon.config.GoogleCommonManagedAccount;
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerRetrofitErrorHandler;
import com.squareup.okhttp.OkHttpClient;
import java.io.File;
import java.util.ArrayList;
Expand Down Expand Up @@ -103,6 +104,7 @@ static MetadataService createMetadataService() {
new RestAdapter.Builder()
.setEndpoint(metadataUrl)
.setClient(new OkClient(client))
.setErrorHandler(SpinnakerRetrofitErrorHandler.getInstance())
.build();
return restAdapter.create(MetadataService.class);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.netflix.spinnaker.clouddriver.aws.edda

import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerRetrofitErrorHandler
import retrofit.RestAdapter
import retrofit.converter.Converter

Expand All @@ -33,6 +34,7 @@ class EddaApiFactory {
return new RestAdapter.Builder()
.setConverter(eddaConverter)
.setEndpoint(endpointTemplate.replaceAll(Pattern.quote('{{region}}'), region))
.setErrorHandler(SpinnakerRetrofitErrorHandler.getInstance())
.build()
.create(EddaApi)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@
import com.netflix.spinnaker.clouddriver.eureka.deploy.ops.AbstractEurekaSupport.DiscoveryStatus;
import com.netflix.spinnaker.clouddriver.security.AccountCredentials;
import com.netflix.spinnaker.credentials.CredentialsRepository;
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException;
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerNetworkException;
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerServerException;
import java.io.IOException;
import java.time.Duration;
import java.util.Arrays;
Expand All @@ -56,7 +59,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpStatus;
import retrofit.RetrofitError;

public class InstanceTerminationLifecycleWorker implements Runnable {

Expand Down Expand Up @@ -227,13 +229,14 @@ private boolean updateInstanceStatus(Eureka eureka, String app, String instanceI
try {
eureka.updateInstanceStatus(app, instanceId, DiscoveryStatus.OUT_OF_SERVICE.getValue());
return true;
} catch (RetrofitError e) {
} catch (SpinnakerServerException e) {
final String recoverableMessage =
dbyron-sf marked this conversation as resolved.
Show resolved Hide resolved
"Failed marking app out of service (status: {}, app: {}, instance: {}, retry: {})";
if (HttpStatus.NOT_FOUND.value() == e.getResponse().getStatus()) {
log.warn(recoverableMessage, e.getResponse().getStatus(), app, instanceId, retry);
} else if (e.getKind() == RetrofitError.Kind.NETWORK) {
log.error(recoverableMessage, e.getResponse().getStatus(), app, instanceId, retry, e);
if (e instanceof SpinnakerHttpException
&& HttpStatus.NOT_FOUND.value() == ((SpinnakerHttpException) e).getResponseCode()) {
log.warn(recoverableMessage, 404, app, instanceId, retry);
} else if (e instanceof SpinnakerNetworkException) {
log.error(recoverableMessage, "none", app, instanceId, retry, e);
} else {
log.error(
"Irrecoverable error while marking app out of service (app: {}, instance: {}, retry: {})",
Expand All @@ -245,6 +248,7 @@ private boolean updateInstanceStatus(Eureka eureka, String app, String instanceI
}
}
}

return false;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ import com.netflix.spinnaker.clouddriver.aws.deploy.ops.discovery.AwsEurekaSuppo
import com.netflix.spinnaker.clouddriver.aws.model.AutoScalingProcessType
import com.netflix.spinnaker.clouddriver.data.task.DefaultTaskStatus
import com.netflix.spinnaker.clouddriver.data.task.TaskState
import com.netflix.spinnaker.clouddriver.eureka.model.EurekaApplication
import com.netflix.spinnaker.clouddriver.eureka.model.EurekaInstance
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException
import retrofit.RetrofitError
import retrofit.client.Response
import spock.lang.Unroll
Expand Down Expand Up @@ -134,9 +133,9 @@ class DisableAsgAtomicOperationUnitSpec extends EnableDisableAtomicOperationUnit
describeInstanceResult.getReservations() >> [new Reservation().withInstances(instance)]

eureka.updateInstanceStatus('asg1', 'i1', 'OUT_OF_SERVICE') >> {
throw new RetrofitError("error", "url",
throw new SpinnakerHttpException(new RetrofitError("error", "url",
new Response("url", 503, "service unavailable", [], null),
null, null, null, null)
null, null, null, null))
}

when:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ import com.amazonaws.services.ec2.model.DescribeInstancesResult
import com.amazonaws.services.ec2.model.InstanceState
import com.amazonaws.services.ec2.model.InstanceStateName
import com.amazonaws.services.ec2.model.Reservation
import com.netflix.spinnaker.clouddriver.aws.TestCredential
import com.netflix.spinnaker.clouddriver.aws.deploy.description.EnableDisableInstanceDiscoveryDescription
import com.netflix.spinnaker.clouddriver.aws.security.AmazonClientProvider
import com.netflix.spinnaker.clouddriver.aws.services.AsgService
import com.netflix.spinnaker.clouddriver.aws.services.RegionScopedProviderFactory
import com.netflix.spinnaker.clouddriver.data.task.DefaultTaskStatus
import com.netflix.spinnaker.clouddriver.data.task.Task
import com.netflix.spinnaker.clouddriver.data.task.TaskState
Expand All @@ -33,10 +37,7 @@ import com.netflix.spinnaker.clouddriver.eureka.deploy.ops.AbstractEurekaSupport
import com.netflix.spinnaker.clouddriver.eureka.deploy.ops.EurekaSupportConfigurationProperties
import com.netflix.spinnaker.clouddriver.model.ClusterProvider
import com.netflix.spinnaker.clouddriver.model.ServerGroup
import com.netflix.spinnaker.clouddriver.aws.TestCredential
import com.netflix.spinnaker.clouddriver.aws.deploy.description.EnableDisableInstanceDiscoveryDescription
import com.netflix.spinnaker.clouddriver.aws.services.AsgService
import com.netflix.spinnaker.clouddriver.aws.services.RegionScopedProviderFactory
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException
import retrofit.RetrofitError
import retrofit.client.Response
import spock.lang.Specification
Expand Down Expand Up @@ -210,9 +211,9 @@ class DiscoverySupportUnitSpec extends Specification {
task.getStatus() >> new DefaultTaskStatus(TaskState.STARTED)
1 * task.fail()
1 * eureka.getInstanceInfo(_) >> [ instance: [ app: appName, status: "OUT_OF_SERVICE" ] ]
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(400)}
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(400))}
1 * eureka.resetInstanceStatus(appName, "good", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {response(200)}
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(400)}
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(400))}
1 * task.updateStatus("PHASE", { it.startsWith("Looking up discovery") })
3 * task.updateStatus("PHASE", { it.startsWith("Attempting to mark") })
2 * task.updateStatus('PHASE', { it.startsWith("Failed updating status") })
Expand Down Expand Up @@ -243,9 +244,9 @@ class DiscoverySupportUnitSpec extends Specification {
then:
task.getStatus() >> new DefaultTaskStatus(TaskState.STARTED)
1 * eureka.getInstanceInfo(_) >> [ instance: [ app: appName, status: "OUT_OF_SERVICE" ] ]
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(500)}
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(500))}
1 * eureka.resetInstanceStatus(appName, "good", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> response(200)
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(500)}
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(500))}
1 * task.updateStatus("PHASE", { it.startsWith("Looking up discovery") })
3 * task.updateStatus("PHASE", { it.startsWith("Attempting to mark") })
0 * task.updateStatus("PHASE", { it.startsWith("Failed marking instances 'UP'")})
Expand Down Expand Up @@ -279,9 +280,9 @@ class DiscoverySupportUnitSpec extends Specification {
then:
task.getStatus() >> new DefaultTaskStatus(TaskState.STARTED)
1 * eureka.getInstanceInfo(_) >> [ instance: [ app: appName, status: "OUT_OF_SERVICE" ] ]
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(500)}
1 * eureka.resetInstanceStatus(appName, "bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(500))}
1 * eureka.resetInstanceStatus(appName, "good", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> response(200)
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw httpError(500)}
1 * eureka.resetInstanceStatus(appName, "also-bad", AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> {throw new SpinnakerHttpException(httpError(500))}
1 * task.updateStatus("PHASE", { it.startsWith("Looking up discovery") })
3 * task.updateStatus("PHASE", { it.startsWith("Attempting to mark") })
1 * task.updateStatus("PHASE", { it.startsWith("Failed marking instances 'UP'")})
Expand Down Expand Up @@ -313,10 +314,10 @@ class DiscoverySupportUnitSpec extends Specification {
then: "should only retry a maximum of DISCOVERY_RETRY_MAX times on NOT_FOUND"
discoverySupport.eurekaSupportConfigurationProperties.retryMax * task.getStatus() >> new DefaultTaskStatus(TaskState.STARTED)
discoverySupport.eurekaSupportConfigurationProperties.retryMax * eureka.getInstanceInfo(_) >> {
throw httpError(errorCode)
throw new SpinnakerHttpException(httpError(errorCode))
}
0 * task.fail()
thrown(RetrofitError)
thrown(SpinnakerHttpException)

where:
discoveryUrl = "http://us-west-1.discovery.netflix.net"
Expand Down Expand Up @@ -377,8 +378,8 @@ class DiscoverySupportUnitSpec extends Specification {
app: appName
]
]
eureka.updateInstanceStatus(appName, 'i-123', status.value) >> { throw httpError(404) }
eureka.resetInstanceStatus(appName, 'i-123', AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> { throw httpError(404) }
eureka.updateInstanceStatus(appName, 'i-123', status.value) >> { throw new SpinnakerHttpException(httpError(404)) }
eureka.resetInstanceStatus(appName, 'i-123', AbstractEurekaSupport.DiscoveryStatus.OUT_OF_SERVICE.value) >> { throw new SpinnakerHttpException(httpError(404)) }
task.getStatus() >> new DefaultTaskStatus(TaskState.STARTED)
0 * task.fail()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,7 @@ import com.netflix.spinnaker.clouddriver.aws.security.NetflixAmazonCredentials
import com.netflix.spinnaker.clouddriver.eureka.api.Eureka
import com.netflix.spinnaker.clouddriver.eureka.deploy.ops.AbstractEurekaSupport.DiscoveryStatus
import com.netflix.spinnaker.credentials.CredentialsRepository
import retrofit.RetrofitError
import retrofit.RetrofitError.Kind
import retrofit.client.Response
import retrofit.converter.Converter
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerNetworkException
import spock.lang.Shared
import spock.lang.Specification
import spock.lang.Subject
Expand Down Expand Up @@ -213,8 +210,7 @@ class InstanceTerminationLifecycleWorkerSpec extends Specification {

then:
1 * eureka.updateInstanceStatus(_, _, _) >> {
throw new RetrofitError("cannot connect", "http://discovery", new Response("http://discovery", 400, "reason", [], null), Mock(Converter), String, Kind.NETWORK, Mock(Throwable))
}
throw new SpinnakerNetworkException(new RuntimeException("cannot connect")) }
1 * eureka.updateInstanceStatus(_, _, _)
0 * eureka.updateInstanceStatus(_, _, _)
}
Expand Down
2 changes: 2 additions & 0 deletions clouddriver-consul/clouddriver-consul.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ dependencies {
implementation "org.codehaus.groovy:groovy"
implementation "org.codehaus.groovy:groovy-json"
implementation "org.springframework.boot:spring-boot-starter-web"
implementation "io.spinnaker.kork:kork-retrofit"
implementation "io.spinnaker.kork:kork-exceptions"

testImplementation "cglib:cglib-nodep"
testImplementation "org.objenesis:objenesis"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package com.netflix.spinnaker.clouddriver.consul.api.v1

import com.netflix.spinnaker.clouddriver.consul.config.ConsulConfig
import com.netflix.spinnaker.clouddriver.consul.config.ConsulProperties
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerRetrofitErrorHandler
import com.squareup.okhttp.OkHttpClient
import retrofit.RestAdapter
import retrofit.client.OkClient
Expand All @@ -39,6 +40,7 @@ class Consul<T> {
.setEndpoint(this.endpoint)
.setClient(new OkClient(new OkHttpClient()))
.setLogLevel(RestAdapter.LogLevel.NONE)
.setErrorHandler(SpinnakerRetrofitErrorHandler.getInstance())
.build()
.create(type)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,9 @@
package com.netflix.spinnaker.clouddriver.consul.config

import com.netflix.spinnaker.clouddriver.consul.api.v1.ConsulCatalog
import com.netflix.spinnaker.clouddriver.consul.api.v1.services.CatalogApi
import com.squareup.okhttp.OkHttpClient
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerServerException
import groovy.util.logging.Slf4j
import retrofit.RestAdapter
import retrofit.RetrofitError
import retrofit.client.OkClient

import java.lang.invoke.ConstantCallSite
import java.util.concurrent.TimeUnit

@Slf4j
Expand Down Expand Up @@ -57,7 +52,7 @@ class ConsulConfig {
try {
def catalog = new ConsulCatalog(this)
datacenters = catalog.api.datacenters()
} catch (RetrofitError e) {
} catch (SpinnakerServerException e) {
log.warn "Unable to connect to Consul running on the local Clouddriver instance.", e
datacenters = []
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import com.netflix.spinnaker.clouddriver.consul.config.ConsulConfig
import com.netflix.spinnaker.clouddriver.consul.model.ConsulHealth
import com.netflix.spinnaker.clouddriver.consul.model.ConsulNode
import com.netflix.spinnaker.clouddriver.consul.model.ConsulService
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerServerException
import groovy.util.logging.Slf4j
import retrofit.RetrofitError

@Slf4j
class ConsulProviderUtils {
Expand All @@ -40,7 +40,7 @@ class ConsulProviderUtils {
return new ConsulService(result)
} ?: []
running = true
} catch (RetrofitError e) {
} catch (SpinnakerServerException e) {
// Instance can't be connected to on hostname:port/v1/agent/checks
log.debug(e.message)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,21 @@
import com.netflix.spinnaker.clouddriver.model.ServerGroup;
import com.netflix.spinnaker.clouddriver.names.NamerRegistry;
import com.netflix.spinnaker.kork.dynamicconfig.DynamicConfigService;
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException;
import com.netflix.spinnaker.moniker.Moniker;
import java.util.*;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import retrofit.RetrofitError;

@Component
public class TrafficGuard {
Expand Down Expand Up @@ -340,10 +346,9 @@ public boolean hasDisableLock(Moniker clusterMoniker, String account, String loc
Map application;
try {
application = front50Service.getApplication(clusterMoniker.getApp());
} catch (RetrofitError e) {
} catch (SpinnakerHttpException e) {
// ignore an unknown (404) or unauthorized (403) application
if (e.getResponse() != null
&& Arrays.asList(404, 403).contains(e.getResponse().getStatus())) {
if (Arrays.asList(404, 403).contains(e.getResponseCode())) {
application = null;
} else {
throw e;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import com.netflix.spinnaker.clouddriver.model.ServerGroup
import com.netflix.spinnaker.clouddriver.model.SimpleInstance
import com.netflix.spinnaker.clouddriver.model.SimpleServerGroup
import com.netflix.spinnaker.kork.dynamicconfig.DynamicConfigService
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerHttpException
import com.netflix.spinnaker.moniker.Moniker
import retrofit.RetrofitError
import retrofit.client.Response
Expand Down Expand Up @@ -443,7 +444,7 @@ class TrafficGuardSpec extends Specification {
!application.containsKey("trafficGuards")
result == false
1 * front50Service.getApplication("app") >> {
throw new RetrofitError(null, null, new Response("http://stash.com", 404, "test reason", [], null), null, null, null, null)
throw new SpinnakerHttpException(new RetrofitError(null, null, new Response("http://stash.com", 404, "test reason", [], null), null, null, null, null))
}
}

Expand Down
2 changes: 2 additions & 0 deletions clouddriver-docker/clouddriver-docker.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ dependencies {
implementation "io.spinnaker.fiat:fiat-api:$fiatVersion"
implementation "io.spinnaker.fiat:fiat-core:$fiatVersion"
implementation "io.spinnaker.kork:kork-credentials"
implementation "io.spinnaker.kork:kork-retrofit"
implementation "io.spinnaker.kork:kork-exceptions"

testImplementation "cglib:cglib-nodep"
testImplementation "org.objenesis:objenesis"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ package com.netflix.spinnaker.clouddriver.docker.registry.api.v2.auth

import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.DockerUserAgent
import com.netflix.spinnaker.clouddriver.docker.registry.api.v2.exception.DockerRegistryAuthenticationException
import com.netflix.spinnaker.kork.retrofit.exceptions.SpinnakerRetrofitErrorHandler
import groovy.util.logging.Slf4j
import org.apache.commons.io.IOUtils
import retrofit.RestAdapter
Expand Down Expand Up @@ -188,7 +189,11 @@ class DockerBearerTokenService {
def tokenService = realmToService.get(realm)

if (tokenService == null) {
def builder = new RestAdapter.Builder().setEndpoint(realm).setLogLevel(RestAdapter.LogLevel.NONE).build()
def builder = new RestAdapter.Builder()
.setEndpoint(realm)
.setLogLevel(RestAdapter.LogLevel.NONE)
.setErrorHandler(SpinnakerRetrofitErrorHandler.getInstance())
.build()
tokenService = builder.create(TokenService.class)
realmToService[realm] = tokenService
}
Expand Down