feat(build): add apiGroup to config (#42)

Author: paullatzelsperger

plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/conventions/SwaggerGeneratorConvention.java

@@ -21,6 +21,7 @@
 import org.gradle.api.plugins.JavaPluginExtension;
 import org.hidetake.gradle.swagger.generator.SwaggerGeneratorPlugin;
 
+import java.nio.file.Path;
 import java.util.Map;
 
 import static org.eclipse.edc.plugins.edcbuild.conventions.ConventionFunctions.requireExtension;
@@ -30,6 +31,9 @@
  * Congfigures the Swagger Generator to create openapi yaml file per project
  */
 class SwaggerGeneratorConvention implements EdcConvention {
+
+    private static final String DEFAULT_API_GROUP = "";
+
     @Override
     public void apply(Project target) {
         // apply root script plugin
@@ -46,10 +50,15 @@ public void apply(Project target) {
 
             var javaExt = requireExtension(target, JavaPluginExtension.class);
             var swaggerExt = requireExtension(target, BuildExtension.class).getSwagger();
-            var outputPath = defaultOutputDirectory(target);
+            var fallbackOutputDir = defaultOutputDirectory(target);
 
             var outputFileName = swaggerExt.getOutputFilename().getOrElse(target.getName());
-            var outputDir = swaggerExt.getOutputDirectory().getOrElse(outputPath.toFile());
+
+            var apiGroup = swaggerExt.getApiGroup().getOrElse(DEFAULT_API_GROUP);
+            var outputDir = Path.of(swaggerExt.getOutputDirectory().getOrElse(fallbackOutputDir.toFile()).toURI())
+                    .resolve(apiGroup)
+                    .toFile();
+
             var resourcePkgs = swaggerExt.getResourcePackages(); // already provides the default
 
             target.getTasks().withType(ResolveTask.class, task -> {

plugins/edc-build/src/main/java/org/eclipse/edc/plugins/edcbuild/extensions/SwaggerGeneratorExtension.java

@@ -77,4 +77,7 @@ public String getMergedFileExtension() {
     public void setMergedFileExtension(String mergedFileExtension) {
         this.mergedFileExtension = mergedFileExtension;
     }
+
+    public abstract Property<String> getApiGroup();
+
 }

plugins/edc-build/src/test/java/org/eclipse/edc/plugins/edcbuild/conventions/SwaggerGeneratorConventionTest.java

@@ -0,0 +1,90 @@
+/*
+ *  Copyright (c) 2022 Microsoft Corporation
+ *
+ *  This program and the accompanying materials are made available under the
+ *  terms of the Apache License, Version 2.0 which is available at
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *
+ *  Contributors:
+ *       Microsoft Corporation - initial API and implementation
+ *
+ */
+
+package org.eclipse.edc.plugins.edcbuild.conventions;
+
+import io.swagger.v3.plugins.gradle.tasks.ResolveTask;
+import org.eclipse.edc.plugins.edcbuild.extensions.BuildExtension;
+import org.gradle.api.Project;
+import org.gradle.api.plugins.JavaPlugin;
+import org.gradle.testfixtures.ProjectBuilder;
+import org.hidetake.gradle.swagger.generator.SwaggerGeneratorPlugin;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SwaggerGeneratorConventionTest {
+
+
+    private static final String PROJECT_NAME = "testproject";
+    private Project project;
+
+    @BeforeEach
+    void setUp() {
+        project = ProjectBuilder.builder().withName(PROJECT_NAME).build();
+        project.getPluginManager().apply("io.swagger.core.v3.swagger-gradle-plugin");
+        project.getPluginManager().apply(JavaPlugin.class);
+        project.getExtensions().create("edcBuild", BuildExtension.class, project.getObjects());
+    }
+
+    @Test
+    void apply_whenApiGroupNotSpecified_shouldUseDefault() {
+        var convention = new SwaggerGeneratorConvention();
+        convention.apply(project);
+
+        assertThat(project.getPlugins().findPlugin(SwaggerGeneratorPlugin.class)).isNotNull();
+
+        var resolveTask = (ResolveTask) project.getTasks().getByName("resolve");
+
+        assertThat(resolveTask.getOutputDir().getPath()).endsWith("/resources/openapi/yaml");
+        assertThat(resolveTask.getOutputFileName()).isEqualTo(PROJECT_NAME);
+        assertThat(resolveTask.getOutputFormat()).isEqualTo(ResolveTask.Format.YAML);
+    }
+
+    @Test
+    void apply_whenApiGroupSpecified_shouldAppend() {
+        var swagger = ConventionFunctions.requireExtension(project, BuildExtension.class).getSwagger();
+        swagger.getApiGroup().set("test-api");
+        var convention = new SwaggerGeneratorConvention();
+        convention.apply(project);
+
+        assertThat(project.getPlugins().findPlugin(SwaggerGeneratorPlugin.class)).isNotNull();
+
+        var resolveTask = (ResolveTask) project.getTasks().getByName("resolve");
+
+        assertThat(resolveTask.getOutputDir().getPath()).endsWith("/resources/openapi/yaml/test-api");
+        assertThat(resolveTask.getOutputFileName()).isEqualTo(PROJECT_NAME);
+        assertThat(resolveTask.getOutputFormat()).isEqualTo(ResolveTask.Format.YAML);
+    }
+
+    @Test
+    void apply_whenOutputDirSet_shouldAppend() {
+        var swagger = ConventionFunctions.requireExtension(project, BuildExtension.class).getSwagger();
+        swagger.getApiGroup().set("test-api");
+        swagger.getOutputDirectory().set(new File("some/funny/path"));
+        var convention = new SwaggerGeneratorConvention();
+        convention.apply(project);
+
+        assertThat(project.getPlugins().findPlugin(SwaggerGeneratorPlugin.class)).isNotNull();
+
+        var resolveTask = (ResolveTask) project.getTasks().getByName("resolve");
+
+        assertThat(resolveTask.getOutputDir().getPath()).endsWith("/some/funny/path/test-api");
+        assertThat(resolveTask.getOutputFileName()).isEqualTo(PROJECT_NAME);
+        assertThat(resolveTask.getOutputFormat()).isEqualTo(ResolveTask.Format.YAML);
+    }
+}