cmd

package
v1.226.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 14, 2022 License: Apache-2.0 Imports: 113 Imported by: 0

Documentation

Index

Constants

View Source
const (
	PyBomFilename = "bom.xml"
)

Variables

View Source
var ErrorGaugeInstall error = errors.New("error installing gauge")
View Source
var ErrorGaugeRun error = errors.New("error running gauge")
View Source
var ErrorGaugeRunnerInstall error = errors.New("error installing runner")
View Source
var GitCommit string

GitCommit ...

View Source
var GitTag string

GitTag ...

Functions

func AbapAddonAssemblyKitCheckCVsCommand

func AbapAddonAssemblyKitCheckCVsCommand() *cobra.Command

AbapAddonAssemblyKitCheckCVsCommand This step checks the validity of ABAP Software Component Versions.

func AbapAddonAssemblyKitCheckPVCommand

func AbapAddonAssemblyKitCheckPVCommand() *cobra.Command

AbapAddonAssemblyKitCheckPVCommand This step checks the validity of a Addon Product Version.

func AbapAddonAssemblyKitCreateTargetVectorCommand

func AbapAddonAssemblyKitCreateTargetVectorCommand() *cobra.Command

AbapAddonAssemblyKitCreateTargetVectorCommand This step creates a Target Vector for software lifecycle operations

func AbapAddonAssemblyKitPublishTargetVectorCommand

func AbapAddonAssemblyKitPublishTargetVectorCommand() *cobra.Command

AbapAddonAssemblyKitPublishTargetVectorCommand This step triggers the publication of the Target Vector according to the specified scope.

func AbapAddonAssemblyKitRegisterPackagesCommand

func AbapAddonAssemblyKitRegisterPackagesCommand() *cobra.Command

AbapAddonAssemblyKitRegisterPackagesCommand This step uploads the SAR archives and creates physical Delivery Packages to AAKaaS.

func AbapAddonAssemblyKitReleasePackagesCommand

func AbapAddonAssemblyKitReleasePackagesCommand() *cobra.Command

AbapAddonAssemblyKitReleasePackagesCommand This step releases the physical Delivery Packages

func AbapAddonAssemblyKitReserveNextPackagesCommand

func AbapAddonAssemblyKitReserveNextPackagesCommand() *cobra.Command

AbapAddonAssemblyKitReserveNextPackagesCommand This step determines the ABAP delivery packages (name and type), which are needed to deliver Software Component Versions.

func AbapEnvironmentAssembleConfirmCommand

func AbapEnvironmentAssembleConfirmCommand() *cobra.Command

AbapEnvironmentAssembleConfirmCommand Confirm the Delivery of Assembly for installation, support package or patch in SAP Cloud Platform ABAP Environment system

func AbapEnvironmentAssemblePackagesCommand

func AbapEnvironmentAssemblePackagesCommand() *cobra.Command

AbapEnvironmentAssemblePackagesCommand Assembly of installation, support package or patch in SAP Cloud Platform ABAP Environment system

func AbapEnvironmentBuildCommand

func AbapEnvironmentBuildCommand() *cobra.Command

AbapEnvironmentBuildCommand Executes builds as defined with the build framework

func AbapEnvironmentCheckoutBranchCommand

func AbapEnvironmentCheckoutBranchCommand() *cobra.Command

AbapEnvironmentCheckoutBranchCommand Switches between branches of a git repository on a SAP BTP ABAP Environment system

func AbapEnvironmentCloneGitRepoCommand

func AbapEnvironmentCloneGitRepoCommand() *cobra.Command

AbapEnvironmentCloneGitRepoCommand Clones a git repository to a SAP BTP ABAP Environment system

func AbapEnvironmentCreateSystemCommand

func AbapEnvironmentCreateSystemCommand() *cobra.Command

AbapEnvironmentCreateSystemCommand Creates a SAP BTP ABAP Environment system (aka Steampunk system)

func AbapEnvironmentCreateTagCommand

func AbapEnvironmentCreateTagCommand() *cobra.Command

