#130: Add default content length to progress bar

cli/pom.xml

@@ -77,7 +77,7 @@
     <dependency>
       <groupId>me.tongfei</groupId>
       <artifactId>progressbar</artifactId>
-      <version>0.10.0</version>
+      <version>0.10.1</version>
     </dependency>
     <dependency>
       <groupId>org.jline</groupId>

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

@@ -7,9 +7,6 @@
 import com.devonfw.tools.ide.log.IdeLogLevel;
 import com.devonfw.tools.ide.log.IdeSubLoggerOut;
 
-import me.tongfei.progressbar.ProgressBarBuilder;
-import me.tongfei.progressbar.ProgressBarStyle;
-
 /**
  * Default implementation of {@link IdeContext} using the console.
  */
@@ -63,24 +60,6 @@ protected String readLine() {
 
   @Override
   public IdeProgressBar prepareProgressBar(String taskName, long size) {
-
-    ProgressBarBuilder pbb = new ProgressBarBuilder();
-    // default (COLORFUL_UNICODE_BLOCK)
-    pbb.setStyle(ProgressBarStyle.builder().refreshPrompt("\r").leftBracket("\u001b[33m│").delimitingSequence("")
-        .rightBracket("│\u001b[0m").block('█').space(' ').fractionSymbols(" ▏▎▍▌▋▊▉").rightSideFractionSymbol(' ')
-        .build());
-    // set different style for Windows systems (ASCII)
-    if (getSystemInfo().isWindows()) {
-      pbb.setStyle(ProgressBarStyle.builder().refreshPrompt("\r").leftBracket("[").delimitingSequence("")
-          .rightBracket("]").block('=').space(' ').fractionSymbols(">").rightSideFractionSymbol(' ').build());
-    }
-    pbb.showSpeed();
-    pbb.setTaskName(taskName);
-    pbb.setUnit("MiB", 1048576);
-    pbb.setInitialMax(size);
-    pbb.continuousUpdate();
-    pbb.setUpdateIntervalMillis(1);
-    return new IdeProgressBarConsole(pbb.build());
+    return new IdeProgressBarConsole(getSystemInfo(), taskName, size);
   }
-
 }

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

@@ -0,0 +1,68 @@
+package com.devonfw.tools.ide.io;
+
+/**
+ * Abstract implementation of {@link IdeProgressBar}.
+ */
+public abstract class AbstractIdeProgressBar implements IdeProgressBar {
+
+  /** The default value for missing content length */
+  public static final long DEFAULT_CONTENT_LENGTH = 10000000L;
+
+  private long currentProgress;
+  private final long maxLength;
+
+  /**
+   * @param maxLength the maximum length of the progress bar.
+   */
+  public AbstractIdeProgressBar(long maxLength) {
+
+    this.maxLength = maxLength;
+  }
+
+  /**
+   * Increases the progress bar by given step size.
+   *
+   * @param stepSize size to step by.
+   * @param currentProgress
+   */
+  protected abstract void doStepBy(long stepSize, long currentProgress);
+
+  /**
+   * Increases the progress bar by given step size.
+   *
+   * @param stepSize size to step by.
+   */
+  protected abstract void doStepBy(long stepSize);
+
+  /**
+   * Sets the progress bar to given step position.
+   *
+   * @param stepPosition position to set to.
+   */
+  protected abstract void doStepTo(long stepPosition);
+
+  @Override
+  public void stepBy(long stepSize) {
+
+    this.currentProgress += stepSize;
+    if (this.maxLength > 0) {
+      // check if maximum overflow
+      if (this.currentProgress > this.maxLength) {
+        this.currentProgress = this.maxLength;
+        doStepTo(this.maxLength);
+        return;
+      }
+    }
+
+    doStepBy(stepSize, this.currentProgress);
+  }
+
+  @Override
+  public void close() {
+    if (this.currentProgress < this.maxLength) {
+      // TODO: Check if doStepTo should be used instead.
+      doStepBy(this.maxLength - this.currentProgress, this.currentProgress);
+    }
+  }
+
+}

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

