Jenkins Custom WAR Packager

❗ This tool is under development

A small packaging tool, which bundles custom Jenkins WAR files using the YAML specification. Generally the tool is a wrapper on the top of Maven HPI's plugin Custom WAR Mojo.

Differences:

• It can build package plugins from custom branches with unreleased/unstaged packages
• It can run as a CLI tool outside Maven
• It takes YAML specification instead of Maven pom.xml
• It allows patching WAR contents like bundled libraries, system properties
• It allows embedding Groovy Hook Scripts so that the instance can be auto-configured

Demo

• Jenkins WAR which bundles master branches for core and some key libraries/modules
• External Task Logging to Elasticsearch

Usage

The tool offers a CLI interface and a Maven Plugin wrapper.

CLI

java -jar custom-war-packager-cli.jar -configPath=mywar.yml -version=1.0-SNAPSHOT -tmpDir=tmp

After the build the generated WAR file will be put to tmp/output/${artifactId}.war.

To run the tool in a demo mode with this config, just use the following command:

java -jar war-packager-cli.jar -demo

Invoke the tool without options without options to get a full CLI options list.

Maven

Maven plugin runs the packager and generates the artifact. The artifact will be put to "target/custom-war-packager-maven-plugin/output/target/${bundle.artifactId}.war" and added to the project artifacts.

  <build>
    <plugins>
      <plugin>
        <groupId>io.jenkins.tools.custom-war-packager</groupId>
        <artifactId>custom-war-packager-maven-plugin</artifactId>
        <version>@project.version@</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>custom-war</goal>
            </goals>
            <configuration>
              <configFilePath>spotcheck.yml</configFilePath>
              <warVersion>1.1-SNAPSHOT</warVersion>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

Note that this plugin invokes Maven-in-Maven, and that it won't pass build options to the plugin. Configuration file can be used to configure the downstream builder.

Prerequisites

• Maven 3.5.0 or above
• Java 8
• Git (if any Git sources are defined)

Configuration file

Example:

bundle:
  groupId: "io.github.oleg-nenashev"
  artifactId: "mywar"
  description: "Just a WAR auto-generation-sample"
war:
  groupId: "org.jenkins-ci.main"
  artifactId: "jenkins-war"
  source:
    version: 2.107
plugins:
  - groupId: "org.jenkins-ci.plugins"
    artifactId: "matrix-project"
    source:
      version: 1.9
  - groupId: "org.jenkins-ci.plugins"
    artifactId: "durable-task"
    source:
      git: https://github.com/jglick/durable-task-plugin.git
      branch: watch-JENKINS-38381
libPatches:
  - groupId: "org.jenkins-ci.main"
    artifactId: "remoting"
    source:
      git: https://github.com/jenkinsci/remoting.git
systemProperties: {
     jenkins.model.Jenkins.slaveAgentPort: "50000",
     jenkins.model.Jenkins.slaveAgentPortEnforce: "true"}
groovyHooks:
  - type: "init"
    id: "initScripts"
    source: 
      dir: scripts

Limitations

Currently the tool is in the alpha state. It has some serious limitations:

• All built artifacts with Git source are being installed to the local repository
  • Versions are unique for every commit, so beware of local repo pollution
• System properties work only for a custom jenkins.util.SystemProperties class defined in the core
  • Use Groovy Hook Scripts if you need to setup other system properties
• libPatches steps bundles only a specified JAR file, but not its dependencies. Dependencies need to be explicitly packaged as well if they change compared to the base WAR file.
  • libExcludes can be used to remove dependencies which are not required anymore