#1024: Move urls into url-updater module (#1025)

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

Author: jan-vcapgemini

.github/workflows/build-pr.yml

@@ -11,8 +11,8 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v1
         with:
-          java-version: '17'
+          java-version: '21'
       - name: Build project with Maven
         run: mvn -B -ntp -Dstyle.color=always install
       - name: Coveralls GitHub Action
-        uses: coverallsapp/[email protected]
+        uses: coverallsapp/[email protected]

.github/workflows/build.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v1
         with:
-          java-version: '17'
+          java-version: '21'
       - name: Build project with Maven
         run: mvn -B -ntp -Dstyle.color=always install
       - name: Coveralls GitHub Action

.github/workflows/nightly-build.yml

@@ -72,7 +72,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v1
         with:
-          java-version: '17'
+          java-version: '21'
       - name: Download natives and build project
         uses: actions/download-artifact@v4
         with:

.github/workflows/release.yml

@@ -78,7 +78,7 @@ jobs:
       - name: Set up Apache Maven Central
         uses: actions/setup-java@v3
         with:
-          java-version: 17
+          java-version: 21
           distribution: 'temurin'
           cache: 'maven'
           gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }} # Value of the GPG private key to import

.github/workflows/update-urls.yml

@@ -20,14 +20,13 @@ jobs:
       - name: Set up Java
         uses: actions/setup-java@v3
         with:
-          java-version: 17
+          java-version: 21
           distribution: 'temurin'
           cache: 'maven'
       - name: Build and run url updater
         run: |
-          cd cli
-          mvn -B -ntp -Dstyle.color=always install
-          mvn -B -ntp -Dstyle.color=always exec:java -Dexec.mainClass="com.devonfw.tools.ide.url.UpdateInitiator" -Dexec.args="../ide-urls PT5H30M"
+          mvn -B -ntp -Dstyle.color=always -pl url-updater -am install
+          mvn -B -ntp -Dstyle.color=always -pl url-updater exec:java -Dexec.mainClass="com.devonfw.tools.ide.url.UpdateInitiator" -Dexec.args="ide-urls PT5H30M"
       - name: Commit and push to ide-urls
         run: |
           cd ide-urls

cli/pom.xml

@@ -16,9 +16,6 @@
     <imageName>ideasy</imageName>
     <native.maven.plugin.version>0.10.4</native.maven.plugin.version>
     <assembly.maven.plugin.version>3.7.1</assembly.maven.plugin.version>
-    <jline.version>3.24.1</jline.version>
-    <jansi.version>2.4.1</jansi.version>
-    <jackson.version>2.18.2</jackson.version>
     <build.helper.maven.plugin.version>3.6.0</build.helper.maven.plugin.version>
   </properties>
 
@@ -27,39 +24,32 @@
     <dependency>
       <groupId>org.apache.commons</groupId>
       <artifactId>commons-compress</artifactId>
-      <version>1.27.1</version>
     </dependency>
     <!-- JSON and XML support -->
     <dependency>
       <groupId>jakarta.json</groupId>
       <artifactId>jakarta.json-api</artifactId>
-      <version>2.1.3</version>
     </dependency>
     <dependency>
       <groupId>org.eclipse.parsson</groupId>
       <artifactId>parsson</artifactId>
-      <version>1.1.7</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
-      <version>${jackson.version}</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.datatype</groupId>
       <artifactId>jackson-datatype-jsr310</artifactId>
-      <version>${jackson.version}</version>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.dataformat</groupId>
       <artifactId>jackson-dataformat-xml</artifactId>
-      <version>${jackson.version}</version>
     </dependency>
     <!-- Logging (only for URL-Updaters) -->
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
-      <version>2.0.17</version>
       <!--optional>true</optional-->
     </dependency>
     <dependency>
@@ -68,54 +58,56 @@
       <version>1.5.17</version>
       <!--optional>true</optional-->
     </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>me.tongfei</groupId>
       <artifactId>progressbar</artifactId>
-      <version>0.10.1</version>
     </dependency>
     <dependency>
       <groupId>org.jline</groupId>
       <artifactId>jline</artifactId>
-      <version>${jline.version}</version>
     </dependency>
     <dependency>
       <groupId>org.fusesource.jansi</groupId>
       <artifactId>jansi</artifactId>
