#100: implement repository commandlet

cli/src/main/java/com/devonfw/tools/ide/cli/Ide.java

@@ -155,7 +155,7 @@ private CliArgument initContext(CliArgument first) {
   }
 
   /**
-   * @param argument the current {@link CliArgument} (position) to match.
+   * @param current the current {@link CliArgument} (position) to match.
    * @param commandlet the potential {@link Commandlet} to {@link #apply(CliArgument, Commandlet) apply} and
    *        {@link Commandlet#run() run}.
    * @return {@code true} if the given {@link Commandlet} matched and did {@link Commandlet#run() run} successfully,

cli/src/main/java/com/devonfw/tools/ide/commandlet/CommandletManagerImpl.java

@@ -58,6 +58,7 @@ private CommandletManagerImpl(IdeContext context) {
     add(new VersionSetCommandlet(context));
     add(new VersionGetCommandlet(context));
     add(new VersionListCommandlet(context));
+    add(new RepositoryCommandlet(context));
     add(new Gh(context));
     add(new Helm(context));
     add(new Java(context));

cli/src/main/java/com/devonfw/tools/ide/commandlet/RepositoryCommandlet.java

@@ -0,0 +1,169 @@
+package com.devonfw.tools.ide.commandlet;
+
+import com.devonfw.tools.ide.context.IdeContext;
+import com.devonfw.tools.ide.process.ProcessContext;
+import com.devonfw.tools.ide.property.PathProperty;
+import com.devonfw.tools.ide.property.StringProperty;
+import com.devonfw.tools.ide.util.FilenameUtil;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Properties;
+
+/**
+ * {@link Commandlet} to setup a repository
+ */
+public class RepositoryCommandlet extends Commandlet {
+
+  /** the repository to setup. */
+  public final PathProperty repository;
+
+  /**
+   * The constructor.
+   *
+   * @param context the {@link IdeContext}.
+   */
+  public RepositoryCommandlet(IdeContext context) {
+
+    super(context);
+    addKeyword(getName());
+    add(new StringProperty("setup", true, null));
+    this.repository = add(new PathProperty("", false, "repository"));
+  }
+
+  @Override
+  public String getName() {
+
+    return "repository";
+  }
+
+  @Override
+  public void run() {
+
+    Path repositoriesPath = this.context.getSettingsPath().resolve("repositories");
+    Path legacyRepositoriesPath = this.context.getSettingsPath().resolve("projects");
+    Path repositoryFile = repository.getValue();
+
+    if (repositoryFile != null) {
+      // Handle the case when a specific repository is provided
+      if (!Files.exists(repositoryFile)) {
+        repositoryFile = repositoriesPath.resolve(repositoryFile.getFileName().toString() + ".properties");
+      }
+      if (!Files.exists(repositoryFile)) {
+        Path legacyRepositoryFile = legacyRepositoriesPath.resolve(repositoryFile.getFileName().toString());
+        if (Files.exists(legacyRepositoryFile)) {
+          repositoryFile = legacyRepositoryFile;
+        } else {
+          this.context.warning("Could not find " + repositoryFile);
+          return;
+        }
+      }
+      doImportRepository(repositoryFile, true);
+    } else {
+      // If no specific repository is provided, check for repositories folder
+      Path repositories = Files.exists(repositoriesPath) ? repositoriesPath :
+          Files.exists(legacyRepositoriesPath) ? legacyRepositoriesPath : null;
+
+      if (repositories == null) return;
+
+      List <Path> propertiesFiles = this.context.getFileAccess().getFilesInDir(repositories,
+          path -> "properties".equals(FilenameUtil.getExtension(path.getFileName().toString())));
+
+      if (propertiesFiles != null) {
+        boolean forceMode = this.context.isForceMode();
+        for (Path propertiesFile : propertiesFiles) {
+          doImportRepository(propertiesFile, forceMode);
+        }
+      }
+    }
+  }
+
+  private void doImportRepository(Path repositoryFile, boolean forceMode) {
+
+    this.context.info("Importing from {} ...", repositoryFile.toString());
+    RepositoryConfig repositoryConfig = loadProperties(repositoryFile);
+
+    if (!repositoryConfig.active()) {
+      this.context.info("Repository is not active by default.");
+      if (forceMode) {
+        this.context.info("Repository setup is forced, hence proceeding ...");
+      } else {
+        this.context.info("Skipping repository - use force (-f) to setup all repositories ...");
+        return;
+      }
+    }
+
+    String repository = repositoryConfig.path();
+    String gitUrl = repositoryConfig.gitUrl();
+    if (repository == null || "".equals(repository) || gitUrl == null || "".equals(gitUrl)) {
+      this.context.warning("Invalid repository configuration {} - both 'path' and 'git-url' have to be defined."
+          , repositoryFile);
+      return;
+    }
+
+    this.context.debug(repositoryConfig.toString());
+    this.context.debug("Pull or clone git repository {} ...", repository);
+
+    String workspace = repositoryConfig.workspace() != null ? repositoryConfig.workspace() : "main";
+    Path workspacePath = this.context.getIdeHome().resolve("workspaces").resolve(workspace);
+    this.context.getFileAccess().mkdirs(workspacePath);
+
+    if (repositoryConfig.gitBranch() != null && !repositoryConfig.gitBranch().isEmpty()) {
+      gitUrl = gitUrl + "#" + repositoryConfig.gitBranch();
+    }
+
+    Path repositoryPath = workspacePath.resolve(repository);
+    this.context.gitPullOrClone(repositoryPath, gitUrl);
+
+    String buildCmd = repositoryConfig.buildCmd();
+    this.context.debug("Building project with ide command: {}", buildCmd);
+    if (buildCmd != null && !buildCmd.isEmpty()) {
+      String[] command = buildCmd.split("\\s+");
+      this.context.getCommandletManager().getToolCommandlet(command[0]).install(true);
+      ProcessContext pc = this.context.newProcess();
+      pc.executable(command[0]);
+      pc.addArgs(Arrays.copyOfRange(command, 1, command.length));
+      Path buildPath = repositoryPath;
+      if (repositoryConfig.buildPath() != null) {
+        buildPath = buildPath.resolve(repositoryConfig.buildPath());
+      }
+      pc.directory(buildPath);
+      pc.run();
+    } else {
+      this.context.info("Build command not set. Skipping build for repository.");
+    }
+
+    if ("import".equals(repositoryConfig.eclipse()) && !Files.exists(repositoryPath.resolve(".project"))) {
+      //TODO: import repository to eclipse
+    }
+  }
+
+
+  private RepositoryConfig loadProperties(Path filePath) {
+
+    Properties properties = new Properties();
+    try (InputStream input = new FileInputStream(filePath.toString())) {
+      properties.load(input);
+    } catch (IOException e) {
+      throw new IllegalStateException("Failed to read file: " + filePath, e);
+    }
+
+    return new RepositoryConfig(
+        properties.getProperty("path"),
+        properties.getProperty("workingsets"),
+        properties.getProperty("workspace"),
+        properties.getProperty("git_url"),
+        properties.getProperty("git_branch"),
+        properties.getProperty(("build_path")),
+        properties.getProperty("build_cmd"),
+        properties.getProperty("eclipse"),
+        Boolean.parseBoolean(properties.getProperty("active"))
+    );
+  }
+
+}