AbapEnvironmentCreateTagCommand Creates a tag for a git repository to a SAP BTP ABAP Environment system

func AbapEnvironmentPullGitRepoCommand

func AbapEnvironmentPullGitRepoCommand() *cobra.Command

AbapEnvironmentPullGitRepoCommand Pulls a git repository to a SAP BTP ABAP Environment system

func AbapEnvironmentPushATCSystemConfigCommand

func AbapEnvironmentPushATCSystemConfigCommand() *cobra.Command

AbapEnvironmentPushATCSystemConfigCommand Create/Update ATC System Configuration

func AbapEnvironmentRunATCCheckCommand

func AbapEnvironmentRunATCCheckCommand() *cobra.Command

AbapEnvironmentRunATCCheckCommand Runs an ATC Check

func AbapEnvironmentRunAUnitTestCommand

func AbapEnvironmentRunAUnitTestCommand() *cobra.Command

AbapEnvironmentRunAUnitTestCommand Runs an AUnit Test

func AccessTokensFromEnvJSON

func AccessTokensFromEnvJSON(env string) []string

AccessTokensFromEnvJSON resolves access tokens when passed as JSON in an environment variable

func ApiKeyValueMapDownloadCommand

func ApiKeyValueMapDownloadCommand() *cobra.Command

ApiKeyValueMapDownloadCommand Download a specific Key Value Map from the API Portal

func ApiKeyValueMapUploadCommand

func ApiKeyValueMapUploadCommand() *cobra.Command

ApiKeyValueMapUploadCommand this steps creates an API key value map artifact in the API Portal

func ApiProviderDownloadCommand

func ApiProviderDownloadCommand() *cobra.Command

ApiProviderDownloadCommand Download a specific API Provider from the API Portal

func ApiProviderUploadCommand

func ApiProviderUploadCommand() *cobra.Command

ApiProviderUploadCommand this steps creates an API provider artifact in the API Portal.

func ApiProxyDownloadCommand

func ApiProxyDownloadCommand() *cobra.Command

ApiProxyDownloadCommand Download a specific API Proxy from the API Portal

func ApiProxyUploadCommand

func ApiProxyUploadCommand() *cobra.Command

ApiProxyUploadCommand Upload an api proxy artifact in to the API Portal

func ArtifactPrepareVersionCommand

func ArtifactPrepareVersionCommand() *cobra.Command

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

func AwsS3UploadCommand

func AwsS3UploadCommand() *cobra.Command

AwsS3UploadCommand Uploads a specified file or directory into a given AWS S3 Bucket

func BatsExecuteTestsCommand

func BatsExecuteTestsCommand() *cobra.Command

