Merge pull request simpligility#769 from simpligility/dont-generate-existing-R

Don't generate existing R

Author: mosabua

pom.xml

@@ -20,7 +20,7 @@
 
   <groupId>com.simpligility.maven.plugins</groupId>
   <artifactId>android-maven-plugin</artifactId>
-  <version>4.5.0-jarfix</version>
+  <version>4.5.1-SNAPSHOT</version>
   <packaging>maven-plugin</packaging>
 
   <name>Android Maven Plugin - android-maven-plugin</name>

src/conf/maven_checks.xml

@@ -130,7 +130,9 @@ Android Maven Plugin uses the APL v2 but with copyright mentions -->
 
         <!-- Checks for Size Violations.                    -->
         <!-- See http://checkstyle.sf.net/config_sizes.html -->
-        <module name="MethodLength"/>
+        <module name="MethodLength">
+            <property name="countEmpty" value="false"/>
+        </module>
         <module name="ParameterNumber">
             <property name="max" value="10"/>
         </module>

src/main/java/com/simpligility/maven/plugins/android/AndroidSdk.java

@@ -142,7 +142,7 @@ private IAndroidTarget findPlatformByApiLevel( String apiLevel )
         // fallback to searching for platform on standard Android platforms (isPlatform() is true)
         for ( IAndroidTarget t: sdkManager.getAndroidTargetManager( null ).getTargets( null ) )
         {
-            if ( t.isPlatform() && t.getVersionName().equals( apiLevel ) )
+            if ( t.isPlatform() && apiLevel.equals( t.getVersionName() ) )
             {
                 return t;
             }

src/main/java/com/simpligility/maven/plugins/android/phase01generatesources/ClassLoaderFactory.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2009 Jayway AB
+ * Copyright (C) 2007-2008 JVending Masa
+ *
+ * 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.phase01generatesources;
+
+import java.io.File;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Creates a ClassLoader from a Collection of classpath elements.
+ *
+ * @author William Ferguson - william.ferguson@xandar.com.au
+ */
+final class ClassLoaderFactory
+{
+    private final List<String> classpathElements;
+
+    ClassLoaderFactory( List<String> classpathElements )
+    {
+        this.classpathElements = classpathElements;
+    }
+
+    /**
+     * @return ClassLoader containing the classpaths.
+     */
+    ClassLoader create()
+    {
+        final List<URL> urls = new ArrayList<>();
+        for ( final String element : classpathElements )
+        {
+            try
+            {
+                urls.add( new File( element ).toURI().toURL() );
+            }
+            catch ( MalformedURLException e )
+            {
+                throw new IllegalArgumentException( "Could not resolve dependency : " + element, e );
+            }
+        }
+        return new URLClassLoader(
+                urls.toArray( new URL[urls.size()] ),
+                Thread.currentThread().getContextClassLoader()
+        );
+    }
+}

src/main/java/com/simpligility/maven/plugins/android/phase01generatesources/GenerateSourcesMojo.java

@@ -20,15 +20,15 @@
 import com.simpligility.maven.plugins.android.CommandExecutor;
 import com.simpligility.maven.plugins.android.ExecutionException;
 import com.simpligility.maven.plugins.android.common.AaptCommandBuilder;
+import com.simpligility.maven.plugins.android.common.AaptCommandBuilder.AaptPackageCommandBuilder;
 import com.simpligility.maven.plugins.android.common.DependencyResolver;
 import com.simpligility.maven.plugins.android.common.FileRetriever;
-import com.simpligility.maven.plugins.android.common.AaptCommandBuilder.AaptPackageCommandBuilder;
 import com.simpligility.maven.plugins.android.configuration.BuildConfigConstant;
-
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.artifact.Artifact;
+import org.apache.maven.artifact.DependencyResolutionRequiredException;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.Component;
@@ -53,7 +53,6 @@
 import javax.xml.transform.TransformerFactory;
 import javax.xml.transform.dom.DOMSource;
 import javax.xml.transform.stream.StreamResult;
-
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
@@ -812,14 +811,37 @@ private void generateR() throws MojoExecutionException
             throw new MojoExecutionException( "", e );
         }
 
-        final ResourceClassGenerator resGenerator = new ResourceClassGenerator( this, targetDirectory, genDirectory );
+        final ClassLoader compileClassLoader = getCompileClassLoader();
+        final ResourceClassGenerator resGenerator = new ResourceClassGenerator(
+                this,
+                targetDirectory,
+                genDirectory,
+                compileClassLoader
+        );
         generateCorrectRJavaForApklibDependencies( resGenerator );
         generateCorrectRJavaForAarDependencies( resGenerator );
 
         getLog().info( "Adding R gen folder to compile classpath: " + genDirectory );
         project.addCompileSourceRoot( genDirectory.getAbsolutePath() );
     }
 
