2020-02-21 13:56:09 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
2020-02-04 12:43:27 +02:00
package cmd
import (
"fmt"
"os"
"time"
"github.com/SAP/jenkins-library/pkg/config"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/telemetry"
"github.com/spf13/cobra"
)
type abapEnvironmentPullGitRepoOptions struct {
2020-05-07 15:51:11 +02:00
Username string ` json:"username,omitempty" `
Password string ` json:"password,omitempty" `
RepositoryNames [ ] string ` json:"repositoryNames,omitempty" `
Host string ` json:"host,omitempty" `
CfAPIEndpoint string ` json:"cfApiEndpoint,omitempty" `
CfOrg string ` json:"cfOrg,omitempty" `
CfSpace string ` json:"cfSpace,omitempty" `
CfServiceInstance string ` json:"cfServiceInstance,omitempty" `
2020-06-30 15:46:07 +02:00
CfServiceKeyName string ` json:"cfServiceKeyName,omitempty" `
2020-02-04 12:43:27 +02:00
}
// AbapEnvironmentPullGitRepoCommand Pulls a git repository to a SAP Cloud Platform ABAP Environment system
func AbapEnvironmentPullGitRepoCommand ( ) * cobra . Command {
2020-04-28 07:42:02 +02:00
const STEP_NAME = "abapEnvironmentPullGitRepo"
2020-02-04 12:43:27 +02:00
metadata := abapEnvironmentPullGitRepoMetadata ( )
var stepConfig abapEnvironmentPullGitRepoOptions
var startTime time . Time
var createAbapEnvironmentPullGitRepoCmd = & cobra . Command {
2020-04-28 07:42:02 +02:00
Use : STEP_NAME ,
2020-02-04 12:43:27 +02:00
Short : "Pulls a git repository to a SAP Cloud Platform ABAP Environment system" ,
Long : ` Pulls a git repository ( Software Component ) to a SAP Cloud Platform ABAP Environment system .
Please provide either of the following options :
2020-02-05 16:46:14 +02:00
* The host and credentials the Cloud Platform ABAP Environment system itself . The credentials must be configured for the Communication Scenario SAP_COM_0510 .
* The Cloud Foundry parameters ( API endpoint , organization , space ) , credentials , the service instance for the ABAP service and the service key for the Communication Scenario SAP_COM_0510 .
* Only provide one of those options with the respective credentials . If all values are provided , the direct communication ( via host ) has priority . ` ,
2020-06-23 18:05:21 +02:00
PreRunE : func ( cmd * cobra . Command , _ [ ] string ) error {
2020-02-04 12:43:27 +02:00
startTime = time . Now ( )
2020-04-28 07:42:02 +02:00
log . SetStepName ( STEP_NAME )
2020-02-04 12:43:27 +02:00
log . SetVerbose ( GeneralConfig . Verbose )
2020-04-28 07:42:02 +02:00
path , _ := os . Getwd ( )
fatalHook := & log . FatalHook { CorrelationID : GeneralConfig . CorrelationID , Path : path }
log . RegisterHook ( fatalHook )
err := PrepareConfig ( cmd , & metadata , STEP_NAME , & stepConfig , config . OpenPiperFile )
2020-04-16 14:37:45 +02:00
if err != nil {
2020-06-24 10:04:05 +02:00
log . SetErrorCategory ( log . ErrorConfiguration )
2020-04-16 14:37:45 +02:00
return err
}
log . RegisterSecret ( stepConfig . Username )
log . RegisterSecret ( stepConfig . Password )
2020-05-05 08:36:24 +02:00
if len ( GeneralConfig . HookConfig . SentryConfig . Dsn ) > 0 {
sentryHook := log . NewSentryHook ( GeneralConfig . HookConfig . SentryConfig . Dsn , GeneralConfig . CorrelationID )
log . RegisterHook ( & sentryHook )
}
2020-04-16 14:37:45 +02:00
return nil
2020-02-04 12:43:27 +02:00
} ,
2020-06-23 18:05:21 +02:00
Run : func ( _ * cobra . Command , _ [ ] string ) {
2020-02-04 12:43:27 +02:00
telemetryData := telemetry . CustomData { }
telemetryData . ErrorCode = "1"
handler := func ( ) {
telemetryData . Duration = fmt . Sprintf ( "%v" , time . Since ( startTime ) . Milliseconds ( ) )
telemetry . Send ( & telemetryData )
}
log . DeferExitHandler ( handler )
defer handler ( )
2020-04-28 07:42:02 +02:00
telemetry . Initialize ( GeneralConfig . NoTelemetry , STEP_NAME )
2020-02-04 12:43:27 +02:00
abapEnvironmentPullGitRepo ( stepConfig , & telemetryData )
telemetryData . ErrorCode = "0"
2020-05-18 21:52:54 +02:00
log . Entry ( ) . Info ( "SUCCESS" )
2020-02-04 12:43:27 +02:00
} ,
}
addAbapEnvironmentPullGitRepoFlags ( createAbapEnvironmentPullGitRepoCmd , & stepConfig )
return createAbapEnvironmentPullGitRepoCmd
}
func addAbapEnvironmentPullGitRepoFlags ( cmd * cobra . Command , stepConfig * abapEnvironmentPullGitRepoOptions ) {
cmd . Flags ( ) . StringVar ( & stepConfig . Username , "username" , os . Getenv ( "PIPER_username" ) , "User for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0510" )
cmd . Flags ( ) . StringVar ( & stepConfig . Password , "password" , os . Getenv ( "PIPER_password" ) , "Password for either the Cloud Foundry API or the Communication Arrangement for SAP_COM_0510" )
2020-05-07 15:51:11 +02:00
cmd . Flags ( ) . StringSliceVar ( & stepConfig . RepositoryNames , "repositoryNames" , [ ] string { } , "Specifies a list of Repositories (Software Components) on the SAP Cloud Platform ABAP Environment system" )
2020-02-04 12:43:27 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . Host , "host" , os . Getenv ( "PIPER_host" ) , "Specifies the host address of the SAP Cloud Platform ABAP Environment system" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfAPIEndpoint , "cfApiEndpoint" , os . Getenv ( "PIPER_cfApiEndpoint" ) , "Cloud Foundry API Enpoint" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfOrg , "cfOrg" , os . Getenv ( "PIPER_cfOrg" ) , "Cloud Foundry target organization" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfSpace , "cfSpace" , os . Getenv ( "PIPER_cfSpace" ) , "Cloud Foundry target space" )
cmd . Flags ( ) . StringVar ( & stepConfig . CfServiceInstance , "cfServiceInstance" , os . Getenv ( "PIPER_cfServiceInstance" ) , "Cloud Foundry Service Instance" )
2020-06-30 15:46:07 +02:00
cmd . Flags ( ) . StringVar ( & stepConfig . CfServiceKeyName , "cfServiceKeyName" , os . Getenv ( "PIPER_cfServiceKeyName" ) , "Cloud Foundry Service Key" )
2020-02-04 12:43:27 +02:00
cmd . MarkFlagRequired ( "username" )
cmd . MarkFlagRequired ( "password" )
2020-05-07 15:51:11 +02:00
cmd . MarkFlagRequired ( "repositoryNames" )
2020-02-04 12:43:27 +02:00
}
// retrieve step metadata
func abapEnvironmentPullGitRepoMetadata ( ) config . StepData {
var theMetaData = config . StepData {
2020-03-19 18:24:35 +02:00
Metadata : config . StepMetadata {
Name : "abapEnvironmentPullGitRepo" ,
Aliases : [ ] config . Alias { } ,
} ,
2020-02-04 12:43:27 +02:00
Spec : config . StepSpec {
Inputs : config . StepInputs {
Parameters : [ ] config . StepParameters {
{
Name : "username" ,
2020-08-28 15:38:15 +02:00
ResourceRef : [ ] config . ResourceReference { { Name : "abapCredentialsId" , Param : "username" } } ,
2020-02-04 12:43:27 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "password" ,
2020-08-28 15:38:15 +02:00
ResourceRef : [ ] config . ResourceReference { { Name : "abapCredentialsId" , Param : "password" } } ,
2020-02-04 12:43:27 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
Type : "string" ,
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
2020-05-07 15:51:11 +02:00
Name : "repositoryNames" ,
2020-02-04 12:43:27 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" } ,
2020-05-07 15:51:11 +02:00
Type : "[]string" ,
2020-02-04 12:43:27 +02:00
Mandatory : true ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "host" ,
ResourceRef : [ ] config . ResourceReference { } ,
2020-07-07 16:19:57 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { } ,
} ,
{
Name : "cfApiEndpoint" ,
ResourceRef : [ ] config . ResourceReference { } ,
2020-05-14 14:48:12 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/apiEndpoint" } } ,
} ,
{
Name : "cfOrg" ,
ResourceRef : [ ] config . ResourceReference { } ,
2020-05-14 14:48:12 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/org" } } ,
} ,
{
Name : "cfSpace" ,
ResourceRef : [ ] config . ResourceReference { } ,
2020-05-14 14:48:12 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/space" } } ,
} ,
{
Name : "cfServiceInstance" ,
ResourceRef : [ ] config . ResourceReference { } ,
2020-05-14 14:48:12 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
Aliases : [ ] config . Alias { { Name : "cloudFoundry/serviceInstance" } } ,
} ,
{
2020-06-30 15:46:07 +02:00
Name : "cfServiceKeyName" ,
2020-02-04 12:43:27 +02:00
ResourceRef : [ ] config . ResourceReference { } ,
2020-05-14 14:48:12 +02:00
Scope : [ ] string { "PARAMETERS" , "STAGES" , "STEPS" , "GENERAL" } ,
2020-02-04 12:43:27 +02:00
Type : "string" ,
Mandatory : false ,
2020-06-30 15:46:07 +02:00
Aliases : [ ] config . Alias { { Name : "cloudFoundry/serviceKey" } , { Name : "cloudFoundry/serviceKeyName" } , { Name : "cfServiceKey" } } ,
2020-02-04 12:43:27 +02:00
} ,
} ,
} ,
} ,
}
return theMetaData
}