Added ProgressSpinner to show which probes are currently executing (#143)

Author: Conradowatz

pom.xml

@@ -98,6 +98,11 @@
             <artifactId>protocol-attacker</artifactId>
             <version>2.1.0</version>
         </dependency>
+        <dependency>
+            <groupId>de.rub.nds</groupId>
+            <artifactId>terminal-utils</artifactId>
+            <version>1.0.0</version>
+        </dependency>
         <dependency>
             <groupId>jakarta.xml.bind</groupId>
             <artifactId>jakarta.xml.bind-api</artifactId>

src/main/java/de/rub/nds/scanner/core/execution/Scanner.java

@@ -17,6 +17,7 @@
 import de.rub.nds.scanner.core.report.ScanReport;
 import de.rub.nds.scanner.core.report.rating.ScoreReport;
 import de.rub.nds.scanner.core.report.rating.SiteReportRater;
+import de.rub.nds.terminalutils.ProgressSpinner;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -152,7 +153,7 @@ public ReportT scan() {
 
         // Check Scan Prerequisites
         if (!checkScanPrerequisites(report)) {
-            LOGGER.debug("Scan cannot be performed due to prerequisites not being fulfilled");
+            LOGGER.info("Scan cannot be performed due to prerequisites not being fulfilled");
             return report;
         }
 
@@ -165,15 +166,18 @@ public ReportT scan() {
                         scanJob,
                         executorConfig.getParallelProbes(),
                         "ScannerProbeExecutor " + report.getRemoteName())) {
+            ProgressSpinner.startSpinnerTask("Executing:");
             report.setScanStartTime(System.currentTimeMillis());
             scanJobExecutor.execute(report);
         } catch (InterruptedException e) {
             LOGGER.warn("Scan execution interrupted");
             report.setScanEndTime(System.currentTimeMillis());
             Thread.currentThread().interrupt();
+            ProgressSpinner.stopSpinner();
             return report;
         }
         LOGGER.debug("Scan execution complete");
+        ProgressSpinner.stopSpinner();
 
         // Rating
         LOGGER.debug("Retrieving site report rater for score evaluation");

src/main/java/de/rub/nds/scanner/core/execution/ThreadedScanJobExecutor.java

@@ -147,8 +147,8 @@ private void executeProbesTillNoneCanBeExecuted(ReportT report) throws Interrupt
                         probeResult = result.get();
                         LOGGER.info(
                                 "[{}/{}] {} probe executed",
-                                currentFinishedProbes,
-                                probeCount,
+                                String.format("%2d", currentFinishedProbes),
+                                String.format("%2d", probeCount),
                                 probeResult.getType().getName());
                     } catch (ExecutionException e) {
                         LOGGER.error("Some probe execution failed", e);

src/main/java/de/rub/nds/scanner/core/probe/ScannerProbe.java

@@ -13,6 +13,7 @@
 import de.rub.nds.scanner.core.probe.result.*;
 import de.rub.nds.scanner.core.report.PerformanceData;
 import de.rub.nds.scanner.core.report.ScanReport;
+import de.rub.nds.terminalutils.ProgressSpinner;
 import java.math.BigInteger;
 import java.util.HashMap;
 import java.util.List;
@@ -41,8 +42,10 @@ public ScannerProbe(ProbeType type) {
     @Override
     public ScannerProbe<ReportT, StateT> call() {
         LOGGER.debug("Executing: {}", getProbeName());
+        ProgressSpinner.startSpinnerTask(getProbeName() + " probe");
         this.startTime = System.currentTimeMillis();
         executeTest();
+        ProgressSpinner.stopSpinnerTask(getProbeName() + " probe");
         this.stopTime = System.currentTimeMillis();
 
         LOGGER.debug("Finished {} -  Took {}s", getProbeName(), (stopTime - startTime) / 1000);