+    /**
+     * @return ClassLoader containing the compile paths.
+     */
+    private ClassLoader getCompileClassLoader()
+    {
+        try
+        {
+            final List<String> runtimeClasspathElements = project.getCompileClasspathElements();
+            final ClassLoaderFactory factory = new ClassLoaderFactory( runtimeClasspathElements );
+            return factory.create();
+        }
+        catch ( DependencyResolutionRequiredException e )
+        {
+            throw new IllegalStateException( "Mojo should have resolved dependencies", e );
+        }
+    }
+
     /**
      * Generate correct R.java for apklibs dependencies of a current project
      *
@@ -854,7 +876,7 @@ private void generateCorrectRJavaForApklibDependencies( ResourceClassGenerator r
     /**
      * Generate correct R.java for aar dependencies of a current project
      *
-     * @throws MojoExecutionException
+     * @throws MojoExecutionException if it could not generate the R java for one of the libraries.
      */
     private void generateCorrectRJavaForAarDependencies( ResourceClassGenerator resourceGenerator )
             throws MojoExecutionException

src/main/java/com/simpligility/maven/plugins/android/phase01generatesources/ResourceClassGenerator.java

@@ -4,9 +4,7 @@
 import com.android.builder.symbols.RGeneration;
 import com.android.builder.symbols.SymbolIo;
 import com.android.builder.symbols.SymbolTable;
-import com.android.utils.ILogger;
 import org.apache.maven.artifact.Artifact;
-import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.logging.Log;
 
 import java.io.File;
@@ -25,26 +23,34 @@ final class ResourceClassGenerator
     private final File targetDirectory;
     private final File genDirectory;
     private final Log log;
-    private final ILogger androidUtilsLog;
+    private final ClassLoader compileClassLoader;
 
-    ResourceClassGenerator( final GenerateSourcesMojo mojo, final File targetDirectory,
-                            final File genDirectory )
+    ResourceClassGenerator( final GenerateSourcesMojo mojo,
+                            final File targetDirectory,
+                            final File genDirectory,
+                            final ClassLoader compileClassLoader
+    )
     {
         this.mojo = mojo;
         this.targetDirectory = targetDirectory;
         this.genDirectory = genDirectory;
         this.log = mojo.getLog();
-        this.androidUtilsLog = new MavenILogger( log );
+        this.compileClassLoader = compileClassLoader;
     }
 
     /**
-     * see {@link com.android.builder.core.AndroidBuilder#processResources(com.android.builder.internal.aapt.Aapt,
+     * Generates R java files those libraries that do not already have their R java in the compile classpath.
+     *
+     * If we are generating an integration test APK and the APK under test has a reference to a library for which
+     * it generated an R java, then we don't want to generate that R java again for the test APK because otherwise
+     * Proguard will fail when building the test APK because of duplication of the R java in the compile classpath.
+     *
+     * See {@link com.android.builder.core.AndroidBuilder#processResources(com.android.builder.internal.aapt.Aapt,
      * com.android.builder.internal.aapt.AaptPackageConfig.Builder, boolean)}
      *
-     * @param libraries
-     * @throws MojoExecutionException
+     * @param libraries AAR libraries for which to generate R java files.
      */
-    public void generateLibraryRs( final Set<Artifact> libraries ) throws MojoExecutionException
+    public void generateLibraryRs( final Set<Artifact> libraries )
     {
         // list of all the symbol tables
         final List<SymbolTable> symbolTables = new ArrayList<>( libraries.size() );
@@ -59,7 +65,12 @@ public void generateLibraryRs( final Set<Artifact> libraries ) throws MojoExecut
             {
                 final File libManifestFile = new File( unpackedLibDirectory, "AndroidManifest.xml" );
                 final String packageName = new DefaultManifestParser( libManifestFile ).getPackage();
-                log.info( "Reading R for " + packageName + " at " + rFile );
+                if ( rJavaAlreadyExists( packageName ) )
+                {
+                    log.info( "Not creating R for " + packageName + " as it already exists" );
+                    continue;
+                }
+                log.info( "Generating R for " + packageName + " at " + rFile );
 
                 SymbolTable libSymbols = SymbolIo.read( rFile );
                 libSymbols = libSymbols.rename( packageName, libSymbols.getTableName() );
@@ -80,4 +91,18 @@ public void generateLibraryRs( final Set<Artifact> libraries ) throws MojoExecut
         RGeneration.generateRForLibraries( mainSymbols, symbolTables, genDirectory.getAbsoluteFile(), false );
     }
 
+    private boolean rJavaAlreadyExists( String packageName )
+    {
+        final String rJavaClass = packageName + ".R";
+        try
+        {
+            compileClassLoader.loadClass( rJavaClass );
+            return true;
+        }
+        catch ( ClassNotFoundException e )
+        {
+            log.debug( "Could not resolve R java : " + rJavaClass );
+            return false;
+        }
+    }
 }