org.eclipse.tycho.extras.custombundle.CustomBundleMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tycho-custom-bundle-plugin Show documentation
There is a newer version: 3.0.5
Show newest version
/*******************************************************************************
 * Copyright (c) 2011, 2018 Sonatype Inc. and others.
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *    Sonatype Inc. - initial API and implementation
 *******************************************************************************/
package org.eclipse.tycho.extras.custombundle;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.jar.Attributes;
import java.util.jar.Attributes.Name;
import java.util.jar.Manifest;

import org.apache.maven.archiver.MavenArchiveConfiguration;
import org.apache.maven.archiver.MavenArchiver;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.codehaus.plexus.archiver.Archiver;
import org.codehaus.plexus.archiver.FileSet;
import org.codehaus.plexus.archiver.jar.JarArchiver;
import org.codehaus.plexus.archiver.util.DefaultFileSet;
import org.eclipse.tycho.ReactorProject;
import org.eclipse.tycho.core.osgitools.DefaultReactorProject;

/**
 * Builds OSGi bundle
 */
@Mojo(name = "custom-bundle")
public class CustomBundleMojo extends AbstractMojo {

	/**
	 * Location of OSGi bundle, must have META-INF/MANIFEST.MF bundle manifest file.
	 */
	@Parameter(required = true)
	private File bundleLocation;

	/**
	 * Classifier of attached artifact.
	 */
	@Parameter(required = true)
	private String classifier;

	/**
	 * File patterns to include from bundleLocation. Include everything by default.
	 */
	@Parameter
	private String[] includes = new String[] { "**/*.*" };

	/**
	 * File patterns to exclude from bundleLocation.
	 */
	@Parameter
	private String[] excludes;

	/**
	 * Additional files to be included in the generated bundle.
	 */
	@Parameter(required = true)
	private List fileSets;

	@Parameter(property = "project")
	private MavenProject project;

	@Parameter(property = "session", readonly = true)
	private MavenSession session;

	@Parameter
	private MavenArchiveConfiguration archive = new MavenArchiveConfiguration();

	@Component(role = Archiver.class, hint = "jar")
	private JarArchiver jarArchiver;

	@Component
	private MavenProjectHelper projectHelper;

	@Override
	public void execute() throws MojoExecutionException, MojoFailureException {
		File outputJarFile = getOutputJarFile();

		MavenArchiver archiver = new MavenArchiver();
		archiver.setArchiver(jarArchiver);
		archiver.setOutputFile(outputJarFile);

		try {
			archiver.getArchiver().setManifest(updateManifest());

			DefaultFileSet mainFileSet = new DefaultFileSet();
			mainFileSet.setDirectory(bundleLocation);
			mainFileSet.setIncludes(includes);
			mainFileSet.setExcludes(excludes);

			archiver.getArchiver().addFileSet(mainFileSet);

			for (FileSet fileSet : fileSets) {
				archiver.getArchiver().addFileSet(fileSet);
			}

			archiver.createArchive(session, project, archive);

			projectHelper.attachArtifact(project, outputJarFile, classifier);
		} catch (Exception e) {
			throw new MojoExecutionException("Could not create OSGi bundle", e);
		}
	}

	protected File getOutputJarFile() {
		String filename = project.getArtifactId() + "-" + project.getVersion() + "-" + classifier + ".jar";
		return new File(project.getBuild().getDirectory(), filename);
	}

	// copy&paste from PackagePluginMojo
	private File updateManifest() throws IOException {
		File mfile = new File(bundleLocation, "META-INF/MANIFEST.MF");

		Manifest mf;
		try (InputStream is = new FileInputStream(mfile)) {
			mf = new Manifest(is);
		}
		Attributes attributes = mf.getMainAttributes();

		if (attributes.getValue(Name.MANIFEST_VERSION) == null) {
			attributes.put(Name.MANIFEST_VERSION, "1.0");
		}

		ReactorProject reactorProject = DefaultReactorProject.adapt(project);
		attributes.putValue("Bundle-Version", reactorProject.getExpandedVersion());

		mfile = new File(project.getBuild().getDirectory(), classifier + "-MANIFEST.MF");
		mfile.getParentFile().mkdirs();
		try (BufferedOutputStream os = new BufferedOutputStream(new FileOutputStream(mfile))) {
			mf.write(os);
		}

		return mfile;
	}

}