com.seleniumtests.util.StringUtility Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-selenium4 Show documentation
The newest version!
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 * 				Copyright 2017-2019 B.Hecquet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.seleniumtests.util;

import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.text.StringEscapeUtils;
import org.apache.logging.log4j.Logger;

import com.seleniumtests.core.SeleniumTestsContext;
import com.seleniumtests.core.TestVariable;
import com.seleniumtests.customexception.CustomSeleniumTestsException;
import com.seleniumtests.util.logging.SeleniumRobotLogger;

public class StringUtility {

	private static final Logger logger = SeleniumRobotLogger.getLogger(StringUtility.class);
	public static Pattern PLACEHOLDER_PATTERN = Pattern.compile("\\$\\{(.*?)\\}");

	private StringUtility() {
		// As a utility class, it is not meant to be instantiated.
	}

    public static String constructMethodSignature(final Method method, final Object[] parameters) {
        return method.getDeclaringClass().getCanonicalName() + "." + method.getName() + "("
                + constructParameterString(parameters) + ")";
    }

    public static String constructParameterString(final Object[] parameters) {
        StringBuilder sbParam = new StringBuilder();

        if (parameters != null) {
            for (int i = 0; i < parameters.length; i++) {
                if (parameters[i] == null) {
                    sbParam.append("null, ");
                } else if (parameters[i] instanceof java.lang.String) {
                    sbParam.append("\"").append(parameters[i]).append("\", ");
                } else {
                    sbParam.append(parameters[i]).append(", ");
                }
            }
        }

        if (sbParam.length() > 0) {
            sbParam.delete(sbParam.length() - 2, sbParam.length() - 1);
        }

        return sbParam.toString();
    }

    public static String md5(final String str) {

        if (str == null) {
            return null;
        }

        MessageDigest messageDigest = null;

        try {
            messageDigest = MessageDigest.getInstance("MD5");
            messageDigest.reset();
            messageDigest.update(str.getBytes(StandardCharsets.UTF_8));
        } catch (NoSuchAlgorithmException e) {
        	logger.error(e);
            return str;
        }

        byte[] byteArray = messageDigest.digest();

        return toHexString(byteArray);
    }

    public static String toHexString(byte[] byteArray) {
        StringBuilder builder = new StringBuilder();

        for (int i = 0; i < byteArray.length; i++) {
            if (Integer.toHexString(0xFF & byteArray[i]).length() == 1)
                builder.append("0").append(String.format("%02X", byteArray[i]));
            else
                builder.append(String.format("%02X", byteArray[i]));
        }

        return builder.toString();
    }

	/**
	 * @param ch
	 * @return true if the given character is a letter
	 */
	public static boolean isLetter(char ch) {
		int ascii = (int) ch;
		/*
		 * A=65 ; Z=90
		 * a=97 ; z=122
		 */
		return ((ascii >= 65 && ascii <= 90)
			|| (ascii >= 97 && ascii <= 122));


	}

	/**
	 * Replace chars that cannot be used for file names
	 * @return
	 */
	public static String replaceOddCharsFromFileName(String inString) {
		if (inString == null) {
			return "null";
		}

		return StringUtils.stripAccents(inString).replace(" ",  "_")
				.replaceAll("['\"/|%]", "")
				.replaceAll("[:*?]", ".")
				.replaceAll("[<>]", "-")
				.replace("\\", "_");
	}

	/**
	 * Do interpolation like groovy language, using context variables
	 * ex: provided the 'url' variable is present in test configuration with value 'http://my.site',
	 *     'connect to ${url}' => 'connect to http://my.site
	 * If testContext is set to mask password, then, they will be replaced by '****'
	 *
	 * @param initialString		the string to interpolate
	 * @return
	 */
	public static String interpolateString(String initialString, SeleniumTestsContext testContext) {

    	if (testContext == null) {
    		return initialString;
    	}
		return interpolateString(initialString, testContext, testContext.getMaskedPassword());
	}

	/**
	 * Do interpolation like groovy language, using context variables
	 * ex: provided the 'url' variable is present in test configuration with value 'http://my.site',
	 *     'connect to ${url}' => 'connect to http://my.site
	 *
	 * @param initialString		the string to interpolate
	 * @return
	 */
	public static String interpolateString(String initialString, SeleniumTestsContext testContext, Boolean maskPassword) {
		if (initialString == null) {
			return null;
		}

		String interpolatedString  = initialString;

    	if (testContext == null || testContext.getConfiguration() == null) {
    		return initialString;
    	}
    	Map variables = testContext.getConfiguration();
    	List unknownKeys = new ArrayList<>();

    	for (int i = 0; i < 10; i++) {
	    	Matcher matcher = PLACEHOLDER_PATTERN.matcher(interpolatedString);
	    	boolean processed = false;

	    	while (matcher.find()) {
	    		processed = true;
	    		String key = matcher.group(1);

	    		if (Boolean.TRUE.equals(maskPassword) && (key.toLowerCase().contains("password") || key.toLowerCase().contains("pwd") || key.toLowerCase().contains("passwd"))) {
	    			interpolatedString = interpolatedString.replace(String.format("${%s}",  key), "****");
	    		} else if (variables.containsKey(key)) {
	    			interpolatedString = interpolatedString.replace(String.format("${%s}",  key), variables.get(key).getValueNoInterpolation());
	    		} else if (!unknownKeys.contains(key)){
	    			unknownKeys.add(key);
	    			logger.warn(String.format("Error while interpolating '%s', key '%s' not found in configuration", interpolatedString, key));
	    		}
	    	}

	    	if (!processed) {
	    		break;
	    	}
    	}

    	return interpolatedString;
	}

	/**
	 * Encode string according to provided format
	 * @param message		message to encode
	 * @param format		'xml', 'csv', 'html', 'json', 'text'. the later does not change anything
	 * @return
	 */
	public static String encodeString(String message, String format) {
		String newMessage;

		if (format == null) { throw new CustomSeleniumTestsException("only escaping of 'xml', 'html', 'csv', 'json' is allowed"); }

		switch (format) {
		case "xml":
			newMessage = StringEscapeUtils.escapeXml11(message);
			break;
		case "csv":
			newMessage = StringEscapeUtils.escapeCsv(message);
			break;
		case "html":
			if (message == null) {
				newMessage = null;
			} else {
				newMessage = StringEscapeUtils.escapeHtml4(message.replace("\n", "__BR__")).replace("__BR__", "
\n");
			}
			break;
		case "json":
			newMessage = StringEscapeUtils.escapeJson(message);
			break;
		case "text":
			newMessage = message;
			break;
		default:
			throw new CustomSeleniumTestsException("only escaping of 'xml', 'html', 'csv', 'json' is allowed");
		}
		return newMessage;
	}


}