mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
53f4ce96ae
* feat(cpe): provide go templating functions * change type * fix: type in test * chore: add comment for exported function * fix: ensure that custom returns string properly * fix types and add tests Co-authored-by: Anil Keshav <anil.keshav@sap.com>
84 lines
2.7 KiB
Go
84 lines
2.7 KiB
Go
package piperenv
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"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))
|
|
cErr := os.MkdirAll(filepath.Dir(filename), 0777)
|
|
if cErr != nil {
|
|
return fmt.Errorf("failed to create directory %v, %w", filepath.Dir(filename), cErr)
|
|
}
|
|
}
|
|
|
|
//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)
|
|
}
|