com.google.code.play.PlayStartMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of play-maven-plugin Show documentation
Maven Plugin for Play! Framework for integration of these two very different worlds
There is a newer version: 1.0.0-beta8
/*
 * Copyright 2010-2014 Grzegorz Slowikowski
 *
 * 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.google.code.play;

import java.io.File;
import java.io.IOException;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;

import org.apache.tools.ant.taskdefs.Java;

/**
 * Start Play! server ("play start" equivalent).
 * 
 * @author Grzegorz Slowikowski
 * @since 1.0.0
 */
@Mojo( name = "start", requiresDependencyResolution = ResolutionScope.TEST )
public class PlayStartMojo
    extends AbstractPlayStartServerMojo
{
    /**
     * Play! id (profile) used when starting server without tests.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.id", defaultValue = "" )
    private String playId;

    /**
     * Play! id (profile) used when starting server with tests.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.testId", defaultValue = "test" )
    private String playTestId;

    /**
     * Allows the server startup to be skipped.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.startSkip", defaultValue = "false" )
    private boolean startSkip;

    /**
     * Start server with test profile.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.startWithTests", defaultValue = "false" )
    private boolean startWithTests;

    /**
     * Spawns started JVM process. See Ant Java task documentation for details.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.startSpawn", defaultValue = "true" )
    private boolean startSpawn;

    /**
     * After starting server wait for "http://localhost:${httpPort}/" URL to be available.
     * 
     * @since 1.0.0
     */
    @Parameter( property = "play.startSynchro", defaultValue = "false" )
    private boolean startSynchro;

    @Override
    protected void internalExecute()
        throws MojoExecutionException, MojoFailureException, IOException
    {
        if ( startSkip )
        {
            getLog().info( "Skipping execution" );
            return;
        }
        
        File baseDir = project.getBasedir();

        File confDir = new File( baseDir, "conf" );

        File applicationConfFile = new File( confDir, "application.conf" );
        if ( applicationConfFile.length() == 0 )
        {
            getLog().info( "Empty \"conf/application.conf\" file, skipping execution" );
            return;
        }

        File routesFile = new File( confDir, "routes" );
        if ( !routesFile.isFile() )
        {
            getLog().info( "No \"conf/routes\" file, skipping execution" );
            return;
        }
        else if ( routesFile.length() == 0 )
        {
            getLog().info( "Empty \"conf/routes\" file, skipping execution" );
            return;
        }
        
        String startPlayId = ( startWithTests ? playTestId : playId );

        ConfigurationParser configParser =  getConfiguration( startPlayId );

        String sysOut = configParser.getProperty( "application.log.system.out" );
        boolean redirectSysOutToFile = !( "false".equals( sysOut ) || "off".equals( sysOut ) );

        File logFile = null;
        if ( redirectSysOutToFile )
        {
            File logDirectory = new File( baseDir, "logs" );
            logFile = new File( logDirectory, "system.out" );
        }

        if ( redirectSysOutToFile )
        {
            getLog().info( String.format( "Starting Play! Server, output is redirected to %s", logFile.getPath() ) );
        }
        else
        {
            getLog().info( "Starting Play! Server" );
        }

        Java javaTask = getStartServerTask( configParser, startPlayId, logFile, startSpawn );

        JavaRunnable runner = new JavaRunnable( javaTask );
        Thread t = new Thread( runner, "Play! Server runner" );
        t.start();
        try
        {
            t.join();
        }
        catch ( InterruptedException e )
        {
            throw new MojoExecutionException( "?", e );
        }
        Exception startServerException = runner.getException();
        if ( startServerException != null )
        {
            throw new MojoExecutionException( "?", startServerException );
        }
        
        if ( startSynchro )
        {
            String rootUrl = getRootUrl( configParser );

            getLog().info( String.format( "Waiting for %s", rootUrl ) );

            waitForServerStarted( rootUrl, runner );
        }
        
        getLog().info( "Play! Server started" );
    }

}