mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
157f6d4e35
* including negative conditions * clean up and todos * removing debug logging * clean up * fix unit test name * fixing unit tests * negative stage test Co-authored-by: anilkeshav27 <you@example.com> Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
439 lines
14 KiB
Go
439 lines
14 KiB
Go
package config
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"path"
|
|
"strings"
|
|
|
|
"github.com/SAP/jenkins-library/pkg/orchestrator"
|
|
"github.com/SAP/jenkins-library/pkg/piperutils"
|
|
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
const (
|
|
configCondition = "config"
|
|
configKeysCondition = "configKeys"
|
|
filePatternFromConfigCondition = "filePatternFromConfig"
|
|
filePatternCondition = "filePattern"
|
|
npmScriptsCondition = "npmScripts"
|
|
)
|
|
|
|
// EvaluateConditionsV1 validates stage conditions and updates runSteps in runConfig according to V1 schema
|
|
func (r *RunConfigV1) evaluateConditionsV1(config *Config, filters map[string]StepFilters, parameters map[string][]StepParameters,
|
|
secrets map[string][]StepSecrets, stepAliases map[string][]Alias, utils piperutils.FileUtils) error {
|
|
|
|
// initialize in case not initialized
|
|
if r.RunConfig.RunSteps == nil {
|
|
r.RunConfig.RunSteps = map[string]map[string]bool{}
|
|
}
|
|
if r.RunConfig.RunStages == nil {
|
|
r.RunConfig.RunStages = map[string]bool{}
|
|
}
|
|
|
|
for _, stage := range r.PipelineConfig.Spec.Stages {
|
|
runStep := map[string]bool{}
|
|
stageActive := false
|
|
|
|
// currently displayName is used, may need to consider to use technical name as well
|
|
stageName := stage.DisplayName
|
|
|
|
for _, step := range stage.Steps {
|
|
// Only consider orchestrator-specific steps in case orchestrator limitation is set
|
|
currentOrchestrator := orchestrator.DetectOrchestrator().String()
|
|
if len(step.Orchestrators) > 0 && !piperutils.ContainsString(step.Orchestrators, currentOrchestrator) {
|
|
continue
|
|
}
|
|
|
|
stepActive := false
|
|
stepNotActive := false
|
|
stepConfig, err := r.getStepConfig(config, stageName, step.Name, filters, parameters, secrets, stepAliases)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if active, ok := stepConfig.Config[step.Name].(bool); ok {
|
|
// respect explicit activation/de-activation if available
|
|
stepActive = active
|
|
} else {
|
|
if step.Conditions == nil || len(step.Conditions) == 0 {
|
|
// if no condition is available, step will be active by default
|
|
stepActive = true
|
|
} else {
|
|
for _, condition := range step.Conditions {
|
|
stepActive, err = condition.evaluateV1(stepConfig, utils)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to evaluate stage conditions: %w", err)
|
|
}
|
|
if stepActive {
|
|
// first condition which matches will be considered to activate the step
|
|
break
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// TODO: PART 1 : if explicit activation/de-activation is available should notActiveConditions be checked ?
|
|
// Fortify has no anchor, so if we explicitly set it to true then it may run even during commit pipelines, if we implement TODO PART 1??
|
|
for _, condition := range step.NotActiveConditions {
|
|
stepNotActive, err = condition.evaluateV1(stepConfig, utils)
|
|
if err != nil {
|
|
return fmt.Errorf("failed to evaluate not active stage conditions: %w", err)
|
|
}
|
|
if stepNotActive {
|
|
// first condition which matches will be considered to not activate the step
|
|
break
|
|
}
|
|
}
|
|
|
|
// final decision is when step is activated and negate when not active is true
|
|
stepActive = stepActive && !stepNotActive
|
|
|
|
if stepActive {
|
|
stageActive = true
|
|
}
|
|
runStep[step.Name] = stepActive
|
|
r.RunSteps[stageName] = runStep
|
|
}
|
|
r.RunStages[stageName] = stageActive
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *StepCondition) evaluateV1(config StepConfig, utils piperutils.FileUtils) (bool, error) {
|
|
|
|
// only the first condition will be evaluated.
|
|
// if multiple conditions should be checked they need to provided via the Conditions list
|
|
if s.Config != nil {
|
|
|
|
if len(s.Config) > 1 {
|
|
return false, errors.Errorf("only one config key allowed per condition but %v provided", len(s.Config))
|
|
}
|
|
|
|
// for loop will only cover first entry since we throw an error in case there is more than one config key defined already above
|
|
for param, activationValues := range s.Config {
|
|
for _, activationValue := range activationValues {
|
|
if activationValue == config.Config[param] {
|
|
return true, nil
|
|
}
|
|
}
|
|
return false, nil
|
|
}
|
|
}
|
|
|
|
if len(s.ConfigKey) > 0 {
|
|
if configValue := config.Config[s.ConfigKey]; configValue != nil {
|
|
return true, nil
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
if len(s.FilePattern) > 0 {
|
|
files, err := utils.Glob(s.FilePattern)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "failed to check filePattern condition")
|
|
}
|
|
if len(files) > 0 {
|
|
return true, nil
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
if len(s.FilePatternFromConfig) > 0 {
|
|
|
|
configValue := fmt.Sprint(config.Config[s.FilePatternFromConfig])
|
|
if len(configValue) == 0 {
|
|
return false, nil
|
|
}
|
|
files, err := utils.Glob(configValue)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "failed to check filePatternFromConfig condition")
|
|
}
|
|
if len(files) > 0 {
|
|
return true, nil
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
if len(s.NpmScript) > 0 {
|
|
return checkForNpmScriptsInPackagesV1(s.NpmScript, config, utils)
|
|
}
|
|
|
|
// needs to be checked last:
|
|
// if none of the other conditions matches, step will be active unless set to inactive
|
|
if s.Inactive == true {
|
|
return false, nil
|
|
} else {
|
|
return true, nil
|
|
}
|
|
}
|
|
|
|
// EvaluateConditions validates stage conditions and updates runSteps in runConfig
|
|
func (r *RunConfig) evaluateConditions(config *Config, filters map[string]StepFilters, parameters map[string][]StepParameters,
|
|
secrets map[string][]StepSecrets, stepAliases map[string][]Alias, glob func(pattern string) (matches []string, err error)) error {
|
|
for stageName, stepConditions := range r.StageConfig.Stages {
|
|
runStep := map[string]bool{}
|
|
for stepName, stepCondition := range stepConditions.Conditions {
|
|
stepActive := false
|
|
stepConfig, err := r.getStepConfig(config, stageName, stepName, filters, parameters, secrets, stepAliases)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if active, ok := stepConfig.Config[stepName].(bool); ok {
|
|
// respect explicit activation/de-activation if available
|
|
stepActive = active
|
|
} else {
|
|
for conditionName, condition := range stepCondition {
|
|
var err error
|
|
switch conditionName {
|
|
case configCondition:
|
|
if stepActive, err = checkConfig(condition, stepConfig, stepName); err != nil {
|
|
return errors.Wrapf(err, "error: check config condition failed")
|
|
}
|
|
case configKeysCondition:
|
|
if stepActive, err = checkConfigKeys(condition, stepConfig, stepName); err != nil {
|
|
return errors.Wrapf(err, "error: check configKeys condition failed")
|
|
}
|
|
case filePatternFromConfigCondition:
|
|
if stepActive, err = checkForFilesWithPatternFromConfig(condition, stepConfig, stepName, glob); err != nil {
|
|
return errors.Wrapf(err, "error: check filePatternFromConfig condition failed")
|
|
}
|
|
case filePatternCondition:
|
|
if stepActive, err = checkForFilesWithPattern(condition, stepConfig, stepName, glob); err != nil {
|
|
return errors.Wrapf(err, "error: check filePattern condition failed")
|
|
}
|
|
case npmScriptsCondition:
|
|
if stepActive, err = checkForNpmScriptsInPackages(condition, stepConfig, stepName, glob, r.OpenFile); err != nil {
|
|
return errors.Wrapf(err, "error: check npmScripts condition failed")
|
|
}
|
|
default:
|
|
return errors.Errorf("unknown condition %s", conditionName)
|
|
}
|
|
if stepActive {
|
|
break
|
|
}
|
|
}
|
|
}
|
|
runStep[stepName] = stepActive
|
|
r.RunSteps[stageName] = runStep
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func checkConfig(condition interface{}, config StepConfig, stepName string) (bool, error) {
|
|
switch condition := condition.(type) {
|
|
case string:
|
|
if configValue := stepConfigLookup(config.Config, stepName, condition); configValue != nil {
|
|
return true, nil
|
|
}
|
|
case map[string]interface{}:
|
|
for conditionConfigKey, conditionConfigValue := range condition {
|
|
configValue := stepConfigLookup(config.Config, stepName, conditionConfigKey)
|
|
if configValue == nil {
|
|
return false, nil
|
|
}
|
|
configValueStr, ok := configValue.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: config value of %v to compare with is not a string", configValue)
|
|
}
|
|
condConfigValueArr, ok := conditionConfigValue.([]interface{})
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to []interface{} failed: %T", conditionConfigValue)
|
|
}
|
|
for _, item := range condConfigValueArr {
|
|
itemStr, ok := item.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to string failed: %T", conditionConfigValue)
|
|
}
|
|
if configValueStr == itemStr {
|
|
return true, nil
|
|
}
|
|
}
|
|
}
|
|
default:
|
|
return false, errors.Errorf("error: condidiion type invalid: %T, possible types: string, map[string]interface{}", condition)
|
|
}
|
|
|
|
return false, nil
|
|
}
|
|
|
|
func checkConfigKey(configKey string, config StepConfig, stepName string) (bool, error) {
|
|
if configValue := stepConfigLookup(config.Config, stepName, configKey); configValue != nil {
|
|
return true, nil
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func checkConfigKeys(condition interface{}, config StepConfig, stepName string) (bool, error) {
|
|
arrCondition, ok := condition.([]interface{})
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to []interface{} failed: %T", condition)
|
|
}
|
|
for _, configKey := range arrCondition {
|
|
if configValue := stepConfigLookup(config.Config, stepName, configKey.(string)); configValue != nil {
|
|
return true, nil
|
|
}
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func checkForFilesWithPatternFromConfig(condition interface{}, config StepConfig, stepName string,
|
|
glob func(pattern string) (matches []string, err error)) (bool, error) {
|
|
filePatternConfig, ok := condition.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to string failed: %T", condition)
|
|
}
|
|
filePatternFromConfig := stepConfigLookup(config.Config, stepName, filePatternConfig)
|
|
if filePatternFromConfig == nil {
|
|
return false, nil
|
|
}
|
|
filePattern, ok := filePatternFromConfig.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to string failed: %T", filePatternFromConfig)
|
|
}
|
|
matches, err := glob(filePattern)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "error: failed to check if file-exists")
|
|
}
|
|
if len(matches) > 0 {
|
|
return true, nil
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func checkForFilesWithPattern(condition interface{}, config StepConfig, stepName string,
|
|
glob func(pattern string) (matches []string, err error)) (bool, error) {
|
|
switch condition := condition.(type) {
|
|
case string:
|
|
filePattern := condition
|
|
matches, err := glob(filePattern)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "error: failed to check if file-exists")
|
|
}
|
|
if len(matches) > 0 {
|
|
return true, nil
|
|
}
|
|
case []interface{}:
|
|
filePatterns := condition
|
|
for _, filePattern := range filePatterns {
|
|
filePatternStr, ok := filePattern.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to string failed: %T", filePatternStr)
|
|
}
|
|
matches, err := glob(filePatternStr)
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "error: failed to check if file-exists")
|
|
}
|
|
if len(matches) > 0 {
|
|
return true, nil
|
|
}
|
|
}
|
|
default:
|
|
return false, errors.Errorf("error: condidiion type invalid: %T, possible types: string, []interface{}", condition)
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func checkForNpmScriptsInPackages(condition interface{}, config StepConfig, stepName string,
|
|
glob func(pattern string) (matches []string, err error), openFile func(s string, t map[string]string) (io.ReadCloser, error)) (bool, error) {
|
|
packages, err := glob("**/package.json")
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "error: failed to check if file-exists")
|
|
}
|
|
for _, pack := range packages {
|
|
packDirs := strings.Split(path.Dir(pack), "/")
|
|
isNodeModules := false
|
|
for _, dir := range packDirs {
|
|
if dir == "node_modules" {
|
|
isNodeModules = true
|
|
break
|
|
}
|
|
}
|
|
if isNodeModules {
|
|
continue
|
|
}
|
|
|
|
jsonFile, err := openFile(pack, nil)
|
|
if err != nil {
|
|
return false, errors.Errorf("error: failed to open file %s: %v", pack, err)
|
|
}
|
|
defer jsonFile.Close()
|
|
packageJSON := map[string]interface{}{}
|
|
if err := json.NewDecoder(jsonFile).Decode(&packageJSON); err != nil {
|
|
return false, errors.Errorf("error: failed to unmarshal json file %s: %v", pack, err)
|
|
}
|
|
npmScripts, ok := packageJSON["scripts"]
|
|
if !ok {
|
|
continue
|
|
}
|
|
scriptsMap, ok := npmScripts.(map[string]interface{})
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to map[string]interface{} failed: %T", npmScripts)
|
|
}
|
|
switch condition := condition.(type) {
|
|
case string:
|
|
if _, ok := scriptsMap[condition]; ok {
|
|
return true, nil
|
|
}
|
|
case []interface{}:
|
|
for _, conditionNpmScript := range condition {
|
|
conditionNpmScriptStr, ok := conditionNpmScript.(string)
|
|
if !ok {
|
|
return false, errors.Errorf("error: type assertion to string failed: %T", conditionNpmScript)
|
|
}
|
|
if _, ok := scriptsMap[conditionNpmScriptStr]; ok {
|
|
return true, nil
|
|
}
|
|
}
|
|
default:
|
|
return false, errors.Errorf("error: condidiion type invalid: %T, possible types: string, []interface{}", condition)
|
|
}
|
|
}
|
|
return false, nil
|
|
}
|
|
|
|
func checkForNpmScriptsInPackagesV1(npmScript string, config StepConfig, utils piperutils.FileUtils) (bool, error) {
|
|
packages, err := utils.Glob("**/package.json")
|
|
if err != nil {
|
|
return false, errors.Wrap(err, "failed to check if file-exists")
|
|
}
|
|
for _, pack := range packages {
|
|
packDirs := strings.Split(path.Dir(pack), "/")
|
|
isNodeModules := false
|
|
for _, dir := range packDirs {
|
|
if dir == "node_modules" {
|
|
isNodeModules = true
|
|
break
|
|
}
|
|
}
|
|
if isNodeModules {
|
|
continue
|
|
}
|
|
|
|
jsonFile, err := utils.FileRead(pack)
|
|
if err != nil {
|
|
return false, errors.Errorf("failed to open file %s: %v", pack, err)
|
|
}
|
|
packageJSON := map[string]interface{}{}
|
|
if err := json.Unmarshal(jsonFile, &packageJSON); err != nil {
|
|
return false, errors.Errorf("failed to unmarshal json file %s: %v", pack, err)
|
|
}
|
|
npmScripts, ok := packageJSON["scripts"]
|
|
if !ok {
|
|
continue
|
|
}
|
|
scriptsMap, ok := npmScripts.(map[string]interface{})
|
|
if !ok {
|
|
return false, errors.Errorf("failed to read scripts from package.json: %T", npmScripts)
|
|
}
|
|
if _, ok := scriptsMap[npmScript]; ok {
|
|
return true, nil
|
|
}
|
|
}
|
|
return false, nil
|
|
}
|