Maven 1.x Jar Plugin

Jar plugin generate incorrect manifest file

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Critical Critical
  • Resolution: Fixed
  • Affects Version/s: 1.5
  • Fix Version/s: 1.8
  • Labels:
    None
  • Number of attachments :
    3

Description

Current jar plugin genrate an invalid manifest file. In particular it is impossible to retrieve package version information for jars created by this plugin. See more details at http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#JAR%20Manifest

Here is the example of current generated manifest file:

----------
Manifest-Version: 1.0
Ant-Version: Apache Ant 1.5.3
Created-By: Apache Maven
Built-By: Administrator
Package: org.codehaus.activemq.jms.cci
Build-Jdk: 1.4.2_02
Class-Path: commons-logging-1.0.3.jar log4j-1.2.8.jar
Extension-Name: ra-jms
Specification-Title:
Specification-Vendor:
Implementation-Title: org.codehaus.activemq.jms.cci
Implementation-Vendor:
Implementation-Version: 0.0.2

----------

And this is about how it should look like instead:

------------
Manifest-Version: 1.0
Ant-Version: Apache Ant 1.5.3
Created-By: 1.4.2_02-b03 (Sun Microsystems Inc.)
Class-path: commons-logging-1.0.3.jar log4j-1.2.8.jar

Name: org/codehaus/some/component/
Specification-Title: something
Specification-Vendor:
Specification-Version: 0.0.2
Implementation-Title: org.codehaus.activemq.jms.cci
Implementation-Vendor:
Implementation-Version: 0.0.2

--------------------------

Issue Links

is depended upon by

Bug - A problem which impairs or prevents the functions of the product. PICO-197 PicoContainer jar should include proper package version specification

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.
is related to

Bug - A problem which impairs or prevents the functions of the product. MPWAR-58 War plugin generates incorrect manifest file

  • Major - Major loss of function.
  • Resolved - A resolution has been taken, and it is awaiting verification by reporter. From here issues are either reopened, or are closed.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Felipe Leme added a comment -

Eugene,

Is there any tool or Java code that could be used to verify if a Jar file is complaint or not? That would make it much easier to test the fix.

Felipe

Show
Felipe Leme added a comment - Eugene, Is there any tool or Java code that could be used to verify if a Jar file is complaint or not? That would make it much easier to test the fix. Felipe
Hide
Permalink
Ian Springer added a comment -

java.util.jar.Manifest does basic validation of the format. It could always be extended to do more robust validation.

Show
Ian Springer added a comment - java.util.jar.Manifest does basic validation of the format. It could always be extended to do more robust validation.
Hide
Permalink
Eugene Kuleshov added a comment -

I'm not sure if you can do much automatically.

For the manifest from my original comment if package org/codehaus/some/component/ (notice last slash!) have class MyComponent, then the following code should return true:

"0.0.2".equals( MyComponent.class.getPackage().getSpecificationVersion())

I also noticed that standard jarsigner tool is sometimes picky for incomplete manifests, you can try it too.

Thank you.

Show
Eugene Kuleshov added a comment - I'm not sure if you can do much automatically. For the manifest from my original comment if package org/codehaus/some/component/ (notice last slash!) have class MyComponent, then the following code should return true: "0.0.2".equals( MyComponent.class.getPackage().getSpecificationVersion()) I also noticed that standard jarsigner tool is sometimes picky for incomplete manifests, you can try it too. Thank you.
Hide
Permalink
Felipe Leme added a comment -

Simple testcase for this issue - I will try to do the fix later...

Show
Felipe Leme added a comment - Simple testcase for this issue - I will try to do the fix later...
Felipe Leme made changes -
Field Original Value New Value
Attachment maven-1415-testcase.zip [ 12753 ]
Brett Porter made changes -
Affects Version/s 1.0 [ 10830 ]
Key MAVEN-1415 MPJAR-36
Project maven [ 10030 ] maven-jar-plugin [ 10362 ]
Affects Version/s 1.5 [ 10778 ]
Hide
Permalink
Felipe Leme added a comment -

Eugene,

I couldn't get the package information from any jar that I tested. Could you please attach a jar where your code snippet works? Better yet if it has a main class that already test it.

Felipe

Show
Felipe Leme added a comment - Eugene, I couldn't get the package information from any jar that I tested. Could you please attach a jar where your code snippet works? Better yet if it has a main class that already test it. Felipe
Hide
Permalink
Eugene Kuleshov added a comment -

complete Eclipse prject to demonstrate usage of the Package API

Show
Eugene Kuleshov added a comment - complete Eclipse prject to demonstrate usage of the Package API
Eugene Kuleshov made changes -
Attachment jartest.zip [ 12820 ]
Hide
Permalink
Jörg Schaible added a comment -

Link directly to the Maven issue

Show
Jörg Schaible added a comment - Link directly to the Maven issue
Jörg Schaible made changes -
Link This issue is depended upon by PICO-197 [ PICO-197 ]
Hide
Permalink
Michael Gaffney added a comment -

I've attached a patch to fix this problem. I moved version information about a package from the 'main' manifest section to a package section. I looked at manifest files for other projects (like ant and xalan) and noticed they were also doing it this way. An added benefit is that it would now be possible to correctly merge two jar files and their manifest files.

I deleted the setting of the 'Created-By' attribute because the ant manifest task correctly sets this with the java version used to generate the manifest file (which is what the Sun spec says it should be). This info was previously captured in the non-standard 'Build-Jdk' attribute which I removed because it was redundant.

Show
Michael Gaffney added a comment - I've attached a patch to fix this problem. I moved version information about a package from the 'main' manifest section to a package section. I looked at manifest files for other projects (like ant and xalan) and noticed they were also doing it this way. An added benefit is that it would now be possible to correctly merge two jar files and their manifest files. I deleted the setting of the 'Created-By' attribute because the ant manifest task correctly sets this with the java version used to generate the manifest file (which is what the Sun spec says it should be). This info was previously captured in the non-standard 'Build-Jdk' attribute which I removed because it was redundant.
Michael Gaffney made changes -
Attachment patch.txt [ 13142 ]
Lukas Theussl made changes -
Fix Version/s 1.8 [ 11767 ]
Hide
Permalink
Lukas Theussl added a comment -

Patch applied with some modifications. Thanks!

Show
Lukas Theussl added a comment - Patch applied with some modifications. Thanks!
Lukas Theussl made changes -
Resolution Fixed [ 1 ]
Status Open [ 1 ] Closed [ 6 ]
Assignee Lukas Theussl [ lukas ]
Stéphane Nicoll made changes -
Link This issue is related to MPWAR-58 [ MPWAR-58 ]
Hide
Permalink
wolfgang haefelinger added a comment -

It appears, that there is now no way in Maven 1.1 to add a entry to the Main section. This does not make sense. Of course, Maven should create a "correct" Manifest file. However, why having an opinion about explicitly adding something to the Main section? This patch needs to be improved to allow for attributes in the Main section as well.

Show
wolfgang haefelinger added a comment - It appears, that there is now no way in Maven 1.1 to add a entry to the Main section. This does not make sense. Of course, Maven should create a "correct" Manifest file. However, why having an opinion about explicitly adding something to the Main section? This patch needs to be improved to allow for attributes in the Main section as well.
Hide
Permalink
Lukas Theussl added a comment -

For non-standard attributes you should use a custom manifest file with the maven.jar.manifest property.

Show
Lukas Theussl added a comment - For non-standard attributes you should use a custom manifest file with the maven.jar.manifest property.

People

  • Assignee:
    Lukas Theussl
    Reporter:
    Eugene Kuleshov
Vote (2)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: