cmd

Documentation

Index

• Variables
• func AbapEnvironmentPullGitRepoCommand() *cobra.Command
• func ArtifactPrepareVersionCommand() *cobra.Command
• func CheckmarxExecuteScanCommand() *cobra.Command
• func CloudFoundryCreateServiceKeyCommand() *cobra.Command
• func CloudFoundryDeleteServiceCommand() *cobra.Command
• func ConfigCommand() *cobra.Command
• func DetectExecuteScanCommand() *cobra.Command
• func Execute()
• func GctsCreateRepositoryCommand() *cobra.Command
• func GithubCreatePullRequestCommand() *cobra.Command
• func GithubPublishReleaseCommand() *cobra.Command
• func KarmaExecuteTestsCommand() *cobra.Command
• func KubernetesDeployCommand() *cobra.Command
• func MalwareExecuteScanCommand() *cobra.Command
• func MavenBuildCommand() *cobra.Command
• func MavenExecuteCommand() *cobra.Command
• func MavenExecuteStaticCodeChecksCommand() *cobra.Command
• func MtaBuildCommand() *cobra.Command
• func NexusUploadCommand() *cobra.Command
• func NpmExecuteScriptsCommand() *cobra.Command
• func PrepareConfig(cmd *cobra.Command, metadata *config.StepData, stepName string, ...) error
• func ProtecodeExecuteScanCommand() *cobra.Command
• func SonarExecuteScanCommand() *cobra.Command
• func VersionCommand() *cobra.Command
• func XsDeployCommand() *cobra.Command
• type Action
  • func ValueOfAction(str string) (Action, error)
  • func (a Action) GetAction() (string, error)
  • func (a Action) String() string
• type DeployMode
  • func ValueOfMode(str string) (DeployMode, error)
  • func (m DeployMode) GetDeployCommand() (string, error)
  • func (m DeployMode) String() string
• type GeneralConfigOptions
• type HookConfiguration
• type MTABuildTarget
  • func ValueOfBuildTarget(str string) (MTABuildTarget, error)
  • func (m MTABuildTarget) String() string
• type SentryConfiguration

Variables

var GitCommit string

GitCommit ...

var GitTag string

GitTag ...

Functions

func AbapEnvironmentPullGitRepoCommand

func AbapEnvironmentPullGitRepoCommand() *cobra.Command

AbapEnvironmentPullGitRepoCommand Pulls a git repository to a SAP Cloud Platform ABAP Environment system

func ArtifactPrepareVersionCommand

func ArtifactPrepareVersionCommand() *cobra.Command

ArtifactPrepareVersionCommand Prepares and potentially updates the artifact's version before building the artifact.

func CheckmarxExecuteScanCommand

func CheckmarxExecuteScanCommand() *cobra.Command

CheckmarxExecuteScanCommand Checkmarx is the recommended tool for security scans of JavaScript, iOS, Swift and Ruby code.

func CloudFoundryCreateServiceKeyCommand

func CloudFoundryCreateServiceKeyCommand() *cobra.Command

CloudFoundryCreateServiceKeyCommand cloudFoundryCreateServiceKey

func CloudFoundryDeleteServiceCommand

func CloudFoundryDeleteServiceCommand() *cobra.Command

CloudFoundryDeleteServiceCommand DeleteCloudFoundryService

func ConfigCommand

func ConfigCommand() *cobra.Command

ConfigCommand is the entry command for loading the configuration of a pipeline step

func DetectExecuteScanCommand

func DetectExecuteScanCommand() *cobra.Command

DetectExecuteScanCommand Executes Synopsis Detect scan

func Execute

func Execute()

Execute is the starting point of the piper command line tool

func GctsCreateRepositoryCommand

func GctsCreateRepositoryCommand() *cobra.Command

GctsCreateRepositoryCommand Creates a Git repository on an ABAP system

func GithubCreatePullRequestCommand

func GithubCreatePullRequestCommand() *cobra.Command

GithubCreatePullRequestCommand Create a pull request on GitHub

func GithubPublishReleaseCommand

func GithubPublishReleaseCommand() *cobra.Command

GithubPublishReleaseCommand Publish a release in GitHub

func KarmaExecuteTestsCommand

func KarmaExecuteTestsCommand() *cobra.Command

KarmaExecuteTestsCommand Executes the Karma test runner

func KubernetesDeployCommand

func KubernetesDeployCommand() *cobra.Command

KubernetesDeployCommand Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster.

func MalwareExecuteScanCommand

func MalwareExecuteScanCommand() *cobra.Command

MalwareExecuteScanCommand Performs a malware scan

func MavenBuildCommand

