Improve error message namespace mismatch (#105)

* Improve error message namespace mismatch * Fix unit test
michelin · Feb 24, 2024 · 084dd74 · 084dd74
1 parent 1856be3
commit 084dd74
Show file tree

Hide file tree

Showing 17 changed files with 96 additions and 93 deletions.
diff --git a/src/main/java/com/michelin/kafkactl/ApiResourcesSubcommand.java b/src/main/java/com/michelin/kafkactl/ApiResourcesSubcommand.java
@@ -3,7 +3,7 @@
 import static com.michelin.kafkactl.services.FormatService.TABLE;
 import static com.michelin.kafkactl.utils.constants.ConstantKind.RESOURCE_DEFINITION;
 
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.parents.AuthenticatedCommand;
 import com.michelin.kafkactl.services.FormatService;
@@ -44,7 +44,7 @@ public Integer onAuthSuccess() {
             List<Resource> resources = apiResourcesService.listResourceDefinitions()
                 .stream()
                 .map(apiResource -> Resource.builder()
-                    .metadata(ObjectMeta.builder()
+                    .metadata(Metadata.builder()
                         .name(apiResource.getKind())
                         .build())
                     .spec(Map.of("names", String.join(",", apiResource.getNames()),

diff --git a/src/main/java/com/michelin/kafkactl/ConfigSubcommand.java b/src/main/java/com/michelin/kafkactl/ConfigSubcommand.java
@@ -4,7 +4,7 @@
 import static com.michelin.kafkactl.utils.constants.ConstantKind.CONTEXT;
 
 import com.michelin.kafkactl.config.KafkactlConfig;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.services.ConfigService;
 import com.michelin.kafkactl.services.FormatService;
@@ -78,7 +78,7 @@ public Integer call() throws IOException {
 
             String currentContextName = configService.getCurrentContextName();
             Resource currentContextAsResource = Resource.builder()
-                .metadata(ObjectMeta.builder()
+                .metadata(Metadata.builder()
                     .name(currentContextName != null ? currentContextName : StringUtils.EMPTY_STRING)
                     .build())
                 .spec(specs)
@@ -102,7 +102,7 @@ public Integer call() throws IOException {
                 specs.put("token", userContext.getDefinition().getUserToken());
 
                 Resource currentContextAsResource = Resource.builder()
-                    .metadata(ObjectMeta.builder()
+                    .metadata(Metadata.builder()
                         .name(userContext.getName())
                         .build())
                     .spec(specs)

diff --git a/src/main/java/com/michelin/kafkactl/ConnectorsSubcommand.java b/src/main/java/com/michelin/kafkactl/ConnectorsSubcommand.java
@@ -5,7 +5,7 @@
 import static com.michelin.kafkactl.utils.constants.ConstantKind.CONNECTOR;
 
 import com.michelin.kafkactl.models.ApiResource;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.parents.AuthenticatedCommand;
 import com.michelin.kafkactl.services.FormatService;
@@ -72,7 +72,7 @@ public Integer onAuthSuccess() {
             List<Resource> changeConnectorResponses = connectors.stream()
                 // Prepare request object
                 .map(connector -> Resource.builder()
-                    .metadata(ObjectMeta.builder()
+                    .metadata(Metadata.builder()
                         .namespace(namespace)
                         .name(connector)
                         .build())

diff --git a/src/main/java/com/michelin/kafkactl/DeleteSubcommand.java b/src/main/java/com/michelin/kafkactl/DeleteSubcommand.java
@@ -1,7 +1,7 @@
 package com.michelin.kafkactl;
 
 import com.michelin.kafkactl.models.ApiResource;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.parents.DryRunCommand;
 import com.michelin.kafkactl.services.FileService;
@@ -105,7 +105,7 @@ private List<Resource> parseResources(String namespace) {
         }
         // Generate a single resource with minimum details from input
         return List.of(Resource.builder()
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name(config.nameConfig.name)
                 .namespace(namespace)
                 .build())

diff --git a/src/main/java/com/michelin/kafkactl/ResetOffsetsSubcommand.java b/src/main/java/com/michelin/kafkactl/ResetOffsetsSubcommand.java
@@ -1,6 +1,6 @@
 package com.michelin.kafkactl;
 
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.parents.DryRunCommand;
 import com.michelin.kafkactl.services.FormatService;
@@ -84,7 +84,7 @@ public Integer onAuthSuccess() throws IOException {
         Resource consumerGroupResetOffset = Resource.builder()
             .apiVersion("v1")
             .kind("ConsumerGroupResetOffsets")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .namespace(namespace)
                 .name(group)
                 .build())

diff --git a/.../michelin/kafkactl/models/ObjectMeta.java → ...om/michelin/kafkactl/models/Metadata.java b/.../michelin/kafkactl/models/ObjectMeta.java → ...om/michelin/kafkactl/models/Metadata.java
@@ -21,7 +21,7 @@
 @ReflectiveAccess
 @NoArgsConstructor
 @AllArgsConstructor
-public class ObjectMeta {
+public class Metadata {
     private String name;
     private String namespace;
     private String cluster;

diff --git a/src/main/java/com/michelin/kafkactl/models/Resource.java b/src/main/java/com/michelin/kafkactl/models/Resource.java
@@ -19,7 +19,7 @@
 public class Resource {
     private String apiVersion;
     private String kind;
-    private ObjectMeta metadata;
+    private Metadata metadata;
     @JsonInclude(value = JsonInclude.Include.NON_ABSENT)
     private Map<String, Object> spec;
     private Object status;

diff --git a/src/main/java/com/michelin/kafkactl/parents/AuthenticatedCommand.java b/src/main/java/com/michelin/kafkactl/parents/AuthenticatedCommand.java
@@ -71,11 +71,11 @@ protected void validateNamespace(List<Resource> resources) {
         if (!namespaceMismatch.isEmpty()) {
             String invalid = namespaceMismatch
                 .stream()
-                .map(resource -> resource.getKind() + "/" + resource.getMetadata().getName())
+                .map(resource -> "\"" + resource.getKind() + "/" + resource.getMetadata().getName() + "\"")
                 .distinct()
                 .collect(Collectors.joining(", "));
             throw new CommandLine.ParameterException(commandSpec.commandLine(),
-                "Namespace mismatch between Kafkactl and YAML document " + invalid + ".");
+                "Namespace mismatch between Kafkactl configuration and YAML resource(s): " + invalid + ".");
         }
     }
 

diff --git a/src/test/java/com/michelin/kafkactl/ApplySubcommandTest.java b/src/test/java/com/michelin/kafkactl/ApplySubcommandTest.java
@@ -13,7 +13,7 @@
 
 import com.michelin.kafkactl.config.KafkactlConfig;
 import com.michelin.kafkactl.models.ApiResource;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.services.ApiResourcesService;
 import com.michelin.kafkactl.services.FormatService;
@@ -107,7 +107,7 @@ void shouldNotApplyWhenInvalidResources() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .build())
             .spec(Collections.emptyMap())
@@ -135,7 +135,7 @@ void shouldNotApplyWhenNamespaceMismatch() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -155,15 +155,16 @@ void shouldNotApplyWhenNamespaceMismatch() {
 
         int code = cmd.execute("-f", "topic.yml");
         assertEquals(2, code);
-        assertTrue(sw.toString().contains("Namespace mismatch between Kafkactl and YAML document Topic/prefix.topic."));
+        assertTrue(sw.toString().contains("Namespace mismatch between Kafkactl configuration and YAML resource(s): "
+            + "\"Topic/prefix.topic\"."));
     }
 
     @Test
     void shouldNotApplyWhenHttpClientResponseException() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -195,7 +196,7 @@ void shouldApply() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -240,7 +241,7 @@ void shouldApplyDryRun() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .build())
             .spec(Collections.emptyMap())
@@ -288,7 +289,7 @@ void shouldApplySchema() {
         Resource resource = Resource.builder()
             .kind("Schema")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.schema")
                 .namespace("namespace")
                 .build())
@@ -338,7 +339,7 @@ void shouldApplyInlineSchema() {
         Resource resource = Resource.builder()
             .kind("Schema")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.schema")
                 .namespace("namespace")
                 .build())
@@ -385,7 +386,7 @@ void shouldNotApplySchemaWhenNotExist() {
         Resource resource = Resource.builder()
             .kind("Schema")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.schema")
                 .namespace("namespace")
                 .build())

diff --git a/src/test/java/com/michelin/kafkactl/ConnectorsSubcommandTest.java b/src/test/java/com/michelin/kafkactl/ConnectorsSubcommandTest.java
@@ -13,7 +13,7 @@
 
 import com.michelin.kafkactl.config.KafkactlConfig;
 import com.michelin.kafkactl.models.ApiResource;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.services.ApiResourcesService;
 import com.michelin.kafkactl.services.FormatService;
@@ -94,7 +94,7 @@ void shouldChangeState() {
         Resource resource = Resource.builder()
             .kind("Connector")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.connector")
                 .namespace("namespace")
                 .build())
@@ -122,7 +122,7 @@ void shouldChangeStateOfAll() {
         Resource resource = Resource.builder()
             .kind("Connector")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.connector")
                 .namespace("namespace")
                 .build())

diff --git a/src/test/java/com/michelin/kafkactl/DeleteSubcommandTest.java b/src/test/java/com/michelin/kafkactl/DeleteSubcommandTest.java
@@ -10,7 +10,7 @@
 
 import com.michelin.kafkactl.config.KafkactlConfig;
 import com.michelin.kafkactl.models.ApiResource;
-import com.michelin.kafkactl.models.ObjectMeta;
+import com.michelin.kafkactl.models.Metadata;
 import com.michelin.kafkactl.models.Resource;
 import com.michelin.kafkactl.services.ApiResourcesService;
 import com.michelin.kafkactl.services.FileService;
@@ -101,7 +101,7 @@ void shouldNotDeleteByFileWhenInvalidResources() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -147,7 +147,7 @@ void shouldNotDeleteByFileWhenNamespaceMismatch() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -163,7 +163,8 @@ void shouldNotDeleteByFileWhenNamespaceMismatch() {
 
         int code = cmd.execute("-f", "topic");
         assertEquals(2, code);
-        assertTrue(sw.toString().contains("Namespace mismatch between Kafkactl and YAML document Topic/prefix.topic."));
+        assertTrue(sw.toString().contains("Namespace mismatch between Kafkactl configuration and YAML resource(s): "
+            + "\"Topic/prefix.topic\"."));
     }
 
     @Test
@@ -177,7 +178,7 @@ void shouldDeleteByFileSuccess() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -247,7 +248,7 @@ void shouldDeleteByFileDryRunSuccess() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .build())
             .spec(Collections.emptyMap())
@@ -289,7 +290,7 @@ void shouldDeleteByFileFail() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())
@@ -329,7 +330,7 @@ void shouldNotDeleteByFileWhenHttpClientResponseException() {
         Resource resource = Resource.builder()
             .kind("Topic")
             .apiVersion("v1")
-            .metadata(ObjectMeta.builder()
+            .metadata(Metadata.builder()
                 .name("prefix.topic")
                 .namespace("namespace")
                 .build())