Maven build file - generation of OSX, Windows, Linux files

[Rob Cashwalker]

Hey why is there an android library in our maven dependency? There are a lot more dependencies listed now, compared to the last git version I had pulled.

[jendave]

Hey why is there an android library in our maven dependency? There are a lot more dependencies listed now, compared to the last git version I had pulled.

There are no new direct deps. The new version of Substance has a transitive dep on android.

[Braids]

Yeah, the code dave provided just prints to the console as an example. a little tweaking and it becomes a callable method that can be used by any part of Forge that needs it.

it's going into Forge.model.FModel real soon now, available via Singletons.getModel().someMethodNameIHaveNotDecidedYetProbablyMoreThanOne()

[Braids]

Yes, there is a plugin that will grab the SVN (or GIT, Mercurial) rev number. The best place to put it would be in the manifest file. Then your Mantis code could grab it. . .

but only for binaries built with Maven. this makes unit testing the methods to fetch these values difficult. after some thought, i have decided that i'll have to make a mock jar file for unit test if it can't find the real one.

The manifest file now includes . . .
Implementation-Version: 1.1.2-SNAPSHOT
. . .
Implementation-Build: 9734 <----- SVN Rev

i updated svn to r9743. i then ran the maven goal "-U -B clean install" from pom.xml in eclipse. the resulting MANIFEST.MF in target/forge-1.1.2-SNAPSHOT-jar-with-dependencies.jar does not contain the build number:

Code: Select all

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: Braids
Build-Jdk: 1.6.0_26
Implementation-Title: Forge
Implementation-Version: 1.1.2-SNAPSHOT
Implementation-Vendor-Id: forge
Implementation-Vendor: CardForge
Main-Class: forge.Gui_NewGame
Implementation-Build:



do i need to run a different maven build command?

Here is some sample code to grab it

Code: Select all

String appServerHome = getServletContext().getRealPath("/");

File manifestFile = new File(appServerHome, "META-INF/MANIFEST.MF");
 
Manifest mf = new Manifest();
mf.read(new FileInputStream(manifestFile));

Attributes atts = mf.getMainAttributes();

System.out.println("Version: " + atts.getValue("Implementation-Version"));
System.out.println("Build: " + atts.getValue("Implementation-Build"));


This code was not meant to be run. I simply copied it from a tutorial on how to use the manifest attributes. Disregard the first line

ok, but then i need a path to a jar file.

is there some way to get the currently executing jar file from System.properties or something? would it be the first item in the classpath perhaps?

the path depends on the version. i guess i could look for forge*.jar in the application's present working directory and just use that. i hope nobody tries to put multiple forge jar versions in the same directory. yes, that would be an error condition worth testing.

[silly freak]

If you mean to grab the manifest from inside the jar, try

Code: Select all

ClassLoader.getSystemResourceAsStream("META-INF/MANIFEST.MF");


the code is from the top of my head, a leading slash may be missing etc. but in principle you should be able to grab everything inside the jar this way for read only access (if no security policy says otherwise...)

Edit:

is there some way to get the currently executing jar file from System.properties or something? would it be the first item in the classpath perhaps?

there is, using

Code: Select all

URL url = Gui_NewGame.class.getProtectionDomain().getCodeSource().getLocation();


[jendave]

but only for binaries built with Maven. this makes unit testing the methods to fetch these values difficult. after some thought, i have decided that i'll have to make a mock jar file for unit test if it can't find the real one.

Yes. This is a good use case for a mock.

i updated svn to r9743. i then ran the maven goal "-U -B clean install" from pom.xml in eclipse. the resulting MANIFEST.MF in target/forge-1.1.2-SNAPSHOT-jar-with-dependencies.jar does not contain the build number:

Code: Select all

...
Main-Class: forge.Gui_NewGame
Implementation-Build:



do i need to run a different maven build command?

Not sure what happened here. I cannot recreate the issue. I added the buildnumber to the regular jar as well as the jar-with-deps just in case.

[Braids]

i updated svn to r9743. i then ran the maven goal "-U -B clean install" from pom.xml in eclipse. the resulting MANIFEST.MF in target/forge-1.1.2-SNAPSHOT-jar-with-dependencies.jar does not contain the build number:
...

Not sure what happened here. I cannot recreate the issue. I added the buildnumber to the regular jar as well as the jar-with-deps just in case.

i now have the build number in the manifest file. there are two potential causes for my prior problem.

• i ran svn update, and there was a conflict in the .svn/tmp version of pom.xml. i accepted the server's version entirely.
• maven complained that i wasn't using a JDK compiler, but a JRE one. i fixed the setting in preferences and it built OK.

[Braids]

Yeah, the code dave provided just prints to the console as an example. a little tweaking and it becomes a callable method that can be used by any part of Forge that needs it.

it's going into Forge.model.FModel real soon now . . .

as of r9761, to access these values, you can make the following calls:

Code: Select all

import forge.Singletons;
import forge.model.BuildInfo;

BuildInfo buildInfo = Singletons.getModel().getBuildInfo();

String version = buildInfo.getVersion();  // returns "SVN" if unknown
String buildID = buildInfo.getBuildID();  // returns null if unknown


these typically only work if Forge is being run from a jar file created by maven. they also work if there is a single forge-*-with-dependencies.jar in the CLASSPATH. i got even more clever. if getBuildID() can't deduce the version number, it tries to invoke the OS command svnversion as a last-ditch effort. so, your buildID could end up looking like "4123", "4123:4168", "4168M", "4123S", "4123P" or even "4123:4168MS".

i wrote extensive unit tests for these because i wanted them to be robust.

edit: if it finds more than one, it throws a special MultipleForgeJarsFoundError. this should never happen in real life, right?

[friarsol]

If it finds more than one, can it just grab from the most recent version?

[Braids]

If it finds more than one, can it just grab from the most recent version?

only if "the most recent version" is well defined. it could go by the file with the later timestamp, or the one that is last in dictionary order, i guess.

but i think it's silly to have more than one forge jar in your classpath, so it throws an error instead.

[jendave]

Chris - I updated the launch4j Maven plugin (I maintain a fork of it). It should work on Lion now. Can you do a test

Code: Select all

mvn -U clean install -P windows-linux


That should create a Windows executable. Let me know if it works on OSX Lion.
The new version works on Snow Leopard.

Thanks
Dave

[Chris H.]

Chris - I updated the launch4j Maven plugin (I maintain a fork of it). It should work on Lion now. Can you do a test

Code: Select all

mvn -U clean install -P windows-linux


That should create a Windows executable. Let me know if it works on OSX Lion.
The new version works on Snow Leopard.

`
I entered this as a Maven goal while choosing Run -> Run As -> Maven Build... from Lion and it worked!

Thank you. I may now be able to migrate my Nightly Builds and Bi-Weekly betas to Lion.

I had spent some time recently trying to get VirtualBox to accept a Snow Leopard guest but was having problems getting it to work. The updated launch4j should help to minimize my need for Snow Leopard.

[Chris H.]

It looks like the AdiumApplescriptRunner app has the same PPC error under Lion.

`

[jendave]

It looks like the AdiumApplescriptRunner app has the same PPC error under Lion.

`

Please update from SVN and re-run the

Code: Select all

mvn clean install -P windows-linux,osx


I checked in a change that removes the dependency on AdiumApplescriptRunner.

[Chris H.]

Please update from SVN and re-run the

Code: Select all

mvn clean install -P windows-linux,osx


`
I checked in a change that removes the dependency on AdiumApplescriptRunner.

`
That works, I have both of the archives built locally.