mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +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>
80 lines
2.6 KiB
Go
80 lines
2.6 KiB
Go
package piperenv
|
|
|
|
import (
|
|
"encoding/json"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/SAP/jenkins-library/pkg/log"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// This file contains functions used to read/write pipeline environment data from/to disk.
|
|
// The content of a written file is the value. For the custom parameters this could for example also be a JSON representation of a more complex value.
|
|
|
|
// SetResourceParameter sets a resource parameter in the environment stored in the file system
|
|
func SetResourceParameter(path, resourceName, paramName string, value interface{}) error {
|
|
var content []byte
|
|
paramPath := filepath.Join(path, resourceName, paramName)
|
|
switch typedValue := value.(type) {
|
|
case string:
|
|
content = []byte(typedValue)
|
|
default:
|
|
var err error
|
|
paramPath += ".json"
|
|
content, err = json.Marshal(typedValue)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "failed to marshal resource parameter value %v", typedValue)
|
|
}
|
|
}
|
|
return writeToDisk(paramPath, content)
|
|
}
|
|
|
|
// GetResourceParameter reads a resource parameter from the environment stored in the file system
|
|
func GetResourceParameter(path, resourceName, paramName string) string {
|
|
//TODO: align JSON un/marshalling, currently done in pkg/config/stepmeta.go#getParameterValue
|
|
|
|
paramPath := filepath.Join(path, resourceName, paramName)
|
|
return readFromDisk(paramPath)
|
|
}
|
|
|
|
// SetParameter sets any parameter in the pipeline environment or another environment stored in the file system
|
|
func SetParameter(path, name, value string) error {
|
|
paramPath := filepath.Join(path, name)
|
|
return writeToDisk(paramPath, []byte(value))
|
|
}
|
|
|
|
// GetParameter reads any parameter from the pipeline environment or another environment stored in the file system
|
|
func GetParameter(path, name string) string {
|
|
paramPath := filepath.Join(path, name)
|
|
return readFromDisk(paramPath)
|
|
}
|
|
|
|
func writeToDisk(filename string, data []byte) error {
|
|
|
|
if _, err := os.Stat(filepath.Dir(filename)); os.IsNotExist(err) {
|
|
log.Entry().Debugf("Creating directory: %v", filepath.Dir(filename))
|
|
os.MkdirAll(filepath.Dir(filename), 0777)
|
|
}
|
|
|
|
//ToDo: make sure to not overwrite file but rather add another file? Create error if already existing?
|
|
if len(data) > 0 {
|
|
log.Entry().Debugf("Writing file to disk: %v", filename)
|
|
return ioutil.WriteFile(filename, data, 0766)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func readFromDisk(filename string) string {
|
|
//ToDo: if multiple files exist, read from latest file
|
|
log.Entry().Debugf("Reading file from disk: %v", filename)
|
|
v, err := ioutil.ReadFile(filename)
|
|
val := string(v)
|
|
if err != nil {
|
|
val = ""
|
|
}
|
|
return strings.TrimSpace(val)
|
|
}
|