Add swagger-ui support (#679)

* adds draft impl of swagger support

* implements swagger config application context test

* updates CHANGELOG.md

Author: stitakis

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Added
 
+- Add swagger-ui support ([#679](https://github.com/opendevstack/ods-provisioning-app/pull/679))
 - Handle logout in SPA ([#675](https://github.com/opendevstack/ods-provisioning-app/issues/675)) 
 - Handle form based auth in SPA ([#637](https://github.com/opendevstack/ods-provisioning-app/issues/637)) 
 - Add default permissions to project groups on project creation ([#636](https://github.com/opendevstack/ods-provisioning-app/pull/636))

build.gradle

@@ -60,6 +60,7 @@ configurations {
 }
 
 dependencies {
+    implementation('io.springfox:springfox-boot-starter:3.0.0')
     implementation('org.springframework.boot:spring-boot-starter-actuator')
     implementation('org.springframework.boot:spring-boot-starter-mail')
     implementation('org.springframework.boot:spring-boot-starter-security')

src/main/java/org/opendevstack/provision/config/SwaggerConfig.java

@@ -0,0 +1,25 @@
+package org.opendevstack.provision.config;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.oas.annotations.EnableOpenApi;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spring.web.plugins.Docket;
+
+@Configuration
+@EnableOpenApi
+@ConditionalOnProperty(name = "springfox.documentation.enabled", havingValue = "true")
+public class SwaggerConfig {
+
+  @Bean
+  public Docket api() {
+    return new Docket(DocumentationType.OAS_30)
+        .select()
+        .apis(RequestHandlerSelectors.any())
+        .paths(PathSelectors.any())
+        .build();
+  }
+}

src/main/resources/application.properties

@@ -146,3 +146,5 @@ jenkinspipeline.adminjobs.delete-projects.repo=ods-core
 
 jenkinspipeline.adminjobs.delete-components.desc=Delete openshift components 
 jenkinspipeline.adminjobs.delete-components.repo=ods-core
+
+springfox.documentation.enabled=false

src/test/java/org/opendevstack/provision/config/SwaggerConfigTest.java

@@ -0,0 +1,44 @@
+package org.opendevstack.provision.config;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.NoSuchBeanDefinitionException;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import springfox.documentation.spring.web.plugins.Docket;
+
+class SwaggerConfigTest {
+
+  private final ApplicationContextRunner contextRunner = new ApplicationContextRunner();
+
+  @Test
+  public void whenDefaultApplicationContext_thenSwaggerUINotAvailable() {
+    this.contextRunner
+        .withUserConfiguration(SwaggerConfig.class)
+        .run(
+            context -> {
+              try {
+                // this raise an exception if the bean does not exists!
+                Docket docket = context.getBean(Docket.class);
+                Assertions.fail();
+              } catch (NoSuchBeanDefinitionException ex) {
+                // This is expected
+              }
+            });
+  }
+
+  @Test
+  public void whenDocumentationPropertyIsTrue_thenSwaggerUIIsAvailable() {
+
+    this.contextRunner
+        .withPropertyValues("springfox.documentation.enabled=true")
+        .withUserConfiguration(SwaggerConfig.class)
+        .run(
+            context -> {
+              // this raise an exception if the bean does not exists!
+              Docket docket = context.getBean(Docket.class);
+              assertThat(docket).isNotNull(); // This is redundant
+            });
+  }
+}