1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-14 11:03:09 +02:00
sap-jenkins-library/cmd/mavenExecute_generated.go

182 lines
6.6 KiB
Go
Raw Normal View History

2020-02-28 14:09:46 +02:00
// Code generated by piper's step-generator. DO NOT EDIT.
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 mavenExecuteOptions struct {
PomPath string `json:"pomPath,omitempty"`
Goals []string `json:"goals,omitempty"`
Defines []string `json:"defines,omitempty"`
Flags []string `json:"flags,omitempty"`
ReturnStdout bool `json:"returnStdout,omitempty"`
2020-03-17 13:09:08 +02:00
ProjectSettingsFile string `json:"projectSettingsFile,omitempty"`
GlobalSettingsFile string `json:"globalSettingsFile,omitempty"`
M2Path string `json:"m2Path,omitempty"`
LogSuccessfulMavenTransfers bool `json:"logSuccessfulMavenTransfers,omitempty"`
2020-02-28 14:09:46 +02:00
}
// MavenExecuteCommand This step allows to run maven commands
func MavenExecuteCommand() *cobra.Command {
const STEP_NAME = "mavenExecute"
2020-02-28 14:09:46 +02:00
metadata := mavenExecuteMetadata()
var stepConfig mavenExecuteOptions
var startTime time.Time
var createMavenExecuteCmd = &cobra.Command{
Use: STEP_NAME,
2020-02-28 14:09:46 +02:00
Short: "This step allows to run maven commands",
Long: `This step runs a maven command based on the parameters provided to the step.`,
PreRunE: func(cmd *cobra.Command, args []string) error {
startTime = time.Now()
log.SetStepName(STEP_NAME)
2020-02-28 14:09:46 +02:00
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)
2020-04-16 14:37:45 +02:00
if err != nil {
return err
}
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-28 14:09:46 +02:00
},
Run: func(cmd *cobra.Command, args []string) {
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()
telemetry.Initialize(GeneralConfig.NoTelemetry, STEP_NAME)
2020-02-28 14:09:46 +02:00
mavenExecute(stepConfig, &telemetryData)
telemetryData.ErrorCode = "0"
},
}
addMavenExecuteFlags(createMavenExecuteCmd, &stepConfig)
return createMavenExecuteCmd
}
func addMavenExecuteFlags(cmd *cobra.Command, stepConfig *mavenExecuteOptions) {
cmd.Flags().StringVar(&stepConfig.PomPath, "pomPath", os.Getenv("PIPER_pomPath"), "Path to the pom file that should be used.")
cmd.Flags().StringSliceVar(&stepConfig.Goals, "goals", []string{}, "Maven goals that should be executed.")
cmd.Flags().StringSliceVar(&stepConfig.Defines, "defines", []string{}, "Additional properties in form of -Dkey=value.")
cmd.Flags().StringSliceVar(&stepConfig.Flags, "flags", []string{}, "Flags to provide when running mvn.")
cmd.Flags().BoolVar(&stepConfig.ReturnStdout, "returnStdout", false, "Returns the output of the maven command for further processing.")
2020-03-17 13:09:08 +02:00
cmd.Flags().StringVar(&stepConfig.ProjectSettingsFile, "projectSettingsFile", os.Getenv("PIPER_projectSettingsFile"), "Path to the mvn settings file that should be used as project settings file.")
cmd.Flags().StringVar(&stepConfig.GlobalSettingsFile, "globalSettingsFile", os.Getenv("PIPER_globalSettingsFile"), "Path to the mvn settings file that should be used as global settings file.")
cmd.Flags().StringVar(&stepConfig.M2Path, "m2Path", os.Getenv("PIPER_m2Path"), "Path to the location of the local repository that should be used.")
cmd.Flags().BoolVar(&stepConfig.LogSuccessfulMavenTransfers, "logSuccessfulMavenTransfers", false, "Configures maven to log successful downloads. This is set to `false` by default to reduce the noise in build logs.")
2020-02-28 14:09:46 +02:00
cmd.MarkFlagRequired("goals")
}
// retrieve step metadata
func mavenExecuteMetadata() config.StepData {
var theMetaData = config.StepData{
Metadata: config.StepMetadata{
Name: "mavenExecute",
Aliases: []config.Alias{},
},
2020-02-28 14:09:46 +02:00
Spec: config.StepSpec{
Inputs: config.StepInputs{
Parameters: []config.StepParameters{
{
Name: "pomPath",
ResourceRef: []config.ResourceReference{},
Scope: []string{"PARAMETERS", "STEPS"},
Type: "string",
Mandatory: false,
Aliases: []config.Alias{},
},
{
2020-03-17 13:09:08 +02:00
Name: "goals",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"PARAMETERS"},
Type: "[]string",
Mandatory: true,
2020-02-28 14:09:46 +02:00
Aliases: []config.Alias{},
},
{
2020-03-17 13:09:08 +02:00
Name: "defines",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"PARAMETERS"},
Type: "[]string",
2020-02-28 14:09:46 +02:00
Mandatory: false,
Aliases: []config.Alias{},
},
{
2020-03-17 13:09:08 +02:00
Name: "flags",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
Scope: []string{"PARAMETERS", "STEPS"},
2020-03-17 13:09:08 +02:00
Type: "[]string",
2020-02-28 14:09:46 +02:00
Mandatory: false,
Aliases: []config.Alias{},
},
{
2020-03-17 13:09:08 +02:00
Name: "returnStdout",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
Scope: []string{"PARAMETERS"},
2020-03-17 13:09:08 +02:00
Type: "bool",
Mandatory: false,
2020-02-28 14:09:46 +02:00
Aliases: []config.Alias{},
},
{
2020-03-17 13:09:08 +02:00
Name: "projectSettingsFile",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"GENERAL", "STEPS", "STAGES", "PARAMETERS"},
Type: "string",
2020-02-28 14:09:46 +02:00
Mandatory: false,
2020-03-17 13:09:08 +02:00
Aliases: []config.Alias{{Name: "maven/projectSettingsFile"}},
2020-02-28 14:09:46 +02:00
},
{
2020-03-17 13:09:08 +02:00
Name: "globalSettingsFile",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"GENERAL", "STEPS", "STAGES", "PARAMETERS"},
Type: "string",
2020-02-28 14:09:46 +02:00
Mandatory: false,
2020-03-17 13:09:08 +02:00
Aliases: []config.Alias{{Name: "maven/globalSettingsFile"}},
2020-02-28 14:09:46 +02:00
},
{
2020-03-17 13:09:08 +02:00
Name: "m2Path",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"GENERAL", "STEPS", "STAGES", "PARAMETERS"},
Type: "string",
2020-02-28 14:09:46 +02:00
Mandatory: false,
2020-03-17 13:09:08 +02:00
Aliases: []config.Alias{{Name: "maven/m2Path"}},
2020-02-28 14:09:46 +02:00
},
{
2020-03-17 13:09:08 +02:00
Name: "logSuccessfulMavenTransfers",
2020-02-28 14:09:46 +02:00
ResourceRef: []config.ResourceReference{},
2020-03-17 13:09:08 +02:00
Scope: []string{"GENERAL", "STEPS", "STAGES", "PARAMETERS"},
2020-02-28 14:09:46 +02:00
Type: "bool",
Mandatory: false,
2020-03-17 13:09:08 +02:00
Aliases: []config.Alias{{Name: "maven/logSuccessfulMavenTransfers"}},
2020-02-28 14:09:46 +02:00
},
},
},
},
}
return theMetaData
}