Display an error message when apply or diff with a non-existing file (#300)

* Display an error message when applying or diffing a non-existing file

* Handle not found in delete cmd

* update

* update message

* fix test

* add comment

Author: loicgreffier

src/main/java/com/michelin/kafkactl/Kafkactl.java

@@ -78,9 +78,11 @@ public class Kafkactl implements Callable<Integer> {
     public CommandSpec commandSpec;
 
     /**
-     * Main Micronaut method There are 3 ways to configure kafkactl: - Setup config file in $HOME/.kafkactl/config.yml -
-     * Setup config file anywhere and set KAFKACTL_CONFIG=/path/to/config.yml - No file but environment variables
-     * instead
+     * Main Micronaut method.
+     *
+     * <p>There are three ways to configure kafkactl: - Set up a config file in $HOME/.kafkactl/config.yml - Set up a
+     * config file anywhere and set KAFKACTL_CONFIG=/path/to/config.yml - Use environment variables instead of a config
+     * file
      *
      * @param args Input arguments
      */

src/main/java/com/michelin/kafkactl/command/Delete.java

@@ -130,6 +130,12 @@ public Integer onAuthSuccess() {
      */
     private List<Resource> parseResources(String namespace) {
         if (config.fileConfig != null && config.fileConfig.file.isPresent()) {
+            if (!config.fileConfig.file.get().exists()) {
+                throw new ParameterException(
+                        commandSpec.commandLine(),
+                        "File or directory \"" + config.fileConfig.file.get().getAbsolutePath() + "\" not found.");
+            }
+
             // List all files to process
             List<File> yamlFiles =
                     fileService.computeYamlFileList(config.fileConfig.file.get(), config.fileConfig.recursive);

src/main/java/com/michelin/kafkactl/hook/HelpHook.java

@@ -21,7 +21,10 @@
 import picocli.CommandLine.Command;
 import picocli.CommandLine.Option;
 
-/** Help abstract command. */
+/**
+ * Help abstract command. This is preferred over the mixinStandardHelpOptions property of {@link Command}, which
+ * displays the "-V" version option that is only available on the main Kafkactl command.
+ */
 @Command
 public abstract class HelpHook {
     @Option(

src/main/java/com/michelin/kafkactl/service/ResourceService.java

@@ -496,13 +496,20 @@ public int vaultsOnConnectClusters(
      */
     public List<Resource> parseResources(Optional<File> file, boolean recursive, CommandSpec commandSpec) {
         if (file.isPresent()) {
+            if (!file.get().exists()) {
+                throw new ParameterException(
+                        commandSpec.commandLine(),
+                        "File or directory \"" + file.get().getAbsolutePath() + "\" not found.");
+            }
+
             // List all files to process
             List<File> yamlFiles = fileService.computeYamlFileList(file.get(), recursive);
             if (yamlFiles.isEmpty()) {
                 throw new ParameterException(
                         commandSpec.commandLine(),
                         "Could not find YAML or YML files in " + file.get().getName() + " directory.");
             }
+
             // Load each files
             return fileService.parseResourceListFromFiles(yamlFiles);
         }
@@ -619,12 +626,10 @@ private List<Resource> prepareSchemaResources(List<Resource> resources, CommandS
                 String name =
                         new AvroSchema(spec.get(SCHEMA_FIELD).toString(), references, resolvedReferences, null).name();
 
-                // String subjectName = resource.getMetadata().getName();
                 Stream<Resource> schemasList =
                         Stream.concat(schemasByName.getOrDefault(name, Stream.of()), Stream.of(resource));
                 schemasByName.put(name, schemasList);
                 referencesByParentName.put(name, references);
-
             } else {
                 finalResources.add(resource);
             }

src/test/java/com/michelin/kafkactl/command/DeleteTest.java

@@ -98,15 +98,28 @@ void shouldReturnInvalidCurrentContext() {
 
     @Test
     void shouldNotDeleteByNameWhenNotAuthenticated() {
+        CommandLine cmd = new CommandLine(delete);
+        StringWriter sw = new StringWriter();
+        cmd.setErr(new PrintWriter(sw));
+
         when(configService.isCurrentContextValid()).thenReturn(true);
         when(loginService.doAuthenticate(any(), anyBoolean())).thenReturn(false);
 
+        int code = cmd.execute("topic", "myTopic");
+        assertEquals(1, code);
+    }
+
+    @Test
+    void shouldNotDeleteWhenFileNotFound() {
         CommandLine cmd = new CommandLine(delete);
         StringWriter sw = new StringWriter();
         cmd.setErr(new PrintWriter(sw));
 
-        int code = cmd.execute("topic", "myTopic");
-        assertEquals(1, code);
+        when(configService.isCurrentContextValid()).thenReturn(true);
+        when(loginService.doAuthenticate(any(), anyBoolean())).thenReturn(true);
+
+        int code = cmd.execute("-f", "src/test/resources/topics/unknown.yml");
+        assertEquals(2, code);
     }
 
     @Test
@@ -120,9 +133,9 @@ void shouldNotDeleteByFileWhenYmlFileNotFound() {
         StringWriter sw = new StringWriter();
         cmd.setErr(new PrintWriter(sw));
 
-        int code = cmd.execute("-f", "topic");
+        int code = cmd.execute("-f", "src/test/resources/topics-empty");
         assertEquals(2, code);
-        assertTrue(sw.toString().contains("Could not find YAML or YML files in topic directory."));
+        assertTrue(sw.toString().contains("Could not find YAML or YML files in topics-empty directory."));
     }
 
     @Test
@@ -152,7 +165,7 @@ void shouldNotDeleteByFileWhenInvalidResources() {
                 .when(resourceService)
                 .validateAllowedResources(any(), any());
 
-        int code = cmd.execute("-f", "topic", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespace");
         assertEquals(2, code);
         assertTrue(sw.toString().contains("The server does not have resource type(s) Topic."));
     }
@@ -195,7 +208,7 @@ void shouldNotDeleteByFileWhenNamespaceMismatch() {
         StringWriter sw = new StringWriter();
         cmd.setErr(new PrintWriter(sw));
 
-        int code = cmd.execute("-f", "topic", "-n", "namespaceMismatch");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespaceMismatch");
         assertEquals(2, code);
         assertTrue(sw.toString()
                 .contains("Namespace mismatch between Kafkactl configuration and YAML resource(s): "
@@ -237,7 +250,7 @@ void shouldDeleteByFile() {
         StringWriter sw = new StringWriter();
         cmd.setOut(new PrintWriter(sw));
 
-        int code = cmd.execute("-f", "topic", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespace");
         assertEquals(0, code);
     }
 
@@ -276,7 +289,7 @@ void shouldDeleteOneVersionByFile() {
         StringWriter sw = new StringWriter();
         cmd.setOut(new PrintWriter(sw));
 
-        int code = cmd.execute("-f", "topic", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespace");
         assertEquals(0, code);
     }
 
@@ -364,7 +377,7 @@ void shouldNotDeleteByFileWhenInDryRunMode() {
         StringWriter sw = new StringWriter();
         cmd.setOut(new PrintWriter(sw));
 
-        int code = cmd.execute("-f", "topic", "--dry-run", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "--dry-run", "-n", "namespace");
         assertEquals(0, code);
         assertTrue(sw.toString().contains("Dry run execution."));
     }
@@ -402,7 +415,7 @@ void shouldNotDeleteByFileWhenFail() {
 
         CommandLine cmd = new CommandLine(delete);
 
-        int code = cmd.execute("-f", "topic", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespace");
         assertEquals(1, code);
     }
 
@@ -431,7 +444,7 @@ void shouldNotDeleteByFileWhenHttpClientResponseException() {
 
         CommandLine cmd = new CommandLine(delete);
 
-        int code = cmd.execute("-f", "topic", "-n", "namespace");
+        int code = cmd.execute("-f", "src/test/resources/topics/topic.yml", "-n", "namespace");
         assertEquals(1, code);
         verify(formatService).displayError(exception, cmd.getCommandSpec());
     }

src/test/java/com/michelin/kafkactl/service/ResourceServiceTest.java

@@ -1435,7 +1435,17 @@ void shouldParse() {
     }
 
     @Test
-    void shouldNotParseNotFound() {
+    void shouldNotParseWhenFileDoesNotExist() {
+        CommandLine cmd = new CommandLine(new Kafkactl());
+
+        Optional<File> file = Optional.of(new File("src/test/resources/topics/unknown.yml"));
+        CommandLine.Model.CommandSpec spec = cmd.getCommandSpec();
+
+        assertThrows(ParameterException.class, () -> resourceService.parseResources(file, false, spec));
+    }
+
+    @Test
+    void shouldNotParseWhenNoYamlFilesInDirectory() {
         CommandLine cmd = new CommandLine(new Kafkactl());
 
         when(fileService.computeYamlFileList(any(), anyBoolean())).thenReturn(Collections.emptyList());