Transfer config - Precheck for Docker repo names

artifactory/commands/transferconfig/transferconfig.go

@@ -14,6 +14,7 @@ import (
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/generic"
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/transferconfig/configxmlutils"
 	commandsUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils/precheckrunner"
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
 	"github.com/jfrog/jfrog-cli-core/v2/common/commands"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
@@ -212,7 +213,7 @@ func (tcc *TransferConfigCommand) runPreChecks() error {
 		return err
 	}
 
-	return tcc.NewPreChecksRunner(remoteRepositories).Run(context.Background(), tcc.TargetServerDetails)
+	return tcc.NewPreChecksRunner(selectedRepos, remoteRepositories).Run(context.Background(), tcc.TargetServerDetails)
 }
 
 func (tcc *TransferConfigCommand) printWarnings() (err error) {
@@ -296,16 +297,17 @@ func (tcc *TransferConfigCommand) verifyConfigImportPlugin() error {
 }
 
 // Creates the Pre-checks runner for the config import command
-func (tcc *TransferConfigCommand) NewPreChecksRunner(remoteRepositories []interface{}) (runner *commandsUtils.PreCheckRunner) {
-	runner = commandsUtils.NewPreChecksRunner()
+func (tcc *TransferConfigCommand) NewPreChecksRunner(selectedRepos map[utils.RepoType][]services.RepositoryDetails, remoteRepositories []interface{}) (runner *precheckrunner.PreCheckRunner) {
+	runner = precheckrunner.NewPreChecksRunner()
 
 	// Add pre-checks here
-	runner.AddCheck(commandsUtils.NewRemoteRepositoryCheck(&tcc.TargetArtifactoryManager, remoteRepositories))
+	runner.AddCheck(precheckrunner.NewRepositoryNamingCheck(selectedRepos))
+	runner.AddCheck(precheckrunner.NewRemoteRepositoryCheck(&tcc.TargetArtifactoryManager, remoteRepositories))
 
 	return
 }
 
-func (tcc *TransferConfigCommand) getEncryptedItems(selectedSourceRepos map[utils.RepoType][]string) (configXml string, remoteRepositories []interface{}, err error) {
+func (tcc *TransferConfigCommand) getEncryptedItems(selectedSourceRepos map[utils.RepoType][]services.RepositoryDetails) (configXml string, remoteRepositories []interface{}, err error) {
 	reactivateKeyEncryption, err := tcc.DeactivateKeyEncryption()
 	if err != nil {
 		return "", nil, err
@@ -324,10 +326,10 @@ func (tcc *TransferConfigCommand) getEncryptedItems(selectedSourceRepos map[util
 	}
 
 	// Get all remote repositories from the source Artifactory server.
-	if remoteRepositoryNames, ok := selectedSourceRepos[utils.Remote]; ok && len(remoteRepositoryNames) > 0 {
-		remoteRepositories = make([]interface{}, len(remoteRepositoryNames))
-		for i, repoName := range remoteRepositoryNames {
-			if err = tcc.SourceArtifactoryManager.GetRepository(repoName, &remoteRepositories[i]); err != nil {
+	if remoteRepositoriesDetails, ok := selectedSourceRepos[utils.Remote]; ok && len(remoteRepositoriesDetails) > 0 {
+		remoteRepositories = make([]interface{}, len(remoteRepositoriesDetails))
+		for i, remoteRepositoryDetails := range remoteRepositoriesDetails {
+			if err = tcc.SourceArtifactoryManager.GetRepository(remoteRepositoryDetails.Key, &remoteRepositories[i]); err != nil {
 				return
 			}
 		}

artifactory/commands/transferconfig/transferconfig_test.go

@@ -95,7 +95,7 @@ func TestGetConfigXml(t *testing.T) {
 
 	// Test get config xml
 	transferConfigCmd := createTransferConfigCommand(t, serverDetails, nil)
-	configXml, _, err := transferConfigCmd.getEncryptedItems(make(map[utils.RepoType][]string))
+	configXml, _, err := transferConfigCmd.getEncryptedItems(make(map[utils.RepoType][]services.RepositoryDetails))
 	assert.NoError(t, err)
 	assert.Equal(t, "<config></config>", configXml)
 }

artifactory/commands/transferconfigmerge/transferconfigmerge.go

@@ -53,7 +53,7 @@ func (tcmc *TransferConfigMergeCommand) SetExcludeProjectsPatterns(excludeProjec
 
 type mergeEntities struct {
 	projectsToTransfer []accessServices.Project
-	reposToTransfer    map[utils.RepoType][]string
+	reposToTransfer    map[utils.RepoType][]services.RepositoryDetails
 }
 
 type Conflict struct {
@@ -243,8 +243,8 @@ func compareProjects(sourceProject, targetProject accessServices.Project) (*Conf
 	}, nil
 }
 
-func (tcmc *TransferConfigMergeCommand) mergeRepositories(conflicts *[]Conflict) (reposToTransfer map[utils.RepoType][]string, err error) {
-	reposToTransfer = make(map[utils.RepoType][]string)
+func (tcmc *TransferConfigMergeCommand) mergeRepositories(conflicts *[]Conflict) (reposToTransfer map[utils.RepoType][]services.RepositoryDetails, err error) {
+	reposToTransfer = make(map[utils.RepoType][]services.RepositoryDetails)
 	sourceRepos, err := tcmc.SourceArtifactoryManager.GetAllRepositories()
 	if err != nil {
 		return
@@ -286,7 +286,7 @@ func (tcmc *TransferConfigMergeCommand) mergeRepositories(conflicts *[]Conflict)
 			}
 		} else {
 			repoType := utils.RepoTypeFromString(sourceRepo.Type)
-			reposToTransfer[repoType] = append(reposToTransfer[repoType], sourceRepo.Key)
+			reposToTransfer[repoType] = append(reposToTransfer[repoType], sourceRepo)
 		}
 	}
 	return
@@ -351,7 +351,7 @@ func (tcmc *TransferConfigMergeCommand) transferProjectsToTarget(reposToTransfer
 	return
 }
 
-func (tcmc *TransferConfigMergeCommand) decryptAndGetAllRemoteRepositories(remoteRepositoryNames []string) (remoteRepositories []interface{}, err error) {
+func (tcmc *TransferConfigMergeCommand) decryptAndGetAllRemoteRepositories(remoteRepositoriesDetails []services.RepositoryDetails) (remoteRepositories []interface{}, err error) {
 	// Decrypt source Artifactory to get remote repositories with raw text passwords
 	reactivateKeyEncryption, err := tcmc.DeactivateKeyEncryption()
 	if err != nil {
@@ -362,7 +362,11 @@ func (tcmc *TransferConfigMergeCommand) decryptAndGetAllRemoteRepositories(remot
 			err = reactivationErr
 		}
 	}()
-	return tcmc.GetAllRemoteRepositories(remoteRepositoryNames)
+	var remoteRepositoryKeys []string
+	for _, remoteRepositoryDetails := range remoteRepositoriesDetails {
+		remoteRepositoryKeys = append(remoteRepositoryKeys, remoteRepositoryDetails.Key)
+	}
+	return tcmc.GetAllRemoteRepositories(remoteRepositoryKeys)
 }
 
 type projectsMapper struct {

artifactory/commands/transferfiles/longpropertycheck.go

@@ -9,6 +9,7 @@ import (
 	"github.com/jfrog/gofrog/parallel"
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/transferfiles/api"
 	cmdutils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils/precheckrunner"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/progressbar"
 	"github.com/jfrog/jfrog-client-go/artifactory"
@@ -67,7 +68,7 @@ func (lpc *LongPropertyCheck) Name() string {
 	return longPropertyCheckName
 }
 
-func (lpc *LongPropertyCheck) ExecuteCheck(args cmdutils.RunArguments) (passed bool, err error) {
+func (lpc *LongPropertyCheck) ExecuteCheck(args precheckrunner.RunArguments) (passed bool, err error) {
 	// Init producer consumer
 	lpc.producerConsumer = parallel.NewRunner(threadCount, maxThreadCapacity, false)
 	lpc.filesChan = make(chan FileWithLongProperty, threadCount)
@@ -111,7 +112,7 @@ func (lpc *LongPropertyCheck) ExecuteCheck(args cmdutils.RunArguments) (passed b
 
 // Search for long properties in the server and create a search task to find the files that contains them
 // Returns the number of long properties found
-func (lpc *LongPropertyCheck) longPropertiesTaskProducer(progress *progressbar.TasksProgressBar, args cmdutils.RunArguments) int {
+func (lpc *LongPropertyCheck) longPropertiesTaskProducer(progress *progressbar.TasksProgressBar, args precheckrunner.RunArguments) int {
 	// Init
 	serviceManager, err := createTransferServiceManager(args.Context, args.ServerDetails)
 	if err != nil {
@@ -173,7 +174,7 @@ func getSearchAllPropertiesQuery(pageNumber int) string {
 
 // Create a task that fetch from the server the files with the given property.
 // We keep only the files that are at the requested repos and pass them at the files channel
-func createSearchPropertyTask(property Property, repos []string, args cmdutils.RunArguments, filesChan chan FileWithLongProperty, progress *progressbar.TasksProgressBar) parallel.TaskFunc {
+func createSearchPropertyTask(property Property, repos []string, args precheckrunner.RunArguments, filesChan chan FileWithLongProperty, progress *progressbar.TasksProgressBar) parallel.TaskFunc {
 	return func(threadId int) (err error) {
 		serviceManager, err := createTransferServiceManager(args.Context, args.ServerDetails)
 		if err != nil {

artifactory/commands/transferfiles/longpropertycheck_test.go

@@ -2,21 +2,22 @@ package transferfiles
 
 import (
 	"encoding/json"
+	"io"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"sync"
+	"testing"
+
 	"github.com/jfrog/gofrog/parallel"
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/transferfiles/api"
-	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils/precheckrunner"
 	commonTests "github.com/jfrog/jfrog-cli-core/v2/common/tests"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
 	"github.com/jfrog/jfrog-client-go/artifactory"
 	servicesUtils "github.com/jfrog/jfrog-client-go/artifactory/services/utils"
 	clientutils "github.com/jfrog/jfrog-client-go/utils"
 	"github.com/stretchr/testify/assert"
-	"io"
-	"net/http"
-	"net/http/httptest"
-	"strings"
-	"sync"
-	"testing"
 )
 
 var (
@@ -82,7 +83,7 @@ func testGetLongProperties(t *testing.T, serverProperties, expectedLongPropertie
 	longPropertyCheck := NewLongPropertyCheck([]string{})
 	longPropertyCheck.filesChan = make(chan FileWithLongProperty, threadCount)
 
-	count := longPropertyCheck.longPropertiesTaskProducer(nil, utils.RunArguments{Context: nil, ServerDetails: serverDetails})
+	count := longPropertyCheck.longPropertiesTaskProducer(nil, precheckrunner.RunArguments{Context: nil, ServerDetails: serverDetails})
 	assert.Len(t, expectedLongProperties, count)
 }
 
@@ -119,7 +120,7 @@ func testSearchPropertyInFilesTask(t *testing.T, prop Property, specificRepos []
 		wait.Done()
 	}()
 
-	task := createSearchPropertyTask(prop, specificRepos, utils.RunArguments{Context: nil, ServerDetails: serverDetails}, filesChan, nil)
+	task := createSearchPropertyTask(prop, specificRepos, precheckrunner.RunArguments{Context: nil, ServerDetails: serverDetails}, filesChan, nil)
 	assert.NoError(t, task(0))
 	close(filesChan)
 	wait.Wait()
@@ -170,7 +171,7 @@ func testSearchPropertiesInFiles(t *testing.T, properties []Property, specificRe
 		waitCollection.Done()
 	}()
 
-	longPropertyCheck.longPropertiesTaskProducer(nil, utils.RunArguments{Context: nil, ServerDetails: serverDetails})
+	longPropertyCheck.longPropertiesTaskProducer(nil, precheckrunner.RunArguments{Context: nil, ServerDetails: serverDetails})
 	longPropertyCheck.producerConsumer.Done()
 	longPropertyCheck.producerConsumer.Run()
 	close(longPropertyCheck.filesChan)
@@ -201,7 +202,7 @@ func testLongPropertyCheckWithStubServer(t *testing.T, serverProperties []Proper
 	defer testServer.Close()
 
 	longPropertyCheck := NewLongPropertyCheck(specificRepos)
-	passed, err := longPropertyCheck.ExecuteCheck(utils.RunArguments{Context: nil, ServerDetails: serverDetails})
+	passed, err := longPropertyCheck.ExecuteCheck(precheckrunner.RunArguments{Context: nil, ServerDetails: serverDetails})
 	assert.NoError(t, err)
 	assert.Equal(t, shouldPass, passed)
 }

artifactory/commands/transferfiles/transfer.go

@@ -13,7 +13,7 @@ import (
 	"time"
 
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/transferfiles/state"
-	commandsUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils/precheckrunner"
 	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
@@ -292,7 +292,7 @@ func (tdc *TransferFilesCommand) initStorageInfoManagers() error {
 }
 
 // Creates the Pre-checks runner for the data transfer command
-func (tdc *TransferFilesCommand) NewTransferDataPreChecksRunner() (runner *commandsUtils.PreCheckRunner, err error) {
+func (tdc *TransferFilesCommand) NewTransferDataPreChecksRunner() (runner *precheckrunner.PreCheckRunner, err error) {
 	// Get relevant repos
 	serviceManager, err := createTransferServiceManager(tdc.context, tdc.sourceServerDetails)
 	if err != nil {
@@ -307,7 +307,7 @@ func (tdc *TransferFilesCommand) NewTransferDataPreChecksRunner() (runner *comma
 		return
 	}
 
-	runner = commandsUtils.NewPreChecksRunner()
+	runner = precheckrunner.NewPreChecksRunner()
 
 	// Add pre checks here
 	runner.AddCheck(NewLongPropertyCheck(append(localRepos, federatedRepos...)))

artifactory/commands/utils/checkrunner.go → artifactory/commands/utils/precheckrunner/checkrunner.go

@@ -1,4 +1,4 @@
-package utils
+package precheckrunner
 
 import (
 	"context"

artifactory/commands/utils/checkrunner_test.go → artifactory/commands/utils/precheckrunner/checkrunner_test.go

@@ -1,4 +1,4 @@
-package utils
+package precheckrunner
 
 import (
 	"context"

artifactory/commands/utils/remoteurlchecker.go → artifactory/commands/utils/precheckrunner/remoteurlchecker.go

@@ -1,11 +1,12 @@
-package utils
+package precheckrunner
 
 import (
 	"encoding/json"
 	"fmt"
 	"net/http"
 	"time"
 
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
 	"github.com/jfrog/jfrog-cli-core/v2/utils/progressbar"
 	"github.com/jfrog/jfrog-client-go/artifactory"
@@ -114,7 +115,7 @@ func (rrc *RemoteRepositoryCheck) doCheckRemoteRepositories(args RunArguments, r
 	}
 
 	// Create rtDetails
-	rtDetails, err := CreateArtifactoryClientDetails(*rrc.targetServicesManager)
+	rtDetails, err := utils.CreateArtifactoryClientDetails(*rrc.targetServicesManager)
 	if err != nil {
 		return nil, err
 	}
@@ -145,7 +146,7 @@ func (rrc *RemoteRepositoryCheck) startCheckRemoteRepositories(rtDetails *httput
 		LogMsgPrefix:             "[Config import]",
 		ExecutionHandler: func() (shouldRetry bool, err error) {
 			// Start the remote repositories check process
-			resp, responseBody, err := (*rrc.targetServicesManager).Client().SendPost(artifactoryUrl+PluginsExecuteRestApi+"remoteRepositoriesCheck", requestBody, rtDetails)
+			resp, responseBody, err := (*rrc.targetServicesManager).Client().SendPost(artifactoryUrl+utils.PluginsExecuteRestApi+"remoteRepositoriesCheck", requestBody, rtDetails)
 			if err != nil {
 				return false, err
 			}
@@ -190,7 +191,7 @@ func (rrc *RemoteRepositoryCheck) waitForRemoteReposCheckCompletion(rtDetails *h
 func (rrc *RemoteRepositoryCheck) createImportPollingAction(rtDetails *httputils.HttpClientDetails, artifactoryUrl string, progressBar *progressbar.TasksProgressBar) httputils.PollingAction {
 	return func() (shouldStop bool, responseBody []byte, err error) {
 		// Get config import status
-		resp, body, _, err := (*rrc.targetServicesManager).Client().SendGet(artifactoryUrl+PluginsExecuteRestApi+"remoteRepositoriesCheckStatus", true, rtDetails)
+		resp, body, _, err := (*rrc.targetServicesManager).Client().SendGet(artifactoryUrl+utils.PluginsExecuteRestApi+"remoteRepositoriesCheckStatus", true, rtDetails)
 		if err != nil {
 			return true, nil, err
 		}
@@ -227,7 +228,7 @@ func unmarshalRemoteUrlResponse(body []byte) (*remoteUrlResponse, error) {
 // Create csv summary of all the files with inaccessible remote repositories and log the result
 func handleFailureRun(inaccessibleRepositories []inaccessibleRepository) (err error) {
 	// Create summary
-	csvPath, err := CreateCSVFile("inaccessible-repositories", inaccessibleRepositories, time.Now())
+	csvPath, err := utils.CreateCSVFile("inaccessible-repositories", inaccessibleRepositories, time.Now())
 	if err != nil {
 		log.Error("Couldn't create the inaccessible remote repository URLs CSV file", err)
 		return

artifactory/commands/utils/remoteurlchecker_test.go → artifactory/commands/utils/precheckrunner/remoteurlchecker_test.go

@@ -1,4 +1,4 @@
-package utils
+package precheckrunner
 
 import (
 	"encoding/json"

artifactory/commands/utils/precheckrunner/repositorynamingchecker.go

@@ -0,0 +1,74 @@
+package precheckrunner
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	commandUtils "github.com/jfrog/jfrog-cli-core/v2/artifactory/commands/utils"
+
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
+	"github.com/jfrog/jfrog-client-go/artifactory/services"
+	"github.com/jfrog/jfrog-client-go/utils/log"
+)
+
+const (
+	repositoryNamingCheckName        = "Repositories naming"
+	illegalDockerRepositoryKeyReason = "Docker repository keys in the SasS are not allowed to include '.' or '_' characters."
+)
+
+type illegalRepositoryKeys struct {
+	RepoKey string `json:"repo_key,omitempty"`
+	Reason  string `json:"reason,omitempty"`
+}
+
+// Run repository naming check before transferring configuration from one Artifactory to another
+type RepositoryNamingCheck struct {
+	selectedRepos map[utils.RepoType][]services.RepositoryDetails
+}
+
+func NewRepositoryNamingCheck(selectedRepos map[utils.RepoType][]services.RepositoryDetails) *RepositoryNamingCheck {
+	return &RepositoryNamingCheck{selectedRepos}
+}
+
+func (drc *RepositoryNamingCheck) Name() string {
+	return repositoryNamingCheckName
+}
+
+func (drc *RepositoryNamingCheck) ExecuteCheck(args RunArguments) (passed bool, err error) {
+	results := drc.getIllegalRepositoryKeys()
+	if len(results) == 0 {
+		return true, nil
+	}
+
+	return false, handleFailuresInRepositoryKeysRun(results)
+}
+
+func (drc *RepositoryNamingCheck) getIllegalRepositoryKeys() []illegalRepositoryKeys {
+	var results []illegalRepositoryKeys
+	for _, repositoriesOfType := range drc.selectedRepos {
+		for _, repository := range repositoriesOfType {
+			if strings.ToLower(repository.PackageType) == "docker" && strings.ContainsAny(repository.Key, "_.") {
+				log.Debug("Found Docker repository with illegal characters:", repository.Key)
+				results = append(results, illegalRepositoryKeys{
+					RepoKey: repository.Key,
+					Reason:  illegalDockerRepositoryKeyReason,
+				})
+			}
+		}
+	}
+	return results
+}
+
+// Create CSV summary of all the files with illegal repository keys and log the result
+func handleFailuresInRepositoryKeysRun(illegalDockerRepositoryKeys []illegalRepositoryKeys) (err error) {
+	// Create summary
+	csvPath, err := commandUtils.CreateCSVFile("illegal-repository-keys", illegalDockerRepositoryKeys, time.Now())
+	if err != nil {
+		log.Error("Couldn't create the illegal repository keys CSV file", err)
+		return
+	}
+	// Log result
+	log.Info(fmt.Sprintf("Found %d illegal repository keys. Check the summary CSV file in: %s", len(illegalDockerRepositoryKeys), csvPath))
+	return
+}