Merge pull request kitodo#5681 from matthias-ronge/issue-5580a

Remove ID of the command interface

Kitodo-API/src/main/java/org/kitodo/api/command/CommandInterface.java

@@ -16,11 +16,9 @@ public interface CommandInterface {
     /**
      * Runs a given command.
      *
-     * @param id
-     *            The id, to identify the command and it's results.
      * @param command
      *            The command as a String.
      * @return A commandResult, which contains id and result messages.
      */
-    CommandResult runCommand(Integer id, String command);
+    CommandResult runCommand(String command);
 }

Kitodo-API/src/main/java/org/kitodo/api/command/CommandResult.java

@@ -16,9 +16,6 @@
 
 public class CommandResult {
 
-    /** The id of the command. */
-    private Integer id;
-
     /** The command as a String. */
     private String command;
 
@@ -31,31 +28,19 @@ public class CommandResult {
     /**
      * Constructor.
      * 
-     * @param id
-     *            The id.
      * @param command
      *            The command.
      * @param successful
      *            If command was successful.
      * @param messages
      *            The resultMessages
      */
-    public CommandResult(Integer id, String command, boolean successful, List<String> messages) {
-        this.id = id;
+    public CommandResult(String command, boolean successful, List<String> messages) {
         this.command = command;
         this.successful = successful;
         this.messages = messages;
     }
 
-    /**
-     * Gets the id.
-     * 
-     * @return The id.
-     */
-    public Integer getId() {
-        return id;
-    }
-
     /**
      * Gets the command.
      * 
@@ -99,8 +84,7 @@ public boolean equals(Object object) {
         if (object instanceof CommandResult) {
             CommandResult that = (CommandResult) object;
 
-            return this.id.equals(that.id)
-                    && this.successful == that.successful
+            return this.successful == that.successful
                     && this.command.equals(that.command)
                     && this.messages.equals(that.messages);
         }
@@ -109,6 +93,6 @@ public boolean equals(Object object) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(id, successful, command, messages);
+        return Objects.hash(successful, command, messages);
     }
 }

Kitodo-Command/src/main/java/org/kitodo/command/Command.java

@@ -31,14 +31,12 @@ public class Command implements CommandInterface {
     /**
      * Method executes a script.
      *
-     * @param id
-     *            The id, to identify the command and it's results.
      * @param command
      *            The command as a String.
      * @return The command result.
      */
     @Override
-    public CommandResult runCommand(Integer id, String command) {
+    public CommandResult runCommand(String command) {
         CommandResult commandResult;
         Process process;
         String[] callSequence = command.split("[\\r\\n\\s]+");
@@ -53,26 +51,26 @@ public CommandResult runCommand(Integer id, String command) {
 
                 outputMessage.addAll(errorMessage);
 
-                commandResult = new CommandResult(id, command, errCode == 0, outputMessage);
+                commandResult = new CommandResult(command, errCode == 0, outputMessage);
                 if (commandResult.isSuccessful()) {
-                    logger.info("Execution of Command {} {} was successful!: {}", commandResult.getId(),
+                    logger.info("Execution of Command {} was successful!: {}",
                         commandResult.getCommand(), commandResult.getMessages());
                 } else {
-                    logger.error("Execution of Command {} {} failed!: {}", commandResult.getId(),
+                    logger.error("Execution of Command {} failed!: {}",
                         commandResult.getCommand(), commandResult.getMessages());
                 }
             }
         } catch (InterruptedException e) {
-            commandResult = new CommandResult(id, command, false, Collections.singletonList(e.getMessage()));
+            commandResult = new CommandResult(command, false, Collections.singletonList(e.getMessage()));
             logger.error("Execution of Command Thread was interrupted!");
             Thread.currentThread().interrupt();
             return commandResult;
         } catch (IOException e) {
             List<String> errorMessages = new ArrayList<>();
             errorMessages.add(e.getCause().toString());
             errorMessages.add(e.getMessage());
-            commandResult = new CommandResult(id, command, false, errorMessages);
-            logger.error("Execution of Command {} {} failed!: {}", commandResult.getId(), commandResult.getCommand(),
+            commandResult = new CommandResult(command, false, errorMessages);
+            logger.error("Execution of Command {} failed!: {}", commandResult.getCommand(),
                 commandResult.getMessages());
             return commandResult;
         }

Kitodo-Command/src/test/java/org/kitodo/command/CommandTest.java

@@ -31,7 +31,6 @@
 
 public class CommandTest {
     private static String scriptExtension;
-    private int processId = 3;
     private static boolean windows = false;
     private static File workingScript = new File(
             System.getProperty("user.dir") + "/src/test/resources/working_script.sh");
@@ -70,7 +69,7 @@ public void shouldRunCommand() {
         Command command = new Command();
 
         String commandString = "src/test/resources/working_script" + scriptExtension;
-        CommandResult commandResult = command.runCommand(processId, commandString);
+        CommandResult commandResult = command.runCommand(commandString);
 
         List<String> expectedMessages = new ArrayList<>();
         if (windows) {
@@ -80,7 +79,7 @@ public void shouldRunCommand() {
 
         expectedMessages.add("Hello World");
 
-        CommandResult expectedCommandResult = new CommandResult(processId, commandString, true, expectedMessages);
+        CommandResult expectedCommandResult = new CommandResult(commandString, true, expectedMessages);
 
         assertEquals("successful booleans of CommandResults are not identical", expectedCommandResult.isSuccessful(),
                 commandResult.isSuccessful());
@@ -95,9 +94,9 @@ public void shouldNotRunNotExistingCommand() {
         Command command = new Command();
 
         String commandString = "src/test/resources/notExistingScript" + scriptExtension;
-        CommandResult commandResult = command.runCommand(processId, commandString);
+        CommandResult commandResult = command.runCommand(commandString);
 
-        CommandResult expectedCommandResult = new CommandResult(processId, commandString, false, null);
+        CommandResult expectedCommandResult = new CommandResult(commandString, false, null);
 
         assertEquals("Should not run not existing Command", expectedCommandResult.isSuccessful(),
                 commandResult.isSuccessful());
@@ -108,9 +107,9 @@ public void shouldNotRunCommandWithFalseSyntax() {
         Command command = new Command();
 
         String commandString = "src/test/resources/not_working_script" + scriptExtension;
-        CommandResult commandResult = command.runCommand(processId, commandString);
+        CommandResult commandResult = command.runCommand(commandString);
 
-        CommandResult expectedCommandResult = new CommandResult(processId, commandString, false, null);
+        CommandResult expectedCommandResult = new CommandResult(commandString, false, null);
 
         assertEquals("Should not run command with false syntax", expectedCommandResult.isSuccessful(),
                 commandResult.isSuccessful());
@@ -121,7 +120,7 @@ public void shouldRunCommandWithParameter() {
         Command command = new Command();
 
         String commandString = "src/test/resources/working_script_with_parameters" + scriptExtension + " testParameter";
-        CommandResult commandResult = command.runCommand(processId, commandString);
+        CommandResult commandResult = command.runCommand(commandString);
 
         ArrayList<String> expectedMessages = new ArrayList<>();
 
@@ -132,7 +131,7 @@ public void shouldRunCommandWithParameter() {
 
         expectedMessages.add("testParameter");
 
-        CommandResult expectedCommandResult = new CommandResult(processId, commandString, true, expectedMessages);
+        CommandResult expectedCommandResult = new CommandResult(commandString, true, expectedMessages);
 
         assertEquals("successful booleans of CommandResults are not identical", expectedCommandResult.isSuccessful(),
                 commandResult.isSuccessful());

Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/CommandService.java

@@ -14,16 +14,13 @@
 import java.io.File;
 import java.io.IOException;
 import java.util.List;
-import java.util.Random;
 
 import org.kitodo.api.command.CommandInterface;
 import org.kitodo.api.command.CommandResult;
 import org.kitodo.serviceloader.KitodoServiceLoader;
 
 class CommandService {
 
-    private Random random = new Random(1000000);
-
     /**
      * Method executes a script string.
      *
@@ -39,7 +36,7 @@ CommandResult runCommand(String script) throws IOException {
         KitodoServiceLoader<CommandInterface> serviceLoader = new KitodoServiceLoader<>(CommandInterface.class);
         CommandInterface command = serviceLoader.loadModule();
 
-        CommandResult commandResult = command.runCommand(random.nextInt(), script);
+        CommandResult commandResult = command.runCommand(script);
         List<String> commandResultMessages = commandResult.getMessages();
         if (commandResultMessages.size() > 0 && commandResultMessages.get(0).contains("IOException")) {
             throw new IOException(commandResultMessages.get(1));

Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/FileManagement.java

@@ -393,7 +393,7 @@ public URI createProcessLocation(String processId) throws IOException {
         File processRootDirectory = new File(KitodoConfig.getKitodoDataDirectory() + File.separator + processId);
         String scriptCreateDirMeta = KitodoConfig.getParameter("script_createDirMeta");
         String command = scriptCreateDirMeta + ' ' + processRootDirectory.getPath();
-        if (!processRootDirectory.exists() && !commandService.runCommand(command.hashCode(), command).isSuccessful()) {
+        if (!processRootDirectory.exists() && !commandService.runCommand(command).isSuccessful()) {
             throw new IOException("Could not create processRoot directory.");
         }
         return fileMapper.unmapUriFromKitodoDataDirectoryUri(Paths.get(processRootDirectory.getPath()).toUri());

Kitodo/src/main/java/org/kitodo/production/services/command/CommandService.java

@@ -19,17 +19,14 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
-import java.util.Random;
 
 import org.kitodo.api.command.CommandInterface;
 import org.kitodo.api.command.CommandResult;
-import org.kitodo.production.services.ServiceManager;
 import org.kitodo.serviceloader.KitodoServiceLoader;
 
 public class CommandService {
     private final CommandInterface commandModule;
     private final ArrayList<CommandResult> finishedCommandResults = new ArrayList<>();
-    private final Random random = new Random(1000000);
 
     /**
      * Initialize Command Service.
@@ -54,7 +51,7 @@ public CommandResult runCommand(String script) throws IOException {
         if (Objects.isNull(script)) {
             return null;
         }
-        CommandResult commandResult = commandModule.runCommand(random.nextInt(), script);
+        CommandResult commandResult = commandModule.runCommand(script);
         List<String> commandResultMessages = commandResult.getMessages();
         if (!commandResultMessages.isEmpty() && commandResultMessages.get(0).contains("IOException")) {
             throw new IOException(commandResultMessages.get(1));
@@ -110,7 +107,7 @@ public CommandResult runCommand(File scriptFile) throws IOException {
     public void runCommandAsync(String script) {
         if (Objects.nonNull(script)) {
             Flowable<CommandResult> source = Flowable.fromCallable(() ->
-                commandModule.runCommand(random.nextInt(), script)
+                commandModule.runCommand(script)
             );
 
             Flowable<CommandResult> commandBackgroundWorker = source.subscribeOn(Schedulers.io());