mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-16 11:09:33 +02:00
42b92d1bfe
* Adds GetLog() function to orchestrator * Fixes BUILD_NUMBER env variable * Fixes correct env var for JENKINS_HOME * Adds getEnv to read env variables with default value, adds test for jenkins GetLog() implementation * Adds possibility to read errorJsons; updates splunk package for log files (WIP) * Uncommenting dev code * Adds GetLog() function to orchestrator * Fixes BUILD_NUMBER env variable * Fixes correct env var for JENKINS_HOME * Adds getEnv to read env variables with default value, adds test for jenkins GetLog() implementation * Adds possibility to read errorJsons; updates splunk package for log files (WIP) * Uncommenting dev code * Adds GetRequest function which holds the response in memory (not saved to disk) * Implements GetLog() function for ADO, adds function to read PipelineRuntime * PAT has been revoked * Changes http package, s.t. if password only is required basic auth works too * Adds env variable for azure token, error handling in case of unauthenticated/nil response * Adds logging output in case env variable can not be read and fallback variable needs to be used * Adds usage of environment variables for auth, uses jenkins api * Adds init functionality for orchestrators, updates GetLog() and GetPipelineStartTime() function * Adds initaliziation function for orchestrator authetnication * Adds settings struct for orchestrator authentication * Adds function to whole logfile to Splunk * Struct for pipeline related telemetry information * Increase messagebatch size to 10k * Changes splunk package to a pointer based implementation, updates generated files and corresponding template and tests for splunk * Changes telemetry package to pointer based implementation to have multiple telemetry objects, adjusted tests and splunk implementation * Changes content type to txt * Send telemetry independent of logfiles, increases amount of messages per file * Adds JobURL for orchestrators and UnknownOrchestrator as fallback * telemetry makes use of orchestrator specific information * Adds orchestrator independent correlationID * Adds custom fields for pipeline status * go fmt * Removes env var test - no env variables are read anymore * Use UnknownOrchestratorConfigProvider in case the orchestrator can not be initalized * Removes Custom fields from telemetry as these can not be reflected in SWA * Adds custom telemetry information (piperHash,..) to each step telemetry information * Removes falltrough in case no orchestrator has been found * Updates tests for orchestrator package * Adds orchestrator import in generated files * Updates generator files for internal library * Adds orchestrator telemetry information to steps * Updates generated files, fatalHook writes to cpe * Go generate from master, go fmt * Adds Custom Data field LastErrorCode * Removes GetLog() test * Update init_unix.go * Update docker_integration_test_executor.go * Update integration_api_cli_test.go * Reverts go1.17 fmt formatting * Reverts go1.17 fmt formatting * Reverts go1.17 fmt formatting * Renames customTelemetryData to stepTelemetryData * Adjustments to orchestrator-package, cleanup, adds JobName * Adjusts commonPipelineEnvironment path * Adds pipelineTelemetry struct to telemetry package, removes pipeline telemetry structs from splunk package * Go fmt * Changes path for errorDetails, adds debug information * Removes custom fields from step, adds orchestrator, commithash to baseMetadata * Adjusts tests for telemetry package * Adds tests for orchestrator * Updates generated files, initalization of splunk client only if its available in the config * Fixes typo in helper go * Update pkg/http/downloader.go * Update pkg/http/downloader.go * Update pkg/log/fatalHook.go * Update fatalHook.go * Update pkg/splunk/splunk.go * Update pkg/telemetry/data.go * Adds GetBuildStatus() and GetAPIInformation() to orchestrators * error formatting * Bugfix: dont send telemetry data if disabled, adjusts test * go fmt * Use correct error handling * Update pkg/telemetry/telemetry.go * Fixes telemetry disabled in the tests * Fixes http tests * Log fatal errors to logFile * Adds CustomReportingConfig to hooks * Cleanup comments in splunk package * Adds possibility to send telemetry to custom endpoint * Adds debug output for the payload * Debug output for the payload as a string * Adds test cases for changes in telemetry package * go fmt * Adds generated files for new step * Reverts changes for http tests, causing problems with go1.15, changes need to be applied for newer go version >=1.17 * Adjusts test for sonarExecuteScan * Adjusts test for sonarExecuteScan * Adds explanation for customreportingConfig * Makes disableing of customSend more obvious * Adds custom step reporting to each step, updates generated files, adjusts helper testdata * fixes unit test wrong usage of logging * Send pipeline data altough there has been no error, adjust test cases * Reverts changes for customReporting * Updates generated files, removes customReporting * Removes writing errorDetails to CPE * Reverts usage of customreporting * go fmt * reverts changes in http_test * reverts changes in http_test * Skips integration cnb test Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
109 lines
2.3 KiB
Go
109 lines
2.3 KiB
Go
package orchestrator
|
|
|
|
import (
|
|
"errors"
|
|
"github.com/SAP/jenkins-library/pkg/log"
|
|
"os"
|
|
"time"
|
|
)
|
|
|
|
type Orchestrator int
|
|
|
|
const (
|
|
Unknown Orchestrator = iota
|
|
AzureDevOps
|
|
GitHubActions
|
|
Jenkins
|
|
)
|
|
|
|
type OrchestratorSpecificConfigProviding interface {
|
|
InitOrchestratorProvider(settings *OrchestratorSettings)
|
|
OrchestratorType() string
|
|
OrchestratorVersion() string
|
|
GetStageName() string
|
|
GetBranch() string
|
|
GetBuildUrl() string
|
|
GetBuildId() string
|
|
GetJobUrl() string
|
|
GetJobName() string
|
|
GetCommit() string
|
|
GetPullRequestConfig() PullRequestConfig
|
|
GetRepoUrl() string
|
|
IsPullRequest() bool
|
|
GetLog() ([]byte, error)
|
|
GetPipelineStartTime() time.Time
|
|
GetBuildStatus() string
|
|
}
|
|
|
|
type PullRequestConfig struct {
|
|
Branch string
|
|
Base string
|
|
Key string
|
|
}
|
|
|
|
type OrchestratorSettings struct {
|
|
JenkinsUser string
|
|
JenkinsToken string
|
|
AzureToken string
|
|
}
|
|
|
|
func NewOrchestratorSpecificConfigProvider() (OrchestratorSpecificConfigProviding, error) {
|
|
switch DetectOrchestrator() {
|
|
case AzureDevOps:
|
|
return &AzureDevOpsConfigProvider{}, nil
|
|
case GitHubActions:
|
|
return &GitHubActionsConfigProvider{}, nil
|
|
case Jenkins:
|
|
return &JenkinsConfigProvider{}, nil
|
|
default:
|
|
return &UnknownOrchestratorConfigProvider{}, errors.New("unable to detect a supported orchestrator (Azure DevOps, GitHub Actions, Jenkins)")
|
|
}
|
|
}
|
|
|
|
func DetectOrchestrator() Orchestrator {
|
|
if isAzure() {
|
|
return Orchestrator(AzureDevOps)
|
|
} else if isGitHubActions() {
|
|
return Orchestrator(GitHubActions)
|
|
} else if isJenkins() {
|
|
return Orchestrator(Jenkins)
|
|
} else {
|
|
return Orchestrator(Unknown)
|
|
}
|
|
}
|
|
|
|
func (o Orchestrator) String() string {
|
|
return [...]string{"Unknown", "AzureDevOps", "GitHubActions", "Jenkins"}[o]
|
|
}
|
|
|
|
func areIndicatingEnvVarsSet(envVars []string) bool {
|
|
for _, v := range envVars {
|
|
if truthy(v) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Checks if var is set and neither empty nor false
|
|
func truthy(key string) bool {
|
|
val, exists := os.LookupEnv(key)
|
|
if !exists {
|
|
return false
|
|
}
|
|
if len(val) == 0 || val == "no" || val == "false" || val == "off" || val == "0" {
|
|
return false
|
|
}
|
|
|
|
return true
|
|
}
|
|
|
|
// Wrapper function to read env variable and set default value
|
|
func getEnv(key, fallback string) string {
|
|
if value, ok := os.LookupEnv(key); ok {
|
|
return value
|
|
}
|
|
log.Entry().Warnf("Could not read env variable %v using fallback value %v", key, fallback)
|
|
return fallback
|
|
}
|