com.simpligility.maven.plugins.android.standalonemojos.ManifestMergerMojo Maven / Gradle / Ivy
package com.simpligility.maven.plugins.android.standalonemojos;
import com.android.SdkConstants;
import com.android.builder.core.AndroidBuilder;
import com.android.builder.core.ErrorReporter;
import com.android.ide.common.process.DefaultProcessExecutor;
import com.android.manifmerger.ManifestMerger2;
import com.android.utils.ILogger;
import com.simpligility.maven.plugins.android.AbstractAndroidMojo;
import com.simpligility.maven.plugins.android.DefaultJavaProcessExecutor;
import com.simpligility.maven.plugins.android.MavenErrorReporter;
import com.simpligility.maven.plugins.android.common.AndroidExtension;
import com.simpligility.maven.plugins.android.common.MavenManifestDependency;
import com.simpligility.maven.plugins.android.configuration.ManifestMerger;
import com.simpligility.maven.plugins.android.configuration.UsesSdk;
import com.simpligility.maven.plugins.android.configuration.VersionGenerator;
import com.simpligility.maven.plugins.android.phase01generatesources.MavenILogger;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Set;
/**
* Manifest Merger V2 AndroidManifest.xml file.
* http://tools.android.com/tech-docs/new-build-system/user-guide/manifest-merger
*
* @author Benoit Billington
*/
@Mojo( name = "manifest-merger", defaultPhase = LifecyclePhase.PROCESS_RESOURCES )
public class ManifestMergerMojo extends AbstractAndroidMojo
{
/**
* Configuration for the manifest-update goal.
*
* You can configure this mojo to update the following basic manifestMerger attributes:
*
*
* android:versionName on the manifestMerger element.
* android:versionCode on the manifestMerger element.
*
*
* You can configure attributes in the plugin configuration like so
*
*
* <plugin>
* <groupId>com.jayway.maven.plugins.android.generation2</groupId>
* <artifactId>android-maven-plugin</artifactId>
* <executions>
* <execution>
* <id>merge-manifest</id>
* <goals>
* <goal>manifest-merger</goal>
* </goals>
* <configuration>
* <manifestMerger>
* <versionName></versionName>
* <versionCode>123</versionCode>
* <versionCodeUpdateFromVersion>true|false</versionCodeUpdateFromVersion>
* <versionNamingPattern></versionNamingPattern>
* <mergeLibraries>true|false</mergeLibraries>
* <mergeReportFile>${project.build.directory}/ManifestMergeReport.txt</mergeReportFile>
* <usesSdk>
* <minSdkVersion>14</minSdkVersion>
* <targetSdkVersion>21</targetSdkVersion>
* </usesSdk>
* </manifestMerger>
* </configuration>
* </execution>
* </executions>
* </plugin>
*
*
* or use properties set in the pom or settings file or supplied as command line parameter. Add
* "android." in front of the property name for command line usage. All parameters follow a
* manifestMerger.* naming convention.
*
*/
@Parameter
private ManifestMerger manifestMerger;
/**
* Update the android:versionName with the specified parameter. If left empty it
* will use the version number of the project. Exposed via the project property
* android.manifestMerger.versionName.
*/
@Parameter( property = "android.manifestMerger.versionName", defaultValue = "${project.version}" )
protected String manifestVersionName;
/**
* Update the android:versionCode attribute with the specified parameter. Exposed via
* the project property android.manifestMerger.versionCode.
*/
@Parameter( property = "android.manifestMerger.versionCode", defaultValue = "1" )
protected Integer manifestVersionCode;
/**
* Update the android:versionCode attribute automatically from the project version
* e.g 3.2.1 will become version code 3002001. As described in this blog post
* http://www.simpligility.com/2010/11/release-version-management-for-your-android-application/
* but done without using resource filtering. The value is exposed via the project property
* property android.manifest.versionCodeUpdateFromVersion and the resulting value
* as android.manifest.versionCode.
* For the purpose of generating the versionCode, if a version element is missing it is presumed to be 0.
* The maximum values for the version increment and version minor values are 999,
* the version major should be no larger than 2000. Any other suffixes do not
* participate in the version code generation.
*/
@Parameter( property = "android.manifest.versionCodeUpdateFromVersion", defaultValue = "false" )
protected Boolean manifestVersionCodeUpdateFromVersion = false;
/**
* Optionally use a pattern to match version elements for automatic generation of version codes,
* useful in case of complex version naming schemes. The new behavior is disabled by default;
* set the pattern to a non-empty string to activate. Otherwise, continue using the old
* behavior of separating version elements by dots and ignoring all non-digit characters.
* The pattern is standard Java regex. Capturing groups in the pattern are sequentially passed
* to the version code generator, while other parts are ignored. Be sure to properly escape
* your pattern string, in case you use characters that have special meaning in XML.
* Exposed via the project property
* android.manifestMerger.versionNamingPattern.
*/
@Parameter( property = "android.manifestMerger.versionNamingPattern" )
protected String manifestVersionNamingPattern;
/**
* The number of digits per version element. Must be specified as a comma/semicolon separated list of
* digits, one for each version element, Exposed via the project property
* android.manifestMerger.versionDigits.
*/
@Parameter( property = "android.manifestMerger.versionDigits", defaultValue = "4,3,3" )
protected String manifestVersionDigits;
/**
* Merge Manifest with library projects. Exposed via the project property
* android.manifestMerger.mergeLibraries.
*/
@Parameter( property = "android.manifestMerger.mergeLibraries", defaultValue = "false" )
protected Boolean manifestMergeLibraries;
/**
* Merge Manifest with library projects. Exposed via the project property
* android.manifestMerger.mergeLibraries.
*/
@Parameter( property = "android.manifestMerger.mergeReportFile" )
protected File manifestMergeReportFile;
/**
* Update the uses-sdk tag. It can be configured to change: android:minSdkVersion,
* android:maxSdkVersion and android:targetSdkVersion
*/
protected UsesSdk manifestUsesSdk;
private Boolean parsedVersionCodeUpdateFromVersion;
private String parsedVersionNamingPattern;
private String parsedVersionDigits;
private Boolean parsedMergeLibraries;
private String parsedVersionName;
private Integer parsedVersionCode;
private UsesSdk parsedUsesSdk;
private File parsedMergeReportFile;
/**
* @throws org.apache.maven.plugin.MojoExecutionException
* @throws org.apache.maven.plugin.MojoFailureException
*/
public void execute() throws MojoExecutionException, MojoFailureException
{
if ( ! AndroidExtension.isAndroidPackaging( project.getPackaging() ) )
{
return; // skip, not an android project.
}
if ( androidManifestFile == null )
{
getLog().debug( "skip, no androidmanifest.xml defined (androidManifestFile rare case)" );
return; // skip, no androidmanifest.xml defined (rare case)
}
parseConfiguration();
getLog().info( "Attempting to update manifest " + androidManifestFile );
getLog().debug( " usesSdk=" + parsedUsesSdk );
getLog().debug( " versionName=" + parsedVersionName );
getLog().debug( " versionCode=" + parsedVersionCode );
getLog().debug( " usesSdk=" + parsedUsesSdk );
getLog().debug( " versionCodeUpdateFromVersion=" + parsedVersionCodeUpdateFromVersion );
getLog().debug( " versionNamingPattern=" + parsedVersionNamingPattern );
getLog().debug( " versionDigits=" + parsedVersionDigits );
getLog().debug( " mergeLibraries=" + parsedMergeLibraries );
getLog().debug( " mergeReportFile=" + parsedMergeReportFile );
if ( ! androidManifestFile.exists() )
{
return; // skip, no AndroidManifest.xml file found.
}
getLog().debug( "Using manifest merger V2" );
manifestMergerV2();
}
private void parseConfiguration()
{
// manifestMerger element found in plugin config in pom
if ( manifestMerger != null )
{
if ( StringUtils.isNotEmpty( manifestMerger.getVersionName() ) )
{
parsedVersionName = manifestMerger.getVersionName();
}
else
{
parsedVersionName = manifestVersionName;
}
if ( manifestMerger.getVersionCode() != null )
{
parsedVersionCode = manifestMerger.getVersionCode();
}
else
{
parsedVersionCode = manifestVersionCode;
}
if ( manifestMerger.getVersionCodeUpdateFromVersion() != null )
{
parsedVersionCodeUpdateFromVersion = manifestMerger.getVersionCodeUpdateFromVersion();
}
else
{
parsedVersionCodeUpdateFromVersion = manifestVersionCodeUpdateFromVersion;
}
if ( manifestMerger.getVersionNamingPattern() != null )
{
parsedVersionNamingPattern = manifestMerger.getVersionNamingPattern();
}
else
{
parsedVersionNamingPattern = manifestVersionNamingPattern;
}
if ( manifestMerger.getVersionDigits() != null )
{
parsedVersionDigits = manifestMerger.getVersionDigits();
}
else
{
parsedVersionDigits = manifestVersionDigits;
}
if ( manifestMerger.getUsesSdk() != null )
{
parsedUsesSdk = manifestMerger.getUsesSdk();
}
else
{
parsedUsesSdk = manifestUsesSdk;
}
if ( manifestMerger.getMergeLibraries() != null )
{
parsedMergeLibraries = manifestMerger.getMergeLibraries();
}
else
{
parsedMergeLibraries = manifestMergeLibraries;
}
if ( manifestMerger.getMergeReportFile() != null )
{
parsedMergeReportFile = manifestMerger.getMergeReportFile();
}
else
{
parsedMergeReportFile = manifestMergeReportFile;
}
}
else
{
parsedVersionName = manifestVersionName;
parsedVersionCode = manifestVersionCode;
parsedUsesSdk = manifestUsesSdk;
parsedVersionCodeUpdateFromVersion = manifestVersionCodeUpdateFromVersion;
parsedVersionNamingPattern = manifestVersionNamingPattern;
parsedVersionDigits = manifestVersionDigits;
parsedMergeLibraries = manifestMergeLibraries;
parsedMergeReportFile = manifestMergeReportFile;
}
}
public void manifestMergerV2() throws MojoExecutionException, MojoFailureException
{
ILogger logger = new MavenILogger( getLog(), ( parsedMergeReportFile != null ) );
AndroidBuilder builder = new AndroidBuilder( project.toString(), "created by Android Maven Plugin",
new DefaultProcessExecutor( logger ),
new DefaultJavaProcessExecutor( logger ),
new MavenErrorReporter( logger, ErrorReporter.EvaluationMode.STANDARD ),
logger,
false );
String minSdkVersion = null;
String targetSdkVersion = null;
int versionCode;
if ( parsedUsesSdk != null )
{
minSdkVersion = parsedUsesSdk.getMinSdkVersion();
targetSdkVersion = parsedUsesSdk.getTargetSdkVersion();
}
if ( parsedVersionCodeUpdateFromVersion )
{
VersionGenerator gen = new VersionGenerator( parsedVersionDigits, parsedVersionNamingPattern );
versionCode = gen.generate( parsedVersionName );
}
else
{
versionCode = parsedVersionCode;
}
List manifestDependencies = new ArrayList();
if ( parsedMergeLibraries )
{
final Set allArtifacts = project.getDependencyArtifacts();
Set dependencyArtifacts = getArtifactResolverHelper().getFilteredArtifacts( allArtifacts );
for ( Artifact dependency : dependencyArtifacts )
{
final File unpackedLibFolder = getUnpackedLibFolder( dependency );
final File manifestFile = new File( unpackedLibFolder, SdkConstants.FN_ANDROID_MANIFEST_XML );
if ( manifestFile.exists() )
{
manifestDependencies.add( new MavenManifestDependency( manifestFile,
manifestFile.getAbsolutePath(), new ArrayList() ) );
}
}
}
builder.mergeManifests(
androidManifestFile, // mainManifest
new ArrayList(), // manifestOverlays
manifestDependencies, // libraries
"", // packageOverride
versionCode, // versionCode
parsedVersionName, // versionName
minSdkVersion, // minSdkVersion
targetSdkVersion, // targetSdkVersion
null, // maxSdkVersion
destinationManifestFile.getPath(), // outManifestLocation
null, // outAaptSafeManifestLocation
ManifestMerger2.MergeType.APPLICATION, // mergeType
new HashMap(), // placeHolders
parsedMergeReportFile // reportFile
);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy