TeamControlium.Utilities.TestArguments Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of utilities Show documentation
TeamControlium Utilities provides a set of Test Framework utilities for use within the Team Controlium suite
There is a newer version: 1.2.3
package TeamControlium.Utilities;

import java.util.HashMap;
import java.util.regex.Pattern;

/// 
/// Processes test command-line arguments and presents them to the test script as a string array
/// 
//
// Note: Thanks to Mike Burns (https://www.linkedin.com/in/maddogmikeb) for original C# code
//
 public class TestArguments {
    // Variables
    private HashMap processedParameters;

    /// 
    /// Process the test arguments and make available for the test to use.
    /// 
    /// 
    /// Arguments are space delimited and handle various common parameter preambles


    /// EG. Test.exe -param1 value1 --param2 /param3:"Test-:-work /param4=happy -param5 '--=nice=--'
    /// 
    /// String array of arguments for the test to use.
    public TestArguments(String[] argumentsToProcess) {
        processedParameters = new HashMap<>();
        Pattern Spliter = Pattern.compile("^-{1,2}|^/|=|:", Pattern.CASE_INSENSITIVE);
        Pattern Remover = Pattern.compile("^['\"]?(.*?)['\"]?$", Pattern.CASE_INSENSITIVE);

        String currentParameterBeingBuilt = null;
        String[] argumentParts;

        // Valid parameters forms:
        // {-,/,--}param{ ,=,:}((",')value(",'))
        // Examples:
        // -param1 value1 --param2 /param3:"Test-:-work"
        //   /param4=happy -param5 '--=nice=--'
        for (String currentArgument : argumentsToProcess) {
            // Look for new parameters (-,/ or --) and a
            // possible enclosed value (=,:)
            argumentParts = Spliter.split(currentArgument, 3);

            switch (argumentParts.length) {
                // Found a value (for the last parameter
                // found (space separator))
                case 1:
                    if (currentParameterBeingBuilt != null) {
                        if (!processedParameters.containsKey(currentParameterBeingBuilt)) {
                            argumentParts[0] = Remover.matcher(argumentParts[0]).replaceAll("$1");

                            processedParameters.put(currentParameterBeingBuilt, argumentParts[0]);
                        }
                        currentParameterBeingBuilt = null;
                    }
                    // else Error: no parameter waiting for a value (skipped)
                    break;

                // Found just a parameter
                case 2:
                    // The last parameter is still waiting.
                    // With no value, set it to true.
                    if (currentParameterBeingBuilt != null) {
                        if (!processedParameters.containsKey(currentParameterBeingBuilt))
                            processedParameters.put(currentParameterBeingBuilt, "true");
                    }
                    currentParameterBeingBuilt = argumentParts[1];
                    break;

                // Parameter with enclosed value
                case 3:
                    // The last parameter is still waiting.
                    // With no value, set it to true.
                    if (currentParameterBeingBuilt != null) {
                        if (!processedParameters.containsKey(currentParameterBeingBuilt))
                            processedParameters.put(currentParameterBeingBuilt, "true");
                    }

                    currentParameterBeingBuilt = argumentParts[1];

                    // Remove possible enclosing characters (",')
                    if (!processedParameters.containsKey(currentParameterBeingBuilt)) {
                        argumentParts[2] = Remover.matcher(argumentParts[2]).replaceAll("$1");
                        processedParameters.put(currentParameterBeingBuilt, argumentParts[2]);
                    }

                    currentParameterBeingBuilt = null;
                    break;
            }
        }
        // In case a parameter is still waiting
        if (currentParameterBeingBuilt != null) {
            if (!processedParameters.containsKey(currentParameterBeingBuilt))
                processedParameters.put(currentParameterBeingBuilt, "true");
        }
    }

    /// 
    /// Return a named parameter value if it exists
    /// 
    /// Parameter to obtain
    /// Value of named parameter.  If named parameter does not exist null is returned
    public String getParameter(String Param) {
        try {
            return (processedParameters.get(Param));
        } catch (Exception ex) {
            return null;
        }
    }
}