cli/src/main/java/com/devonfw/tools/ide/commandlet/RepositoryConfig.java

@@ -0,0 +1,26 @@
+package com.devonfw.tools.ide.commandlet;
+
+/**
+ * Represents the configuration of a repository to be used by the {@link RepositoryCommandlet}.
+ *
+ * @param path Path into which the project is cloned. This path is relative to the workspace.
+ * @param workingSets The working sets associated with the repository.
+ * @param workspace Workspace to use for checkout and import. Default is main.
+ * @param gitUrl Git URL to use for cloning the project.
+ * @param gitBranch Git branch to checkout. Git default branch is default.
+ * @param buildPath The build path for the repository.
+ * @param buildCmd The command to invoke to build the repository after clone or pull. If omitted no build is triggered.
+ * @param eclipse Desired action for eclipse IDE. If equals to "import" all modules will be imported into eclipse.
+ * @param active {@code true} to setup the repository during setup, {@code false} to skip.
+ */
+public record RepositoryConfig(
+    String path,
+    String workingSets,
+    String workspace,
+    String gitUrl,
+    String gitBranch,
+    String buildPath,
+    String buildCmd,
+    String eclipse,
+    boolean active) {
+}

cli/src/main/java/com/devonfw/tools/ide/io/FileAccess.java