@@ -24,8 +24,9 @@ public interface FileAccess {
    * @param url the location of the binary file to download. May also be a local or remote path to copy from.
    * @param targetFile the {@link Path} to the target file to download to. Should not already exists. Missing parent directories will be created
    *     automatically.
+   * @param test boolean indicating if this is used in a test or not.
    */
-  void download(String url, Path targetFile);
+  void download(String url, Path targetFile, boolean test);
 
   /**
    * Creates the entire {@link Path} as directories if not already existing.

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

@@ -89,7 +89,7 @@ private HttpClient createHttpClient(String url) {
   }
 
   @Override
-  public void download(String url, Path target) {
+  public void download(String url, Path target, boolean test) {
 
     this.context.info("Trying to download {} from {}", target.getFileName(), url);
     mkdirs(target.getParent());
@@ -109,7 +109,7 @@ public void download(String url, Path target) {
         Path source = Path.of(url);
         if (isFile(source)) {
           // network drive
-          copyFileWithProgressBar(source, target);
+          copyFileWithProgressBar(source, target, test);
         } else {
           throw new IllegalArgumentException("Download path does not point to a downloadable file: " + url);
         }
@@ -126,13 +126,10 @@ public void download(String url, Path target) {
    * @param target Path of the target directory.
    * @param response the {@link HttpResponse} to use.
    */
-  private void downloadFileWithProgressBar(String url, Path target, HttpResponse<InputStream> response) throws IOException {
+  private void downloadFileWithProgressBar(String url, Path target, HttpResponse<InputStream> response) {
 
     long contentLength = response.headers().firstValueAsLong("content-length").orElse(0);
-    if (contentLength == 0) {
-      this.context.warning("Content-Length was not provided by download source : {} using fallback for the progress bar which will be inaccurate.", url);
-      contentLength = 10000000;
-    }
+    informAboutSettingDefaultContentLength(contentLength, url, null);
 
     byte[] data = new byte[1024];
     boolean fileComplete = false;
@@ -151,6 +148,7 @@ private void downloadFileWithProgressBar(String url, Path target, HttpResponse<I
           pb.stepBy(count);
         }
       }
+
     } catch (Exception e) {
       throw new RuntimeException(e);
     }
@@ -161,26 +159,49 @@ private void downloadFileWithProgressBar(String url, Path target, HttpResponse<I
    *
    * @param source Path of file to copy
    * @param target Path of target directory
+   * @param test the flag about calling this method from test classes.
    */
-  private void copyFileWithProgressBar(Path source, Path target) throws IOException {
+  private void copyFileWithProgressBar(Path source, Path target, boolean test) throws IOException {
 
     try (InputStream in = new FileInputStream(source.toFile()); OutputStream out = new FileOutputStream(target.toFile())) {
+      long size;
+      if (test) {
+        size = 0L;
+      } else {
+        size = source.toFile().length();
+      }
 
-      long size = source.toFile().length();
+      informAboutSettingDefaultContentLength(size, null, source);
       byte[] buf = new byte[1024];
       int readBytes;
 
       try (IdeProgressBar pb = this.context.prepareProgressBar("Copying", size)) {
         while ((readBytes = in.read(buf)) > 0) {
           out.write(buf, 0, readBytes);
-          pb.stepByOne();
+          if (size > 0) {
+            pb.stepBy(readBytes);
+          }
         }
       } catch (Exception e) {
         throw new RuntimeException(e);
       }
     }
   }
 
+  private void informAboutSettingDefaultContentLength(long contentLength, String url, Path path) {
+
+    String source;
+    if (contentLength == 0) {
+      if (path != null) {
+        source = path.toString();
+      } else {
+        source = url;
+      }
+      this.context.warning("Content-Length was not provided by download/copy source: {}.",
+          source);
+    }
+  }
+
   @Override
   public void mkdirs(Path directory) {
 

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

@@ -12,14 +12,6 @@ public interface IdeProgressBar extends AutoCloseable {
    */
   void stepBy(long stepSize);
 
-  /**
-   * Increases the progress bar by one step.
-   */
-  default void stepByOne() {
-
-    stepBy(1);
-  }
-
   @Override
   void close();
 }

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

@@ -1,33 +1,88 @@
 package com.devonfw.tools.ide.io;
 
+import com.devonfw.tools.ide.os.SystemInfo;
+
 import me.tongfei.progressbar.ProgressBar;
+import me.tongfei.progressbar.ProgressBarBuilder;
+import me.tongfei.progressbar.ProgressBarStyle;
 
 /**
  * Implementation of {@link IdeProgressBar}.
  */
-public class IdeProgressBarConsole implements IdeProgressBar {
+public class IdeProgressBarConsole extends AbstractIdeProgressBar {
 
   private final ProgressBar progressBar;
+  private final SystemInfo systemInfo;
 
   /**
    * The constructor.
    *
-   * @param progressBar the {@link ProgressBar} to initialize.
+   * @param systemInfo the {@link SystemInfo}.
+   * @param taskName the {@link ProgressBar} to initialize.
+   * @param maxSize the maximum size of the progress bar.
+   */
+  public IdeProgressBarConsole(SystemInfo systemInfo, String taskName, long maxSize) {
+
+    super(maxSize);
+
+    this.systemInfo = systemInfo;
+    this.progressBar = createProgressBar(taskName, maxSize);
+  }
+
+  /**
+   * Creates the {@link ProgressBar} initializes task name and maximum size as well as the behaviour and style.
+   *
+   * @param taskName name of the task.
+   * @param size of the content.
+   * @return {@link ProgressBar} to use.
    */
-  public IdeProgressBarConsole(ProgressBar progressBar) {
+  protected ProgressBar createProgressBar(String taskName, long size) {
 
-    this.progressBar = progressBar;
+    ProgressBarBuilder pbb = new ProgressBarBuilder();
+    // default (COLORFUL_UNICODE_BLOCK)
+    pbb.setStyle(ProgressBarStyle.builder().refreshPrompt("\r").leftBracket("\u001b[33m│").delimitingSequence("")
+        .rightBracket("│\u001b[0m").block('█').space(' ').fractionSymbols(" ▏▎▍▌▋▊▉").rightSideFractionSymbol(' ')
+        .build());
+    // set different style for Windows systems (ASCII)
+    if (this.systemInfo.isWindows()) {
+      pbb.setStyle(ProgressBarStyle.builder().refreshPrompt("\r").leftBracket("[").delimitingSequence("")
+          .rightBracket("]").block('=').space(' ').fractionSymbols(">").rightSideFractionSymbol(' ').build());
+    }
+
+    pbb.setUnit("MiB", 1048576);
+    if (size == 0) {
+      pbb.setTaskName(taskName + " (unknown size)");
+      pbb.setInitialMax(-1);
+      pbb.hideEta();
+    } else {
+      pbb.setTaskName(taskName);
+      pbb.showSpeed();
+      pbb.setInitialMax(size);
+    }
+    pbb.continuousUpdate();
+    pbb.setUpdateIntervalMillis(1);
+
+    return pbb.build();
   }
 
   @Override
-  public void stepBy(long stepSize) {
+  protected void doStepBy(long stepSize, long currentProgress) {
+    doStepBy(stepSize);
+  }
 
+  @Override
+  protected void doStepBy(long stepSize) {
     this.progressBar.stepBy(stepSize);
   }
 
   @Override
-  public void close() {
+  protected void doStepTo(long stepPosition) {
+    this.progressBar.stepTo(stepPosition);
+  }
 
+  @Override
+  public void close() {
+    super.close();
     this.progressBar.close();
   }
 }

cli/src/main/java/com/devonfw/tools/ide/repo/AbstractToolRepository.java

@@ -157,7 +157,7 @@ protected Path download(String url, Path target, String downloadFilename, Versio
 
     Path tmpDownloadFile = createTempDownload(downloadFilename);
     try {
-      this.context.getFileAccess().download(url, tmpDownloadFile);
+      this.context.getFileAccess().download(url, tmpDownloadFile, false);
       if (resolvedVersion.toString().equals("latest")) {
         // Some software vendors violate best-practices and provide the latest version only under a fixed URL.
         // Therefore if a newer version of that file gets released, the same URL suddenly leads to a different

cli/src/main/java/com/devonfw/tools/ide/tool/ide/IdeaBasedIdeToolCommandlet.java

@@ -109,7 +109,7 @@ private Path downloadPlugin(FileAccess fileAccess, String downloadUrl, Path tmpD
     }
     String fileName = String.format("%s-plugin-%s%s", this.getName(), pluginId, extension);
     Path downloadedFile = tmpDir.resolve(fileName);
-    fileAccess.download(downloadUrl, downloadedFile);
+    fileAccess.download(downloadUrl, downloadedFile, false);
     return downloadedFile;
   }
 

cli/src/main/java/com/devonfw/tools/ide/tool/mvn/Mvn.java

@@ -185,8 +185,9 @@ private Set<String> findVariables(String content) {
   @Override
   public void installPlugin(PluginDescriptor plugin) {
 
-    Path mavenPlugin = this.getToolPath().resolve("lib/ext/" + plugin.getName() + ".jar");
-    this.context.getFileAccess().download(plugin.getUrl(), mavenPlugin);
+    Path mavenPlugin = this.context.getSoftwarePath().resolve(this.tool).resolve("lib/ext/" + plugin.getName() + ".jar");
+    this.context.getFileAccess().download(plugin.getUrl(), mavenPlugin, false);
+
     if (Files.exists(mavenPlugin)) {
       this.context.success("Successfully added {} to {}", plugin.getName(), mavenPlugin.toString());
     } else {