batch.performance.PerformanceTestDescriptor.java Source code

Introduction

Here is the source code for batch.performance.PerformanceTestDescriptor.java

Source

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package batch.performance;

import java.io.File;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.dom4j.Element;

import batch.core.Util;
import batch.core.om.Instance;
import batch.core.om.Schema;
import batch.core.om.TestDescriptor;

/**
 * {@link PerformanceTestDescriptor} for performance test.
 * 
 * @author
 *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
 */
public class PerformanceTestDescriptor extends TestDescriptor {

    public class Config {
        public final Scenario scenario;
        public final Profiler profiler;
        /**
         * If this configuration is associated with a particular
         * instance, this field will point to that instance.
         * If it is run against the schema and therefore not 
         * associated with any instance, the field is null.
         */
        public final Instance instance;

        public Config(Scenario _scenario, Profiler _profiler, Instance _instance) {
            this.scenario = _scenario;
            this.profiler = _profiler;
            this.instance = _instance;
        }

        public String toString() {
            return getName();
        }

        /**
         * Returns a human readable short description of the configuration.
         */
        public String getName() {
            String r = scenario.getName();
            if (instance != null)
                r += " : " + instance.getName();
            return r;
        }

        /**
         * Gets the {@link PerformanceTestDescriptor} that owns this object.
         */
        public PerformanceTestDescriptor getParent() {
            return PerformanceTestDescriptor.this;
        }
    }

    /**
     * {@link Config}s to be run.
     */
    public final Config[] configs;

    public PerformanceTestDescriptor(File _outDir, Schema _schema, Instance[] _instances, Config[] _configs) {
        super(_outDir, _schema, _instances);
        this.configs = _configs;
    }

    /**
     * @param metaFile
     * @throws Exception
     */
    public PerformanceTestDescriptor(File metaFile) throws Exception {
        super(metaFile);

        Element testSpec = Util.loadXML(metaFile).getRootElement();

        List configs = new ArrayList();
        for (Iterator itr = testSpec.elementIterator("performance"); itr.hasNext();) {
            Element performance = (Element) itr.next();

            // load scenario
            Scenario scenario = createScenario(metaFile, performance);

            // load profiler
            Profiler profiler;
            if (performance.attributeValue("profiler").equals("memory"))
                profiler = Profiler.MEMORY;
            else
                profiler = Profiler.SPEED;

            // associated with instance?
            if (performance.attributeValue("run", "---").equals("once")) {
                // no
                configs.add(new Config(scenario, profiler, null));
            } else {
                // yes
                for (int i = 0; i < instances.length; i++)
                    configs.add(new Config(scenario, profiler, instances[i]));
            }
        }

        this.configs = (Config[]) configs.toArray(new Config[configs.size()]);

    }

    /**
     * Creates the {@link Scenario} object from the descriptor.
     * 
     * Derived classes may override this method.
     */
    protected Scenario createScenario(File baseLocation, Element performance) throws Exception {
        String className = performance.attributeValue("scenario");

        if (className == null) {
            // this is a bean-shell based script.
            return new ScriptScenario(performance.element("scenario"));
        }

        Class clazz = Class.forName("batch.performance.scenarios." + className);
        try {
            // try the constructor with Element
            return (Scenario) clazz.getConstructor(new Class[] { Element.class })
                    .newInstance(new Object[] { performance });
        } catch (NoSuchMethodException e) {
            // then the default constructor
            return (Scenario) clazz.newInstance();
        }
    }
}