2021-02-19 14:07:18 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
package cmd
import (
"fmt"
"os"
2021-03-19 09:58:20 +02:00
"path/filepath"
2021-02-19 14:07:18 +02:00
"time"
"github.com/SAP/jenkins-library/pkg/config"
"github.com/SAP/jenkins-library/pkg/log"
2021-03-19 09:58:20 +02:00
"github.com/SAP/jenkins-library/pkg/piperenv"
2021-05-17 12:14:04 +02:00
"github.com/SAP/jenkins-library/pkg/splunk"
2021-02-19 14:07:18 +02:00
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/spf13/cobra"
)
type transportRequestUploadSOLMANOptions struct {
2021-03-19 09:58:20 +02:00
Endpoint string ` json:"endpoint,omitempty" `
Username string ` json:"username,omitempty" `
Password string ` json:"password,omitempty" `
ApplicationID string ` json:"applicationId,omitempty" `
ChangeDocumentID string ` json:"changeDocumentId,omitempty" `
TransportRequestID string ` json:"transportRequestId,omitempty" `
FilePath string ` json:"filePath,omitempty" `
CmClientOpts [ ] string ` json:"cmClientOpts,omitempty" `
GitFrom string ` json:"gitFrom,omitempty" `
GitTo string ` json:"gitTo,omitempty" `
ChangeDocumentLabel string ` json:"changeDocumentLabel,omitempty" `
TransportRequestLabel string ` json:"transportRequestLabel,omitempty" `
}
type transportRequestUploadSOLMANCommonPipelineEnvironment struct {
custom struct {
changeDocumentID string
transportRequestID string
}
}
func ( p * transportRequestUploadSOLMANCommonPipelineEnvironment ) persist ( path , resourceName string ) {
content := [ ] struct {
category string
name string
value interface { }
} {
{ category : "custom" , name : "changeDocumentId" , value : p . custom . changeDocumentID } ,
{ category : "custom" , name : "transportRequestId" , value : p . custom . transportRequestID } ,
}
errCount := 0
for _ , param := range content {
err := piperenv . SetResourceParameter ( path , resourceName , filepath . Join ( param . category , param . name ) , param . value )
if err != nil {
log . Entry ( ) . WithError ( err ) . Error ( "Error persisting piper environment." )
errCount ++
}
}
if errCount > 0 {
log . Entry ( ) . Fatal ( "failed to persist Piper environment" )
}
2021-02-19 14:07:18 +02:00
}
2021-04-22 09:40:26 +02:00
// TransportRequestUploadSOLMANCommand Uploads a specified file into a given transport via Solution Manager
2021-02-19 14:07:18 +02:00
func TransportRequestUploadSOLMANCommand ( ) * cobra . Command {
const STEP_NAME = "transportRequestUploadSOLMAN"
metadata := transportRequestUploadSOLMANMetadata ( )
var stepConfig transportRequestUploadSOLMANOptions
var startTime time . Time
2021-03-19 09:58:20 +02:00
var commonPipelineEnvironment transportRequestUploadSOLMANCommonPipelineEnvironment
2021-05-17 12:14:04 +02:00
var logCollector * log . CollectorHook
2021-02-19 14:07:18 +02:00
var createTransportRequestUploadSOLMANCmd = & cobra . Command {
Use : STEP_NAME ,
2021-04-22 09:40:26 +02:00
Short : "Uploads a specified file into a given transport via Solution Manager" ,
Long : ` Uploads the specified file into the given transport request via Solution Manager .
The mandatory change document ID points to the associate change document item .
The application ID specifies how the file needs to be handled on server side . ` ,
2021-02-19 14:07:18 +02:00
PreRunE : func ( cmd * cobra . Command , _ [ ] string ) error {
startTime = time . Now ( )
log . SetStepName ( STEP_NAME )
log . SetVerbose ( GeneralConfig . Verbose )
path , _ := os . Getwd ( )
fatalHook := & log . FatalHook { CorrelationID : GeneralConfig . CorrelationID , Path : path }
log . RegisterHook ( fatalHook )
err := PrepareConfig ( cmd , & metadata , STEP_NAME , & stepConfig , config . OpenPiperFile )
if err != nil {
log . SetErrorCategory ( log . ErrorConfiguration )
return err
}
log . RegisterSecret ( stepConfig . Username )
log . RegisterSecret ( stepConfig . Password )
if len ( GeneralConfig . HookConfig . SentryConfig . Dsn ) > 0 {
sentryHook := log . NewSentryHook ( GeneralConfig . HookConfig . SentryConfig . Dsn , GeneralConfig . CorrelationID )
log . RegisterHook ( & sentryHook )
}
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
logCollector = & log . CollectorHook { CorrelationID : GeneralConfig . CorrelationID }
log . RegisterHook ( logCollector )
}
2021-02-19 14:07:18 +02:00
return nil
} ,
Run : func ( _ * cobra . Command , _ [ ] string ) {
telemetryData := telemetry . CustomData { }
telemetryData . ErrorCode = "1"
handler := func ( ) {
config . RemoveVaultSecretFiles ( )
2021-03-19 09:58:20 +02:00
commonPipelineEnvironment . persist ( GeneralConfig . EnvRootPath , "commonPipelineEnvironment" )
2021-02-19 14:07:18 +02:00
telemetryData . Duration = fmt . Sprintf ( "%v" , time . Since ( startTime ) . Milliseconds ( ) )
telemetryData . ErrorCategory = log . GetErrorCategory ( ) . String ( )
telemetry . Send ( & telemetryData )
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
splunk . Send ( & telemetryData , logCollector )
}
2021-02-19 14:07:18 +02:00
}
log . DeferExitHandler ( handler )
defer handler ( )
telemetry . Initialize ( GeneralConfig . NoTelemetry , STEP_NAME )
2021-05-17 12:14:04 +02:00
if len ( GeneralConfig . HookConfig . SplunkConfig . Dsn ) > 0 {
splunk . Initialize ( GeneralConfig . CorrelationID ,
GeneralConfig . HookConfig . SplunkConfig . Dsn ,
GeneralConfig . HookConfig . SplunkConfig . Token ,
GeneralConfig . HookConfig . SplunkConfig . Index ,
GeneralConfig . HookConfig . SplunkConfig . SendLogs )
}
2021-03-19 09:58:20 +02:00
transportRequestUploadSOLMAN ( stepConfig , & telemetryData , & commonPipelineEnvironment )
2021-02-19 14:07:18 +02:00
telemetryData . ErrorCode = "0"
log . Entry ( ) . Info ( "SUCCESS" )
} ,
}
addTransportRequestUploadSOLMANFlags ( createTransportRequestUploadSOLMANCmd , & stepConfig )
return createTransportRequestUploadSOLMANCmd
}
func addTransportRequestUploadSOLMANFlags ( cmd * cobra . Command , stepConfig * transportRequestUploadSOLMANOptions ) {
cmd . Flags ( ) . StringVar ( & stepConfig . Endpoint , "endpoint" , os . Getenv ( "PIPER_endpoint" ) , "Service endpoint" )
2021-04-22 09:40:26 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . Username , "username" , os . Getenv ( "PIPER_username" ) , "Service user for uploading to the Solution Manager" )
cmd . Flags ( ) . StringVar ( & stepConfig . Password , "password" , os . Getenv ( "PIPER_password" ) , "Service user password for uploading to the Solution Manager" )
cmd . Flags ( ) . StringVar ( & stepConfig . ApplicationID , "applicationId" , os . Getenv ( "PIPER_applicationId" ) , "Id of the application. Specifies how the file needs to be handled on server side" )
cmd . Flags ( ) . StringVar ( & stepConfig . ChangeDocumentID , "changeDocumentId" , os . Getenv ( "PIPER_changeDocumentId" ) , "ID of the change document to which the file is uploaded" )
cmd . Flags ( ) . StringVar ( & stepConfig . TransportRequestID , "transportRequestId" , os . Getenv ( "PIPER_transportRequestId" ) , "ID of the transport request to which the file is uploaded" )
2021-02-19 14:07:18 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . FilePath , "filePath" , os . Getenv ( "PIPER_filePath" ) , "Name/Path of the file which should be uploaded" )
cmd . Flags ( ) . StringSliceVar ( & stepConfig . CmClientOpts , "cmClientOpts" , [ ] string { } , "Additional options handed over to the cm client" )
2021-04-22 09:40:26 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . GitFrom , "gitFrom" , ` origin/master ` , "GIT starting point for retrieving the change document and transport request ID" )
cmd . Flags ( ) . StringVar ( & stepConfig . GitTo , "gitTo" , ` HEAD ` , "GIT ending point for retrieving the change document and transport request ID" )
cmd . Flags ( ) . StringVar ( & stepConfig . ChangeDocumentLabel , "changeDocumentLabel" , ` ChangeDocument ` , "Pattern used for identifying lines holding the change document ID. The GIT commit log messages are scanned for this label" )
cmd . Flags ( ) . StringVar ( & stepConfig . TransportRequestLabel , "transportRequestLabel" , ` TransportRequest ` , "Pattern used for identifying lines holding the transport request ID. The GIT commit log messages are scanned for this label" )
2021-02-19 14:07:18 +02:00
cmd . MarkFlagRequired ( "endpoint" )
cmd . MarkFlagRequired ( "username" )
cmd . MarkFlagRequired ( "password" )
cmd . MarkFlagRequired ( "applicationId" )
cmd . MarkFlagRequired ( "filePath" )
cmd . MarkFlagRequired ( "cmClientOpts" )
}
// retrieve step metadata
func transportRequestUploadSOLMANMetadata ( ) config . StepData {
var theMetaData = config . StepData {
Metadata : config . StepMetadata {
Name : "transportRequestUploadSOLMAN" ,
Aliases : [ ] config . Alias { { Name : "transportRequestUploadFile" , Deprecated : false } } ,
2021-04-22 09:40:26 +02:00
Description : "Uploads a specified file into a given transport via Solution Manager" ,
2021-02-19 14:07:18 +02:00
} ,
Spec : config . StepSpec {
Inputs : config . StepInputs {
Parameters : [ ] config . StepParameters {
{
Name : "endpoint" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "changeManagement/endpoint" } } ,
} ,
{
2021-03-22 12:53:37 +02:00
Name : "username" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "uploadCredentialsId" ,
Param : "username" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-02-19 14:07:18 +02:00
} ,
{
2021-03-22 12:53:37 +02:00
Name : "password" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "uploadCredentialsId" ,
Param : "password" ,
Type : "secret" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
2021-02-19 14:07:18 +02:00
} ,
{
Name : "applicationId" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
2021-03-19 09:58:20 +02:00
Name : "changeDocumentId" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "custom/changeDocumentId" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
2021-02-19 14:07:18 +02:00
} ,
{
Name : "transportRequestId" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "custom/transportRequestId" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" } ,
Type : "string" ,
2021-03-19 09:58:20 +02:00
Mandatory : false ,
2021-02-19 14:07:18 +02:00
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "filePath" ,
ResourceRef : [ ] config . ResourceReference {
{
Name : "commonPipelineEnvironment" ,
Param : "mtarFilePath" ,
} ,
} ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "cmClientOpts" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEP" , "GENERAL" } ,
Type : "[]string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { { Name : "clientOpts" } , { Name : "changeManagement/clientOpts" } } ,
} ,
2021-03-19 09:58:20 +02:00
{
Name : "gitFrom" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEP" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "changeManagement/git/from" } } ,
} ,
{
Name : "gitTo" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEP" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "changeManagement/git/to" } } ,
} ,
{
Name : "changeDocumentLabel" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEP" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "changeManagement/changeDocumentLabel" } } ,
} ,
{
Name : "transportRequestLabel" ,
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEP" , "GENERAL" } ,
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "changeManagement/transportRequestLabel" } } ,
} ,
} ,
} ,
2021-03-22 12:53:37 +02:00
Containers : [ ] config . Container {
{ Name : "cmclient" , Image : "ppiper/cm-client" } ,
} ,
2021-03-19 09:58:20 +02:00
Outputs : config . StepOutputs {
Resources : [ ] config . StepResources {
{
Name : "commonPipelineEnvironment" ,
Type : "piperEnvironment" ,
Parameters : [ ] map [ string ] interface { } {
{ "Name" : "custom/changeDocumentId" } ,
{ "Name" : "custom/transportRequestId" } ,
} ,
} ,
2021-02-19 14:07:18 +02:00
} ,
} ,
} ,
}
return theMetaData
}