1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-16 11:09:33 +02:00
sap-jenkins-library/cmd/transportRequestUploadCTS.go
Roland Stengel 7e55556d7e
CTS Upload Go (#2969)
CTS Upload Go
- add cpe
- adjust yaml docker, cpe, text
2021-07-08 10:09:18 +02:00

109 lines
3.7 KiB
Go

package cmd
import (
"github.com/SAP/jenkins-library/pkg/command"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/SAP/jenkins-library/pkg/transportrequest/cts"
)
type transportRequestUploadUtils interface {
command.ShellRunner
// Add more methods here, or embed additional interfaces, or remove/replace as required.
// The transportRequestUploadUtils 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.
}
// UploadAction ...
type UploadAction interface {
Perform(command.ShellRunner) error
WithConnection(cts.Connection)
WithApplication(cts.Application)
WithNodeProperties(cts.Node)
WithTransportRequestID(string)
WithConfigFile(string)
WithDeployUser(string)
}
type transportRequestUploadCTSUtilsBundle struct {
*command.Command
// Embed more structs as necessary to implement methods or interfaces you add to transportRequestUploadUtils.
// 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
// transportRequestUploadUtilsBundle and forward to the implementation of the dependency.
}
func newTransportRequestUploadCTSUtils() transportRequestUploadUtils {
utils := transportRequestUploadCTSUtilsBundle{
Command: &command.Command{},
}
// Reroute command output to logging framework
utils.Stdout(log.Writer())
utils.Stderr(log.Writer())
return &utils
}
func transportRequestUploadCTS(config transportRequestUploadCTSOptions,
telemetryData *telemetry.CustomData,
commonPipelineEnvironment *transportRequestUploadCTSCommonPipelineEnvironment) {
// Utils can be used wherever the command.ExecRunner interface is expected.
// It can also be used for example as a mavenExecRunner.
utils := newTransportRequestUploadCTSUtils()
// 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 := runTransportRequestUploadCTS(&config, &cts.UploadAction{}, telemetryData, utils, commonPipelineEnvironment)
if err != nil {
log.Entry().WithError(err).Fatal("step execution failed")
}
}
func runTransportRequestUploadCTS(
config *transportRequestUploadCTSOptions,
action UploadAction,
telemetryData *telemetry.CustomData,
cmd command.ShellRunner,
commonPipelineEnvironment *transportRequestUploadCTSCommonPipelineEnvironment) error {
log.Entry().Debugf("Entering 'runTransportRequestUpload' with config: %v", config)
action.WithConnection(cts.Connection{
Endpoint: config.Endpoint,
Client: config.Client,
User: config.Username,
Password: config.Password,
})
action.WithApplication(cts.Application{
Name: config.ApplicationName,
Pack: config.AbapPackage,
Desc: config.Description,
})
action.WithNodeProperties(cts.Node{
DeployDependencies: config.DeployToolDependencies,
InstallOpts: config.NpmInstallOpts,
})
action.WithTransportRequestID(config.TransportRequestID)
action.WithConfigFile(config.DeployConfigFile)
action.WithDeployUser(config.OsDeployUser)
commonPipelineEnvironment.custom.transportRequestID = config.TransportRequestID
err := action.Perform(cmd)
if err == nil {
log.Entry().Infof("Upload of application '%s' to CTS succeeded (TransportRequestId: '%s').",
config.ApplicationName,
config.TransportRequestID,
)
}
return err
}