Adding Go Get command to go driver (#709)

Author: sverdlov93

build-info-extractor-go/src/main/java/org/jfrog/build/extractor/go/GoDriver.java

@@ -21,6 +21,7 @@ public class GoDriver implements Serializable {
             Arrays.asList("list", "-f", "\"{{with .Module}}{{.Path}} {{.Version}}{{end}}\"", "all");
     private static final List<String> GO_MOD_TIDY_CMD = Arrays.asList("mod", "tidy");
     private static final String GO_MOD_GRAPH_CMD = "mod graph";
+    private static final String GO_GET_CMD = "get";
     private static final String GO_LIST_MODULE_CMD = "list -m";
     private static final String GO_VERSION_CMD = "version";
 
@@ -106,6 +107,17 @@ public void modTidy(boolean verbose, boolean ignoreErrors) throws IOException {
         runCmd(argsList, verbose);
     }
 
+    /**
+     * Run go get.
+     * @param componentId - Component ID string. ( Example: github.com/jfrog/build-info-go@v1.8.7 )
+     * @param verbose - True if should print the results to the log
+     * @throws IOException - in case of any I/O error.
+     */
+    public void get(String componentId, boolean verbose) throws IOException {
+        List<String> argsList = new ArrayList<>(Arrays.asList(GO_GET_CMD, componentId));
+        runCmd(argsList, verbose);
+    }
+
     /**
      * If ignoreErrors=false, run:
      * go list -f "{{with .Module}}{{.Path}} {{.Version}}{{end}}" all

build-info-extractor-go/src/main/java/org/jfrog/build/extractor/go/extractor/GoCommand.java

@@ -30,7 +30,7 @@ abstract class GoCommand extends PackageManagerExtractor {
     // Module name, as specified in go.mod, is used for naming the relevant go package files.
     String moduleName;
     // Module id is used to determine which buildInfo's module should be used for the current go operation.
-    // By default it's value is moduleNme, unless customize differently.
+    // By default, it's value is moduleNme, unless customize differently.
     String buildInfoModuleId;
     Log logger;
 
@@ -43,7 +43,7 @@ abstract class GoCommand extends PackageManagerExtractor {
 
     protected void preparePrerequisites(String repo, ArtifactoryManager artifactoryManager) throws VersionException, IOException {
         validateArtifactoryVersion(artifactoryManager);
-        validateRepoExists(repo, artifactoryManager, "The provided repo must be specified");
+        validateRepoExists(repo, artifactoryManager);
     }
 
     private void validateArtifactoryVersion(ArtifactoryManager artifactoryManager) throws VersionException, IOException {
@@ -53,14 +53,14 @@ private void validateArtifactoryVersion(ArtifactoryManager artifactoryManager) t
             throw new VersionException(message, VersionCompatibilityType.NOT_FOUND);
         }
         if (!version.isAtLeast(MIN_SUPPORTED_ARTIFACTORY_VERSION)) {
-            String message = String.format("Couldn't execute Go task. Artifactory version is %s but must be at least %s.", version.toString(), MIN_SUPPORTED_ARTIFACTORY_VERSION.toString());
+            String message = String.format("Couldn't execute Go task. Artifactory version is %s but must be at least %s.", version, MIN_SUPPORTED_ARTIFACTORY_VERSION);
             throw new VersionException(message, VersionCompatibilityType.INCOMPATIBLE);
         }
     }
 
-    private void validateRepoExists(String repo, ArtifactoryManager artifactoryManager, String repoNotSpecifiedMsg) throws IOException {
+    private void validateRepoExists(String repo, ArtifactoryManager artifactoryManager) throws IOException {
         if (StringUtils.isBlank(repo)) {
-            throw new IllegalArgumentException(repoNotSpecifiedMsg);
+            throw new IllegalArgumentException("The provided repo must be specified");
         }
         if (!artifactoryManager.isRepositoryExist(repo)) {
             throw new IOException("Repo " + repo + " doesn't exist");

build-info-extractor-go/src/main/java/org/jfrog/build/extractor/go/extractor/GoPublish.java

@@ -21,7 +21,6 @@
 import org.jfrog.build.extractor.go.GoDriver;
 
 import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -47,10 +46,10 @@ public class GoPublish extends GoCommand {
     private static final String PKG_MOD_FILE_EXTENSION = "mod";
     private static final String PKG_INFO_FILE_EXTENSION = "info";
 
-    private ArrayListMultimap<String, String> properties;
-    private List<Artifact> artifactList = new ArrayList<>();
-    private String deploymentRepo;
-    private String version;
+    private final ArrayListMultimap<String, String> properties;
+    private final List<Artifact> artifactList = new ArrayList<>();
+    private final String deploymentRepo;
+    private final String version;
 
     /**
      * Publish go package.
@@ -125,7 +124,7 @@ private void createAndDeployZip(ArtifactoryManager artifactoryManager) throws Ex
         File tmpZipFile = archiveProjectDir();
 
         // Second, filter the raw zip file according to Go rules and create deployable zip can be later resolved.
-        // We use the same code as Artifactory when he resolve a Go module directly from Github.
+        // We use the same code as Artifactory when he resolves a Go module directly from GitHub.
         File deployableZipFile = File.createTempFile(LOCAL_PKG_FILENAME, PKG_ZIP_FILE_EXTENSION, path.toFile());
         try (GoZipBallStreamer pkgArchiver = new GoZipBallStreamer(new ZipFile(tmpZipFile), moduleName, version, logger)) {
             pkgArchiver.writeDeployableZip(deployableZipFile);
@@ -179,7 +178,7 @@ private File archiveProjectDir() throws IOException {
     private File writeInfoFile(String localInfoPath) throws IOException {
         File infoFile = new File(localInfoPath);
         ObjectMapper mapper = new ObjectMapper();
-        Map<String, String> infoMap = new HashMap();
+        Map<String, String> infoMap = new HashMap<>();
         Date date = new Date();
         Instant instant = date.toInstant();
 

build-info-extractor-go/src/main/java/org/jfrog/build/extractor/go/extractor/GoRun.java

@@ -109,7 +109,7 @@ public BuildInfo execute() {
                 preparePrerequisites(resolutionRepository, artifactoryClient);
                 setResolverAsGoProxy(artifactoryClient);
             }
-            // We create the GoDriver here as env might had changed.
+            // We create the GoDriver here as env might have changed.
             this.goDriver = new GoDriver(GO_CLIENT_CMD, env, path.toFile(), logger);
             // First try to run 'go version' to make sure go is in PATH, and write the output to logger.
             goDriver.version(true);
@@ -124,7 +124,7 @@ public BuildInfo execute() {
 
     /**
      * In order to use Artifactory as a resolver we need to set GOPROXY env var with Artifactory details.
-     * Wa also support fallback to VCS in case pkg doesn't exist in Artifactort,
+     * Wa also support fallback to VCS in case pkg doesn't exist in Artifactory,
      */
     private void setResolverAsGoProxy(ArtifactoryManager artifactoryClient) throws Exception {
         String rtUrl = PackageManagerUtils.createArtifactoryUrlWithCredentials(artifactoryClient.getUrl(), resolverUsername, resolverPassword, ARTIFACTORY_GO_API + resolutionRepository);

build-info-extractor-go/src/main/java/org/jfrog/build/extractor/go/extractor/GoVersionUtils.java

@@ -94,7 +94,7 @@ public static boolean isCompatibleGoModuleNaming(String projectName, String vers
     }
 
     /**
-     * @return Sub module name in github projects
+     * @return Sub module name in GitHub projects
      */
     public static String getSubModule(String projectName) {
         if (StringUtils.isBlank(projectName)) {

build-info-extractor-go/src/test/java/org/jfrog/build/extractor/go/GoDriverTest.java

@@ -17,6 +17,7 @@
 import java.util.stream.Collectors;
 
 import static org.testng.Assert.assertEquals;
+import static org.testng.Assert.assertTrue;
 
 /**
  * @author yahavi
@@ -89,4 +90,28 @@ public void testTidyListUsedModulesErroneous() throws IOException {
             FileUtils.deleteDirectory(projectDir);
         }
     }
+
+    /**
+     * Test "go get".
+     *
+     * @throws IOException in case of any I/O exception.
+     */
+    @Test
+    public void testGoGet() throws IOException {
+        File projectDir = Files.createTempDirectory("").toFile();
+        try {
+            FileUtils.copyDirectory(PROJECT_1.toFile(), projectDir);
+            GoDriver driver = new GoDriver(null, System.getenv(), projectDir, new NullLog());
+            driver.modTidy(false, true);
+            // Get dependency and expect it later on go modules list
+            driver.get("rsc.io/sampler@v1.3.1", false);
+
+            // Run "go list -f {{with .Module}}{{.Path}} {{.Version}}{{end}} all"
+            CommandResults results = driver.getUsedModules(false, false, false);
+            Set<String> actualUsedModules = Arrays.stream(results.getRes().split("\\r?\\n")).map(String::trim).collect(Collectors.toSet());
+            assertTrue(actualUsedModules.contains("rsc.io/sampler v1.3.1"));
+        } finally {
+            FileUtils.deleteDirectory(projectDir);
+        }
+    }
 }

build-info-extractor-gradle/src/test/java/org/jfrog/gradle/plugin/artifactory/Utils.java

@@ -112,7 +112,7 @@ static void generateBuildInfoProperties(String contextUrl, String username, Stri
      * @throws IOException - In case of any IO error
      */
     private static String generateBuildInfoPropertiesForServer(String contextUrl, String username, String password, String localRepo, String virtualRepo, String publications, boolean publishBuildInfo, Path source) throws IOException {
-        String content = new String(Files.readAllBytes(source), StandardCharsets.UTF_8);
+        String content = new String(Files.readAllBytes(source), StandardCharsets.UTF_8.name());
         Map<String, String> valuesMap = new HashMap<String, String>() {{
             put("publications", publications);
             put("contextUrl", contextUrl);

build-info-extractor-pip/src/test/java/org/jfrog/build/extractor/pip/extractor/PipLogParserTest.java

@@ -40,7 +40,7 @@ public void pipLogParserTest() throws IOException {
         // Read pip log.
         InputStream pipLogStream = this.getClass().getResourceAsStream("/pipLogParser/pipLog.txt");
         try {
-            String pipLog = IOUtils.toString(pipLogStream, StandardCharsets.UTF_8);
+            String pipLog = IOUtils.toString(pipLogStream, StandardCharsets.UTF_8.name());
             // Parse.
             Map<String, String> actualMap = PipLogParser.parse(pipLog, log);
             // Validate.

build-info-extractor/src/testFixtures/java/org/jfrog/build/IntegrationTestsBase.java

@@ -158,7 +158,7 @@ protected void createTestRepo(String repoKey) throws IOException {
             if (repoConfigInputStream == null) {
                 throw new IOException("Couldn't find repository settings in " + path);
             }
-            String json = IOUtils.toString(repoConfigInputStream, StandardCharsets.UTF_8);
+            String json = IOUtils.toString(repoConfigInputStream, StandardCharsets.UTF_8.name());
             artifactoryManager.createRepository(repoKey, stringSubstitutor.replace(json));
         }
     }