org.opengis.cite.wfs20.nsg.TestNGController Maven / Gradle / Ivy

Go to download
package org.opengis.cite.wfs20.nsg;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.logging.Level;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Source;

import org.apache.commons.io.FilenameUtils;
import org.opengis.cite.iso19142.CommandLineArguments;
import org.opengis.cite.iso19142.TestRunArg;
import org.opengis.cite.iso19142.util.TestSuiteLogger;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import com.beust.jcommander.JCommander;
import com.beust.jcommander.ParameterException;
import com.occamlab.te.spi.executors.TestRunExecutor;
import com.occamlab.te.spi.executors.testng.TestNGExecutor;
import com.occamlab.te.spi.jaxrs.TestSuiteController;

import static org.opengis.cite.iso19142.TestRunArg.IUT;
import static org.opengis.cite.iso19142.TestRunArg.WFS;

/**
 * Main test run controller oversees execution of TestNG test suites.
 */
public class TestNGController implements TestSuiteController {

    private TestRunExecutor executor;

    private Properties etsProperties = new Properties();

    /**
     * A convenience method for running the test suite using a command-line interface. The default values of the test
     * run arguments are as follows:
     * 
     * XML properties file: ${user.home}/test-run-props.xml
     * outputDir: ${user.home}
     * deleteSubjectOnFinish: false
     * 
     * 
     * Synopsis
     * 
     * 
     *      * ets-*-aio.jar [-o|--outputDir $TMPDIR] [-d|--deleteSubjectOnFinish] [test-run-props.xml]
     * 
     *
     * @param args
     *            Test run arguments (optional). The first argument must refer to an XML properties file containing the
     *            expected set of test run arguments. If no argument is supplied, the file located at
     *            ${user.home}/test-run-props.xml will be used.
     * @throws Exception
     *             If the test run cannot be executed (usually due to unsatisfied pre-conditions).
     */
    public static void main( String[] args )
                            throws Exception {
        CommandLineArguments testRunArgs = new CommandLineArguments();
        JCommander cmd = new JCommander( testRunArgs );
        try {
            cmd.parse( args );
        } catch ( ParameterException px ) {
            System.out.println( px.getMessage() );
            cmd.usage();
        }
        if ( testRunArgs.doDeleteSubjectOnFinish() ) {
            System.setProperty( "deleteSubjectOnFinish", "true" );
        }
        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
        DocumentBuilder db = dbf.newDocumentBuilder();
        File xmlArgs = testRunArgs.getPropertiesFile();
        Document testRunProps = db.parse( xmlArgs );
        TestNGController controller = new TestNGController( testRunArgs.getOutputDir() );
        Source testResults = controller.doTestRun( testRunProps );
        System.out.println( "Test results: " + testResults.getSystemId() );
    }

    /**
     * Default constructor uses the location given by the "java.io.tmpdir" system property as the root output directory.
     */
    public TestNGController() {
        this( System.getProperty( "java.io.tmpdir" ) );
    }

    /**
     * Construct a controller that writes results to the given output directory.
     * 
     * @param outputDir
     *            The location of the directory in which test results will be written (a file system path or a 'file'
     *            URI). It will be created if it does not exist.
     */
    public TestNGController( String outputDir ) {
        InputStream is = getClass().getResourceAsStream( "ets.properties" );
        try {
            this.etsProperties.load( is );
        } catch ( IOException ex ) {
            TestSuiteLogger.log( Level.WARNING, "Unable to load ets.properties. " + ex.getMessage() );
        }
        URL tngSuite = TestNGController.class.getResource( "testng.xml" );
        File resultsDir;
        if ( null == outputDir || outputDir.isEmpty() ) {
            resultsDir = new File( FilenameUtils.normalize(System.getProperty("user.home")));
        } else if ( outputDir.startsWith( "file:" ) ) {
            resultsDir = new File( URI.create( FilenameUtils.normalize(outputDir ) ));
        } else {
            resultsDir = new File( FilenameUtils.normalize(outputDir) );
        }
        TestSuiteLogger.log( Level.CONFIG, "Using TestNG config: " + tngSuite );
        TestSuiteLogger.log( Level.CONFIG, "Using outputDirPath: " + resultsDir.getAbsolutePath() );
        // NOTE: setting third argument to 'true' enables the default listeners
        this.executor = new TestNGExecutor( tngSuite.toString(), resultsDir.getAbsolutePath(), false );
    }

    @Override
    public String getCode() {
        return etsProperties.getProperty( "ets-code" );
    }

    @Override
    public String getVersion() {
        return etsProperties.getProperty( "ets-version" );
    }

    @Override
    public String getTitle() {
        return etsProperties.getProperty( "ets-title" );
    }

    @Override
    public Source doTestRun( Document testRunArgs )
                            throws Exception {
        validateTestRunArgs( testRunArgs );
        return executor.execute( testRunArgs );
    }

    /**
     * Validates the test run arguments. The test run is aborted if any of these checks fail.
     *
     * @param testRunArgs
     *            A DOM Document containing a set of XML properties (key-value pairs).
     * @throws IllegalArgumentException
     *             If any arguments are missing or invalid for some reason.
     */
    void validateTestRunArgs( Document testRunArgs ) {
        if ( null == testRunArgs || !testRunArgs.getDocumentElement().getNodeName().equals( "properties" ) ) {
            throw new IllegalArgumentException( "Input is not an XML properties document." );
        }
        NodeList entries = testRunArgs.getDocumentElement().getElementsByTagName( "entry" );
        if ( entries.getLength() == 0 ) {
            throw new IllegalArgumentException( "No test run arguments found." );
        }
        Map args = new HashMap();
        for ( int i = 0; i < entries.getLength(); i++ ) {
            Element entry = (Element) entries.item( i );
            args.put( entry.getAttribute( "key" ), entry.getTextContent() );
        }
        if ( !args.containsKey( IUT.toString() ) && !args.containsKey( WFS.toString() ) ) {
            throw new IllegalArgumentException( String.format( "Missing argument: '%s' or '%s' must be present.", IUT,
                                                               WFS ) );
        }
    }
}