[MSHARED-798] Add defaultEntries option (true by default)

This closes #6

Author: michael-o

src/main/java/org/apache/maven/archiver/ManifestConfiguration.java

@@ -56,6 +56,14 @@ public class ManifestConfiguration
      */
     private String classpathPrefix = "";
 
+    /**
+     * Add default, reproducible entries {@code Created-By} and {@code Build-Jdk-Spec}.
+     *
+     * @since 3.4.0
+     */
+    private boolean addDefaultEntries = true;
+
+
     /**
      * Add build environment information about Maven, JDK, and OS.
      *
@@ -107,6 +115,14 @@ public boolean isAddClasspath()
         return addClasspath;
     }
 
+    /**
+     * @return {@link #addDefaultEntries}
+     */
+    public boolean isAddDefaultEntries()
+    {
+        return addDefaultEntries;
+    }
+
     /**
      * @return {@link #addBuildEnvironmentEntries}
      */
@@ -147,6 +163,14 @@ public void setAddClasspath( boolean addClasspath )
         this.addClasspath = addClasspath;
     }
 
+    /**
+     * @param addDefaultEntries add default entries true/false.
+     */
+    public void setAddDefaultEntries( boolean addDefaultEntries )
+    {
+        this.addDefaultEntries = addDefaultEntries;
+    }
+
     /**
      * @param addBuildEnvironmentEntries add build environment information true/false.
      */

src/main/java/org/apache/maven/archiver/MavenArchiver.java

@@ -58,6 +58,8 @@
 public class MavenArchiver
 {
 
+    private static final String CREATED_BY = "Maven Archiver";
+
     /**
      * The simply layout.
      */
@@ -243,11 +245,13 @@ protected Manifest getManifest( MavenSession session, MavenProject project, Mani
     {
         // TODO: Should we replace "map" with a copy? Note, that we modify it!
 
-        // Added basic entries
         Manifest m = new Manifest();
-        addCreatedByEntry( session, m, entries );
 
-        addCustomEntries( m, entries, config );
+        if ( config.isAddDefaultEntries() )
+        {
+            handleDefaultEntries( m, entries );
+        }
+
 
         if ( config.isAddBuildEnvironmentEntries() )
         {
@@ -393,6 +397,8 @@ else if ( ManifestConfiguration.CLASSPATH_LAYOUT_TYPE_CUSTOM.equals( layoutType
             handleExtensions( project, entries, m );
         }
 
+        addCustomEntries( m, entries, config );
+
         return m;
     }
 
@@ -514,8 +520,6 @@ private void handleSpecificationEntries( MavenProject project, Map<String, Strin
     private void addCustomEntries( Manifest m, Map<String, String> entries, ManifestConfiguration config )
         throws ManifestException
     {
-        addManifestAttribute( m, entries, "Build-Jdk-Spec", System.getProperty( "java.specification.version" ) );
-
         /*
          * TODO: rethink this, it wasn't working Artifact projectArtifact = project.getArtifact(); if (
          * projectArtifact.isSnapshot() ) { Manifest.Attribute buildNumberAttr = new Manifest.Attribute( "Build-Number",
@@ -665,16 +669,17 @@ public void createArchive( MavenSession session, MavenProject project,
         archiver.createArchive();
     }
 
-    private void addCreatedByEntry( MavenSession session, Manifest m, Map<String, String> entries )
+    private void handleDefaultEntries( Manifest m, Map<String, String> entries )
         throws ManifestException
     {
-        String createdBy = "Maven Archiver";
-        String archiverVersion = getArchiverVersion();
-        if ( archiverVersion != null )
-        {
-            createdBy += " " + archiverVersion;
-        }
-        addManifestAttribute( m, entries, "Created-By", createdBy );
+         String createdBy = CREATED_BY;
+         String archiverVersion = getArchiverVersion();
+         if ( archiverVersion != null )
+         {
+             createdBy += " " + archiverVersion;
+         }
+         addManifestAttribute( m, entries, "Created-By", createdBy );
+         addManifestAttribute( m, entries, "Build-Jdk-Spec", System.getProperty( "java.specification.version" ) );
     }
 
     private void handleBuildEnvironmentEntries( MavenSession session, Manifest m, Map<String, String> entries )

src/site/xdoc/index.xml.vm

@@ -41,6 +41,7 @@
   <index/>
   &lt;<a href="#class_manifest">manifest</a>&gt;
     &lt;addClasspath/&gt;
+    &lt;addDefaultEntries/&gt;
     &lt;addDefaultImplementationEntries/&gt;
     &lt;addDefaultSpecificationEntries/&gt;
     &lt;addBuildEnvironmentEntries/&gt;
@@ -191,6 +192,18 @@
             <td>boolean</td>
             <td></td>
           </tr>
+          <tr>
+            <td>addDefaultEntries</td>
+            <td>
+              If the manifest will contain these entries:
+              <source>
+Created-By: Maven Archiver ${maven-archiver.version}
+Build-Jdk-Spec: ${java.specification.version}</source>
+              The default value is <code>true</code>.
+            </td>
+            <td>boolean</td>
+            <td>3.4.0</td>
+          </tr>
           <tr>
             <td>addDefaultImplementationEntries</td>
             <td>

src/test/java/org/apache/maven/archiver/MavenArchiverTest.java

@@ -504,6 +504,33 @@ public void testDeprecatedCreateArchiveAPI()
                       manifest.get( new Attributes.Name( "Build-Jdk-Spec" ) ) );
     }
 
+    @Test
+    public void testMinimalManifestEntries()
+        throws Exception
+    {
+        File jarFile = new File( "target/test/dummy.jar" );
+        JarArchiver jarArchiver = getCleanJarArchiver( jarFile );
+
+        MavenArchiver archiver = getMavenArchiver( jarArchiver );
+
+        MavenSession session = getDummySession();
+        MavenProject project = getDummyProject();
+        MavenArchiveConfiguration config = new MavenArchiveConfiguration();
+        config.setForced( true );
+        config.getManifest().setAddDefaultEntries( false );
+
+        archiver.createArchive( session, project, config );
+        assertTrue( jarFile.exists() );
+
+        final Manifest jarFileManifest = getJarFileManifest( jarFile );
+        Attributes manifest = jarFileManifest.getMainAttributes();
+
+        assertEquals( 1, manifest.size() );
+        assertEquals( new Attributes.Name( "Manifest-Version" ), manifest.keySet().iterator().next() );
+        assertEquals( "1.0", manifest.getValue( "Manifest-Version" ) );
+    }
+
+
     @Test
     public void testManifestEntries()
         throws Exception