-      <version>${jansi.version}</version>
     </dependency>
     <!-- Test dependencies -->
     <!-- Mockito for mocking -->
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-core</artifactId>
-      <version>5.15.2</version>
       <scope>test</scope>
     </dependency>
     <!-- Needed for WireMock test support -->
     <dependency>
-      <groupId>com.github.tomakehurst</groupId>
-      <artifactId>wiremock-jre8</artifactId>
-      <version>2.35.2</version>
+      <groupId>org.wiremock</groupId>
+      <artifactId>wiremock</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>
       <!-- required for advanced mocking -->
       <groupId>net.bytebuddy</groupId>
       <artifactId>byte-buddy</artifactId>
-      <version>1.17.1</version>
       <scope>test</scope>
     </dependency>
     <!-- required for XML assertion (XmlMergerTest) -->
     <dependency>
       <groupId>org.xmlunit</groupId>
       <artifactId>xmlunit-core</artifactId>
-      <version>2.10.0</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.xmlunit</groupId>
       <artifactId>xmlunit-assertj3</artifactId>
-      <version>2.10.0</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

cli/src/main/java/com/devonfw/tools/ide/os/WindowsHelper.java

@@ -40,5 +40,4 @@ static WindowsHelper get(IdeContext context) {
     // IdeContext API is already too large
     return ((AbstractIdeContext) context).getWindowsHelper();
   }
-
 }

cli/src/main/java/com/devonfw/tools/ide/os/WindowsHelperImpl.java

@@ -57,6 +57,17 @@ public String getRegistryValue(String path, String key) {
 
     ProcessResult result = this.context.newProcess().executable("reg").addArgs("query", path, "/v", key).run(ProcessMode.DEFAULT_CAPTURE);
     List<String> out = result.getOut();
+    return retrieveRegString(key, out);
+  }
+
+  /**
+   * Parses the result of a registry query and outputs the given key.
+   *
+   * @param key the key to look for.
+   * @param out List of keys from registry query result.
+   * @return the registry value.
+   */
+  protected String retrieveRegString(String key, List<String> out) {
     for (String line : out) {
       int i = line.indexOf(key);
       if (i >= 0) {

cli/src/test/java/com/devonfw/tools/ide/context/AbstractIdeTestContext.java

@@ -325,5 +325,4 @@ protected Path getIdeRootPathFromEnv() {
     }
     return null;
   }
-
 }

cli/src/test/java/com/devonfw/tools/ide/io/FileAccessImplTest.java

@@ -8,10 +8,16 @@
 import java.nio.file.LinkOption;
 import java.nio.file.NoSuchFileException;
 import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 import java.nio.file.attribute.PosixFilePermission;
 import java.nio.file.attribute.PosixFilePermissions;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Set;
 
+import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
+import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
+import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
@@ -579,4 +585,95 @@ public void testGeneratePermissionString() {
 
   }
 
+  /**
+   * Tests if extract was called with disabled extract param, the archive will be moved.
+   *
+   * @param tempDir temporary directory to use.
+   */
+  @Test
+  public void testDisabledExtractMovesArchive(@TempDir Path tempDir) {
+    // arrange
+    IdeContext context = IdeTestContextMock.get();
+    FileAccessImpl fileAccess = new FileAccessImpl(context);
+    Path downloadArchive = tempDir.resolve("downloaded.zip");
+    fileAccess.touch(downloadArchive);
+    Path installationPath = tempDir.resolve("installation");
+    Path targetPath = installationPath.resolve("downloaded.zip");
+    boolean extract = false;
+    // act
+    fileAccess.extract(downloadArchive, installationPath, this::postExtract, extract);
+    // assert
+    assertThat(targetPath).exists();
+  }
+
+  /**
+   * Tests if a tgz archive with a sub folder can be extracted to a target folder properly.
+   *
+   * @param tempDir temporary directory to use.
+   * @throws IOException when a file could not be created.
+   */
+  @Test
+  public void testExtractTgzArchive(@TempDir Path tempDir) throws IOException {
+    // arrange
+    IdeContext context = IdeTestContextMock.get();
+    FileAccessImpl fileAccess = new FileAccessImpl(context);
+    Path downloadedTgz = tempDir.resolve("downloaded.tgz");
+    fileAccess.touch(downloadedTgz);
+    try (GzipCompressorOutputStream gzipOut = new GzipCompressorOutputStream(Files.newOutputStream(downloadedTgz, StandardOpenOption.WRITE));
+        TarArchiveOutputStream tarOut = new TarArchiveOutputStream(gzipOut)) {
+
+      // Create a subfolder entry
+      TarArchiveEntry subfolderEntry = new TarArchiveEntry("subfolder/");
+      subfolderEntry.setMode(TarArchiveEntry.DEFAULT_DIR_MODE);
+      tarOut.putArchiveEntry(subfolderEntry);
+      tarOut.closeArchiveEntry();
+
+      // Add a file to the subfolder
+      TarArchiveEntry fileEntry = new TarArchiveEntry("subfolder/testfile2.txt");
+      fileEntry.setSize(12);
+      tarOut.putArchiveEntry(fileEntry);
+      tarOut.write("Hello World2".getBytes());
+      tarOut.closeArchiveEntry();
+
+      // create a file in the root of the archive
+      TarArchiveEntry entry = new TarArchiveEntry("testfile.txt");
+      entry.setSize(11);
+      tarOut.putArchiveEntry(entry);
+      tarOut.write("Hello World".getBytes());
+      tarOut.closeArchiveEntry();
+    }
+    Path installationPath = tempDir.resolve("installation");
+    // act
+    fileAccess.extractTar(downloadedTgz, installationPath, TarCompression.GZ);
+    // assert
+    assertThat(installationPath.resolve("testfile.txt")).exists();
+    assertThat(installationPath.resolve("subfolder").resolve("testfile2.txt")).exists();
+  }
+
+  /**
+   * Tests if a file can be found within a list of folders.
+   *
+   * @param tempDir temporary directory to use.
+   */
+  @Test
+  public void testFindExistingFileInFolders(@TempDir Path tempDir) {
+    IdeContext context = IdeTestContextMock.get();
+    FileAccessImpl fileAccess = new FileAccessImpl(context);
+    Path subfolder1 = tempDir.resolve("subfolder1");
+    fileAccess.mkdirs(subfolder1);
+    fileAccess.touch(subfolder1.resolve("testfile"));
+    Path subfolder2 = tempDir.resolve("subfolder2");
+    fileAccess.mkdirs(subfolder2);
+    fileAccess.touch(subfolder2.resolve("targetfile"));
+    List<Path> pathList = new ArrayList<>();
+    pathList.add(subfolder1);
+    pathList.add(subfolder2);
+    Path foundFile = fileAccess.findExistingFile("targetfile", pathList);
+    assertThat(foundFile).exists();
+  }
+
+  private void postExtract(Path path) {
+  }
+
+
 }

