chore(swagger): Code minus kork constraints to switch to openapi.

spinnaker · Jul 18, 2024 · 3850647 · 3850647
1 parent 08fa4c8
commit 3850647
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 41 deletions.
diff --git a/build.gradle b/build.gradle
@@ -19,7 +19,6 @@ allprojects {
   apply plugin: 'org.openrewrite.rewrite'
 
   group = "io.spinnaker.gate"
-
   if ([korkVersion, fiatVersion].find { it.endsWith('-SNAPSHOT') }) {
     repositories {
       mavenLocal()

diff --git a/gate-bom/gate-bom.gradle b/gate-bom/gate-bom.gradle
@@ -28,9 +28,6 @@ dependencies {
     api("io.spinnaker.fiat:fiat-api:$fiatVersion")
     api("io.spinnaker.fiat:fiat-core:$fiatVersion")
 
-    api("io.swagger.core.v3:swagger-annotations:2.2.22")
-    api("io.swagger.core.v3:swagger-core:2.2.22")
-
 
     rootProject
       .subprojects

diff --git a/gate-integrations-gremlin/gate-integrations-gremlin.gradle b/gate-integrations-gremlin/gate-integrations-gremlin.gradle
@@ -1,6 +1,4 @@
 dependencies {
-  implementation platform(project(":gate-bom"))
-
   implementation project(":gate-core")
   implementation "io.swagger.core.v3:swagger-annotations"
 

diff --git a/gate-web/gate-web.gradle b/gate-web/gate-web.gradle
@@ -53,7 +53,7 @@ dependencies {
       force = true					   // Unpin it after adoption of spring-boot-starter-graphql
    }
 
-  implementation "io.springfox:springfox-swagger2"
+  implementation "org.springdoc:springdoc-openapi-ui:1.8.0"
 
   implementation "io.cloudevents:cloudevents-spring:2.5.0"
   implementation "io.cloudevents:cloudevents-json-jackson:2.5.0"

diff --git a/...web/src/main/groovy/com/netflix/spinnaker/gate/config/CloudEventHandlerConfiguration.java b/...web/src/main/groovy/com/netflix/spinnaker/gate/config/CloudEventHandlerConfiguration.java
@@ -26,7 +26,7 @@
 public class CloudEventHandlerConfiguration implements WebMvcConfigurer {
 
   @Override
-  public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
+  public void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
     converters.add(cloudEventHttpMessageConverter());
   }
 

diff --git a/gate-web/src/main/groovy/com/netflix/spinnaker/gate/config/GateConfig.groovy b/gate-web/src/main/groovy/com/netflix/spinnaker/gate/config/GateConfig.groovy
@@ -18,7 +18,6 @@ package com.netflix.spinnaker.gate.config
 
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.SerializationFeature
-import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
 import com.netflix.spectator.api.Registry
 import com.netflix.spinnaker.config.DefaultServiceEndpoint
 import com.netflix.spinnaker.config.OkHttp3ClientConfiguration
@@ -28,8 +27,6 @@ import com.netflix.spinnaker.fiat.shared.FiatPermissionEvaluator
 import com.netflix.spinnaker.fiat.shared.FiatService
 import com.netflix.spinnaker.fiat.shared.FiatStatus
 import com.netflix.spinnaker.filters.AuthenticatedRequestFilter
-import com.netflix.spinnaker.gate.converters.JsonHttpMessageConverter
-import com.netflix.spinnaker.gate.converters.YamlHttpMessageConverter
 import com.netflix.spinnaker.gate.filters.RequestLoggingFilter
 import com.netflix.spinnaker.gate.filters.RequestSheddingFilter
 import com.netflix.spinnaker.gate.filters.ResetAuthenticatedRequestFilter
@@ -57,7 +54,6 @@ import org.springframework.context.annotation.Configuration
 import org.springframework.context.annotation.Import
 import org.springframework.context.annotation.Primary
 import org.springframework.core.Ordered
-import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter
 import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
 import org.springframework.util.CollectionUtils
 import org.springframework.web.client.RestTemplate
@@ -101,19 +97,6 @@ class GateConfig {
   @Autowired
   Jackson2ObjectMapperBuilder objectMapperBuilder
 
-  /**
-   * This needs to be before the yaml converter in order for json to be the default
-   * response type.
-   */
-  @Bean
-  AbstractJackson2HttpMessageConverter jsonHttpMessageConverter() {
-    return new JsonHttpMessageConverter(objectMapperBuilder.build())
-  }
-
-  @Bean
-  AbstractJackson2HttpMessageConverter yamlHttpMessageConverter() {
-    return new YamlHttpMessageConverter(objectMapperBuilder.factory(new YAMLFactory()).build())
-  }
 
   @Bean
   RequestContextProvider requestContextProvider() {

diff --git a/gate-web/src/main/groovy/com/netflix/spinnaker/gate/config/GateWebConfig.groovy b/gate-web/src/main/groovy/com/netflix/spinnaker/gate/config/GateWebConfig.groovy
@@ -16,27 +16,32 @@
 
 package com.netflix.spinnaker.gate.config
 
+
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
 import com.netflix.spectator.api.Registry
+import com.netflix.spinnaker.gate.converters.JsonHttpMessageConverter
+import com.netflix.spinnaker.gate.converters.YamlHttpMessageConverter
 import com.netflix.spinnaker.gate.filters.ContentCachingFilter
 import com.netflix.spinnaker.gate.interceptors.RequestContextInterceptor
 import com.netflix.spinnaker.gate.interceptors.ResponseHeaderInterceptor
 import com.netflix.spinnaker.gate.interceptors.ResponseHeaderInterceptorConfigurationProperties
 import com.netflix.spinnaker.gate.retrofit.UpstreamBadRequest
 import com.netflix.spinnaker.kork.dynamicconfig.DynamicConfigService
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import com.netflix.spinnaker.kork.web.interceptors.MetricsInterceptor
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Value
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.context.ApplicationContext
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.ComponentScan
 import org.springframework.context.annotation.Configuration
 import org.springframework.http.HttpStatus
+import org.springframework.http.converter.HttpMessageConverter
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder
 import org.springframework.web.bind.annotation.ControllerAdvice
 import org.springframework.web.bind.annotation.ExceptionHandler
 import org.springframework.web.bind.annotation.ResponseBody
-import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer
 import org.springframework.web.servlet.config.annotation.InterceptorRegistry
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
 import org.springframework.web.servlet.handler.HandlerMappingIntrospector
@@ -54,6 +59,9 @@ public class GateWebConfig implements WebMvcConfigurer {
 
   @Autowired
   DynamicConfigService dynamicConfigService
+  @Autowired
+  Jackson2ObjectMapperBuilder objectMapperBuilder
+
 
   @Autowired
   Registry spectatorRegistry
@@ -68,7 +76,7 @@ public class GateWebConfig implements WebMvcConfigurer {
   public void addInterceptors(InterceptorRegistry registry) {
     registry.addInterceptor(
       new MetricsInterceptor(
-        this.registry, "controller.invocations", ["account", "region"], ["BasicErrorController"]
+        this.registry, "controller.invocations", ["account", "region"], null, ["BasicErrorController"]
       )
     )
 
@@ -81,8 +89,12 @@ public class GateWebConfig implements WebMvcConfigurer {
     return new HandlerMappingIntrospector(context)
   }
 
-
-  // Add the ability to disable as this breaks numerous integration patterns
+  @Override
+  void extendMessageConverters(List<HttpMessageConverter<?>> converters) {
+    converters.add(new JsonHttpMessageConverter(objectMapperBuilder.build()))
+    converters.add( new YamlHttpMessageConverter(objectMapperBuilder.factory(new YAMLFactory()).build()))
+  }
+// Add the ability to disable as this breaks numerous integration patterns
   @Bean
   @ConditionalOnProperty(value = "content.cachingFilter.enabled", matchIfMissing = true)
   Filter contentCachingFilter() {
@@ -126,9 +138,4 @@ public class GateWebConfig implements WebMvcConfigurer {
       ]
     }
   }
-
-  @Override
-  void configureContentNegotiation(ContentNegotiationConfigurer configurer) {
-    configurer.favorPathExtension(false)
-  }
 }
diff --git a/gate-web/src/main/groovy/com/netflix/spinnaker/gate/controllers/AuthController.groovy b/gate-web/src/main/groovy/com/netflix/spinnaker/gate/controllers/AuthController.groovy
@@ -31,7 +31,6 @@ import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RequestMethod
 import org.springframework.web.bind.annotation.RequestParam
 import org.springframework.web.bind.annotation.RestController
-import springfox.documentation.annotations.ApiIgnore
 
 import javax.servlet.http.HttpServletResponse
 import java.util.regex.Pattern
@@ -69,9 +68,9 @@ class AuthController {
     }
   }
 
-  @Operation(summary = "Get user")
+  @Operation(summary = "Get user", hidden=true)
   @RequestMapping(value = "/user", method = RequestMethod.GET)
-  User user(@ApiIgnore @SpinnakerUser User user) {
+  User user(@SpinnakerUser User user) {
     if (!user) {
       return user
     }
@@ -83,9 +82,9 @@ class AuthController {
     return user
   }
 
-  @Operation(summary = "Get service accounts")
+  @Operation(summary = "Get service accounts", hidden=true)
   @RequestMapping(value = "/user/serviceAccounts", method = RequestMethod.GET)
-  List<String> getServiceAccounts(@ApiIgnore @SpinnakerUser User user,
+  List<String> getServiceAccounts(@SpinnakerUser User user,
                                   @RequestParam(name = "application", required = false) String application) {
 
     String appName = Optional.ofNullable(application)

diff --git a/gate-web/src/main/resources/application.properties b/gate-web/src/main/resources/application.properties
@@ -23,3 +23,4 @@ spring.jackson.deserialization.read-unknown-enum-values-as-null=true
 # https://github.com/spinnaker/gate/pull/230
 # Either way, this filter needs to come before the AuthenticatedRequestFilter
 spring.security.filter.order=0
+springdoc.writer-with-default-pretty-printer=true
diff --git a/gradle.properties b/gradle.properties
@@ -1,7 +1,7 @@
 enablePublishing=false
 fiatVersion=1.48.0
 includeProviders=basic,iap,ldap,oauth2,saml,x509
-korkVersion=7.235.0
+korkVersion=opendocs-upgrade-SNAPSHOT
 kotlinVersion=1.6.21
 org.gradle.parallel=true
 spinnakerGradleVersion=8.32.1