BatsExecuteTestsCommand This step executes tests using the [Bash Automated Testing System - bats-core](https://github.com/bats-core/bats-core).

func CheckStepActiveCommand

func CheckStepActiveCommand() *cobra.Command

CheckStepActiveCommand is the entry command for checking if a step is active in a defined stage

func CheckmarxExecuteScanCommand

func CheckmarxExecuteScanCommand() *cobra.Command

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

func CloudFoundryCreateServiceCommand

func CloudFoundryCreateServiceCommand() *cobra.Command

CloudFoundryCreateServiceCommand Creates one or multiple Services in Cloud Foundry

func CloudFoundryCreateServiceKeyCommand

func CloudFoundryCreateServiceKeyCommand() *cobra.Command

CloudFoundryCreateServiceKeyCommand cloudFoundryCreateServiceKey

func CloudFoundryCreateSpaceCommand

func CloudFoundryCreateSpaceCommand() *cobra.Command

CloudFoundryCreateSpaceCommand Creates a user defined space in Cloud Foundry

func CloudFoundryDeleteServiceCommand

func CloudFoundryDeleteServiceCommand() *cobra.Command

CloudFoundryDeleteServiceCommand DeleteCloudFoundryService

func CloudFoundryDeleteSpaceCommand

func CloudFoundryDeleteSpaceCommand() *cobra.Command

CloudFoundryDeleteSpaceCommand Deletes a space in Cloud Foundry

func CloudFoundryDeployCommand

func CloudFoundryDeployCommand() *cobra.Command

CloudFoundryDeployCommand Deploys an application to Cloud Foundry

func CnbBuildCommand

func CnbBuildCommand() *cobra.Command

CnbBuildCommand Executes Cloud Native Buildpacks.

func CommandLineCompletionCommand

func CommandLineCompletionCommand() *cobra.Command

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

func ConfigCommand() *cobra.Command

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

func ContainerExecuteStructureTestsCommand

func ContainerExecuteStructureTestsCommand() *cobra.Command

ContainerExecuteStructureTestsCommand In this step [Container Structure Tests](https://github.com/GoogleContainerTools/container-structure-test) are executed.

func ContainerSaveImageCommand

func ContainerSaveImageCommand() *cobra.Command

ContainerSaveImageCommand Saves a container image as a tar file

func DefaultsCommand

func DefaultsCommand() *cobra.Command

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

func DeleteIntegrationArtifactResource

func DeleteIntegrationArtifactResource(config *integrationArtifactResourceOptions, httpClient piperhttp.Sender, fileUtils piperutils.FileUtils, apiHost string) error

DeleteIntegrationArtifactResource - Delete integration artifact resource file

func DetectExecuteScanCommand

func DetectExecuteScanCommand() *cobra.Command

DetectExecuteScanCommand Executes Synopsys Detect scan

func Equal

func Equal(a, b string) bool

func Execute

func Execute()

Execute is the starting point of the piper command line tool

func FortifyExecuteScanCommand

func FortifyExecuteScanCommand() *cobra.Command

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 GaugeExecuteTestsCommand

func GaugeExecuteTestsCommand() *cobra.Command

GaugeExecuteTestsCommand Installs gauge and executes specified gauge tests.

func GctsCloneRepositoryCommand

func GctsCloneRepositoryCommand() *cobra.Command

GctsCloneRepositoryCommand Clones a Git repository

func GctsCreateRepositoryCommand

func GctsCreateRepositoryCommand() *cobra.Command

GctsCreateRepositoryCommand Creates a Git repository on an ABAP system

func GctsDeployCommand

func GctsDeployCommand() *cobra.Command

GctsDeployCommand Deploys a Git Repository to a local Repository and then to an ABAP System

func GctsExecuteABAPQualityChecksCommand

func GctsExecuteABAPQualityChecksCommand() *cobra.Command

GctsExecuteABAPQualityChecksCommand Runs ABAP unit tests and ATC (ABAP Test Cockpit) checks for a specified object scope.

func GctsExecuteABAPUnitTestsCommand

func GctsExecuteABAPUnitTestsCommand() *cobra.Command

GctsExecuteABAPUnitTestsCommand Runs ABAP unit tests and ATC (ABAP Test Cockpit) checks for a specified object scope.

func GctsRollbackCommand

func GctsRollbackCommand() *cobra.Command

GctsRollbackCommand Perfoms a rollback of one (default) or several commits

func GetAllStepMetadata

func GetAllStepMetadata() map[string]config.StepData

GetStepMetadata return a map with all the step metadata mapped to their stepName

func GetDockerImageValue

func GetDockerImageValue(stepName string) (string, error)

GetDockerImageValue provides Piper commands additional access to configuration of step execution image if required

func GetJSONPayload

func GetJSONPayload(config *integrationArtifactResourceOptions, mode string, fileUtils piperutils.FileUtils) (*bytes.Buffer, error)

GetJSONPayload -return http payload as byte array

func GetJSONPayloadAsByteArray

func GetJSONPayloadAsByteArray(config *integrationArtifactUploadOptions, mode string, fileUtils piperutils.FileUtils) (*bytes.Buffer, error)

GetJSONPayloadAsByteArray -return http payload as byte array

func GetResourceFileExtension

func GetResourceFileExtension(filename string) string

GetResourceFileExtension -return resource file extension

func GetStageConfig

func GetStageConfig() (config.StepConfig, error)

GetStageConfig provides Piper commands additional access to stage configuration if required. This allows steps to refer to configuration parameters which are not part of the step itself.

func GithubCheckBranchProtectionCommand

func GithubCheckBranchProtectionCommand() *cobra.Command

GithubCheckBranchProtectionCommand Check branch protection of a GitHub branch

func GithubCommentIssueCommand

func GithubCommentIssueCommand() *cobra.Command

GithubCommentIssueCommand Comment on GitHub issues and pull requests.

func GithubCreateIssueCommand

func GithubCreateIssueCommand() *cobra.Command

GithubCreateIssueCommand Create a new GitHub issue.

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 GithubSetCommitStatusCommand

func GithubSetCommitStatusCommand() *cobra.Command

GithubSetCommitStatusCommand Set a status of a certain commit.

func GitopsUpdateDeploymentCommand

func GitopsUpdateDeploymentCommand() *cobra.Command

GitopsUpdateDeploymentCommand Updates Kubernetes Deployment Manifest in an Infrastructure Git Repository

func GolangBuildCommand

func GolangBuildCommand() *cobra.Command

GolangBuildCommand This step will execute a golang build.

func GradleExecuteBuildCommand

func GradleExecuteBuildCommand() *cobra.Command

GradleExecuteBuildCommand This step runs a gradle build command with parameters provided to the step.

func HadolintExecuteCommand

func HadolintExecuteCommand() *cobra.Command

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 HandleHttpResponse

func HandleHttpResponse(resp *http.Response, err error, message string, connectionDetails abaputils.ConnectionDetailsHTTP) error

func HelmExecuteCommand

func HelmExecuteCommand() *cobra.Command

HelmExecuteCommand Executes helm3 functionality as the package manager for Kubernetes.

func HttpResponseHandler

func HttpResponseHandler(resp *http.Response, httpErr error, integrationArtifactResourceData *integrationArtifactResourceData) error

HttpResponseHandler - handle http response object

func InfluxWriteDataCommand

func InfluxWriteDataCommand() *cobra.Command

InfluxWriteDataCommand Writes metrics to influxdb

func IntegrationArtifactDeployCommand

func IntegrationArtifactDeployCommand() *cobra.Command

IntegrationArtifactDeployCommand Deploy a CPI integration flow

func IntegrationArtifactDownloadCommand

func IntegrationArtifactDownloadCommand() *cobra.Command

IntegrationArtifactDownloadCommand Download integration flow runtime artefact

func IntegrationArtifactGetMplStatusCommand

func IntegrationArtifactGetMplStatusCommand() *cobra.Command

IntegrationArtifactGetMplStatusCommand Get the MPL status of an integration flow

func IntegrationArtifactGetServiceEndpointCommand

func IntegrationArtifactGetServiceEndpointCommand() *cobra.Command

IntegrationArtifactGetServiceEndpointCommand Get an deployed CPI intgeration flow service endpoint

func IntegrationArtifactResourceCommand

func IntegrationArtifactResourceCommand() *cobra.Command

IntegrationArtifactResourceCommand Add, Delete or Update an resource file of integration flow designtime artifact

func IntegrationArtifactTriggerIntegrationTestCommand

func IntegrationArtifactTriggerIntegrationTestCommand() *cobra.Command

IntegrationArtifactTriggerIntegrationTestCommand Test the service endpoint of your iFlow

func IntegrationArtifactUnDeployCommand

func IntegrationArtifactUnDeployCommand() *cobra.Command

IntegrationArtifactUnDeployCommand Undeploy a integration flow

func IntegrationArtifactUpdateConfigurationCommand

func IntegrationArtifactUpdateConfigurationCommand() *cobra.Command

IntegrationArtifactUpdateConfigurationCommand Update integration flow Configuration parameter

func IntegrationArtifactUploadCommand

func IntegrationArtifactUploadCommand() *cobra.Command

IntegrationArtifactUploadCommand Upload or Update an integration flow designtime artifact

func IsChangeInDevelopmentCommand

func IsChangeInDevelopmentCommand() *cobra.Command

IsChangeInDevelopmentCommand This step checks if a certain change is in status 'in development'

func JsonApplyPatchCommand

func JsonApplyPatchCommand() *cobra.Command

JsonApplyPatchCommand Patches a json with a patch file

func KanikoExecuteCommand

func KanikoExecuteCommand() *cobra.Command

KanikoExecuteCommand Executes a [Kaniko](https://github.com/GoogleContainerTools/kaniko) build for creating a Docker container.

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 using the [SAP Malware Scanning Service](https://help.sap.com/viewer/b416237f818c4e2e827f6118640079f8/LATEST/en-US/b7c9b86fe724458086a502df3160f380.html).

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 MavenExecuteIntegrationCommand

func MavenExecuteIntegrationCommand() *cobra.Command

MavenExecuteIntegrationCommand This step will execute backend integration tests via the Jacoco Maven-plugin.

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 NewmanExecuteCommand

func NewmanExecuteCommand() *cobra.Command

NewmanExecuteCommand Installs newman and executes specified newman collections.

func NexusUploadCommand

func NexusUploadCommand() *cobra.Command

NexusUploadCommand Upload artifacts to Nexus Repository Manager

func NpmExecuteLintCommand

func NpmExecuteLintCommand() *cobra.Command

NpmExecuteLintCommand Execute ci-lint script on all npm packages in a project or execute default linting

func NpmExecuteScriptsCommand

func NpmExecuteScriptsCommand() *cobra.Command

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

func PipelineCreateScanSummaryCommand

func PipelineCreateScanSummaryCommand() *cobra.Command

PipelineCreateScanSummaryCommand Collect scan result information anc create a summary report

func PrepareConfig

func PrepareConfig(cmd *cobra.Command, metadata *config.StepData, stepName string, options interface{}, openFile func(s string, t map[string]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 Black Duck Binary Analysis (BDBA), previously known as 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 PutFile

PutFile uploads a file to an AWS S3 bucket The function needs a context (including the AWS Region) and a PutObjectInput for the service call The return value is a PutObjectOutput with the result of the upload

func PythonBuildCommand

func PythonBuildCommand() *cobra.Command

PythonBuildCommand Step build a python project

func ReadPipelineEnv

func ReadPipelineEnv() *cobra.Command

ReadPipelineEnv reads the commonPipelineEnvironment from disk and outputs it as JSON

func ResolveAccessTokens

func ResolveAccessTokens(tokenList []string) map[string]string

ResolveAccessTokens reads a list of tokens in format host:token passed via command line and transfers this into a map as a more consumable format.

func ShellExecuteCommand

func ShellExecuteCommand() *cobra.Command

ShellExecuteCommand Step executes defined script

func SonarExecuteScanCommand

func SonarExecuteScanCommand() *cobra.Command

SonarExecuteScanCommand Executes the Sonar scanner

func TerraformExecuteCommand

func TerraformExecuteCommand() *cobra.Command

TerraformExecuteCommand Executes Terraform

func TransportRequestDocIDFromGitCommand

func TransportRequestDocIDFromGitCommand() *cobra.Command

TransportRequestDocIDFromGitCommand Retrieves change document ID from Git repository

func TransportRequestReqIDFromGitCommand

func TransportRequestReqIDFromGitCommand() *cobra.Command

TransportRequestReqIDFromGitCommand Retrieves the transport request ID from Git repository

func TransportRequestUploadCTSCommand

func TransportRequestUploadCTSCommand() *cobra.Command

TransportRequestUploadCTSCommand This step uploads an UI5 application to the SAPUI5 ABAP repository.

func TransportRequestUploadRFCCommand

func TransportRequestUploadRFCCommand() *cobra.Command

TransportRequestUploadRFCCommand This step uploads a UI5 application as ZIP file to the ABAP system via RFC connections.

func TransportRequestUploadSOLMANCommand

func TransportRequestUploadSOLMANCommand() *cobra.Command

TransportRequestUploadSOLMANCommand Uploads a specified file into a given transport via Solution Manager

func UiVeri5ExecuteTestsCommand

func UiVeri5ExecuteTestsCommand() *cobra.Command

UiVeri5ExecuteTestsCommand Executes UI5 e2e tests using uiVeri5

func Unequal

func Unequal(a, b string) bool

func UpdateIntegrationArtifact

func UpdateIntegrationArtifact(config *integrationArtifactUploadOptions, httpClient piperhttp.Sender, fileUtils piperutils.FileUtils, apiHost string) error

UpdateIntegrationArtifact - Update existing integration artifact

func UpdateIntegrationArtifactResource

func UpdateIntegrationArtifactResource(config *integrationArtifactResourceOptions, httpClient piperhttp.Sender, fileUtils piperutils.FileUtils, apiHost string) error

UpdateIntegrationArtifactResource - Update integration artifact resource file

func UploadIntegrationArtifact

func UploadIntegrationArtifact(config *integrationArtifactUploadOptions, httpClient piperhttp.Sender, fileUtils piperutils.FileUtils, apiHost string) error

UploadIntegrationArtifact - Upload new integration artifact

func UploadIntegrationArtifactResource

func UploadIntegrationArtifactResource(config *integrationArtifactResourceOptions, httpClient piperhttp.Sender, fileUtils piperutils.FileUtils, apiHost string) error

UploadIntegrationArtifactResource - Upload new resource file to existing integration flow design time artefact

func VaultRotateSecretIdCommand

func VaultRotateSecretIdCommand() *cobra.Command

VaultRotateSecretIdCommand Rotate Vault AppRole Secret ID

func VersionCommand

func VersionCommand() *cobra.Command

VersionCommand Returns the version of the piper binary

func WhitesourceExecuteScanCommand

func WhitesourceExecuteScanCommand() *cobra.Command

WhitesourceExecuteScanCommand Execute a WhiteSource scan

func WritePipelineEnv

func WritePipelineEnv() *cobra.Command

WritePipelineEnv Serializes the commonPipelineEnvironment JSON to disk

func XsDeployCommand

func XsDeployCommand() *cobra.Command

XsDeployCommand Performs xs deployment

Types

type ATCConfiguration

type ATCConfiguration struct {
	CheckVariant  string              `json:"checkvariant,omitempty"`
	Configuration string              `json:"configuration,omitempty"`
	Objects       ATCObjects          `json:"atcobjects"`
	ObjectSet     abaputils.ObjectSet `json:"objectset,omitempty"`
}

ATCConfiguration object for parsing yaml config of software components and packages

type ATCError

type ATCError struct {
	Text     string `xml:",chardata"`
	Message  string `xml:"message,attr"`
	Source   string `xml:"source,attr"`
	Line     string `xml:"line,attr"`
	Severity string `xml:"severity,attr"`
}

ATCError with message

type ATCObjects

type ATCObjects struct {
	Package           []Package           `json:"package"`
	SoftwareComponent []SoftwareComponent `json:"softwarecomponent"`
}

ATCObjects in form of packages and software components to be checked

type AUnitConfig

type AUnitConfig struct {
	Title     string              `json:"title,omitempty"`
	Context   string              `json:"context,omitempty"`
	Options   AUnitOptions        `json:"options,omitempty"`
	ObjectSet abaputils.ObjectSet `json:"objectset,omitempty"`
}

AUnitConfig object for parsing yaml config of software components and packages

type AUnitLink struct {
	Href string `xml:"href,attr"`
	Rel  string `xml:"rel,attr"`
	Type string `xml:"type,attr"`
}

AUnitLink containing result locations

type AUnitOptions

type AUnitOptions struct {
	Measurements string    `json:"measurements,omitempty"`
	Scope        Scope     `json:"scope,omitempty"`
	RiskLevel    RiskLevel `json:"risklevel,omitempty"`
	Duration     Duration  `json:"duration,omitempty"`
}

AUnitOptions in form of packages and software components to be checked

type AUnitResult

type AUnitResult struct {
	XMLName    xml.Name `xml:"testsuites"`
	Title      string   `xml:"title,attr"`
	System     string   `xml:"system,attr"`
	Client     string   `xml:"client,attr"`
	ExecutedBy string   `xml:"executedBy,attr"`
	Time       string   `xml:"time,attr"`
	Timestamp  string   `xml:"timestamp,attr"`
	Failures   string   `xml:"failures,attr"`
	Errors     string   `xml:"errors,attr"`
	Skipped    string   `xml:"skipped,attr"`
	Asserts    string   `xml:"asserts,attr"`
	Tests      string   `xml:"tests,attr"`
	Testsuite  struct {
		Tests     string `xml:"tests,attr"`
		Asserts   string `xml:"asserts,attr"`
		Skipped   string `xml:"skipped,attr"`
		Errors    string `xml:"errors,attr"`
		Failures  string `xml:"failures,attr"`
		Timestamp string `xml:"timestamp,attr"`
		Time      string `xml:"time,attr"`
		Hostname  string `xml:"hostname,attr"`
		Package   string `xml:"package,attr"`
		Name      string `xml:"name,attr"`
		Testcase  []struct {
			Asserts   string `xml:"asserts,attr"`
			Time      string `xml:"time,attr"`
			Name      string `xml:"name,attr"`
			Classname string `xml:"classname,attr"`
			Error     []struct {
				Text    string `xml:",chardata"`
				Type    string `xml:"type,attr"`
				Message string `xml:"message,attr"`
			} `xml:"error"`
			Failure []struct {
				Text    string `xml:",chardata"`
				Type    string `xml:"type,attr"`
				Message string `xml:"message,attr"`
			} `xml:"failure"`
			Skipped []struct {
				Text    string `xml:",chardata"`
				Message string `xml:"message,attr"`
			} `xml:"skipped"`
		} `xml:"testcase"`
	} `xml:"testsuite"`
}

type AUnitRun

type AUnitRun struct {
	XMLName    xml.Name   `xml:"run"`
	Title      string     `xml:"title,attr"`
	Context    string     `xml:"context,attr"`
	Progress   Progress   `xml:"progress"`
	ExecutedBy ExecutedBy `xml:"executedBy"`
	Time       Time       `xml:"time"`
	Link       AUnitLink  `xml:"link"`
}

AUnitRun Object for parsing XML

type AbapError

type AbapError struct {
	Code    string           `json:"code"`
	Message AbapErrorMessage `json:"message"`
}

AbapError contains the error code and the error message for ABAP errors

type AbapErrorMessage

type AbapErrorMessage struct {
	Lang  string `json:"lang"`
	Value string `json:"value"`
}

AbapErrorMessage contains the lanuage and value fields for ABAP errors

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 CreateTagBacklog

type CreateTagBacklog struct {
	// contains filtered or unexported fields
}

type CreateTagBody

type CreateTagBody struct {
	RepositoryName string `json:"sc_name"`
	CommitID       string `json:"commit_id"`
	Tag            string `json:"tag_name"`
	Description    string `json:"tag_description"`
}

type CreateTagResponse

type CreateTagResponse struct {
	UUID string `json:"uuid"`
}

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 Duration

type Duration struct {
	Short  *bool `json:"short,omitempty"`
	Medium *bool `json:"medium,omitempty"`
	Long   *bool `json:"long,omitempty"`
}

Duration in form of packages and software components to be checked

type ExecutedBy

type ExecutedBy struct {
	User string `xml:"user,attr"`
}

ExecutedBy User

type File

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 {
	GitHubAccessTokens   map[string]string // map of tokens with url as key in order to maintain url-specific tokens
	CorrelationID        string
	CustomConfig         string
	GitHubTokens         []string // list of entries in form of <server>:<token> to allow token authentication for downloading config / defaults
	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
	VaultToken           string
	VaultServerURL       string
	VaultNamespace       string
	VaultPath            string
	HookConfig           HookConfiguration
	MetaDataResolver     func() map[string]config.StepData
	GCPJsonKeyFilePath   string
	GCSFolderPath        string
	GCSBucketId          string
	GCSSubFolder         string
}

GeneralConfigOptions contains all global configuration options for piper binary

var GeneralConfig GeneralConfigOptions

GeneralConfig contains global configuration flags for piper binary

type GithubRepoClient

type GithubRepoClient interface {
	CreateRelease(ctx context.Context, owner string, repo string, release *github.RepositoryRelease) (*github.RepositoryRelease, *github.Response, error)
	DeleteReleaseAsset(ctx context.Context, owner string, repo string, id int64) (*github.Response, error)
	GetLatestRelease(ctx context.Context, owner string, repo string) (*github.RepositoryRelease, *github.Response, error)
	ListReleaseAssets(ctx context.Context, owner string, repo string, id int64, opt *github.ListOptions) ([]*github.ReleaseAsset, *github.Response, error)
	UploadReleaseAsset(ctx context.Context, owner string, repo string, id int64, opt *github.UploadOptions, file *os.File) (*github.ReleaseAsset, *github.Response, error)
}

mock generated with: mockery --name GithubRepoClient --dir cmd --output cmd/mocks

type HadolintClient

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

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

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

HookConfiguration contains the configuration for supported hooks, so far Sentry and Splunk are supported.

type Link struct {
	Key   string `xml:"href,attr"`
	Value string `xml:",chardata"`
}

Link of XML object

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 OperatorCallback

type OperatorCallback map[string]func(string, string) bool

type Package

type Package struct {
	Name               string `json:"name"`
	IncludeSubpackages bool   `json:"includesubpackage"`
}

Package for ATC run to be checked

type Progress

type Progress struct {
	Status     string `xml:"status,attr"`
	Percentage string `xml:"percentage,attr"`
}

Progress of AUnit run

type Result

type Result struct {
	XMLName xml.Name `xml:"checkstyle"`
	Files   []File   `xml:"file"`
}

Result from ATC check for all files that were checked

type RiskLevel

type RiskLevel struct {
	Harmless  *bool `json:"harmless,omitempty"`
	Dangerous *bool `json:"dangerous,omitempty"`
	Critical  *bool `json:"critical,omitempty"`
}

RiskLevel in form of packages and software components to be checked

type Run

type Run struct {
	XMLName xml.Name `xml:"run"`
	Status  string   `xml:"status,attr"`
	Link    []Link   `xml:"link"`
}

Run Object for parsing XML

type S3PutObjectAPI

type S3PutObjectAPI interface {
	PutObject(ctx context.Context,
		params *s3.PutObjectInput,
		optFns ...func(*s3.Options)) (*s3.PutObjectOutput, error)
}

S3PutObjectAPI defines the interface for the PutObject function. We use this interface to test the function using a mocked service.

type ScanOptions

type ScanOptions = whitesourceExecuteScanOptions

ScanOptions is just used to make the lines less long

type Scope

type Scope struct {
	OwnTests     *bool `json:"owntests,omitempty"`
	ForeignTests *bool `json:"foreigntests,omitempty"`
}

Scope in form of packages and software components to be checked

type SentryConfiguration

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

SentryConfiguration defines the configuration options for the Sentry logging system

type Service

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

type SoftwareComponent struct {
	Name string `json:"name"`
}

SoftwareComponent for ATC run to be checked

type SplunkConfiguration

type SplunkConfiguration struct {
	Dsn      string `json:"dsn,omitempty"`
	Token    string `json:"token,omitempty"`
	Index    string `json:"index,omitempty"`
	SendLogs bool   `json:"sendLogs"`
}

SplunkConfiguration defines the configuration options for the Splunk logging system

type Tag

type Tag struct {
	// contains filtered or unexported fields
}

type Time

type Time struct {
	Started string `xml:"started,attr"`
	Ended   string `xml:"ended,attr"`
}

Time run was started and finished

type UploadAction

type UploadAction interface {
	Perform(command.ShellRunner) error
	WithConnection(cts.Connection)
	WithApplication(cts.Application)
	WithNodeProperties(cts.Node)
	WithTransportRequestID(string)
	WithConfigFile(string)
	WithDeployUser(string)
}

UploadAction ...

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL