Warn-log the case of incomplete name-description

Author: pzygielo

src/it/invoker-report/verify.bsh

@@ -22,11 +22,66 @@ import java.util.*;
 
 File reportFile = new File( basedir, "target/site/invoker-report.html");
 
+passed = true;
+
 System.out.println( "Checking for existence of report file: " + reportFile );
 if ( !reportFile.exists() )
 {
     System.out.println( "FAILED!" );
-    return false;
+    passed = false;
+}
+
+buildLogReader = null;
+try
+{
+    buildLogReader = new BufferedReader( new FileReader( new File( basedir, "build.log" ) ) );
+    allWarningLines = new ArrayList();
+
+    currentLine = null;
+    while ( ( currentLine = buildLogReader.readLine() ) != null )
+    {
+        if ( currentLine.contains( "[WARNING] Incomplete job name-description" ) )
+        {
+            allWarningLines.add( currentLine );
+        }
+    }
+
+    missingNameLinesCount = 0;
+    missingDescriptionLinesCount = 0;
+
+    for ( currentLine : allWarningLines )
+    {
+        if ( currentLine.contains( "name is missing" ) )
+        {
+            ++missingNameLinesCount;
+        }
+
+        if ( currentLine.contains( "description is missing" ) )
+        {
+            ++missingDescriptionLinesCount;
+        }
+    }
+
+    expectedMissingNames = 5;
+    if ( expectedMissingNames != missingNameLinesCount )
+    {
+        System.out.println( "Current missingNameLinesCount: " + missingNameLinesCount + " but expecting: " + expectedMissingNames );
+        passed = false;
+    }
+
+    expectedMissingDescriptions = 1;
+    if ( expectedMissingDescriptions != missingDescriptionLinesCount )
+    {
+        System.out.println( "Current missingDescriptionLinesCount: " + missingDescriptionLinesCount + " but expecting: " + expectedMissingDescriptions );
+        passed = false;
+    }
+}
+finally
+{
+    if ( buildLogReader != null )
+    {
+        buildLogReader.close();
+    }
 }
 
-return true;
+return passed;

src/main/java/org/apache/maven/plugins/invoker/InvokerReport.java

@@ -301,16 +301,35 @@ private void renderBuildJob( BuildJob buildJob )
 
     private String getBuildJobReportName( BuildJob buildJob )
     {
-        StringBuilder buffer = new StringBuilder();
-        if ( !StringUtils.isEmpty( buildJob.getName() ) && !StringUtils.isEmpty( buildJob.getDescription() ) )
+        String buildJobName = buildJob.getName();
+        String buildJobDescription = buildJob.getDescription();
+        boolean emptyJobName = StringUtils.isEmpty( buildJobName );
+        boolean emptyJobDescription = StringUtils.isEmpty( buildJobDescription );
+        boolean isReportJobNameComplete = !emptyJobName && !emptyJobDescription;
+        if ( isReportJobNameComplete )
         {
-            buffer.append( getFormattedName( buildJob.getName(), buildJob.getDescription() ) );
+            return getFormattedName( buildJobName, buildJobDescription );
         }
         else
         {
-            buffer.append( buildJob.getProject() );
+            String buildJobProject = buildJob.getProject();
+            if ( emptyJobName )
+            {
+                getLog().warn( incompleteNameWarning( "name", buildJobProject ) );
+            }
+            else if ( emptyJobDescription )
+            {
+                getLog().warn( incompleteNameWarning( "description", buildJobProject ) );
+            }
+            return buildJobProject;
         }
-        return buffer.toString();
+    }
+
+    private static String incompleteNameWarning( String missing, String pom )
+    {
+        return String.format( "Incomplete job name-description: %s is missing. "
+                            + "POM (%s) will be used in place of job name.",
+                              missing, pom );
     }
 
     private String getFormattedName( String name, String description )