Documentation ¶
Index ¶
- Variables
- func AbapAddonAssemblyKitCheckCVsCommand() *cobra.Command
- func AbapAddonAssemblyKitCheckPVCommand() *cobra.Command
- func AbapAddonAssemblyKitCreateTargetVectorCommand() *cobra.Command
- func AbapAddonAssemblyKitPublishTargetVectorCommand() *cobra.Command
- func AbapAddonAssemblyKitRegisterPackagesCommand() *cobra.Command
- func AbapAddonAssemblyKitReleasePackagesCommand() *cobra.Command
- func AbapAddonAssemblyKitReserveNextPackagesCommand() *cobra.Command
- func AbapEnvironmentAssemblePackagesCommand() *cobra.Command
- func AbapEnvironmentCheckoutBranchCommand() *cobra.Command
- func AbapEnvironmentCloneGitRepoCommand() *cobra.Command
- func AbapEnvironmentCreateSystemCommand() *cobra.Command
- func AbapEnvironmentPullGitRepoCommand() *cobra.Command
- func AbapEnvironmentRunATCCheckCommand() *cobra.Command
- func ArtifactPrepareVersionCommand() *cobra.Command
- func CheckmarxExecuteScanCommand() *cobra.Command
- func CloudFoundryCreateServiceCommand() *cobra.Command
- func CloudFoundryCreateServiceKeyCommand() *cobra.Command
- func CloudFoundryCreateSpaceCommand() *cobra.Command
- func CloudFoundryDeleteServiceCommand() *cobra.Command
- func CloudFoundryDeleteSpaceCommand() *cobra.Command
- func CloudFoundryDeployCommand() *cobra.Command
- func CommandLineCompletionCommand() *cobra.Command
- func ConfigCommand() *cobra.Command
- func ContainerSaveImageCommand() *cobra.Command
- func DetectExecuteScanCommand() *cobra.Command
- func Execute()
- func FortifyExecuteScanCommand() *cobra.Command
- func GctsCloneRepositoryCommand() *cobra.Command
- func GctsCreateRepositoryCommand() *cobra.Command
- func GctsDeployCommand() *cobra.Command
- func GctsExecuteABAPUnitTestsCommand() *cobra.Command
- func GctsRollbackCommand() *cobra.Command
- func GetAllStepMetadata() map[string]config.StepData
- func GithubCheckBranchProtectionCommand() *cobra.Command
- func GithubCreatePullRequestCommand() *cobra.Command
- func GithubPublishReleaseCommand() *cobra.Command
- func GithubSetCommitStatusCommand() *cobra.Command
- func GitopsUpdateDeploymentCommand() *cobra.Command
- func HadolintExecuteCommand() *cobra.Command
- func JsonApplyPatchCommand() *cobra.Command
- func KanikoExecuteCommand() *cobra.Command
- func KarmaExecuteTestsCommand() *cobra.Command
- func KubernetesDeployCommand() *cobra.Command
- func MalwareExecuteScanCommand() *cobra.Command
- func MavenBuildCommand() *cobra.Command
- func MavenExecuteCommand() *cobra.Command
- func MavenExecuteIntegrationCommand() *cobra.Command
- func MavenExecuteStaticCodeChecksCommand() *cobra.Command
- func MtaBuildCommand() *cobra.Command
- func NexusUploadCommand() *cobra.Command
- func NpmExecuteLintCommand() *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 VaultRotateSecretIdCommand() *cobra.Command
- func VersionCommand() *cobra.Command
- func WhitesourceExecuteScanCommand() *cobra.Command
- func XsDeployCommand() *cobra.Command
- type ATCError
- type ATCObjects
- type ATCconfig
- type Action
- type DeployMode
- type File
- type GeneralConfigOptions
- type HadolintClient
- type HadolintPiperFileUtils
- type HookConfiguration
- type Link
- type MTABuildTarget
- type Package
- type Result
- type Run
- type ScanOptions
- type SentryConfiguration
- type Service
- type SoftwareComponent
Constants ¶
This section is empty.
Variables ¶
var GitCommit string
GitCommit ...
var GitTag string
GitTag ...
Functions ¶
func AbapAddonAssemblyKitCheckCVsCommand ¶ added in v1.85.0
AbapAddonAssemblyKitCheckCVsCommand This step checks the validity of Software Component Versions.
func AbapAddonAssemblyKitCheckPVCommand ¶ added in v1.85.0
AbapAddonAssemblyKitCheckPVCommand This step checks the validity of a Addon Product Version.
func AbapAddonAssemblyKitCreateTargetVectorCommand ¶ added in v1.85.0
AbapAddonAssemblyKitCreateTargetVectorCommand This step creates a Target Vector for software lifecycle operations
func AbapAddonAssemblyKitPublishTargetVectorCommand ¶ added in v1.85.0
AbapAddonAssemblyKitPublishTargetVectorCommand This step triggers the publication of the Target Vector according to the specified scope.
func AbapAddonAssemblyKitRegisterPackagesCommand ¶ added in v1.85.0
AbapAddonAssemblyKitRegisterPackagesCommand This step uploads the SAR archives and creates physical Delivery Packages in in the File Content Management System of SAP.
func AbapAddonAssemblyKitReleasePackagesCommand ¶ added in v1.85.0
AbapAddonAssemblyKitReleasePackagesCommand This step releases the physical Delivery Packages
func AbapAddonAssemblyKitReserveNextPackagesCommand ¶ added in v1.85.0
AbapAddonAssemblyKitReserveNextPackagesCommand This step determines the ABAP delivery packages (name and type), which are needed to deliver Software Component Versions.
func AbapEnvironmentAssemblePackagesCommand ¶ added in v1.77.0
AbapEnvironmentAssemblePackagesCommand Assembly of installation, support package or patch in SAP Cloud Platform ABAP Environment system
func AbapEnvironmentCheckoutBranchCommand ¶ added in v1.65.0
AbapEnvironmentCheckoutBranchCommand Switches between branches of a git repository on a SAP Cloud Platform ABAP Environment system
func AbapEnvironmentCloneGitRepoCommand ¶ added in v1.74.0
AbapEnvironmentCloneGitRepoCommand Clones a git repository to a SAP Cloud Platform ABAP Environment system
func AbapEnvironmentCreateSystemCommand ¶ added in v1.103.0
AbapEnvironmentCreateSystemCommand Creates a SAP Cloud Platform ABAP Environment system (aka Steampunk system)
func AbapEnvironmentPullGitRepoCommand ¶ added in v1.12.0
AbapEnvironmentPullGitRepoCommand Pulls a git repository to a SAP Cloud Platform ABAP Environment system
func AbapEnvironmentRunATCCheckCommand ¶ added in v1.33.0
AbapEnvironmentRunATCCheckCommand Runs an ATC Check
func ArtifactPrepareVersionCommand ¶ added in v1.20.0
ArtifactPrepareVersionCommand Prepares and potentially updates the artifact's version before building the artifact.
func CheckmarxExecuteScanCommand ¶ added in v1.11.0
CheckmarxExecuteScanCommand Checkmarx is the recommended tool for security scans of JavaScript, iOS, Swift and Ruby code.
func CloudFoundryCreateServiceCommand ¶ added in v1.74.0
CloudFoundryCreateServiceCommand Creates one or multiple Services in Cloud Foundry
func CloudFoundryCreateServiceKeyCommand ¶ added in v1.20.0
CloudFoundryCreateServiceKeyCommand cloudFoundryCreateServiceKey
func CloudFoundryCreateSpaceCommand ¶ added in v1.86.0
CloudFoundryCreateSpaceCommand Creates a user defined space in Cloud Foundry
func CloudFoundryDeleteServiceCommand ¶ added in v1.13.0
CloudFoundryDeleteServiceCommand DeleteCloudFoundryService
func CloudFoundryDeleteSpaceCommand ¶ added in v1.86.0
CloudFoundryDeleteSpaceCommand Deletes a space in Cloud Foundry
func CloudFoundryDeployCommand ¶ added in v1.64.0
CloudFoundryDeployCommand Deploys an application to Cloud Foundry
func CommandLineCompletionCommand ¶ added in v1.83.0
CommandLineCompletionCommand allows to generate convenience scripts for using the piper cli in a shell. See https://github.com/spf13/cobra/blob/master/shell_completions.md for docs on the subject.
func ConfigCommand ¶
ConfigCommand is the entry command for loading the configuration of a pipeline step
func ContainerSaveImageCommand ¶ added in v1.34.0
ContainerSaveImageCommand Saves a container image as a tar file
func DetectExecuteScanCommand ¶ added in v1.4.0
DetectExecuteScanCommand Executes Synopsys Detect scan
func FortifyExecuteScanCommand ¶ added in v1.38.0
FortifyExecuteScanCommand This step executes a Fortify scan on the specified project to perform static code analysis and check the source code for security flaws.
func GctsCloneRepositoryCommand ¶ added in v1.46.0
GctsCloneRepositoryCommand Clones a Git repository
func GctsCreateRepositoryCommand ¶ added in v1.24.0
GctsCreateRepositoryCommand Creates a Git repository on an ABAP system
func GctsDeployCommand ¶ added in v1.35.0
GctsDeployCommand Pulls a commit from the remote Git repository to a local repository
func GctsExecuteABAPUnitTestsCommand ¶ added in v1.56.0
GctsExecuteABAPUnitTestsCommand Runs ABAP unit tests for all packages of the specified repository
func GctsRollbackCommand ¶ added in v1.60.0
GctsRollbackCommand Perfoms roll back of one (default) or several commit(s)
func GetAllStepMetadata ¶ added in v1.108.0
GetStepMetadata return a map with all the step metadata mapped to their stepName
func GithubCheckBranchProtectionCommand ¶ added in v1.85.0
GithubCheckBranchProtectionCommand Check branch protection of a GitHub branch
func GithubCreatePullRequestCommand ¶ added in v1.5.0
GithubCreatePullRequestCommand Create a pull request on GitHub
func GithubPublishReleaseCommand ¶
GithubPublishReleaseCommand Publish a release in GitHub
func GithubSetCommitStatusCommand ¶ added in v1.85.0
GithubSetCommitStatusCommand Set a status of a certain commit.
func GitopsUpdateDeploymentCommand ¶ added in v1.95.0
GitopsUpdateDeploymentCommand Updates Kubernetes Deployment Manifest in an Infrastructure Git Repository
func HadolintExecuteCommand ¶ added in v1.108.0
HadolintExecuteCommand Executes the Haskell Dockerfile Linter which is a smarter Dockerfile linter that helps you build [best practice](https://docs.docker.com/develop/develop-images/dockerfile_best-practices/) Docker images.
func JsonApplyPatchCommand ¶ added in v1.46.0
JsonApplyPatchCommand Patches a json with a patch file
func KanikoExecuteCommand ¶ added in v1.55.0
KanikoExecuteCommand Executes a [Kaniko](https://github.com/GoogleContainerTools/kaniko) build for creating a Docker container.
func KarmaExecuteTestsCommand ¶
KarmaExecuteTestsCommand Executes the Karma test runner
func KubernetesDeployCommand ¶ added in v1.10.0
KubernetesDeployCommand Deployment to Kubernetes test or production namespace within the specified Kubernetes cluster.
func MalwareExecuteScanCommand ¶ added in v1.24.0
MalwareExecuteScanCommand Performs a malware scan
func MavenBuildCommand ¶ added in v1.17.0
MavenBuildCommand This step will install the maven project into the local maven repository.
func MavenExecuteCommand ¶ added in v1.15.0
MavenExecuteCommand This step allows to run maven commands
func MavenExecuteIntegrationCommand ¶ added in v1.62.0
MavenExecuteIntegrationCommand This step will execute backend integration tests via the Jacoco Maven-plugin.
func MavenExecuteStaticCodeChecksCommand ¶ added in v1.17.0
MavenExecuteStaticCodeChecksCommand Execute static code checks for Maven based projects. The plugins SpotBugs and PMD are used.
func MtaBuildCommand ¶ added in v1.15.0
MtaBuildCommand Performs an mta build
func NexusUploadCommand ¶ added in v1.18.0
NexusUploadCommand Upload artifacts to Nexus Repository Manager
func NpmExecuteLintCommand ¶ added in v1.47.0
NpmExecuteLintCommand Execute ci-lint script on all npm packages in a project or execute default linting
func NpmExecuteScriptsCommand ¶ added in v1.24.0
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 ¶ added in v1.12.0
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 ¶ added in v1.19.0
SonarExecuteScanCommand Executes the Sonar scanner
func VaultRotateSecretIdCommand ¶ added in v1.108.0
VaultRotateSecretIdCommand Rotate vault AppRole Secret ID
func VersionCommand ¶
VersionCommand Returns the version of the piper binary
func WhitesourceExecuteScanCommand ¶ added in v1.51.0
WhitesourceExecuteScanCommand BETA
func XsDeployCommand ¶ added in v1.3.0
XsDeployCommand Performs xs deployment
Types ¶
type ATCObjects ¶ added in v1.33.0
type ATCObjects struct { Package []Package `json:"package"` SoftwareComponent []SoftwareComponent `json:"softwarecomponent"` }
ATCObjects in form of packages and software components to be checked
type ATCconfig ¶ added in v1.33.0
type ATCconfig struct { CheckVariant string `json:"checkvariant,omitempty"` Configuration string `json:"configuration,omitempty"` Objects ATCObjects `json:"atcobjects"` }
ATCconfig object for parsing yaml config of software components and packages
type Action ¶ added in v1.3.0
type Action int
Action ...
func ValueOfAction ¶ added in v1.3.0
ValueOfAction ...
type DeployMode ¶ added in v1.3.0
type DeployMode int
DeployMode ...
const ( // NoDeploy ... NoDeploy DeployMode = iota //Deploy ... Deploy DeployMode = iota //BGDeploy ... BGDeploy DeployMode = iota )
func (DeployMode) GetDeployCommand ¶ added in v1.3.0
func (m DeployMode) GetDeployCommand() (string, error)
GetDeployCommand ...
type File ¶ added in v1.33.0
type File struct { Key string `xml:"name,attr"` Value string `xml:",chardata"` ATCErrors []ATCError `xml:"error"` }
File that contains ATC check with error for checked file
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' IgnoreCustomDefaults bool 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 VaultRoleID string VaultRoleSecretID string HookConfig HookConfiguration }
GeneralConfigOptions contains all global configuration options for piper binary
var GeneralConfig GeneralConfigOptions
GeneralConfig contains global configuration flags for piper binary
type HadolintClient ¶ added in v1.108.0
type HadolintClient interface { SetOptions(options piperhttp.ClientOptions) DownloadFile(url, filename string, header http.Header, cookies []*http.Cookie) error }
HadolintClient abstracts http.Client mock generated with: mockery --name hadolintClient --dir cmd --output pkg/hadolint/mocks
type HadolintPiperFileUtils ¶ added in v1.108.0
type HadolintPiperFileUtils interface { FileExists(filename string) (bool, error) FileWrite(filename string, data []byte, perm os.FileMode) error }
HadolintPiperFileUtils abstracts piperutils.Files mock generated with: mockery --name HadolintPiperFileUtils --dir cmd --output pkg/hadolint/mocks
type HookConfiguration ¶ added in v1.28.0
type HookConfiguration struct {
SentryConfig SentryConfiguration `json:"sentry,omitempty"`
}
HookConfiguration contains the configuration for supported hooks, so far only Sentry is supported.
type MTABuildTarget ¶ added in v1.15.0
type MTABuildTarget int
MTABuildTarget ...
const ( // NEO ... NEO MTABuildTarget = iota // CF ... CF MTABuildTarget = iota //XSA ... XSA MTABuildTarget = iota )
func ValueOfBuildTarget ¶ added in v1.15.0
func ValueOfBuildTarget(str string) (MTABuildTarget, error)
ValueOfBuildTarget ...
type Package ¶ added in v1.33.0
type Package struct { Name string `json:"name"` IncludeSubpackages bool `json:"includesubpackage"` }
Package for ATC run to be checked
type Run ¶ added in v1.33.0
type Run struct { XMLName xml.Name `xml:"run"` Status string `xml:"status,attr"` Link []Link `xml:"link"` }
Run Object for parsing XML
type ScanOptions ¶ added in v1.51.0
type ScanOptions = whitesourceExecuteScanOptions
just to make the lines less long
type SentryConfiguration ¶ added in v1.28.0
type SentryConfiguration struct {
Dsn string `json:"dsn,omitempty"`
}
SentryConfiguration defines the configuration options for the Sentry logging system
type Service ¶ added in v1.103.0
type Service struct { Name string `json:"name"` Broker string `json:"broker"` Plan string `json:"plan"` Parameters string `json:"parameters,omitempty"` }
Service struct for creating a cloud foundry service
type SoftwareComponent ¶ added in v1.33.0
type SoftwareComponent struct {
Name string `json:"name"`
}
SoftwareComponent for ATC run to be checked
Source Files ¶
- abapAddonAssemblyKitCheckCVs.go
- abapAddonAssemblyKitCheckCVs_generated.go
- abapAddonAssemblyKitCheckPV.go
- abapAddonAssemblyKitCheckPV_generated.go
- abapAddonAssemblyKitCreateTargetVector.go
- abapAddonAssemblyKitCreateTargetVector_generated.go
- abapAddonAssemblyKitPublishTargetVector.go
- abapAddonAssemblyKitPublishTargetVector_generated.go
- abapAddonAssemblyKitRegisterPackages.go
- abapAddonAssemblyKitRegisterPackages_generated.go
- abapAddonAssemblyKitReleasePackages.go
- abapAddonAssemblyKitReleasePackages_generated.go
- abapAddonAssemblyKitReserveNextPackages.go
- abapAddonAssemblyKitReserveNextPackages_generated.go
- abapEnvironmentAssemblePackages.go
- abapEnvironmentAssemblePackages_generated.go
- abapEnvironmentCheckoutBranch.go
- abapEnvironmentCheckoutBranch_generated.go
- abapEnvironmentCloneGitRepo.go
- abapEnvironmentCloneGitRepo_generated.go
- abapEnvironmentCreateSystem.go
- abapEnvironmentCreateSystem_generated.go
- abapEnvironmentPullGitRepo.go
- abapEnvironmentPullGitRepo_generated.go
- abapEnvironmentRunATCCheck.go
- abapEnvironmentRunATCCheck_generated.go
- artifactPrepareVersion.go
- artifactPrepareVersion_generated.go
- checkmarxExecuteScan.go
- checkmarxExecuteScan_generated.go
- cloudFoundryCreateService.go
- cloudFoundryCreateServiceKey.go
- cloudFoundryCreateServiceKey_generated.go
- cloudFoundryCreateService_generated.go
- cloudFoundryCreateSpace.go
- cloudFoundryCreateSpace_generated.go
- cloudFoundryDeleteService.go
- cloudFoundryDeleteService_generated.go
- cloudFoundryDeleteSpace.go
- cloudFoundryDeleteSpace_generated.go
- cloudFoundryDeploy.go
- cloudFoundryDeploy_generated.go
- completions.go
- containerSaveImage.go
- containerSaveImage_generated.go
- detectExecuteScan.go
- detectExecuteScan_generated.go
- fortifyExecuteScan.go
- fortifyExecuteScan_generated.go
- gctsCloneRepository.go
- gctsCloneRepository_generated.go
- gctsCreateRepository.go
- gctsCreateRepository_generated.go
- gctsDeploy.go
- gctsDeploy_generated.go
- gctsExecuteABAPUnitTests.go
- gctsExecuteABAPUnitTests_generated.go
- gctsRollback.go
- gctsRollback_generated.go
- getConfig.go
- githubCheckBranchProtection.go
- githubCheckBranchProtection_generated.go
- githubCreatePullRequest.go
- githubCreatePullRequest_generated.go
- githubPublishRelease.go
- githubPublishRelease_generated.go
- githubSetCommitStatus.go
- githubSetCommitStatus_generated.go
- gitopsUpdateDeployment.go
- gitopsUpdateDeployment_generated.go
- hadolintExecute.go
- hadolintExecute_generated.go
- jsonApplyPatch.go
- jsonApplyPatch_generated.go
- kanikoExecute.go
- kanikoExecute_generated.go
- karmaExecuteTests.go
- karmaExecuteTests_generated.go
- kubernetesDeploy.go
- kubernetesDeploy_generated.go
- malwareExecuteScan.go
- malwareExecuteScan_generated.go
- mavenBuild.go
- mavenBuild_generated.go
- mavenExecute.go
- mavenExecuteIntegration.go
- mavenExecuteIntegration_generated.go
- mavenExecuteStaticCodeChecks.go
- mavenExecuteStaticCodeChecks_generated.go
- mavenExecute_generated.go
- metadata_generated.go
- mtaBuild.go
- mtaBuild_generated.go
- nexusUpload.go
- nexusUpload_generated.go
- npmExecuteLint.go
- npmExecuteLint_generated.go
- npmExecuteScripts.go
- npmExecuteScripts_generated.go
- piper.go
- protecodeExecuteScan.go
- protecodeExecuteScan_generated.go
- sonarExecuteScan.go
- sonarExecuteScan_generated.go
- vaultRotateSecretId.go
- vaultRotateSecretId_generated.go
- version.go
- whitesourceExecuteScan.go
- whitesourceExecuteScan_generated.go
- xsDeploy.go
- xsDeploy_generated.go