sap-jenkins-library/cmd/abapEnvironmentCloneGitRepo.go

package cmd

import (
	"time"

	"github.com/SAP/jenkins-library/pkg/abaputils"
	"github.com/SAP/jenkins-library/pkg/command"
	piperhttp "github.com/SAP/jenkins-library/pkg/http"
	"github.com/SAP/jenkins-library/pkg/log"
	"github.com/SAP/jenkins-library/pkg/piperutils"
	"github.com/SAP/jenkins-library/pkg/telemetry"
	"github.com/pkg/errors"
)

func abapEnvironmentCloneGitRepo(config abapEnvironmentCloneGitRepoOptions, _ *telemetry.CustomData) {

	c := command.Command{}

	c.Stdout(log.Writer())
	c.Stderr(log.Writer())

	var autils = abaputils.AbapUtils{
		Exec: &c,
	}

	apiManager := abaputils.SoftwareComponentApiManager{
		Client:        &piperhttp.Client{},
		PollIntervall: 5 * time.Second,
	}

	var reports []piperutils.Path
	logOutputManager := abaputils.LogOutputManager{
		LogOutput:    config.LogOutput,
		PiperStep:    "clone",
		FileNameStep: "clone",
		StepReports:  reports,
	}

	// error situations should stop execution through log.Entry().Fatal() call which leads to an os.Exit(1) in the end
	err := runAbapEnvironmentCloneGitRepo(&config, &autils, &apiManager, &logOutputManager)
	if err != nil {
		log.Entry().WithError(err).Fatal("step execution failed")
	}
}

func runAbapEnvironmentCloneGitRepo(config *abapEnvironmentCloneGitRepoOptions, com abaputils.Communication, apiManager abaputils.SoftwareComponentApiManagerInterface, logOutputManager *abaputils.LogOutputManager) error {
	// Mapping for options
	subOptions := convertCloneConfig(config)

	errConfig := checkConfiguration(config)
	if errConfig != nil {
		return errors.Wrap(errConfig, "The provided configuration is not allowed")
	}

	repositories, errGetRepos := abaputils.GetRepositories(&abaputils.RepositoriesConfig{BranchName: config.BranchName, RepositoryName: config.RepositoryName, Repositories: config.Repositories, ByogUsername: config.ByogUsername, ByogPassword: config.ByogPassword, ByogAuthMethod: config.ByogAuthMethod}, false)
	if errGetRepos != nil {
		return errors.Wrap(errGetRepos, "Could not read repositories")
	}

	// Determine the host, user and password, either via the input parameters or via a cloud foundry service key
	connectionDetails, errorGetInfo := com.GetAbapCommunicationArrangementInfo(subOptions, "")
	if errorGetInfo != nil {
		return errors.Wrap(errorGetInfo, "Parameters for the ABAP Connection not available")
	}
	connectionDetails.CertificateNames = config.CertificateNames

	log.Entry().Infof("Start cloning %v repositories", len(repositories))

	for _, repo := range repositories {

		cloneError := cloneSingleRepo(apiManager, connectionDetails, repo, config, com, logOutputManager)
		if cloneError != nil {
			return cloneError
		}
	}
	// Persist log archive
	abaputils.PersistArchiveLogsForPiperStep(logOutputManager)

	abaputils.AddDefaultDashedLine(1)
	log.Entry().Info("All repositories were cloned successfully")
	return nil
}

func cloneSingleRepo(apiManager abaputils.SoftwareComponentApiManagerInterface, connectionDetails abaputils.ConnectionDetailsHTTP, repo abaputils.Repository, config *abapEnvironmentCloneGitRepoOptions, com abaputils.Communication, logOutputManager *abaputils.LogOutputManager) error {

	// New API instance for each request
	// Triggering the Clone of the repository into the ABAP Environment system
	// Polling the status of the repository import on the ABAP Environment system
	// If the repository had been cloned already, as checkout/pull has been done - polling the status is not necessary anymore
	api, errGetAPI := apiManager.GetAPI(connectionDetails, repo)
	if errGetAPI != nil {
		return errors.Wrap(errGetAPI, "Could not initialize the connection to the system")
	}

	logString := repo.GetCloneLogString()
	errorString := "Clone of " + logString + " failed on the ABAP system"

	abaputils.AddDefaultDashedLine(1)
	log.Entry().Info("Start cloning " + logString)
	abaputils.AddDefaultDashedLine(1)

	alreadyCloned, activeBranch, errCheckCloned, isByog := api.GetRepository()
	if errCheckCloned != nil {
		return errors.Wrapf(errCheckCloned, errorString)
	}

	if !alreadyCloned {
		if isByog {
			api.UpdateRepoWithBYOGCredentials(config.ByogAuthMethod, config.ByogUsername, config.ByogPassword)
		}
		errClone := api.Clone()
		if errClone != nil {
			return errors.Wrapf(errClone, errorString)
		}
		// set correct filename for archive file
		logOutputManager.FileNameStep = "clone"
		status, errorPollEntity := abaputils.PollEntity(api, apiManager.GetPollIntervall(), logOutputManager)
		if errorPollEntity != nil {
			return errors.Wrapf(errorPollEntity, errorString)
		}
		if status == "E" {
			return errors.New("Clone of " + logString + " failed on the ABAP System")
		}
		log.Entry().Info("The " + logString + " was cloned successfully")
	} else {
		abaputils.AddDefaultDashedLine(2)
		log.Entry().Infof("%s", "The repository / software component has already been cloned on the ABAP Environment system ")
		log.Entry().Infof("%s", "If required, a `checkout branch`, and a `pull` will be performed instead")
		abaputils.AddDefaultDashedLine(2)
		var returnedError error
		if repo.Branch != "" && !(activeBranch == repo.Branch) {
			returnedError = runAbapEnvironmentCheckoutBranch(getCheckoutOptions(config, repo), com, apiManager, logOutputManager)
			abaputils.AddDefaultDashedLine(2)
			if returnedError != nil {
				return returnedError
			}
		}
		returnedError = runAbapEnvironmentPullGitRepo(getPullOptions(config, repo), com, apiManager, logOutputManager)
		return returnedError
	}
	return nil
}

