AbstractIssueMojo

/*
 * Copyright 2012 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.maven.bugzilla;

import org.apache.commons.lang.StringUtils;
import org.apache.maven.model.IssueManagement;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.apache.maven.settings.Server;
import org.apache.maven.settings.Settings;

import de.smartics.maven.issue.command.CommandTarget;
import de.smartics.maven.issue.util.LogLevel;
import de.smartics.maven.issue.util.MavenProjectWrapper;

/**
 * Base implementation for Bugzilla mojos.
 */
public abstract class AbstractIssueMojo extends AbstractMojo
{
  // ********************************* Fields *********************************

  // --- constants ------------------------------------------------------------

  // --- members --------------------------------------------------------------

  // ... Mojo infrastructure ..................................................

  /**
   * The Maven project.
   *
   * @parameter expression="${project}"
   * @required
   * @readonly
   * @since 1.0
   */
  private MavenProject project;

  /**
   * The user's settings.
   *
   * @parameter expression="${settings}"
   * @required
   * @readonly
   * @since 1.0
   */
  protected Settings settings;

  // ... parameter ............................................................

  /**
   * The name of the server configuration in the <code>settings.xml</code> that
   * provides credentials to access the issues server. Only used if no server
   * matches the POM's <code>issueManagement/url</code> and
   * <code>issueManagement/system</code>.
   *
   * @parameter default-value="bugzilla"
   * @since 1.0
   */
  protected String issueServerId;

  // ... command ..............................................................

  /**
   * Information about the issue server.
   */
  protected IssueServer server;

  /**
   * The console to execute commands.
   */
  protected Console console;

  /**
   * Defines the verboseness of the output.
   * <ul>
   * <li><code>QUIET</code> - prints no info messages.</li>
   * <li><code>NORMAL</code> - only prints the returned page titles.</li>
   * <li><code>VERBOSE</code> - adds information about the called service and
   * parameters.</li>
   * <li><code>TRACE</code> - provides the most verbose output with dumping the
   * contents of the returned pages.</li>
   * </ul>
   *
   * @parameter expression="${verbose}" default-value="NORMAL"
   * @since 1.0
   */
  protected String verbose;

  // ... fixes ................................................................

  // ****************************** Initializer *******************************

  // ****************************** Constructors ******************************

  // ****************************** Inner Classes *****************************

  /**
   * Provides access information for the continuous integration server.
   */
  protected static final class IssueServer extends Server
  {
    /**
     * The class version identifier.
     * <p>
     * The value of this constant is {@value}.
     * </p>
     */
    private static final long serialVersionUID = 1L;

    /**
     * The URL to the server.
     */
    private final String url;

    /**
     * Default constructor.
     *
     * @param url the URL to the server.
     * @param server the server information from the <code>settings.xml</code>.
     */
    private IssueServer(final Server server, final String url)
    {
      this.url = url;

      if (server != null)
      {
        this.setId(server.getId());
        this.setUsername(server.getUsername());

        this.setPassword(server.getPassword());
        this.setPassphrase(server.getPassphrase());
        this.setPrivateKey(server.getPrivateKey());

        this.setDirectoryPermissions(server.getDirectoryPermissions());
        this.setFilePermissions(server.getFilePermissions());
        this.setConfiguration(server.getConfiguration());

        this.setSourceLevel(server.getSourceLevel());
      }
    }

    /**
     * Returns the URL to the server.
     *
     * @return the URL to the server.
     */
    public String getUrl()
    {
      return url;
    }
  }

  // ********************************* Methods ********************************

  // --- init -----------------------------------------------------------------

  // --- get&set --------------------------------------------------------------

  /**
   * Returns the Maven project.
   *
   * @return the Maven project.
   */
  protected final MavenProject getProject()
  {
    return new MavenProjectWrapper(project);
  }

  // --- business -------------------------------------------------------------

  /**
   * Returns the issue server configuration to run a remote access.
   *
   * @return the server information. If no access information is found, only the
   *         URL to the issue server is returned.
   * @throws MojoExecutionException if no issue server URL is specified.
   */
  protected final IssueServer getIssueServer() throws MojoExecutionException
  {
    final IssueManagement issueManagement = project.getIssueManagement();
    if (issueManagement == null)
    {
      throw new MojoExecutionException(
          "No issue management specified. Please provide issue information"
              + " within the 'issueManagement' block of your POM.");
    }

    final Server server = getIssueServerFromSettings(issueManagement);
    final String ciUrl = issueManagement.getUrl();
    return new IssueServer(server, ciUrl);
  }

  // CHECKSTYLE:OFF
  /**
   * {@inheritDoc}
   *
   * @see org.apache.maven.plugin.Mojo#execute()
   */
  @Override
  public void execute() throws MojoExecutionException, MojoFailureException
  // CHECKSTYLE:ON
  {
    final Log log = getLog();

    server = getIssueServer();
    final String url = server.getUrl();
    final LogLevel logLevel = new LogLevel(verbose);
    final CommandTarget target = new CommandTarget(url);

    console = new Console(target, log, logLevel);
  }

  private Server getIssueServerFromSettings(
      final IssueManagement issueManagement) throws MojoExecutionException
  {
    final String issueUrl = issueManagement.getUrl();
    if (StringUtils.isBlank(issueUrl))
    {
      throw new MojoExecutionException(
          "No issue URL specified. Please provide issue information within the"
              + " 'issueManagement/url' block of your POM.");
    }

    Server server;
    if (StringUtils.isNotBlank(issueServerId))
    {
      server = settings.getServer(issueServerId);
      if (server != null)
      {
        return server;
      }
    }

    final String ciName = issueManagement.getSystem();
    if (StringUtils.isNotBlank(ciName))
    {
      server = settings.getServer(ciName);
      if (server != null)
      {
        return server;
      }
    }

    server = settings.getServer(issueUrl);

    return server;
  }

  /**
   * Checks whether or not the plugin should execute.
   *
   * @return <code>true</code> if the execution of the plugin should be skipped,
   *         <code>false</code> if it should run.
   */
  protected final boolean isToSkip()
  {
    return !project.isExecutionRoot();
  }

  // --- object basics --------------------------------------------------------

}