feat: add default package in case no one is specified (#442)

Author: ndr-brt

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

@@ -58,8 +58,6 @@ public void apply(Project target) {
             var resolve = tasks.named("resolve");
             resolve.configure(it -> it.setEnabled(false));
 
-            var openapiAll = tasks.register("openapi");
-
             target.afterEvaluate(p -> getApiGroups(swaggerExt).forEach(apiGroup -> {
                 var resolveTask = tasks.register("resolve" + apiGroup.name(), ResolveTask.class, task -> {
                     var fallbackOutputDir = defaultOutputDirectory(target);
@@ -90,7 +88,6 @@ public void apply(Project target) {
 
                     baseTaskConfiguration(task, target);
                 });
-                openapiAll.configure(t -> t.dependsOn(openapiTask));
                 tasks.named("jar").configure(t -> t.dependsOn(openapiTask));
             }));
 

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

@@ -23,17 +23,20 @@
 
 public abstract class SwaggerGeneratorExtension {
 
-    private Set<String> resourcePackages = Set.of("org.eclipse.edc");
-    private Set<ApiGroup> apiGroups = new HashSet<>();
+    public static final String DEFAULT_PACKAGE = "org.eclipse.edc";
+    private Set<String> resourcePackages = Set.of(DEFAULT_PACKAGE);
+    private final Set<ApiGroup> apiGroups = new HashSet<>();
 
     public abstract Property<String> getOutputFilename();
 
     public abstract Property<File> getOutputDirectory();
 
+    @Deprecated(since = "0.15.1")
     public Set<String> getResourcePackages() {
         return resourcePackages;
     }
 
+    @Deprecated(since = "0.15.1")
     public void setResourcePackages(Set<String> resourcePackages) {
         this.resourcePackages = resourcePackages;
     }
@@ -48,7 +51,8 @@ public void setResourcePackages(Set<String> resourcePackages) {
     public abstract Property<String> getApiGroup();
 
     public void apiGroup(String group, String... packages) {
-        apiGroups.add(new ApiGroup(group, new HashSet<>(Arrays.asList(packages))));
+        var groupPackages = packages.length == 0 ? Set.of(DEFAULT_PACKAGE) : new HashSet<>(Arrays.asList(packages));
+        apiGroups.add(new ApiGroup(group, groupPackages));
     }
 
     public Set<ApiGroup> getApiGroups() {

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

@@ -55,7 +55,7 @@ void shouldDisableTask_whenNoGroupSpecified() {
     }
 
     @Test
-    void apply_whenApiGroupSpecified_shouldAppend() {
+    void shouldCreateTaskForApiGroup() {
         var swagger = ConventionFunctions.requireExtension(project, BuildExtension.class).getSwagger();
         swagger.apiGroup("test-api");
 
@@ -69,6 +69,27 @@ void apply_whenApiGroupSpecified_shouldAppend() {
                 assertThat(actual.getOutputDir().get().toString()).endsWith("/resources/openapi/yaml/test-api");
                 assertThat(actual.getOutputFileName().get()).isEqualTo(PROJECT_NAME);
                 assertThat(actual.getOutputFormat().get()).isEqualTo(ResolveTask.Format.YAML);
+                assertThat(actual.getResourcePackages().get()).containsExactly("org.eclipse.edc");
+            });
+        });
+    }
+
+    @Test
+    void shouldAssignPackageNames() {
+        var swagger = ConventionFunctions.requireExtension(project, BuildExtension.class).getSwagger();
+        swagger.apiGroup("test-api", "package.name");
+
+        convention.apply(project);
+        ((ProjectInternal) project).evaluate();
+        var resolveTask = project.getTasks().getByName("resolve");
+
+        assertThat(resolveTask.getDependsOn()).hasSize(1).first().isInstanceOfSatisfying(TaskProvider.class, taskProvider -> {
+            assertThat(taskProvider.isPresent()).isTrue();
+            assertThat(taskProvider.get()).isInstanceOfSatisfying(ResolveTask.class, actual -> {
+                assertThat(actual.getOutputDir().get().toString()).endsWith("/resources/openapi/yaml/test-api");
+                assertThat(actual.getOutputFileName().get()).isEqualTo(PROJECT_NAME);
+                assertThat(actual.getOutputFormat().get()).isEqualTo(ResolveTask.Format.YAML);
+                assertThat(actual.getResourcePackages().get()).containsExactly("package.name");
             });
         });
     }