func getCheckoutOptions(config *abapEnvironmentCloneGitRepoOptions, repo abaputils.Repository) *abapEnvironmentCheckoutBranchOptions {
	checkoutOptions := abapEnvironmentCheckoutBranchOptions{
		Username:          config.Username,
		Password:          config.Password,
		Host:              config.Host,
		RepositoryName:    repo.Name,
		BranchName:        repo.Branch,
		CfAPIEndpoint:     config.CfAPIEndpoint,
		CfOrg:             config.CfOrg,
		CfServiceInstance: config.CfServiceInstance,
		CfServiceKeyName:  config.CfServiceKeyName,
		CfSpace:           config.CfSpace,
	}
	return &checkoutOptions
}

func getPullOptions(config *abapEnvironmentCloneGitRepoOptions, repo abaputils.Repository) *abapEnvironmentPullGitRepoOptions {
	pullOptions := abapEnvironmentPullGitRepoOptions{
		Username:          config.Username,
		Password:          config.Password,
		Host:              config.Host,
		RepositoryName:    repo.Name,
		CommitID:          repo.CommitID,
		CfAPIEndpoint:     config.CfAPIEndpoint,
		CfOrg:             config.CfOrg,
		CfServiceInstance: config.CfServiceInstance,
		CfServiceKeyName:  config.CfServiceKeyName,
		CfSpace:           config.CfSpace,
		LogOutput:         config.LogOutput,
	}
	return &pullOptions
}

func checkConfiguration(config *abapEnvironmentCloneGitRepoOptions) error {
	if config.Repositories != "" && config.RepositoryName != "" {
		return errors.New("It is not allowed to configure the parameters `repositories`and `repositoryName` at the same time")
	}
	if config.Repositories == "" && config.RepositoryName == "" {
		return errors.New("Please provide one of the following parameters: `repositories` or `repositoryName`")
	}
	return nil
}

func triggerClone(repo abaputils.Repository, api abaputils.SoftwareComponentApiInterface) (error, bool) {

	//cloneConnectionDetails.URL = cloneConnectionDetails.URL + "/sap/opu/odata/sap/MANAGE_GIT_REPOSITORY/Clones"

	// The entity "Clones" does not allow for polling. To poll the progress, the related entity "Pull" has to be called
	// While "Clones" has the key fields UUID, SC_NAME and BRANCH_NAME, "Pull" only has the key field UUID
	//uriConnectionDetails.URL = uriConnectionDetails.URL + "/sap/opu/odata/sap/MANAGE_GIT_REPOSITORY/Pull(uuid=guid'" + body.UUID + "')"
	return nil, false
}

func convertCloneConfig(config *abapEnvironmentCloneGitRepoOptions) abaputils.AbapEnvironmentOptions {
	subOptions := abaputils.AbapEnvironmentOptions{}

	subOptions.CfAPIEndpoint = config.CfAPIEndpoint
	subOptions.CfServiceInstance = config.CfServiceInstance
	subOptions.CfServiceKeyName = config.CfServiceKeyName
	subOptions.CfOrg = config.CfOrg
	subOptions.CfSpace = config.CfSpace
	subOptions.Host = config.Host
	subOptions.Password = config.Password
	subOptions.Username = config.Username
	subOptions.ByogUsername = config.ByogUsername
	subOptions.ByogPassword = config.ByogPassword
	subOptions.ByogAuthMethod = config.ByogAuthMethod
	return subOptions
}