001/*
002 *   Copyright (C) Christian Schulte, 2005-206
003 *   All rights reserved.
004 *
005 *   Redistribution and use in source and binary forms, with or without
006 *   modification, are permitted provided that the following conditions
007 *   are met:
008 *
009 *     o Redistributions of source code must retain the above copyright
010 *       notice, this list of conditions and the following disclaimer.
011 *
012 *     o Redistributions in binary form must reproduce the above copyright
013 *       notice, this list of conditions and the following disclaimer in
014 *       the documentation and/or other materials provided with the
015 *       distribution.
016 *
017 *   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
018 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
019 *   AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
020 *   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
021 *   INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
022 *   NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
023 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
024 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
025 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
026 *   THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027 *
028 *   $JOMC: TestSpecificationShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
029 *
030 */
031package org.jomc.mojo;
032
033import org.apache.maven.plugin.MojoExecutionException;
034import org.jomc.model.Modules;
035import org.jomc.model.ObjectFactory;
036import org.jomc.model.Specification;
037import org.jomc.model.modlet.ModelHelper;
038import org.jomc.modlet.Model;
039import org.jomc.modlet.ModelContext;
040
041/**
042 * Displays a project's test specification.
043 *
044 * @author <a href="mailto:cs@schulte.it">Christian Schulte</a>
045 * @version $JOMC: TestSpecificationShowMojo.java 4613 2012-09-22 10:07:08Z schulte $
046 *
047 * @goal show-test-specification
048 * @threadSafe
049 * @requiresDependencyResolution test
050 * @since 1.1
051 */
052public final class TestSpecificationShowMojo extends AbstractModelShowMojo
053{
054
055    /**
056     * Identifier of the specification to show.
057     *
058     * @parameter expression="${jomc.identifier}"
059     * @required
060     */
061    private String identifier;
062
063    /**
064     * Execution strategy of the goal ({@code always} or {@code once-per-session}).
065     *
066     * @parameter default-value="once-per-session" expression="${jomc.showTestSpecificationExecutionStrategy}"
067     */
068    private String showTestSpecificationExecutionStrategy;
069
070    /** Creates a new {@code TestSpecificationShowMojo} instance. */
071    public TestSpecificationShowMojo()
072    {
073        super();
074    }
075
076    @Override
077    protected Model getDisplayModel( final ModelContext modelContext ) throws MojoExecutionException
078    {
079        final Model model = this.getModel( modelContext );
080        final Modules modules = ModelHelper.getModules( model );
081        final Specification specification = modules != null ? modules.getSpecification( this.identifier ) : null;
082        Model displayModel = null;
083
084        if ( specification != null )
085        {
086            displayModel = new Model();
087            displayModel.setIdentifier( model.getIdentifier() );
088            displayModel.getAny().add( new ObjectFactory().createSpecification( specification ) );
089        }
090
091        return displayModel;
092    }
093
094    @Override
095    protected ClassLoader getDisplayClassLoader() throws MojoExecutionException
096    {
097        return this.getTestClassLoader();
098    }
099
100    @Override
101    protected String getGoal() throws MojoExecutionException
102    {
103        return "show-test-specification";
104    }
105
106    @Override
107    protected String getExecutionStrategy() throws MojoExecutionException
108    {
109        return this.showTestSpecificationExecutionStrategy;
110    }
111
112}