Implement includeContracts extension

Author: Xavier

README.md

@@ -25,7 +25,7 @@ buildscript {
         mavenCentral()
     }
     dependencies {
-        classpath 'org.web3j:web3j-gradle-plugin:4.1.2'
+        classpath 'org.web3j:web3j-gradle-plugin:4.1.3'
     }
 }
 
@@ -39,7 +39,7 @@ build file:
 
 ```groovy
 plugins {
-    id 'org.web3j' version '4.1.2'
+    id 'org.web3j' version '4.1.3'
 }
 ```
 
@@ -85,6 +85,7 @@ The properties accepted by the DSL are listed in the following table:
 | `generatedPackageName`  | `String`   | `${group}.web3j` or `org.web3j.{0}` | Generated contract wrappers package. |
 | `generatedFilesBaseDir` | `String`   | `$buildDir/generated/source/web3j`  | Generated Java code output directory. |
 | `excludedContracts`     | `String[]` | `[]`                                | Excluded contract names from wrapper generation. |
+| `includedContracts`     | `String[]` | `[]`                                | Included contract names from wrapper generation. Has preference over `excludedContracts`. |
 | `useNativeJavaTypes`    | `Boolean`  | `true`                              | Generate smart contract wrappers using native Java types. |
 
 The `generatedPackageName` is evaluated as a [message format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/MessageFormat.html) 

gradle.properties

@@ -1,2 +1,2 @@
 group=org.web3j
-version=4.1.2
+version=4.1.3

src/main/java/org/web3j/gradle/plugin/GenerateContractWrappers.java

@@ -30,6 +30,10 @@ public class GenerateContractWrappers extends SourceTask {
     @Optional
     private List<String> excludedContracts;
 
+    @Input
+    @Optional
+    private List<String> includedContracts;
+
     @Inject
     public GenerateContractWrappers(final WorkerExecutor executor) {
         this.executor = executor;
@@ -46,7 +50,7 @@ void generateContractWrappers() {
             final String contractName = contractAbi.getName()
                     .replaceAll("\\.abi", "");
 
-            if (excludedContracts == null || !excludedContracts.contains(contractName)) {
+            if (shouldGenerateContract(contractName)) {
                 final String packageName = MessageFormat.format(
                         getGeneratedJavaPackageName(), contractName.toLowerCase());
 
@@ -62,6 +66,14 @@ void generateContractWrappers() {
         }
     }
 
+    private boolean shouldGenerateContract(final String contractName) {
+        if (includedContracts == null || includedContracts.isEmpty()) {
+            return excludedContracts == null || !excludedContracts.contains(contractName);
+        } else {
+            return includedContracts.contains(contractName);
+        }
+    }
+
     // Getters and setters
     public String getGeneratedJavaPackageName() {
         return generatedJavaPackageName;
@@ -87,5 +99,11 @@ public void setExcludedContracts(final List<String> excludedContracts) {
         this.excludedContracts = excludedContracts;
     }
 
+    public List<String> getIncludedContracts() {
+        return includedContracts;
+    }
 
+    public void setIncludedContracts(final List<String> includedContracts) {
+        this.includedContracts = includedContracts;
+    }
 }

src/main/java/org/web3j/gradle/plugin/Web3jExtension.java

@@ -41,6 +41,11 @@ public class Web3jExtension {
      */
     private List<String> excludedContracts;
 
+    /**
+     * Included contract names from wrapper generation.
+     */
+    private List<String> includedContracts;
+
     public String getGeneratedPackageName() {
         return generatedPackageName;
     }
@@ -75,20 +80,29 @@ public void setExcludedContracts(final List<String> excludedContracts) {
         this.excludedContracts = excludedContracts;
     }
 
+    public List<String> getIncludedContracts() {
+        return includedContracts;
+    }
+
+    public void setIncludedContracts(final List<String> includedContracts) {
+        this.includedContracts = includedContracts;
+    }
+
     public Web3jExtension(final Project project) {
         generatedFilesBaseDir = project.getBuildDir().getAbsolutePath()
-                + "/generated/source/web3j";
+                + "/generated/source/" + NAME;
 
         // Use the project's group name in generated package
         final String projectGroup = project.getGroup().toString();
         if (!projectGroup.isEmpty()) {
-            generatedPackageName = projectGroup + ".web3j";
+            generatedPackageName = projectGroup + "." + NAME;
         } else {
             generatedPackageName = DEFAULT_GENERATED_PACKAGE;
         }
 
         useNativeJavaTypes = true;
         excludedContracts = new ArrayList<>();
+        includedContracts = new ArrayList<>();
     }
 
 }

src/main/java/org/web3j/gradle/plugin/Web3jPlugin.java

@@ -80,6 +80,7 @@ private void configure(final Project project, final SourceSet sourceSet) {
 
         // Set task excluded contracts
         task.setExcludedContracts(extension.getExcludedContracts());
+        task.setIncludedContracts(extension.getIncludedContracts());
 
         task.dependsOn(project.getTasks().withType(SolidityCompile.class)
                 .named("compile" + srcSetName + "Solidity"));

src/test/java/org/web3j/gradle/plugin/Web3jPluginTest.java

@@ -1,20 +1,23 @@
 package org.web3j.gradle.plugin;
 
+import java.io.File;
+import java.io.IOException;
+import java.net.URL;
+import java.nio.file.Files;
+
 import org.gradle.testkit.runner.BuildResult;
 import org.gradle.testkit.runner.GradleRunner;
 import org.junit.Before;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.TemporaryFolder;
 
-import java.io.File;
-import java.io.IOException;
-import java.net.URL;
-import java.nio.file.Files;
-
 import static org.gradle.testkit.runner.TaskOutcome.SUCCESS;
 import static org.gradle.testkit.runner.TaskOutcome.UP_TO_DATE;
-import static org.junit.Assert.*;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 
 public class Web3jPluginTest {
 
@@ -35,7 +38,7 @@ public void setup() throws IOException {
     }
 
     @Test
-    public void generateContractWrappers() throws IOException {
+    public void generateContractWrappersExcluding() throws IOException {
         final String buildFileContent = "plugins {\n" +
                 "    id 'org.web3j'\n" +
                 "}\n" +
@@ -89,4 +92,59 @@ public void generateContractWrappers() throws IOException {
         assertEquals(UP_TO_DATE, upToDate.task(":generateContractWrappers").getOutcome());
     }
 
+    @Test
+    public void generateContractWrappersIncluding() throws IOException {
+        final String buildFileContent = "plugins {\n" +
+                "    id 'org.web3j'\n" +
+                "}\n" +
+                "web3j {\n" +
+                "    generatedPackageName = 'org.web3j.test'\n" +
+                "    includedContracts = ['StandardToken']\n" +
+                "}\n" +
+                "sourceSets {\n" +
+                "    main {\n" +
+                "        solidity {\n" +
+                "            srcDir {" +
+                "                '" + sourceDir.getAbsolutePath() + "'\n" +
+                "            }\n" +
+                "        }\n" +
+                "    }\n" +
+                "}\n" +
+                "repositories {\n" +
+                "   mavenCentral()\n" +
+                "}\n" +
+                "dependencies {\n" +
+                "   implementation \"org.web3j:core:4.1.1\"\n" +
+                "}\n";
+
+        Files.write(buildFile.toPath(), buildFileContent.getBytes());
+
+        final GradleRunner gradleRunner = GradleRunner.create()
+                .withProjectDir(testProjectDir.getRoot())
+                .withArguments("build")
+                .withPluginClasspath()
+                .forwardOutput();
+
+        final BuildResult success = gradleRunner.build();
+        assertNotNull(success.task(":generateContractWrappers"));
+        assertEquals(SUCCESS, success.task(":generateContractWrappers").getOutcome());
+
+        final File web3jContractsDir = new File(testProjectDir.getRoot(),
+                "build/generated/source/web3j/main/java");
+
+        final File generatedContract = new File(web3jContractsDir,
+                "org/web3j/test/StandardToken.java");
+
+        assertTrue(generatedContract.exists());
+
+        final File excludedContract = new File(web3jContractsDir,
+                "org/web3j/test/Token.java");
+
+        assertFalse(excludedContract.exists());
+
+        final BuildResult upToDate = gradleRunner.build();
+        assertNotNull(upToDate.task(":generateContractWrappers"));
+        assertEquals(UP_TO_DATE, upToDate.task(":generateContractWrappers").getOutcome());
+    }
+
 }