com.simpligility.maven.plugins.android.standalonemojos.PushMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-maven-plugin Show documentation
Show all versions of android-maven-plugin Show documentation
Maven Plugin for Android Development
/*
* Copyright (C) 2007-2008 JVending Masa
* Copyright (C) 2011 Jayway AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.simpligility.maven.plugins.android.standalonemojos;
import com.android.ddmlib.AdbCommandRejectedException;
import com.android.ddmlib.IDevice;
import com.android.ddmlib.SyncException;
import com.android.ddmlib.SyncService;
import com.android.ddmlib.TimeoutException;
import com.simpligility.maven.plugins.android.AbstractAndroidMojo;
import com.simpligility.maven.plugins.android.DeviceCallback;
import com.simpligility.maven.plugins.android.common.DeviceHelper;
import com.simpligility.maven.plugins.android.common.LogSyncProgressMonitor;
import com.simpligility.maven.plugins.android.config.ConfigHandler;
import com.simpligility.maven.plugins.android.config.ConfigPojo;
import com.simpligility.maven.plugins.android.config.PullParameter;
import com.simpligility.maven.plugins.android.configuration.Push;
import org.apache.commons.io.FileUtils;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
/**
* Copy file to all the attached (or specified) devices/emulators.
*
* @author Manfred Moser
*/
@SuppressWarnings( "unused" )
@Mojo( name = "push", requiresProject = false )
public class PushMojo extends AbstractAndroidMojo
{
/**
* The configuration for the push goal can be set up in the plugin configuration in the pom file as:
*
* <push>
* <source>path</source>
* <destination>path</destination>
* </push>
*
* The parameters can also be configured as property in the pom or settings file
*
* <properties>
* <android.push.source>pathondevice</android.push.source>
* <android.push.destination>path</android.push.destination>
* </properties>
*
* or from command-line with parameter
* -Dandroid.push.source=path
* and
* -Dandroid.push.destination=path.
*/
@Parameter
@ConfigPojo
private Push push;
/**
* The file name of the local filesystem file to push to the emulator or
* device either as absolute path or relative to the execution folder.
*
* If you specify a directory, all containing files will be pushed recursively.
*/
@Parameter( property = "android.push.source" )
private String pushSource;
@PullParameter( required = true )
private String parsedSource;
/**
* The destination file name as absolute path on the emulator or device.
* If the last character is a "/" it will be assumed that the original
* base filename should be preserved and a target directory is specified.
* This works analogous if the source is a directory.
*/
@Parameter( property = "android.push.destination" )
private String pushDestination;
@PullParameter( required = true )
private String parsedDestination;
public void execute() throws MojoExecutionException, MojoFailureException
{
ConfigHandler configHandler = new ConfigHandler( this, this.session, this.execution );
configHandler.parseConfiguration();
final Map sourceDestinationMap = calculateSourceDestinationMapping();
doWithDevices( new DeviceCallback()
{
public void doWithDevice( final IDevice device ) throws MojoExecutionException
{
String deviceLogLinePrefix = DeviceHelper.getDeviceLogLinePrefix( device );
// message will be set in for each loop according to the processed files
String message = "";
try
{
SyncService syncService = device.getSyncService();
for ( Map.Entry pushFileEntry : sourceDestinationMap.entrySet() )
{
String sourcePath = pushFileEntry.getKey();
String destinationPath = pushFileEntry.getValue();
message = deviceLogLinePrefix + "Push of " + sourcePath + " to " + destinationPath + " on "
+ DeviceHelper.getDescriptiveName( device );
syncService.pushFile( sourcePath, destinationPath, new LogSyncProgressMonitor( getLog() ) );
getLog().info( message + " successful." );
}
}
catch ( SyncException e )
{
throw new MojoExecutionException( message + " failed.", e );
}
catch ( IOException e )
{
throw new MojoExecutionException( message + " failed.", e );
}
catch ( TimeoutException e )
{
throw new MojoExecutionException( message + " failed.", e );
}
catch ( AdbCommandRejectedException e )
{
throw new MojoExecutionException( message + " failed.", e );
}
}
} );
}
/**
* Calculates a map which contains all files to be pushed to the device or
* emulator. The source filename works as the key while the value is the
* destination.
*
* @return a map with file source -> destination pairs
* @throws MojoExecutionException
*/
private Map calculateSourceDestinationMapping() throws MojoExecutionException
{
Map result = new HashMap();
File sourceFile = new File( parsedSource );
final String destinationPath;
if ( parsedDestination.endsWith( "/" ) )
{
destinationPath = parsedDestination + sourceFile.getName();
}
else
{
destinationPath = parsedDestination;
}
if ( sourceFile.isFile() )
{
// only put the source in
final String sourcePath = sourceFile.getAbsolutePath();
result.put( sourcePath, destinationPath );
}
else
{
if ( sourceFile.isDirectory() )
{
// find recursively all files to be pushed
@SuppressWarnings( "unchecked" ) Collection filesList = FileUtils
.listFiles( sourceFile, null, true );
for ( File file : filesList )
{
// make the file's path relative - this is kind of a hack but it
// works just fine in this controlled environment
String filePath = file.getAbsolutePath().substring( sourceFile.getAbsolutePath().length() );
filePath = filePath.replace( System.getProperty( "file.separator" ), "/" );
result.put( file.getAbsolutePath(), destinationPath + filePath );
}
}
else
{
throw new MojoExecutionException( "Cannot execute push goal: File or directory "
+ sourceFile.getAbsolutePath() + " does not exist." );
}
}
return result;
}
}