/*
    * Copyright 2010-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.testdoc.maven;
  
  import java.io.File;
  import java.io.IOException;
  
  import javax.xml.parsers.ParserConfigurationException;
  
  import org.apache.maven.plugin.AbstractMojo;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugin.MojoFailureException;
  import org.apache.maven.project.MavenProject;
  
  import de.smartics.maven.io.MojoIoUtils;
  import de.smartics.maven.util.LoggingUtils;
  import de.smartics.maven.util.PathUtils;
  import de.smartics.testdoc.core.doc.OutputManager;
  import de.smartics.testdoc.core.doc.UnitTestDocIndex;
  import de.smartics.testdoc.core.export.FileOutputManager;
  import de.smartics.testdoc.core.export.UnitTestDocIndexExporter;
  import de.smartics.testdoc.core.export.XmlExporter;
  import de.smartics.testdoc.report.export.doc.IndexProvider;
  import de.smartics.testdoc.report.export.doc.TestDocHelper;
  
  /**
   * Generates XML reports.
   *
   * @goal test-stories
   * @phase process-test-classes
   * @requiresProject
   * @requiresDependencyResolution test
   * @description Generates XML reports containing test stories.
   */
  public class TestStoriesXmlExportMojo extends AbstractMojo
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The Maven project.
     *
     * @parameter expression="${project}"
     * @required
     * @readonly
     * @since 1.0
     */
    protected MavenProject project;
  
    /**
     * A simple flag to skip the generation of the XML files. If set on the
     * command line use <code>-Dtestdoc.test-stories.skip</code>.
     *
     * @parameter expression="${testdoc.test-stories.skip}" default-value="false"
     * @since 1.0
     */
    private boolean skip;
  
    /**
     * Specifies the log level used for this plugin.
     * <p>
     * Allowed values are <code>SEVERE</code>, <code>WARNING</code>,
     * <code>INFO</code> and <code>FINEST</code>.
     * </p>
     *
     * @parameter expression="${testdoc.test-stories.logLevel}"
     * @since 1.0
     */
    private String logLevel;
  
    /**
     * Specifies the root directory to write the XML files to.
     *
     * @parameter expression="${project.build.directory}/testdoc/xml"
     * @since 1.0
     */
    private String outputDirectory;
  
    /**
     * The directory to write to. This is the {@link File} representation of
     * {@link #outputDirectory}.
     *
     * @since 1.0
    */
   protected File outputDir;
 
   /**
    * The output directory to write intermediate serialized files to.
    *
    * @parameter expression="${project.build.directory}/testdoc/ser"
    * @since 1.0
    */
   private String serOutputDirectory;
 
   /**
    * Helper methods to access test documentation information.
    */
   private TestDocHelper testDocHelper;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    */
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException
   {
     if (!skip)
     {
       if (canBuild())
       {
         final IndexProvider indexChecker =
             new IndexProvider(serOutputDirectory);
         testDocHelper = indexChecker.createHelper(null);
         if (testDocHelper.isIndexProvided())
         {
           runExecution();
         }
         else
         {
           getLog().info(
               "No test doc information found, no report will be generated.");
         }
       }
       else
       {
         getLog()
             .debug(
                 "Skipping testdoc since no test classes are provided by this project.");
       }
     }
     else
     {
       getLog().info("Skipping testdoc XML generation since skip=true.");
     }
   }
 
   private void runExecution() throws MojoExecutionException
   {
     init();
 
     try
     {
       final XmlExporter exporter = new XmlExporter(true);
       final OutputManager manager = new FileOutputManager(outputDir, exporter);
       final UnitTestDocIndexExporter indexExporter =
           new UnitTestDocIndexExporter(manager);
       final UnitTestDocIndex index = testDocHelper.getIndex();
       indexExporter.export(index);
     }
     catch (final ParserConfigurationException e)
     {
       throw new MojoExecutionException("Cannot generate testdoc XML files.", e);
     }
     catch (final IOException e)
     {
       throw new MojoExecutionException("Cannot generate testdoc XML files.", e);
     }
   }
 
   @SuppressWarnings("unchecked")
   private boolean canBuild()
   {
     final String packaging = project.getPackaging();
     return !("pom".equals(packaging) || !PathUtils.exists(project
         .getTestCompileSourceRoots()));
   }
 
   private void init() throws MojoExecutionException
   {
     LoggingUtils.configureLogger(getLog(), logLevel);
     this.outputDir = MojoIoUtils.provideMojoDirectory(outputDirectory);
   }
 
   // --- object basics --------------------------------------------------------
 
 }