@@ -1,6 +1,8 @@
 package com.devonfw.tools.ide.io;
 
+import java.io.IOException;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.function.Predicate;
 
 /**
@@ -124,4 +126,12 @@ default void copy(Path source, Path target) {
    */
   Path findFirst(Path dir, Predicate<Path> filter, boolean recursive);
 
+  /**
+   * Retrieves a list of file paths from the specified directory that satisfy the given predicate.
+   * @param dir the folder to iterate through
+   * @param filter the {@link Predicate} that determines whether a file should be included in the list.
+   * @return a list of paths that satisfy the provided {@link Predicate} or {@code null} if no match was found.
+   */
+  public List<Path> getFilesInDir(Path dir, Predicate<Path> filter);
+
 }

cli/src/main/java/com/devonfw/tools/ide/io/FileAccessImpl.java

@@ -451,4 +451,24 @@ private Path findFirstRecursive(Path dir, Predicate<Path> filter, boolean recurs
     return null;
   }
 
+  @Override
+  public List<Path> getFilesInDir(Path dir, Predicate<Path> filter) {
+    List<Path> files = null;
+    try (Stream<Path> childStream = Files.list(dir)) {
+      Iterator<Path> iterator = childStream.iterator();
+      while (iterator.hasNext()) {
+        Path child = iterator.next();
+        if (filter.test(child)) {
+          if (files == null) {
+            files = new ArrayList<>();
+          }
+          files.add(child);
+        }
+      }
+    } catch (IOException e) {
+      throw new IllegalStateException("Failed to iterate through " + dir, e);
+    }
+    return files;
+  }
+
 }

cli/src/main/resources/nls/Ide.properties

@@ -5,6 +5,7 @@ options=Options:
 cmd-az=Tool commandlet for Azure CLI.
 cmd-env=Print the environment variables to set and export.
 cmd-get-version=Get the version of the selected tool.
+cmd-repository=setup the pre-configured repository.
 cmd-gh=Tool commandlet for Github CLI.
 cmd-gradle=Tool commandlet for Gradle (Build-Tool)
 cmd-helm=Tool commandlet for Helm (Kubernetes Package Manager)
@@ -25,6 +26,7 @@ val-args=The commandline arguments to pass to the tool.
 val-tool=The tool commandlet to select.
 val-version=The tool version.
 val-set-version-version=The tool version to set.
+val-repository-repository=The pre-configured repository to setup, omit to setup all active repositories.
 version-banner=Current version of IDE is {}
 opt--batch=enable batch mode (non-interactive)
 opt--debug=enable debug logging

cli/src/main/resources/nls/Ide_de.properties

@@ -5,6 +5,7 @@ options=Optionen:
 cmd-az=Werkzeug Kommando fuer Azure Kommandoschnittstelle.
 cmd-env=Gibt die zu setztenden und exportierenden Umgebungsvariablen aus.
 cmd-get-version=Zeigt die Version des selektierten Werkzeugs an.
+cmd-repository=Richtet das vorkonfigurierte Projekt ein.
 cmd-gh=Werkzeug Kommando für die Github Kommandoschnittstelle.
 cmd-helm=Werkzeug Kommando für Helm (Kubernetes Package Manager)
 cmd-help=Zeigt diese Hilfe an.
@@ -24,6 +25,8 @@ val-args=Die Kommandozeilen-Argumente zur Übergabe an das Werkzeug.
 val-tool=Das zu selektierende Werkzeug Kommando.
 val-version=Die Werkzeug Version.
 val-set-version-version=Die zu setztende Werkzeug Version.
+val-repository-project= Das vorkonfigurierte Projekt zum Einrichten. 
+
 version-banner=Die aktuelle Version der IDE ist {}
 opt--batch=Aktiviert den Batch-Modus (nicht-interaktive Stapelverarbeitung)
 opt--debug=Aktiviert Debug-Ausgaben (Fehleranalyse)