exectck/src/main/java/org/apache/jdo/exectck/Help.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.jdo.exectck;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

/**
 * Goal that displays help text for the exectck Maven plugin.
 *
 * @goal help
 *
 * @phase integration-test
 *
 */
public class Help extends AbstractMojo{

    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        
        StringBuffer msg = new StringBuffer();

        msg.append("\n\n*** jdo-exectck Maven plugin ***\n\n");
        msg.append("This plugin executes the JDO Technology Compatibility Kit (TCK)\n");
        msg.append("against the Reference Implementation (RI) or an implementation under test (IUT).\n\n");
        msg.append("- To display this help text, type \"mvn jdo-exectck:help\"\n");
        msg.append("- To run the entire TCK type \"mvn integration-test\" or \"mvn install\"\n");
        msg.append("- To run individual goals type \"mvn jdo-exectck:<goal>\"\n");
        msg.append("  Specify command line parameters, described below, to configure the test.\n");
        msg.append("\nGOALS\n");
        msg.append("* installSchema\n");
        msg.append("  Installs all of the database schemas required to execute tests\n");
        msg.append("  in the current test configurations.\n");
        msg.append("* enhance\n");
        msg.append("  Enhances classes. Classes must first be compiled (mvn compile).\n");
        msg.append("* runtck\n");
        msg.append("  Runs the JDO Technology Compatibility Kit. Schema must first be installed and classes enhanced.\n");
        msg.append("\nPARAMETERS\n");
        msg.append("To set parameters from the command line, \n  use the -D option and the parameter name.\n");
        msg.append("  For example, \"mvn -Djdo.tck.identitytype=applicationidentity\"\n");
        msg.append("* jdo.tck.impl\n");
        msg.append("  jdori (reference implementation) or iut (mplementation under test\n");
        msg.append("* jdo.tck.cfglist\n");
        msg.append("  List of configuration files, each describing a test configuration.\n");
        msg.append("  Default is all configurations.\n");
        msg.append("* jdo.tck.dblist\n");
        msg.append("  List of databases to run tests under.\n");
        msg.append("  Currently only derby is supported\n");
        msg.append("* jdo.tck.identitytypes\n");
        msg.append("  List of identity types to be tested\n");
        msg.append("  Default value is \"applicationidentity datastoreidentity\"\n");
        msg.append("* project.lib.iut.directory\n");
        msg.append("  Location of implementation jar files. Default: ${basedir}/../lib/iut\n");
        msg.append("* jdo.tck.impl.logfile\n");
        msg.append("  Location of implementation log file. Default: ${user.dir}/datanucleus.txt\n");
        msg.append("* jdo.tck.doInstallSchema\n");
        msg.append("  Setting this parameter to false will bypass schema installation.\n");
        msg.append("* jdo.tck.doEnhance\n");
        msg.append("  Setting this parameter to false will bypass enhancement.\n");
        msg.append("* jdo.tck.doRunTCK\n");
        msg.append("  Setting this parameter to false will bypass running the TCK.\n");
        msg.append("* jdo.tck.runTCKVerbose\n");
        msg.append("  Setting this parameter to true will display test progress and"
                + "error output while the TCK is running.\n");
        msg.append("\n  To run the TCK on an implementation under test, \n"
                + "      place all required jars and their dependencies in lib/iut\n"
                + "      and set jdo.tck.impl to iut:\n");
        msg.append("     mvn integration-test -D jdo.tck.impl=\"iut\"\n\n");
        msg.append("\n END EXECTCK HELP INFORMATION\n");

        System.out.println(msg.toString());
    }

}