JAVA-3738 fixed manual tests and sdk connections

Author: BrianPhillips2020

gradle-plugin/build.gradle

@@ -2,6 +2,7 @@ plugins {
     id 'java'
     id 'java-gradle-plugin'
     id 'com.diffplug.spotless' version("6.10.0")
+    id 'maven-publish'
 }
 
 version = '0.1'
@@ -53,6 +54,18 @@ dependencies {
     testImplementation 'org.junit.jupiter:junit-jupiter'
 }
 
+var e2eTests = "com/contrastsecurity/gradle.plugin/e2e/EndToEndTests.*"
+
+
 test {
+    if(!project.hasProperty("e2e")){
+        exclude(e2eTests)
+    }
+
     useJUnitPlatform()
+    environment = ["CONTRAST__API__USER_NAME"      : System.getenv("CONTRAST__API__USER_NAME"),
+        "CONTRAST__API__URL"            : System.getenv("CONTRAST__API__URL"),
+        "CONTRAST__API__SERVICE_KEY"    : System.getenv("CONTRAST__API__SERVICE_KEY"),
+        "CONTRAST__API__API_KEY"        : System.getenv("CONTRAST__API__API_KEY"),
+        "CONTRAST__API__ORGANIZATION_ID": System.getenv("CONTRAST__API__ORGANIZATION_ID")]
 }

gradle-plugin/src/main/java/com/contrastsecurity/gradle/plugin/ContrastConfigurationExtension.java

