util

package
v0.0.0-...-89916a2 Latest Latest
Warning

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

 Go to latest Published: Oct 3, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	BlobStorageObjectTypeCache    = "cache"
	BlobStorageObjectTypeArtifact = "artifact"
	BlobStorageObjectTypeLog      = "log"
)
View Source 
const (
	DEVTRON                      = "DEVTRON"
	DEFAULT_KEY                  = "default"
	INSECURE                     = "insecure"
	SECUREWITHCERT               = "secure-with-cert"
	DOCKER_PS_START_WAIT_SECONDS = 150
	HOMEDIR                      = "/"
	WORKINGDIR                   = "/devtroncd"
	LOCAL_BUILDX_LOCATION        = "/var/lib/devtron/buildx"
	LOCAL_BUILDX_CACHE_LOCATION  = LOCAL_BUILDX_LOCATION + "/cache"
	CIEVENT                      = "CI"
	JOBEVENT                     = "JOB"
	CDSTAGE                      = "CD"
	DRY_RUN                      = "DryRun"
	ENV_VARIABLE_BUILD_SUCCESS   = "BUILD_SUCCESS"
	CiCdEventEnvKey              = "CI_CD_EVENT"
	Source_Signal                = "Source_Signal"
	Source_Defer                 = "Source_Defer"
	DefaultErrorCode             = 1
	AbortErrorCode               = 143
	CiStageFailErrorCode         = 2
	InAppLogging                 = "IN_APP_LOGGING"
	CiRunnerCommand              = "./cirunner"
	TeeCommand                   = "tee"
	LogFileName                  = "main.log"
	NewLineChar                  = "\n"
)
View Source 
const (
	ResultsDirInCIRunnerPath = "/polling-plugin/results.json"
	PluginArtifactsResults   = "/tmp/pluginArtifacts/results.json"
)
View Source 
const (
	SSH_PRIVATE_KEY_DIR       = ".ssh"
	SSH_PRIVATE_KEY_FILE_NAME = "id_rsa"
	GIT_CREDENTIAL_FILE_NAME  = ".git-credentials"
	CLONING_MODE_SHALLOW      = "SHALLOW"
	CLONING_MODE_FULL         = "FULL"
)
View Source 
const (
	CACHE_PULL                           = "Pulling Cache"
	GIT_CLONE_CHECKOUT                   = "Git Clone & Checkout"
	DOCKER_DAEMON                        = "Starting Docker Daemon"
	DOCKER_LOGIN_STAGE                   = "Docker Login"
	DOCKER_PUSH                          = "Docker Push"
	DOCKER_BUILD                         = "Docker Build"
	DOCKER_STOP                          = "Docker Stop"
	BUILD_ARTIFACT                       = "Build Artifact"
	UPLOAD_ARTIFACT                      = "Uploading Artifact"
	PUSH_CACHE                           = "Pushing Cache"
	DOCKER_PUSH_AND_EXTRACT_IMAGE_DIGEST = "Docker Push And Extract Image Digest"
	IMAGE_SCAN                           = "Image Scanning"
	SETUP_BUILDX_BUILDER                 = "Setting Up Buildx Builder"
	CLEANUP_BUILDX_BUILDER               = "Cleaning Up Buildx Builder"
	BUILD_PACK_BUILD                     = "Build Packs Build"
	EXPORT_BUILD_CACHE                   = "Exporting Build Cache"
)

Variables

View Source 
var (
	TmpArtifactLocation = "./job-artifact"
	TmpLogLocation      = "/main.log"
	Output_path         = filepath.Join(WORKINGDIR, "./process")

	Bash_script = filepath.Join("_script.sh")
)

Functions

func CheckFileExists 

func CheckFileExists(filename string) (bool, error)

CheckFileExists returns boolean value of file existence else error (ignoring file does not exist error)

func CleanupAfterFetchingHttpsSubmodules 

func CleanupAfterFetchingHttpsSubmodules() error

func CreateAndWriteFile 

func CreateAndWriteFile(filePath string, content string) error

func CreateGitCredentialFileAndWriteData 

func CreateGitCredentialFileAndWriteData(data string) error

func CreateSshPrivateKeyOnDisk 

func CreateSshPrivateKeyOnDisk(fileId int, sshPrivateKeyContent string) error

func DeleteFile 

func DeleteFile(path string) error

func ExecuteWithStageInfoLog 

func ExecuteWithStageInfoLog(stageName string, stageExecutor func() error) (err error)

ExecuteWithStageInfoLog logs the stage info. it will log info for pre stage execution and post the stage execution return the error returned by the stageExecutor func

func Generate 

func Generate(size int) string

Generates random string

func GenerateBuildkitdContent 

func GenerateBuildkitdContent(host string) string

func GetBlobStorageBaseAzureConfig 

func GetBlobStorageBaseAzureConfig(b *blob_storage.AzureBlobConfig, blobStorageObjectType string) *blob_storage.AzureBlobBaseConfig

func GetBlobStorageBaseGcpConfig 

func GetBlobStorageBaseGcpConfig(b *blob_storage.GcpBlobConfig, blobStorageObjectType string) *blob_storage.GcpBlobBaseConfig

func GetBlobStorageBaseS3Config 

func GetBlobStorageBaseS3Config(b *blob_storage.BlobStorageS3Config, blobStorageObjectType string) *blob_storage.AwsS3BaseConfig

func GetProjectName 

func GetProjectName(url string) string

GetProjectName this function has been designed for returning project name of git-lab and git-hub providers only do not remove this function

func ParseUrl 

func ParseUrl(rawURL string) (parsedURL *url.URL, err error)

func RunCommand 

func RunCommand(cmd *exec.Cmd) error

func SpawnProcessWithLogging 

func SpawnProcessWithLogging()

SpawnProcessWithLogging This method handles the logic for maintaining a local log file for log archival and handles SIGTERM propagation. The subprocess spawned will bypass this function and execute the main logic

Types

type BlobStorageConfig 

type BlobStorageConfig struct {
	//AWS credentials
	CloudProvider      blob_storage.BlobStorageType `env:"BLOB_STORAGE_PROVIDER"`
	S3AccessKey        string                       `env:"BLOB_STORAGE_S3_ACCESS_KEY"`
	S3SecretKey        string                       `env:"BLOB_STORAGE_S3_SECRET_KEY"`
	S3Endpoint         string                       `env:"BLOB_STORAGE_S3_ENDPOINT"`
	S3EndpointInsecure bool                         `env:"BLOB_STORAGE_S3_ENDPOINT_INSECURE" envDefault:"false"`
	S3BucketVersioned  bool                         `env:"BLOB_STORAGE_S3_BUCKET_VERSIONED" envDefault:"true"`
	//artifact and logs bucket name in s3 will get their values from DEFAULT_BUILD_LOGS_BUCKET
	CdDefaultBuildLogsBucket string `env:"DEFAULT_BUILD_LOGS_BUCKET" `
	//logs and artifact region in s3 will get their values from DEFAULT_CD_LOGS_BUCKET_REGION
	CdDefaultCdLogsBucketRegion string `env:"DEFAULT_CD_LOGS_BUCKET_REGION" `
	//cache bucket name in s3 will get its value from DEFAULT_CACHE_BUCKET
	DefaultCacheBucket string `env:"DEFAULT_CACHE_BUCKET"`
	//cache region in s3 will get its value from DEFAULT_CACHE_BUCKET_REGION
	DefaultCacheBucketRegion string `env:"DEFAULT_CACHE_BUCKET_REGION"`

	//GCP credentials
	GcpBlobStorageCredentialJson string `env:"BLOB_STORAGE_GCP_CREDENTIALS_JSON"`

	//Azure credentials
	AzureAccountName               string `env:"AZURE_ACCOUNT_NAME"`
	AzureGatewayUrl                string `env:"AZURE_GATEWAY_URL"`
	AzureGatewayConnectionInsecure bool   `env:"AZURE_GATEWAY_CONNECTION_INSECURE" envDefault:"true"`
	AzureAccountKey                string `env:"AZURE_ACCOUNT_KEY"`
	//log and artifact container name in azure will get their values from AZURE_BLOB_CONTAINER_CI_LOG
	AzureBlobContainerCiLog string `env:"AZURE_BLOB_CONTAINER_CI_LOG"`
	//cache container name in azure will get their values from AZURE_BLOB_CONTAINER_CI_CACHE
	AzureBlobContainerCiCache string `env:"AZURE_BLOB_CONTAINER_CI_CACHE"`
}

BlobStorageConfig is the blob storage config for external cluster added via cm/secret code will be expecting these env variables acc to cloud provider if UseExternalClusterBlob is true.

func GetBlobStorageConfig 

func GetBlobStorageConfig() (*BlobStorageConfig, error)

type CloudHelperBaseConfig 

type CloudHelperBaseConfig struct {
	StorageModuleConfigured bool
	BlobStorageLogKey       string
	CloudProvider           blob_storage.BlobStorageType
	UseExternalClusterBlob  bool
	BlobStorageS3Config     *blob_storage.BlobStorageS3Config
	AzureBlobConfig         *blob_storage.AzureBlobConfig
	GcpBlobConfig           *blob_storage.GcpBlobConfig
	BlobStorageObjectType   string
}

func (*CloudHelperBaseConfig) SetAwsBlobStorageS3Config 

func (c *CloudHelperBaseConfig) SetAwsBlobStorageS3Config(blobStorageConfig *BlobStorageConfig)

func (*CloudHelperBaseConfig) SetAzureBlobStorageConfig 

func (c *CloudHelperBaseConfig) SetAzureBlobStorageConfig(blobStorageConfig *BlobStorageConfig)

func (*CloudHelperBaseConfig) SetGcpBlobStorageConfig 

func (c *CloudHelperBaseConfig) SetGcpBlobStorageConfig(blobStorageConfig *BlobStorageConfig)

type StageLogData 

type StageLogData struct {
	//eg : 'STAGE_INFO|{"stage":"Resource availability","startTime":"2021-01-01T00:00:00Z"}'
	Stage     string     `json:"stage,omitempty"`
	StartTime *time.Time `json:"startTime,omitempty"`
	EndTime   *time.Time `json:"endTime,omitempty"`
	Status    Status     `json:"status,omitempty"`
}

type Status 

type Status string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.