net.grinder.util.GrinderUtils.java Source code

Introduction

Here is the source code for net.grinder.util.GrinderUtils.java

Source

/* 
 * 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 net.grinder.util;

import HTTPClient.NVPair;
import net.grinder.common.GrinderProperties;
import net.grinder.script.Grinder;
import net.grinder.script.InternalScriptContext;
import org.apache.commons.lang.BooleanUtils;
import org.apache.commons.lang.math.NumberUtils;

import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Random;

/**
 * Convenient NGrinder utilities.
 *
 * @author JunHo Yoon
 * @since 3.2.3
 */
@SuppressWarnings({ "UnusedDeclaration", "SpellCheckingInspection" })
public abstract class GrinderUtils {
    /**
     * Get this thread unique id among all threads in the all agents.
     *
     * @return unique id b/w from 0 to total thread count.
     * @since 3.2.3
     */
    public static int getThreadUniqId() {
        InternalScriptContext grinder = getGrinderInstance();
        GrinderProperties properties = grinder.getProperties();
        int totalProcessCount = properties.getInt("grinder.processes", 1);
        int totalThreadCount = properties.getInt("grinder.threads", 1);
        int agentNumber = grinder.getAgentNumber();
        int processNumber = grinder.getProcessNumber();
        int threadNumber = grinder.getThreadNumber();
        // Calc the current thread's unique id
        return (agentNumber * totalProcessCount * totalThreadCount) + (processNumber * totalThreadCount)
                + threadNumber;
    }

    private static InternalScriptContext getGrinderInstance() {
        InternalScriptContext grinder = Grinder.grinder;
        if (grinder == null || grinder.getThreadNumber() == -1) {
            throw new RuntimeException("This method should be called in the worker thread context.");
        }
        return grinder;
    }

    private static Random random = new Random();

    /**
     * Convert nvpair map to array. With this user can create NVPair array using
     * following code.
     *
     *
     * <code>
     * import static net.ngrinder.util.GrinderUtil.*
     * ...
     * request1.POST("http://www.google.com", nvs(["key1":"value1", "key2":"value2"]))
     * </code>
     *
     * @param nvpairMap map of the
     * @return converted array
     */
    public static NVPair[] nvs(Map<Object, Object> nvpairMap) {
        NVPair[] result = new NVPair[nvpairMap.size()];
        int i = 0;
        for (Entry<Object, Object> each : nvpairMap.entrySet()) {
            result[i++] = new NVPair(each.getKey().toString(), each.getValue().toString());
        }
        return result;
    }

    /**
     * Get the any element from list.
     *
     *
     * <code>
     * import static net.ngrinder.util.GrinderUtil.*
     * ...
     * def values = [1,2,3,4,5]
     * def selected = any(values)
     * </code>
     *
     * @param from list
     * @return any element in the list
     * @since 3.2.3
     */
    public static <T> T any(List<T> from) {
        return from.get(random.nextInt(from.size()));
    }

    /**
     * Get the any element from araay.
     *
     * @param from list
     * @return any element in the list
     * @since 3.2.3
     */
    public static <T> T any(T[] from) {
        return from[random.nextInt(from.length)];
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns empty string.
     *
     * @return param. empty string if none.
     * @since 3.2.3
     */
    public static String getParam() {
        return getParam("");
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value.
     *
     * @return param. default value string if the param was not provided.
     * @since 3.2.3
     */
    public static String getParam(String defaultValue) {
        return System.getProperty("param", defaultValue);
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value 0.
     *
     * @since 3.2.3
     */
    public static int getParamInt() {
        return NumberUtils.toInt(getParam("0"), 0);
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value 0.
     *
     * @since 3.2.3
     */
    public static long getParamLong() {
        return NumberUtils.toLong(getParam("0"), 0);
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value 0.
     *
     * @since 3.2.3
     */
    public static float getParamFloat() {
        return NumberUtils.toFloat(getParam("0"), 0f);
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value 0.
     *
     * @since 3.2.3
     */
    public static double getParamDouble() {
        return NumberUtils.toDouble(getParam("0"), 0);
    }

    /**
     * Get the parameter passed by controller. When it's executed in the
     * validation mode, always returns the given default value(false).
     *
     * @since 3.2.3
     */
    public static boolean getParamBoolean() {
        return BooleanUtils.toBoolean(getParam("false"));
    }

    /**
     * Get the total agent count.
     *
     * @return agent count.
     */
    public static int getAgentCount() {
        return getGrinderInstance().getProperties().getInt("grinder.agents", 1);
    }

    /**
     * Get the process count per an agent.
     *
     * @return process assigned per an agent
     */
    public static int getProcessCount() {
        return getGrinderInstance().getProperties().getInt("grinder.processes", 1);
    }

    /**
     * Get the thread count per a process.
     *
     * @return thread count assigned per a process
     */
    public static int getThreadCount() {
        return getGrinderInstance().getProperties().getInt("grinder.threads", 1);
    }
}