@@ -2,51 +2,57 @@
 
 /** Extension for configuring TeamServer API Credentials for downloading agent */
 public class ContrastConfigurationExtension {
-  final String username;
-  final String apiKey;
-  final String serviceKey;
-  final String apiUrl;
-  final String orgUuid;
-  final String appName;
-  final String serverName;
-  final String jarPath;
-  final String appVersion;
-
-  // default constructor with null values
-  // this is shit figure out what gradle wants
-  public ContrastConfigurationExtension() {
-    this.username = null;
-    this.apiKey = null;
-    this.serviceKey = null;
-    this.apiUrl = null;
-    this.orgUuid = null;
-    this.appName = null;
-    this.serverName = null;
-    this.jarPath = null;
-    this.appVersion = null;
-  }
-
-  public ContrastConfigurationExtension(
-      final String username,
-      final String apiKey,
-      final String serviceKey,
-      final String apiUrl,
-      final String orgUuid,
-      final String appName,
-      final String serverName,
-      final String jarPath,
-      final String appVersion) {
+  private String username;
+  private String apiKey;
+  private String serviceKey;
+  private String apiUrl;
+  private String orgUuid;
+  private String appName;
+  private String serverName;
+  private String jarPath;
+  private String appVersion;
+  private boolean attachToTests;
+
+  public void setUsername(final String username) {
     this.username = username;
+  }
+
+  public void setApiKey(final String apiKey) {
     this.apiKey = apiKey;
+  }
+
+  public void setServiceKey(final String serviceKey) {
     this.serviceKey = serviceKey;
+  }
+
+  public void setApiUrl(final String apiUrl) {
     this.apiUrl = apiUrl;
+  }
+
+  public void setOrgUuid(final String orgUuid) {
     this.orgUuid = orgUuid;
+  }
+
+  public void setAppName(final String appName) {
     this.appName = appName;
+  }
+
+  public void setServerName(final String serverName) {
     this.serverName = serverName;
+  }
+
+  public void setJarPath(final String jarPath) {
     this.jarPath = jarPath;
+  }
+
+  public void setAppVersion(final String appVersion) {
     this.appVersion = appVersion;
   }
 
+  public void setAttachToTests(final boolean attachToTests) {
+    this.attachToTests = attachToTests;
+  }
+
   public String getUsername() {
     return username;
   }
@@ -82,4 +88,8 @@ public String getJarPath() {
   public String getAppVersion() {
     return appVersion;
   }
+
+  public boolean getAttachToTests() {
+    return attachToTests;
+  }
 }

gradle-plugin/src/main/java/com/contrastsecurity/gradle/plugin/ContrastGradlePlugin.java

@@ -2,6 +2,7 @@
 
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
+import org.gradle.api.tasks.testing.Test;
 
 /**
  * Gradle plugin for contrast utilities. The goals for this plugin are defined here <a
@@ -18,7 +19,17 @@ public void apply(final Project target) {
         .getTasks()
         .register("hello", task -> task.doLast(s -> System.out.println("HelloWorld!")));
 
-    target.getTasks().register("empty", EmptyTask.class);
+    target
+        .getTasks()
+        .register("testWithContrast")
+        .configure(
+            task -> {
+              target
+                  .getTasks()
+                  .withType(Test.class)
+                  .configureEach(s -> s.dependsOn("installAgent"));
+              task.doFirst(s -> target.getTasks().withType(Test.class));
+            });
 
     target.getTasks().register("installAgent", InstallAgentTask.class);
   }

gradle-plugin/src/main/java/com/contrastsecurity/gradle/plugin/InstallAgentTask.java

@@ -7,18 +7,21 @@
 import com.contrastsecurity.sdk.ContrastSDK;
 import com.contrastsecurity.sdk.UserAgentProduct;
 import java.io.IOException;
+import java.nio.file.FileAlreadyExistsException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.nio.file.StandardOpenOption;
 import java.text.SimpleDateFormat;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.Date;
+import java.util.HashSet;
+import java.util.Objects;
 import org.gradle.api.DefaultTask;
-import org.gradle.api.tasks.JavaExec;
+import org.gradle.api.Project;
 import org.gradle.api.tasks.TaskAction;
-import org.gradle.internal.impldep.org.apache.commons.io.FileUtils;
+import org.gradle.api.tasks.testing.Test;
+import org.jetbrains.annotations.VisibleForTesting;
 
 /**
  * Downloads the current java agent from TeamServer using Credentials provided by the
@@ -31,25 +34,48 @@ public class InstallAgentTask extends DefaultTask {
 
   @TaskAction
   void installAgent() {
+    System.out.println("Running installAgent task");
 
     // create sdk object for connecting to Contrast
     final ContrastSDK sdk = connectToContrast();
+    System.out.println("Connected to Contrast at: " + sdk.getRestApiURL());
 
     // get agent, either from configured jar path or from TS
-    final Path agent = retrieveAgent(sdk);
+    final Path agent = retrieveAgent(sdk, config.getJarPath(), config.getOrgUuid(), getProject());
 
+    System.out.println("preparing to attach agent");
     attachAgentToTasks(agent.toAbsolutePath());
   }
 
-  /** Configures JavaExec tasks to run with the agent attached */
+  /**
+   * Configures tasks to run with the agent attached Should be configurable via the plugin
+   * configurations to determine which tasks we attach to. For now, this configuration is just a
+   * boolean and only attaches to Test tasks.
+   */
   private void attachAgentToTasks(final Path agentPath) {
-    getProject()
-        .getTasks()
-        .withType(JavaExec.class)
-        .configureEach(
-            task -> {
-              task.jvmArgs(createContrastArgs(agentPath));
-            });
+    if (config.getAttachToTests()) {
+      getProject()
+          .getTasks()
+          .withType(Test.class)
+          .configureEach(
+              task -> {
+                System.out.println("Attaching agent arguments to Test Tasks");
+                task.jvmArgs(
+                    createContrastArgs(
+                        agentPath,
+                        config.getAppName(),
+                        config.getServerName(),
+                        config.getAppVersion()));
+                System.out.println("ADDED ARGS " + task.getName() + ":");
+                Objects.requireNonNull(task.getAllJvmArgs()).forEach(System.out::println);
+                System.out.println("-----------------------------\n");
+              });
+
+      getProject()
+          .getTasks()
+          .withType(Test.class)
+          .forEach(s -> System.out.println(s.getAllJvmArgs()));
+    }
   }
 
   /**
@@ -58,16 +84,17 @@ private void attachAgentToTasks(final Path agentPath) {
    * @param agentPath preconfigured path to an agent defined by the ContrastConfigurationExtension
    * @return Set of arguments
    */
-  private Collection<String> createContrastArgs(final Path agentPath) {
-    final Collection<String> args = Collections.emptySet();
+  @VisibleForTesting
+  public static Collection<String> createContrastArgs(
+      final Path agentPath, final String appName, final String serverName, String appVersion) {
+    final Collection<String> args = new HashSet<String>();
     args.add("-javaagent:" + agentPath.toAbsolutePath());
-    args.add("-Dcontrast.override.appname=" + config.appName);
-    args.add("-Dcontrast.server=" + config.serverName);
+    args.add("-Dcontrast.override.appname=" + appName);
+    args.add("-Dcontrast.server=" + serverName);
     args.add("-Dcontrast.env=qa");
 
-    String appVersion = config.getAppVersion();
     if (appVersion == null) {
-      appVersion = computeAppVersion();
+      appVersion = computeAppVersion(appName);
     }
 
     args.add("-Dcontrast.override.appversion=" + appVersion);
@@ -81,7 +108,8 @@ private Collection<String> createContrastArgs(final Path agentPath) {
    *
    * @return computed AppVersion
    */
-  private String computeAppVersion() {
+  @VisibleForTesting
+  public static String computeAppVersion(final String appName) {
     final Date currentDate = new Date();
     String travisBuildNumber = System.getenv("TRAVIS_BUILD_NUMBER");
     String circleBuildNum = System.getenv("CIRCLE_BUILD_NUM");
@@ -94,25 +122,40 @@ private String computeAppVersion() {
     } else {
       appVersionQualifier = new SimpleDateFormat("yyyyMMddHHmmss").format(currentDate);
     }
-    return config.getAppName() + "-" + appVersionQualifier;
+    return appName + "-" + appVersionQualifier;
   }
 
   /** Use ContrastSDK to download agent and return the path where agent jar is stored */
-  private Path retrieveAgent(final ContrastSDK connection) {
+  @VisibleForTesting
+  public static Path retrieveAgent(
+      final ContrastSDK connection,
+      final String jarPath,
+      final String uuid,
+      final Project project) {
     // Initially attempt to run agent from the previously configured location
-    final String jarPath = config.getJarPath();
     if (jarPath != null) {
       final Path agent = Paths.get(jarPath);
       if (!Files.exists(agent)) {
         throw new RuntimeException("Unable to find java agent at " + jarPath);
       }
+      System.out.println("Agent provided via configuration retrieved");
+      return agent;
+    }
+
+    System.out.println("No agent path provided or agent does not exist, checking for cached agent");
+
+    final Path agent = Paths.get(project.getProjectDir().getPath()).resolve(AGENT_NAME);
+    if (Files.exists(agent)) {
+      System.out.println("Agent jar found at " + project.getProjectDir().getPath());
       return agent;
     }
+    System.out.println("Connected to Contrast at: " + connection.getRestApiURL());
 
+    System.out.println("Attempting to retrieve agent from TeamServer");
     // If no jar is provided, and no jarpath configured, attempt to retrieve the agent from TS
     final byte[] bytes;
     try {
-      bytes = connection.getAgent(AgentType.JAVA, config.getOrgUuid());
+      bytes = connection.getAgent(AgentType.JAVA, uuid);
     } catch (IOException e) {
       throw new RuntimeException("Failed to retrieve Contrast Java Agent: " + e);
     } catch (UnauthorizedException e) {
@@ -122,20 +165,23 @@ private Path retrieveAgent(final ContrastSDK connection) {
     }
 
     // Save the jar to the 'target' directory
-    final Path target = Paths.get(getProject().getProjectDir().getPath());
+    final Path target = Paths.get(project.getProjectDir().getPath());
     try {
-      FileUtils.forceMkdir(target.toFile());
+      Files.createFile(target);
+    } catch (final FileAlreadyExistsException e) {
+      System.out.println("Project directory already exists");
     } catch (final IOException e) {
       throw new RuntimeException("Unable to create directory " + target, e);
     }
 
-    final Path agent = target.resolve(AGENT_NAME);
+    final Path downloadedAgent = target.resolve(AGENT_NAME);
     try {
-      Files.write(agent, bytes, StandardOpenOption.CREATE, StandardOpenOption.WRITE);
+      Files.write(downloadedAgent, bytes, StandardOpenOption.CREATE, StandardOpenOption.WRITE);
     } catch (final IOException e) {
       throw new RuntimeException("Unable to save the latest java agent.", e);
     }
-    return agent;
+    System.out.println("Agent retrieved from TeamServer");
+    return downloadedAgent;
   }
 
   /** Use ContrastSDK to download agent creds for running the agent */