func MavenBuildCommand() *cobra.Command

MavenBuildCommand This step will install the maven project into the local maven repository.

func MavenExecuteCommand

func MavenExecuteCommand() *cobra.Command

MavenExecuteCommand This step allows to run maven commands

func MavenExecuteStaticCodeChecksCommand

func MavenExecuteStaticCodeChecksCommand() *cobra.Command

MavenExecuteStaticCodeChecksCommand Execute static code checks for Maven based projects. The plugins SpotBugs and PMD are used.

func MtaBuildCommand

func MtaBuildCommand() *cobra.Command

MtaBuildCommand Performs an mta build

func NexusUploadCommand

func NexusUploadCommand() *cobra.Command

NexusUploadCommand Upload artifacts to Nexus Repository Manager

func NpmExecuteScriptsCommand

func NpmExecuteScriptsCommand() *cobra.Command

NpmExecuteScriptsCommand Execute npm run scripts on all npm packages in a project

func PrepareConfig

func PrepareConfig(cmd *cobra.Command, metadata *config.StepData, stepName string, options interface{}, openFile func(s string) (io.ReadCloser, error)) error

PrepareConfig reads step configuration from various sources and merges it (defaults, config file, flags, ...)

func ProtecodeExecuteScanCommand

func ProtecodeExecuteScanCommand() *cobra.Command

ProtecodeExecuteScanCommand Protecode is an Open Source Vulnerability Scanner that is capable of scanning binaries. It can be used to scan docker images but is supports many other programming languages especially those of the C family.

func SonarExecuteScanCommand

func SonarExecuteScanCommand() *cobra.Command

SonarExecuteScanCommand Executes the Sonar scanner

func VersionCommand

func VersionCommand() *cobra.Command

VersionCommand Returns the version of the piper binary

func XsDeployCommand

func XsDeployCommand() *cobra.Command

XsDeployCommand Performs xs deployment

Types

type Action

type Action int

Action ...

const (
	//None ...
	None Action = iota
	//Resume ...
	Resume Action = iota
	//Abort ...
	Abort Action = iota
	//Retry ...
	Retry Action = iota
)

func ValueOfAction

func ValueOfAction(str string) (Action, error)

ValueOfAction ...

func (Action) GetAction

func (a Action) GetAction() (string, error)

GetAction ...

func (Action) String

func (a Action) String() string

String ...

type DeployMode

type DeployMode int

DeployMode ...

const (
	// NoDeploy ...
	NoDeploy DeployMode = iota
	//Deploy ...
	Deploy DeployMode = iota
	//BGDeploy ...
	BGDeploy DeployMode = iota
)

func ValueOfMode

func ValueOfMode(str string) (DeployMode, error)

ValueOfMode ...

func (DeployMode) GetDeployCommand

func (m DeployMode) GetDeployCommand() (string, error)

GetDeployCommand ...

func (DeployMode) String

func (m DeployMode) String() string

String ...

type GeneralConfigOptions

type GeneralConfigOptions struct {
	CorrelationID  string
	CustomConfig   string
	DefaultConfig  []string //ordered list of Piper default configurations. Can be filePath or ENV containing JSON in format 'ENV:MY_ENV_VAR'
	ParametersJSON string
	EnvRootPath    string
	NoTelemetry    bool
	StageName      string
	StepConfigJSON string
	StepMetadata   string //metadata to be considered, can be filePath or ENV containing JSON in format 'ENV:MY_ENV_VAR'
	StepName       string
	Verbose        bool
	LogFormat      string
	HookConfig     HookConfiguration
}

GeneralConfigOptions contains all global configuration options for piper binary

var GeneralConfig GeneralConfigOptions

GeneralConfig contains global configuration flags for piper binary

type HookConfiguration

type HookConfiguration struct {
	SentryConfig SentryConfiguration `json:"sentry,omitempty"`
}

HookConfiguration contains the configuration for supported hooks, so far only Sentry is supported.

type MTABuildTarget

type MTABuildTarget int

MTABuildTarget ...

const (
	// NEO ...
	NEO MTABuildTarget = iota
	// CF ...
	CF MTABuildTarget = iota
	//XSA ...
	XSA MTABuildTarget = iota
)

func ValueOfBuildTarget

func ValueOfBuildTarget(str string) (MTABuildTarget, error)

ValueOfBuildTarget ...

func (MTABuildTarget) String

func (m MTABuildTarget) String() string

String ...

type SentryConfiguration

type SentryConfiguration struct {
	Dsn string `json:"dsn,omitempty"`
}

SentryConfiguration defines the configuration options for the Sentry logging system