cli/src/test/java/com/devonfw/tools/ide/os/WindowsHelperImplTest.java

@@ -0,0 +1,51 @@
+package com.devonfw.tools.ide.os;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.jupiter.api.Test;
+
+import com.devonfw.tools.ide.context.AbstractIdeContextTest;
+import com.devonfw.tools.ide.context.AbstractIdeTestContext;
+import com.devonfw.tools.ide.context.IdeSlf4jContext;
+
+/**
+ * Tests for {@link WindowsHelperImpl}.
+ */
+public class WindowsHelperImplTest extends AbstractIdeContextTest {
+
+  /**
+   * Tests if the USER_PATH registry entry can be parsed properly.
+   */
+  @Test
+  public void testWindowsHelperParseRegString() {
+    // arrange
+    AbstractIdeTestContext context = new IdeSlf4jContext();
+    WindowsHelperImpl helper = new WindowsHelperImpl(context);
+    List<String> output = new ArrayList<>();
+    output.add("");
+    output.add("HKEY_CURRENT_USER\\Environment");
+    output.add("    PATH    REG_SZ    D:\\projects\\_ide\\installation\\bin;");
+    output.add("");
+    // act
+    String regString = helper.retrieveRegString("PATH", output);
+    // assert
+    assertThat(regString).isEqualTo("D:\\projects\\_ide\\installation\\bin;");
+  }
+
+  /**
+   * Tests if an empty list of outputs will result in null.
+   */
+  @Test
+  public void testWindowsHelperParseEmptyRegStringReturnsNull() {
+    // arrange
+    AbstractIdeTestContext context = new IdeSlf4jContext();
+    WindowsHelperImpl helper = new WindowsHelperImpl(context);
+    List<String> output = new ArrayList<>();
+    // act
+    String regString = helper.retrieveRegString("PATH", output);
+    // assert
+    assertThat(regString).isNull();
+  }
+
+}