sap-jenkins-library/cmd/transportRequestUploadSOLMAN.go

package cmd

import (
	"github.com/SAP/jenkins-library/pkg/command"
	"github.com/SAP/jenkins-library/pkg/log"
	"github.com/SAP/jenkins-library/pkg/piperutils"
	"github.com/SAP/jenkins-library/pkg/telemetry"
	"github.com/SAP/jenkins-library/pkg/transportrequest"
	"github.com/SAP/jenkins-library/pkg/transportrequest/solman"
)

type transportRequestUploadSOLMANUtils interface {
	solman.Exec
	FileExists(filename string) (bool, error)

	// Add more methods here, or embed additional interfaces, or remove/replace as required.
	// The transportRequestUploadSOLMANUtils interface should be descriptive of your runtime dependencies,
	// i.e. include everything you need to be able to mock in tests.
	// Unit tests shall be executable in parallel (not depend on global state), and don't (re-)test dependencies.
}

type transportRequestUploadSOLMANUtilsBundle struct {
	*command.Command
	*piperutils.Files

	// Embed more structs as necessary to implement methods or interfaces you add to transportRequestUploadSOLMANUtils.
	// Structs embedded in this way must each have a unique set of methods attached.
	// If there is no struct which implements the method you need, attach the method to
	// transportRequestUploadSOLMANUtilsBundle and forward to the implementation of the dependency.
}

func newTransportRequestUploadSOLMANUtils() transportRequestUploadSOLMANUtils {
	utils := transportRequestUploadSOLMANUtilsBundle{
		Command: &command.Command{},
		Files:   &piperutils.Files{},
	}
	// Reroute command output to logging framework
	utils.Stdout(log.Writer())
	utils.Stderr(log.Writer())
	return &utils
}

func transportRequestUploadSOLMAN(config transportRequestUploadSOLMANOptions,
	telemetryData *telemetry.CustomData,
	commonPipelineEnvironment *transportRequestUploadSOLMANCommonPipelineEnvironment) {
	// Utils can be used wherever the command.ExecRunner interface is expected.
	// It can also be used for example as a mavenExecRunner.
	utils := newTransportRequestUploadSOLMANUtils()

	// For HTTP calls import  piperhttp "github.com/SAP/jenkins-library/pkg/http"
	// and use a  &piperhttp.Client{} in a custom system
	// Example: step checkmarxExecuteScan.go

	// Error situations should be bubbled up until they reach the line below which will then stop execution
	// through the log.Entry().Fatal() call leading to an os.Exit(1) in the end.
	err := runTransportRequestUploadSOLMAN(&config, &solman.UploadAction{}, telemetryData, utils, commonPipelineEnvironment)
	if err != nil {
		log.Entry().WithError(err).Fatal("step execution failed")
	}
}

// mocking framework. Allows to redirect the containing methods
type iTransportRequestUtils interface {
	FindIDInRange(label, from, to string) (string, error)
}
type transportRequestUtils struct {
}

func (*transportRequestUtils) FindIDInRange(label, from, to string) (string, error) {
	return transportrequest.FindIDInRange(label, from, to)
}

func runTransportRequestUploadSOLMAN(config *transportRequestUploadSOLMANOptions,
	action solman.Action,
	telemetryData *telemetry.CustomData,
	utils transportRequestUploadSOLMANUtils,
	commonPipelineEnvironment *transportRequestUploadSOLMANCommonPipelineEnvironment) error {

	action.WithConnection(solman.Connection{
		Endpoint: config.Endpoint,
		User:     config.Username,
		Password: config.Password,
	})

	cdID, err := getChangeDocumentID(config, &transportRequestUtils{})
	if err != nil {
		return err
	}
	action.WithChangeDocumentID(cdID)

	trID, err := getTransportRequestID(config, &transportRequestUtils{})
	if err != nil {
		return err
	}
	action.WithTransportRequestID(trID)
	action.WithApplicationID(config.ApplicationID)
	action.WithFile(config.FilePath)
	action.WithCMOpts(config.CmClientOpts)

	commonPipelineEnvironment.custom.changeDocumentID = cdID
	commonPipelineEnvironment.custom.transportRequestID = trID

	err = action.Perform(utils, utils)

	if err == nil {
		log.Entry().Infof("Upload of artifact '%s' to SAP Solution Manager succeeded (ChangeDocumentId: '%s', TransportRequestId: '%s').",
			config.FilePath,
			cdID,
			trID,
		)
	}
	return err
}

func getTransportRequestID(config *transportRequestUploadSOLMANOptions,
	trUtils iTransportRequestUtils) (string, error) {

	if len(config.TransportRequestID) > 0 {
		return config.TransportRequestID, nil
	}

	return trUtils.FindIDInRange(config.TransportRequestLabel, config.GitFrom, config.GitTo)
}

func getChangeDocumentID(config *transportRequestUploadSOLMANOptions,
	trUtils iTransportRequestUtils) (string, error) {

	if len(config.ChangeDocumentID) > 0 {
		return config.ChangeDocumentID, nil
	}

	return trUtils.FindIDInRange(config.ChangeDocumentLabel, config.GitFrom, config.GitTo)
}