V1 fix gradle plugin (#209)

Author: gailazar300

artifactory/commands/gradle/gradle.go

@@ -81,11 +81,7 @@ func (gc *GradleCommand) Run() error {
 }
 
 func (gc *GradleCommand) unmarshalDeployableArtifacts(filesPath string) error {
-	serverDetails, err := gc.ServerDetails()
-	if err != nil {
-		return err
-	}
-	result, err := commandsutils.UnmarshalDeployableArtifacts(filesPath, serverDetails.ArtifactoryUrl)
+	result, err := commandsutils.UnmarshalDeployableArtifacts(filesPath, gc.configPath)
 	if err != nil {
 		return err
 	}

artifactory/commands/mvn/mvn.go

@@ -255,11 +255,7 @@ func (mc *MvnCommand) createMvnRunConfig(dependenciesPath string) (*mvnRunConfig
 }
 
 func (mc *MvnCommand) unmarshalDeployableArtifacts(filesPath string) error {
-	serverDetails, err := mc.ServerDetails()
-	if err != nil {
-		return err
-	}
-	result, err := commandsutils.UnmarshalDeployableArtifacts(filesPath, serverDetails.ArtifactoryUrl)
+	result, err := commandsutils.UnmarshalDeployableArtifacts(filesPath, mc.configPath)
 	if err != nil {
 		return err
 	}

artifactory/commands/testdata/gradle/config/gradle.yaml

@@ -0,0 +1,11 @@
+version: 1
+type: gradle
+resolver:
+  repo: libs-release
+  serverId: test
+deployer:
+  repo: gradle-local-repo
+  serverId: test
+  ivyPattern: '[organization]/[module]/ivy-[revision].xml'
+  artifactPattern: '[organization]/[module]/[revision]/[artifact]-[revision](-[classifier]).[ext]'
+usePlugin: true

artifactory/commands/testdata/gradle/deployableArtifacts/artifacts

@@ -0,0 +1 @@
+{"shared":[{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/shared/build/libs/shared-1.0-SNAPSHOT.jar","artifactDest":"org/jfrog/test/gradle/publish/shared/1.0-SNAPSHOT/shared-1.0-SNAPSHOT.jar","sha1":"e471721512461342a0cb230726474c54a3089275","sha256":"3664fa68f0e5ef2c01ccc41715108f8380e336d0cfc82367750f035ec9a494ba","deploySucceeded":true},{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/gradle.properties","artifactDest":"org/jfrog/test/gradle/publish/shared/1.0-SNAPSHOT/shared-1.0-SNAPSHOT.properties","sha1":"06fdab8aa5df49b45b1771cf6ec56d379090a7ba","sha256":"ab17a74ebcbd624ccd245378126bef1fd30ed8d392e3fa2ad3088f7fa8bc4de9","deploySucceeded":true}],"webservice":[{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/services/webservice/build/libs/webservice-1.0-SNAPSHOT.jar","artifactDest":"org/jfrog/test/gradle/publish/webservice/1.0-SNAPSHOT/webservice-1.0-SNAPSHOT.jar","sha1":"73613a903ad45ed335f28aad3a725226a71cd969","sha256":"f8107aa11da0d043e4b5a86827c8ba6945b596486a8c1dbe602e96b6ecb624ad","deploySucceeded":true},{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/gradle.properties","artifactDest":"org/jfrog/test/gradle/publish/webservice/1.0-SNAPSHOT/webservice-1.0-SNAPSHOT.properties","sha1":"06fdab8aa5df49b45b1771cf6ec56d379090a7ba","sha256":"ab17a74ebcbd624ccd245378126bef1fd30ed8d392e3fa2ad3088f7fa8bc4de9","deploySucceeded":true}],"api":[{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/api/build/libs/api-1.0-SNAPSHOT.jar","artifactDest":"org/jfrog/test/gradle/publish/api/1.0-SNAPSHOT/api-1.0-SNAPSHOT.jar","sha1":"0a57f71bbb170f8a1abf8ca48e4d66583ed6c212","sha256":"4e4144738752d89d5f44dc1e1dbadb1a86d07423ff95ed68d993d3d9ee551878","deploySucceeded":true},{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/gradle.properties","artifactDest":"org/jfrog/test/gradle/publish/api/1.0-SNAPSHOT/api-1.0-SNAPSHOT.properties","sha1":"06fdab8aa5df49b45b1771cf6ec56d379090a7ba","sha256":"ab17a74ebcbd624ccd245378126bef1fd30ed8d392e3fa2ad3088f7fa8bc4de9","deploySucceeded":true},{"sourcePath":"/Users/gail/dev/project-examples-master/gradle-examples/gradle-example-publish/settings.gradle","artifactDest":"org/jfrog/test/gradle/publish/api/1.0-SNAPSHOT/gradle-settings-1.0-SNAPSHOT.txt","sha1":"30788efb365346a1bcabfa8b2041cd875fdad213","sha256":"fb08055200862980c6e80a7d862ec306bf4549fcff87f132ab824f38c8a5205c","deploySucceeded":true}]}

artifactory/commands/utils/result.go

@@ -2,6 +2,8 @@ package utils
 
 import (
 	"encoding/json"
+	"github.com/jfrog/jfrog-cli-core/artifactory/utils"
+	"github.com/jfrog/jfrog-cli-core/utils/config"
 	"io/ioutil"
 	"os"
 
@@ -10,6 +12,12 @@ import (
 	"github.com/jfrog/jfrog-client-go/utils/io/content"
 )
 
+const (
+	configDeployerPrefix = "deployer"
+	gradleConfigRepo     = "repo"
+	configServerId       = "serverid"
+)
+
 type Result struct {
 	successCount int
 	failCount    int
@@ -40,10 +48,16 @@ func (r *Result) SetReader(reader *content.ContentReader) {
 	r.reader = reader
 }
 
-// UnmarshalDeployableArtifacts Reads and parses the deployed artifacts details from the provided file.
+// UnmarshalDeployableArtifacts reads and parses the deployed artifacts details from the provided file.
 // The details were written by Buildinfo project while deploying artifacts to maven and gradle repositories.
-func UnmarshalDeployableArtifacts(filePath, rtUrl string) (*Result, error) {
-	modulesMap, err := unmarshalDeployableArtifactsJson(filePath)
+// deployableArtifactsFilePath - path to deployableArtifacts file written by buildinfo project.
+// ProjectConfigPath - path to gradle/maven config yaml path.
+func UnmarshalDeployableArtifacts(deployableArtifactsFilePath, ProjectConfigPath string) (*Result, error) {
+	modulesMap, err := unmarshalDeployableArtifactsJson(deployableArtifactsFilePath)
+	if err != nil {
+		return nil, err
+	}
+	url, repo, err := getDeployerUrlAndRepo(modulesMap, ProjectConfigPath)
 	if err != nil {
 		return nil, err
 	}
@@ -54,21 +68,55 @@ func UnmarshalDeployableArtifacts(filePath, rtUrl string) (*Result, error) {
 		for _, artifact := range module {
 			if artifact.DeploySucceeded {
 				succeeded++
-				artifactsArray = append(artifactsArray, artifact.CreateFileTransferDetails(rtUrl))
+				artifactsArray = append(artifactsArray, artifact.CreateFileTransferDetails(url, repo))
 			} else {
 				failed++
 			}
 		}
 	}
-	err = clientutils.SaveFileTransferDetailsInFile(filePath, &artifactsArray)
+	err = clientutils.SaveFileTransferDetailsInFile(deployableArtifactsFilePath, &artifactsArray)
 	// Return result
 	result := new(Result)
 	result.SetSuccessCount(succeeded)
 	result.SetFailCount(failed)
-	result.SetReader(content.NewContentReader(filePath, "files"))
+	result.SetReader(content.NewContentReader(deployableArtifactsFilePath, "files"))
 	return result, nil
 }
 
+// getDeployerUrlAndRepo returns the deployer url and the target repository for maven and gradle.
+// Url is being read from the project's local configuration file.
+// Repository is being read from the modulesMap.
+// modulesMap - map of the DeployableArtifactDetails.
+// configPath -  path to the project's local configuration file.
+func getDeployerUrlAndRepo(modulesMap *map[string][]clientutils.DeployableArtifactDetails, configPath string) (string, string, error) {
+	repo := getTargetRepoFromMap(modulesMap)
+	vConfig, err := utils.ReadConfigFile(configPath, utils.YAML)
+	if err != nil {
+		return "", "", err
+	}
+	// The relevant deployment repository will be written by the buildinfo project to the diplyableArtifacts file starting from version 2.24.12 of build-info-extractor-gradle.
+	// In case of a gradle project with a configuration of 'usePlugin=true' it's possible that an old build-info-extractor-gradle version is being used.
+	// In this case, the value of "repo" will be empty, and the deployment repository will be therefore read from the local project configuration file.
+	if repo == "" {
+		repo = vConfig.GetString(configDeployerPrefix + "." + gradleConfigRepo)
+	}
+	artDetails, err := config.GetSpecificConfig(vConfig.GetString(configDeployerPrefix+"."+configServerId), true, true)
+	if err != nil {
+		return "", "", err
+	}
+	url := artDetails.ArtifactoryUrl
+	return url, repo, nil
+}
+
+func getTargetRepoFromMap(modulesMap *map[string][]clientutils.DeployableArtifactDetails) string {
+	for _, module := range *modulesMap {
+		for _, artifact := range module {
+			return artifact.TargetRepository
+		}
+	}
+	return ""
+}
+
 func unmarshalDeployableArtifactsJson(filesPath string) (*map[string][]clientutils.DeployableArtifactDetails, error) {
 	// Open the file
 	jsonFile, err := os.Open(filesPath)

artifactory/commands/utils/result_test.go

@@ -0,0 +1,60 @@
+package utils
+
+import (
+	"github.com/jfrog/jfrog-cli-core/common/tests"
+	clientutils "github.com/jfrog/jfrog-client-go/utils"
+	"github.com/jfrog/jfrog-client-go/utils/errorutils"
+	"github.com/jfrog/jfrog-client-go/utils/io/fileutils"
+	"github.com/stretchr/testify/assert"
+	"os"
+	"path"
+	"path/filepath"
+	"strings"
+	"testing"
+)
+
+// Checks a case that targetRepository is not written in a deployableArtifacts file and needs to be read from the config file.
+func TestUnmarshalDeployableArtifacts(t *testing.T) {
+	err, cleanUpJfrogHome := tests.ConfigTestServer(t)
+	assert.NoError(t, err)
+	defer cleanUpJfrogHome()
+	// DeployableArtifact file is changed at runtime so a copy needs to be created.
+	tempDeployableArtifacts, err := createTempDeployableArtifactFile()
+	// Delete DeployableArtifacts tempDir
+	defer os.Remove(filepath.Dir(tempDeployableArtifacts))
+	gradleConfigFile := path.Join(getTestsDataGradlePath(), "config", "gradle.yaml")
+	result, err := UnmarshalDeployableArtifacts(tempDeployableArtifacts, gradleConfigFile)
+	assert.NoError(t, err)
+	for transferDetails := new(clientutils.FileTransferDetails); result.reader.NextRecord(transferDetails) == nil; transferDetails = new(clientutils.FileTransferDetails) {
+		assert.True(t, strings.HasPrefix(transferDetails.TargetPath, "http://localhost:8080/artifactory/"))
+		assert.True(t, strings.Contains(transferDetails.TargetPath, "gradle-local-repo"))
+	}
+}
+
+// createTempDeployableArtifactFile copies a deployableArtifacts file from gradle testdata directory to a tempDir
+func createTempDeployableArtifactFile() (filePath string, err error) {
+	filePath = ""
+	testsDataGradlePath := getTestsDataGradlePath()
+	summary, err := os.Open(path.Join(testsDataGradlePath, "deployableArtifacts", "artifacts"))
+	if err != nil {
+		err = errorutils.CheckError(err)
+		return
+	}
+	defer func() {
+		e := summary.Close()
+		if err == nil {
+			err = e
+		}
+	}()
+	tmpDir, err := fileutils.CreateTempDir()
+	if err != nil {
+		return
+	}
+	fileutils.CopyFile(tmpDir, summary.Name())
+	filePath = filepath.Join(tmpDir, "artifacts")
+	return
+}
+
+func getTestsDataGradlePath() string {
+	return path.Join("..", "testdata", "gradle")
+}

common/commands/config_test.go

@@ -2,6 +2,7 @@ package commands
 
 import (
 	"encoding/json"
+	"github.com/jfrog/jfrog-cli-core/common/tests"
 	"testing"
 
 	"github.com/jfrog/jfrog-cli-core/utils/config"
@@ -15,7 +16,7 @@ func init() {
 }
 
 func TestBasicAuth(t *testing.T) {
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.User = "admin"
 	inputDetails.Password = "password"
 
@@ -24,7 +25,7 @@ func TestBasicAuth(t *testing.T) {
 }
 
 func TestUsernameSavedLowercase(t *testing.T) {
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.User = "ADMIN"
 	inputDetails.Password = "password"
 
@@ -36,7 +37,7 @@ func TestUsernameSavedLowercase(t *testing.T) {
 func TestApiKey(t *testing.T) {
 	// API key is no longer allowed to be configured without providing a username.
 	// This test is here to make sure that old configurations (with API key and no username) are still accepted.
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.ApiKey = "apiKey"
 	configAndTest(t, inputDetails, false)
 
@@ -46,7 +47,7 @@ func TestApiKey(t *testing.T) {
 }
 
 func TestArtifactorySshKey(t *testing.T) {
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.SshKeyPath = "/tmp/sshKey"
 	inputDetails.SshPassphrase = "123456"
 	inputDetails.ArtifactoryUrl = "ssh://localhost:1339/"
@@ -56,7 +57,7 @@ func TestArtifactorySshKey(t *testing.T) {
 }
 
 func TestAccessToken(t *testing.T) {
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.AccessToken = "accessToken"
 
 	configAndTest(t, inputDetails, false)
@@ -65,7 +66,7 @@ func TestAccessToken(t *testing.T) {
 
 func TestRefreshToken(t *testing.T) {
 	// Import after tokens were generated.
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.User = "admin"
 	inputDetails.Password = "password"
 	inputDetails.AccessToken = "accessToken"
@@ -82,7 +83,7 @@ func TestRefreshToken(t *testing.T) {
 }
 
 func TestEmptyCredentials(t *testing.T) {
-	configAndTest(t, createTestServerDetails(), false)
+	configAndTest(t, tests.CreateTestServerDetails(), false)
 }
 
 func TestUrls(t *testing.T) {
@@ -123,7 +124,7 @@ func testUrls(t *testing.T, interactive bool) {
 }
 
 func TestBasicAuthOnlyOption(t *testing.T) {
-	inputDetails := createTestServerDetails()
+	inputDetails := tests.CreateTestServerDetails()
 	inputDetails.User = "admin"
 	inputDetails.Password = "password"
 
@@ -168,17 +169,3 @@ func configStructToString(artConfig *config.ServerDetails) string {
 	marshaledStruct, _ := json.Marshal(*artConfig)
 	return string(marshaledStruct)
 }
-
-func createTestServerDetails() *config.ServerDetails {
-	return &config.ServerDetails{
-		Url:               "http://localhost:8080",
-		ArtifactoryUrl:    "http://localhost:8080/artifactory",
-		DistributionUrl:   "http://localhost:8080/distribution",
-		XrayUrl:           "http://localhost:8080/xray",
-		MissionControlUrl: "http://localhost:8080/mc",
-		PipelinesUrl:      "http://localhost:8080/pipelines",
-		ServerId:          "test",
-		IsDefault:         false,
-		ClientCertPath:    "ClientCertPath", ClientCertKeyPath: "ClientCertKeyPath",
-	}
-}

common/tests/utils.go

@@ -0,0 +1,28 @@
+package tests
+
+import (
+	"github.com/jfrog/jfrog-cli-core/utils/config"
+	testsutils "github.com/jfrog/jfrog-cli-core/utils/config/tests"
+	"testing"
+)
+
+func ConfigTestServer(t *testing.T) (err error, cleanUp func()) {
+	cleanUp = testsutils.CreateTempEnv(t, false)
+	serverDetails := CreateTestServerDetails()
+	err = config.SaveServersConf([]*config.ServerDetails{serverDetails})
+	return
+}
+
+func CreateTestServerDetails() *config.ServerDetails {
+	return &config.ServerDetails{
+		Url:               "http://localhost:8080/",
+		ArtifactoryUrl:    "http://localhost:8080/artifactory/",
+		DistributionUrl:   "http://localhost:8080/distribution/",
+		XrayUrl:           "http://localhost:8080/xray/",
+		MissionControlUrl: "http://localhost:8080/mc/",
+		PipelinesUrl:      "http://localhost:8080/pipelines/",
+		ServerId:          "test",
+		IsDefault:         false,
+		ClientCertPath:    "ClientCertPath", ClientCertKeyPath: "ClientCertKeyPath",
+	}
+}

go.mod

@@ -21,6 +21,6 @@ require (
 	gopkg.in/yaml.v2 v2.3.0
 )
 
-replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.0.1-0.20210808220504-d4c272a91562
+replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.0.1-0.20210809143017-dd454849a8ba
 
 // replace github.com/jfrog/gocmd => github.com/jfrog/gocmd v0.3.1-0.20210623152326-422f211f4e7f

go.sum

@@ -151,8 +151,8 @@ github.com/jfrog/gocmd v0.3.1 h1:EyOot6llZaHlV9S6We6P0OrYA2pKO8Xifm3yXuUxriM=
 github.com/jfrog/gocmd v0.3.1/go.mod h1:spTHT8F2u0DtGdVq3v6frnSiqaKwPdNuMQd856MCHhw=
 github.com/jfrog/gofrog v1.0.6 h1:yUDxSCw8gTK6vC4PvtG0HTnEOQJSZ+O4lWGCgkev1nU=
 github.com/jfrog/gofrog v1.0.6/go.mod h1:HkDzg+tMNw23UryoOv0+LB94BzYcl6MCIoz8Tmlb+s8=
-github.com/jfrog/jfrog-client-go v1.0.1-0.20210808220504-d4c272a91562 h1:5ysqFe2L+MWuRsnGg+9cumjG+s+4IrA+s98mq/2+fOg=
-github.com/jfrog/jfrog-client-go v1.0.1-0.20210808220504-d4c272a91562/go.mod h1:dR0Z+zjSAoMWT5phrPIVjj+kjYYHHAEq1JnvA7klwvI=
+github.com/jfrog/jfrog-client-go v1.0.1-0.20210809143017-dd454849a8ba h1:k13h1j3mkbnIQiVjqWfrPYw7YAm51M0oPRtmo90y6Oo=
+github.com/jfrog/jfrog-client-go v1.0.1-0.20210809143017-dd454849a8ba/go.mod h1:dR0Z+zjSAoMWT5phrPIVjj+kjYYHHAEq1JnvA7klwvI=
 github.com/jonboulle/clockwork v0.1.0/go.mod h1:Ii8DK3G1RaLaWxj9trq07+26W01tbo22gdxWY5EU2bo=
 github.com/json-iterator/go v1.1.6/go.mod h1:+SdeFBvtyEkXs7REEP0seUULqWtbJapLOCVDaaPEHmU=
 github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU=