#931: enhance settings in code repository (#983)

Co-authored-by: jan-vcapgemini <[email protected]>
Co-authored-by: Jörg Hohwiller <[email protected]>

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

@@ -45,7 +45,9 @@ public AbstractUpdateCommandlet(IdeContext context) {
   @Override
   public void run() {
 
-    updateSettings();
+    if (!this.context.isSettingsRepositorySymlinkOrJunction() || this.context.isForceMode()) {
+      updateSettings();
+    }
     updateConf();
     reloadContext();
 

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

@@ -60,7 +60,9 @@ private void logSettingsGitStatus() {
     if (settingsPath != null) {
       GitContext gitContext = this.context.getGitContext();
       if (gitContext.isRepositoryUpdateAvailable(settingsPath, this.context.getSettingsCommitIdPath())) {
-        this.context.warning("Your settings are not up-to-date, please run 'ide update'.");
+        if (!this.context.isSettingsRepositorySymlinkOrJunction()) {
+          this.context.warning("Your settings are not up-to-date, please run 'ide update'.");
+        }
       } else {
         this.context.success("Your settings are up-to-date.");
       }

cli/src/main/java/com/devonfw/tools/ide/context/AbstractIdeContext.java

@@ -221,6 +221,7 @@ private Path findIdeRoot(Path ideHomePath) {
   }
 
   private Path getIdeRootPathFromEnv() {
+
     String root = getSystem().getEnv(IdeVariables.IDE_ROOT.getName());
     if (root != null) {
       Path rootPath = Path.of(root);
@@ -280,6 +281,7 @@ private String getMessageIdeHomeNotFound() {
   }
 
   private String getMessageIdeRootNotFound() {
+
     String root = getSystem().getEnv("IDE_ROOT");
     if (root == null) {
       return "The environment variable IDE_ROOT is undefined. Please reinstall IDEasy or manually repair IDE_ROOT variable.";
@@ -301,7 +303,6 @@ protected SystemPath computeSystemPath() {
     return new SystemPath(this);
   }
 
-
   private boolean isIdeHome(Path dir) {
 
     if (!Files.isDirectory(dir.resolve("workspaces"))) {
@@ -429,15 +430,24 @@ public Path getSettingsGitRepository() {
       return null;
     }
 
-    // check whether the settings path has a .git folder only if its not a symbolic link
-    if (!Files.exists(settingsPath.resolve(".git")) && !Files.isSymbolicLink(settingsPath)) {
+    // check whether the settings path has a .git folder only if its not a symbolic link or junction
+    if (!Files.exists(settingsPath.resolve(".git")) && !isSettingsRepositorySymlinkOrJunction()) {
       error("Settings repository exists but is not a git repository.");
       return null;
     }
 
     return settingsPath;
   }
 
+  public boolean isSettingsRepositorySymlinkOrJunction() {
+
+    Path settingsPath = getSettingsPath();
+    if (settingsPath == null) {
+      return false;
+    }
+    return Files.isSymbolicLink(settingsPath) || getFileAccess().isJunction(settingsPath);
+  }
+
   @Override
   public Path getSettingsCommitIdPath() {
 
@@ -557,6 +567,7 @@ public boolean isOfflineMode() {
 
   @Override
   public boolean isSkipUpdatesMode() {
+
     return this.startContext.isSkipUpdatesMode();
   }
 
@@ -583,6 +594,7 @@ public boolean isOnline() {
   }
 
   private void configureNetworkProxy() {
+
     if (this.networkProxy == null) {
       this.networkProxy = new NetworkProxy(this);
       this.networkProxy.configure();
@@ -873,10 +885,17 @@ private ValidationResult applyAndRun(CliArguments arguments, Commandlet cmd) {
           }
           Path settingsRepository = getSettingsGitRepository();
           if (settingsRepository != null) {
-            if (getGitContext().isRepositoryUpdateAvailable(settingsRepository, getSettingsCommitIdPath()) ||
-                (getGitContext().fetchIfNeeded(settingsRepository) && getGitContext().isRepositoryUpdateAvailable(settingsRepository,
-                    getSettingsCommitIdPath()))) {
-              interaction("Updates are available for the settings repository. If you want to apply the latest changes, call \"ide update\"");
+            if (getGitContext().isRepositoryUpdateAvailable(settingsRepository, getSettingsCommitIdPath()) || (
+                getGitContext().fetchIfNeeded(settingsRepository) && getGitContext().isRepositoryUpdateAvailable(
+                    settingsRepository, getSettingsCommitIdPath()))) {
+              if (isSettingsRepositorySymlinkOrJunction()) {
+                interaction(
+                    "Updates are available for the settings repository. Please pull the latest changes by yourself or by calling \"ide -f update\" to apply them.");
+
+              } else {
+                interaction(
+                    "Updates are available for the settings repository. If you want to apply the latest changes, call \"ide update\"");
+              }
             }
           }
         }
@@ -958,6 +977,7 @@ This product (with its included 3rd party components) is open-source software an
   }
 
   private void verifyIdeRoot() {
+
     if (!isTest()) {
       if (this.ideRoot == null) {
         warning("Variable IDE_ROOT is undefined. Please check your installation or run setup script again.");
@@ -977,6 +997,7 @@ private void verifyIdeRoot() {
    * @return the {@link List} of {@link CompletionCandidate}s to suggest.
    */
   public List<CompletionCandidate> complete(CliArguments arguments, boolean includeContextOptions) {
+
     CompletionCandidateCollector collector = new CompletionCandidateCollectorDefault(this);
     if (arguments.current().isStart()) {
       arguments.next();
@@ -1004,6 +1025,7 @@ public List<CompletionCandidate> complete(CliArguments arguments, boolean includ
   }
 
   private void completeCommandlet(CliArguments arguments, Commandlet cmd, CompletionCandidateCollector collector) {
+
     trace("Trying to match arguments for auto-completion for commandlet {}", cmd.getName());
     Iterator<Property<?>> valueIterator = cmd.getValues().iterator();
     valueIterator.next(); // skip first property since this is the keyword property that already matched to find the commandlet
@@ -1060,7 +1082,6 @@ private void completeCommandlet(CliArguments arguments, Commandlet cmd, Completi
     }
   }
 
-
   /**
    * @param arguments the {@link CliArguments} to apply. Will be {@link CliArguments#next() consumed} as they are matched. Consider passing a
    *     {@link CliArguments#copy() copy} as needed.
@@ -1179,6 +1200,7 @@ private String findBashOnWindows() {
 
   @Override
   public WindowsPathSyntax getPathSyntax() {
+
     return this.pathSyntax;
   }
 
@@ -1202,6 +1224,7 @@ public IdeStartContextImpl getStartContext() {
    * Reloads this context and re-initializes the {@link #getVariables() variables}.
    */
   public void reload() {
+
     this.variables = null;
     this.customToolRepository = null;
   }

cli/src/main/java/com/devonfw/tools/ide/context/IdeContext.java

@@ -405,6 +405,11 @@ default Path getRepositoriesPath() {
    */
   Path getSettingsGitRepository();
 
+  /**
+   * @return {@code true} if the settings repository is a symlink or a junction.
+   */
+  boolean isSettingsRepositorySymlinkOrJunction();
+
   /**
    * @return the {@link Path} to the file containing the last tracked commit Id of the settings repository.
    */

cli/src/main/java/com/devonfw/tools/ide/git/GitOperation.java

@@ -155,7 +155,9 @@ private boolean isNeeded(Path targetRepository, IdeContext context) {
     }
     if (!hasGitDirectory) {
       if (isRequireGitFolder()) {
-        context.warning("Missing .git folder in {}.", targetRepository);
+        if (context.getSettingsGitRepository() == null) {
+          context.warning("Missing .git folder in {}.", targetRepository);
+        }
       } else {
         logEnforceGitOperationBecauseGitFolderNotPresent(targetRepository, context);
       }

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

@@ -306,4 +306,10 @@ default void makeExecutable(Path file) {
    */
   String readFileContent(Path file);
 
+  /**
+   * @param path that is checked whether it is a junction or not.
+   * @return {@code true} if the given {@link Path} is a junction, false otherwise.
+   */
+  boolean isJunction(Path path);
+
 }

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

@@ -247,7 +247,7 @@ public String checksum(Path file) {
     }
   }
 
-  private boolean isJunction(Path path) {
+  public boolean isJunction(Path path) {
 
     if (!SystemInfoImpl.INSTANCE.isWindows()) {
       return false;