com.carrotgarden.maven.scalor.base.Mojo.scala Maven / Gradle / Ivy

Go to download
package com.carrotgarden.maven.scalor.base

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

import com.carrotgarden.maven.scalor.eclipse
import com.carrotgarden.maven.scalor.util.Error.Throw
import com.carrotgarden.maven.scalor.util
import org.codehaus.plexus.util.xml.Xpp3Dom
import org.apache.maven.plugin.MojoExecution
import com.carrotgarden.maven.scalor.util.Maven

/**
 * Shared mojo execution process steps.
 */
trait Mojo extends AbstractMojo
  with Params
  with Logging
  with Context
  with Skip
  with SkipMojo {

  /**
   * Mojo execution name.
   */
  def mojoName : String

  /**
   * Mojo skip flag.
   */
  def hasSkip : Boolean = {
    skip
  }

  def hasSkipPackaging : Boolean = {
    skipPackagingList.contains( project.getPackaging )
  }

  def reportSkipReason( line : String ) : Unit = {
    if ( skipLogReason ) { log.info( line ) }
  }

  def throwNotUsed = Throw( "Not used." )

  /**
   * Actually perform goal execution.
   */
  def perform() : Unit

  override def execute() : Unit = {
    try {
      // Use local JNA native library.
      // https://github.com/sbt/io/issues/110
      sys.props.put( "jna.nosys", "true" )
      //
      contextReset()
      if ( hasSkip ) {
        reportSkipReason( "Skipping plugin execution." )
        return
      }
      if ( hasSkipPackaging ) {
        reportSkipReason( s"Skipping plugin execution for packaging '${project.getPackaging}'." )
        return
      }
      perform()
    } catch {
      case error : Throwable =>
        val message = "Execution failure"
        contextError( message, error );
        logger.fail( s"${message}: ${error.getMessage}" )
        throw new MojoFailureException( message, error )
    }
  }

  /**
   * Perform goal execution from this plugin.
   */
  def executeSelfMojo( goal : String ) : Unit = {
    logger.info( s"Invoking goal: ${goal}" )
    val mojoMeta = pluginMeta.getMojo( goal )
    val mojoConfig = mojoMeta.getMojoConfiguration
    val executionConfig = Maven.convertPlexusConfig( mojoConfig )
    val mojoExecution = new MojoExecution( mojoMeta, executionConfig )
    buildManager.executeMojo( session, mojoExecution )
  }

}