Display plugin's goal prefix and version instead of artifactId (#748)

* Display plugin's goal prefix and version instead of artifactId * Default to groupId:artifactId if goalPrefix is not present
apache · Dec 13, 2022 · 2a8d18d · 2a8d18d
1 parent 1249211
commit 2a8d18d
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 11 deletions.
diff --git a/common/src/main/java/org/mvndaemon/mvnd/common/Message.java b/common/src/main/java/org/mvndaemon/mvnd/common/Message.java
@@ -510,6 +510,7 @@ public static class MojoStartedEvent extends Message {
         final String artifactId;
         final String pluginGroupId;
         final String pluginArtifactId;
+        final String pluginGoalPrefix;
         final String pluginVersion;
         final String mojo;
         final String executionId;
@@ -518,23 +519,27 @@ public static MojoStartedEvent read(DataInputStream input) throws IOException {
             final String artifactId = readUTF(input);
             final String pluginGroupId = readUTF(input);
             final String pluginArtifactId = readUTF(input);
+            final String pluginGoalPrefix = readUTF(input);
             final String pluginVersion = readUTF(input);
             final String mojo = readUTF(input);
             final String executionId = readUTF(input);
-            return new MojoStartedEvent(artifactId, pluginGroupId, pluginArtifactId, pluginVersion, mojo, executionId);
+            return new MojoStartedEvent(
+                    artifactId, pluginGroupId, pluginArtifactId, pluginGoalPrefix, pluginVersion, mojo, executionId);
         }
 
         public MojoStartedEvent(
                 String artifactId,
                 String pluginGroupId,
                 String pluginArtifactId,
+                String pluginGoalPrefix,
                 String pluginVersion,
                 String mojo,
                 String executionId) {
             super(Message.MOJO_STARTED);
             this.artifactId = Objects.requireNonNull(artifactId, "artifactId cannot be null");
             this.pluginGroupId = Objects.requireNonNull(pluginGroupId, "pluginGroupId cannot be null");
             this.pluginArtifactId = Objects.requireNonNull(pluginArtifactId, "pluginArtifactId cannot be null");
+            this.pluginGoalPrefix = Objects.requireNonNull(pluginGoalPrefix, "pluginGoalPrefix cannot be null");
             this.pluginVersion = Objects.requireNonNull(pluginVersion, "pluginVersion cannot be null");
             this.mojo = Objects.requireNonNull(mojo, "mojo cannot be null");
             this.executionId = Objects.requireNonNull(executionId, "executionId cannot be null");
@@ -552,6 +557,10 @@ public String getPluginArtifactId() {
             return pluginArtifactId;
         }
 
+        public String getPluginGoalPrefix() {
+            return pluginGoalPrefix;
+        }
+
         public String getPluginVersion() {
             return pluginVersion;
         }
@@ -566,13 +575,14 @@ public String getMojo() {
 
         @Override
         public String toString() {
-            return "MojoStarted{" + "artifactId='"
-                    + artifactId + '\'' + ", pluginGroupId='"
-                    + pluginGroupId + '\'' + ", pluginArtifactId='"
-                    + pluginArtifactId + '\'' + ", pluginVersion='"
-                    + pluginVersion + '\'' + ", mojo='"
-                    + mojo + '\'' + ", executionId='"
-                    + executionId + '\'' + '}';
+            return "MojoStarted{"
+                    + "artifactId='" + artifactId + '\'' + ", "
+                    + "pluginGroupId='" + pluginGroupId + '\'' + ", "
+                    + "pluginArtifactId='" + pluginArtifactId + '\'' + ", "
+                    + "pluginGoalPrefix='" + pluginGoalPrefix + '\'' + ", "
+                    + "pluginVersion='" + pluginVersion + '\'' + ", "
+                    + "mojo='" + mojo + '\'' + ", "
+                    + "executionId='" + executionId + '\'' + '}';
         }
 
         @Override
@@ -581,6 +591,7 @@ public void write(DataOutputStream output) throws IOException {
             writeUTF(output, artifactId);
             writeUTF(output, pluginGroupId);
             writeUTF(output, pluginArtifactId);
+            writeUTF(output, pluginGoalPrefix);
             writeUTF(output, pluginVersion);
             writeUTF(output, mojo);
             writeUTF(output, executionId);
@@ -1073,10 +1084,12 @@ public static Message mojoStarted(
             String artifactId,
             String pluginGroupId,
             String pluginArtifactId,
+            String pluginGoalPrefix,
             String pluginVersion,
             String mojo,
             String executionId) {
-        return new MojoStartedEvent(artifactId, pluginGroupId, pluginArtifactId, pluginVersion, mojo, executionId);
+        return new MojoStartedEvent(
+                artifactId, pluginGroupId, pluginArtifactId, pluginGoalPrefix, pluginVersion, mojo, executionId);
     }
 
     public static ProjectEvent display(String projectId, String message) {

diff --git a/common/src/main/java/org/mvndaemon/mvnd/common/logging/TerminalOutput.java b/common/src/main/java/org/mvndaemon/mvnd/common/logging/TerminalOutput.java
@@ -785,8 +785,14 @@ private void addProjectLine(final List<AttributedString> lines, Project prj) {
             asb.append(':')
                     .style(CYAN_FOREGROUND)
                     .append(String.format(artifactIdFormat, prj.id))
-                    .style(GREEN_FOREGROUND)
-                    .append(execution.getPluginArtifactId())
+                    .style(GREEN_FOREGROUND);
+            if (execution.getPluginGoalPrefix().isEmpty()) {
+                asb.append(execution.getPluginGroupId()).append(':').append(execution.getPluginArtifactId());
+            } else {
+                asb.append(execution.getPluginGoalPrefix());
+            }
+            asb.append(':')
+                    .append(execution.getPluginVersion())
                     .append(':')
                     .append(execution.getMojo())
                     .append(' ')

diff --git a/daemon/src/main/java/org/mvndaemon/mvnd/daemon/ClientDispatcher.java b/daemon/src/main/java/org/mvndaemon/mvnd/daemon/ClientDispatcher.java
@@ -118,10 +118,12 @@ public void executionFailure(String projectId, boolean halted, String exception)
 
     public void mojoStarted(ExecutionEvent event) {
         final MojoExecution execution = event.getMojoExecution();
+        String goalPrefix = execution.getMojoDescriptor().getPluginDescriptor().getGoalPrefix();
         queue.add(Message.mojoStarted(
                 event.getProject().getArtifactId(),
                 execution.getGroupId(),
                 execution.getArtifactId(),
+                goalPrefix != null ? goalPrefix : "",
                 execution.getVersion(),
                 execution.getGoal(),
                 execution.getExecutionId()));

diff --git a/integration-tests/src/test/java/org/mvndaemon/mvnd/it/SingleModuleTest.java b/integration-tests/src/test/java/org/mvndaemon/mvnd/it/SingleModuleTest.java
@@ -53,6 +53,7 @@ String mojoStarted(Properties props, String pluginArtifactId, String mojo, Strin
                                 "single-module",
                                 "org.apache.maven.plugins",
                                 pluginArtifactId,
+                                pluginArtifactId.replace("maven-", "").replace("-plugin", ""),
                                 props.getProperty(pluginArtifactId + ".version"),
                                 mojo,
                                 executionId)