com.netflix.conductor.common.utils.ConstraintParamUtil Maven / Gradle / Ivy

Go to download
package com.netflix.conductor.common.utils;

import com.netflix.conductor.common.metadata.workflow.WorkflowDef;
import com.netflix.conductor.common.metadata.workflow.WorkflowTask;
import com.netflix.conductor.common.utils.EnvUtils.SystemParameters;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

public class ConstraintParamUtil {

    /**
     * Validates inputParam and returns a list of errors if input is not valid.
     * @param input {@link Map} of inputParameters
     * @param taskName TaskName of inputParameters
     * @param workflow WorkflowDef
     * @return {@link List} of error strings.
     */
    public static List validateInputParam(Map input, String taskName, WorkflowDef workflow) {
        ArrayList errorList = new ArrayList<>();

        for (Entry e : input.entrySet()) {
            Object value = e.getValue();
            if (value instanceof String) {
                errorList.addAll(extractParamPathComponentsFromString(e.getKey(), value.toString(), taskName, workflow));
            } else if (value instanceof Map) {
                //recursive call
                errorList.addAll( validateInputParam((Map) value, taskName, workflow));
            } else if (value instanceof List) {
                errorList.addAll(extractListInputParam(e.getKey(), (List) value, taskName, workflow));
            } else {
                e.setValue(value);
            }
        }
        return errorList;
    }

    private static List extractListInputParam(String key, List values, String taskName, WorkflowDef workflow) {
        ArrayList errorList = new ArrayList<>();
        for (Object listVal : values) {
            if (listVal instanceof String) {
                errorList.addAll(extractParamPathComponentsFromString(key, listVal.toString(), taskName, workflow));
            } else if (listVal instanceof Map) {
                errorList.addAll( validateInputParam((Map) listVal, taskName, workflow));
            } else if (listVal instanceof List) {
                errorList.addAll(extractListInputParam(key, (List) listVal, taskName, workflow));
            }
        }
        return errorList;
    }

    private static List extractParamPathComponentsFromString(String key, String value, String taskName, WorkflowDef workflow) {
        ArrayList errorList = new ArrayList<>();

        if (StringUtils.isEmpty(value)) {
            String message = String.format( "key: %s input parameter value: is null or empty", key);
            errorList.add(message);
            return errorList;
        }

        String[] values = value.split( "(?=\\$\\{)|(?<=\\})" );

        for (int i = 0; i < values.length; i++)
            if (values[i].startsWith( "${" ) && values[i].endsWith( "}" )) {
                String paramPath = values[i].substring( 2, values[i].length() - 1 );

                if (StringUtils.containsWhitespace(paramPath)) {
                    String message = String.format("key: %s input parameter value: %s is not valid",
                            key, paramPath);
                    errorList.add( message );
                } else if (EnvUtils.isEnvironmentVariable(paramPath)) {
                    // if it one of the predefined enums skip validation
                    boolean isPredefinedEnum = false;

                    for (SystemParameters systemParameters : SystemParameters.values()) {
                        if (systemParameters.name().equals(paramPath)) {
                            isPredefinedEnum = true;
                            break;
                        }
                    }

                    if (!isPredefinedEnum) {
                        String sysValue = EnvUtils.getSystemParametersValue(paramPath,"" );
                        if (sysValue == null) {
                            String errorMessage = String.format("environment variable: %s for given task: %s" +
                                    " input value: %s" + " of input parameter: %s is not valid", paramPath, taskName, key, value);
                            errorList.add( errorMessage );
                        }
                    }
                } //workflow, or task reference name
                else {
                    String[] components = paramPath.split( "\\." );
                    if (!"workflow".equals( components[0] )) {
                        WorkflowTask task = workflow.getTaskByRefName( components[0] );
                        if (task == null) {
                            String message = String.format( "taskReferenceName: %s for given task: %s input value: %s of input" + " parameter: %s" + " is not defined in workflow definition.", components[0], taskName, key, value );
                            errorList.add( message );
                        }
                    }
                }
            }
        return errorList;
    }
}