com.sap.cds.maven.plugin.build

Class CdsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.sap.cds.maven.plugin.AbstractCdsMojo

com.sap.cds.maven.plugin.build.CdsMojo

All Implemented Interfaces:

CdsMojoLogger, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="cds",
      defaultPhase=GENERATE_SOURCES,
      aggregator=true)
public class CdsMojo
extends AbstractCdsMojo

Execute CDS commands on the CAP Java project.
Call mvn cds:cds or mvn com.sap.cds:cds-maven-plugin:cds on the command line to execute all configured CDS commands of the project in current directory.

Several CDS commands can be configured in one execution block and they’re executed in the specified order. If a command execution fails, the overall goal execution is stopped and the Maven build fails.

Note: This goal requires the installation of the @sap/cds-dk with a minimum version 4.0.0, either locally or globally. The goal cds:install-cdsdk can be used for this task.

Since:

1.7.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAM_NODE_DIR
protected static String	PARAM_NPM_EXECUTABLE
protected static String	PARAM_NPX_EXECUTABLE
protected static String	PROP_NODE_DIR
protected static String	PROP_NODE_EXECUTABLE
protected static String	PROP_NPM_EXECUTABLE
protected static String	PROP_NPX_EXECUTABLE
protected org.eclipse.aether.RepositorySystemSession	repositorySystemSession Defines settings and components that control the repository system.

Fields inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo

buildContext, CDS_SERVICES_GROUPID, mojoExecution, PLUGIN_KEY, project, session, settings

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
CdsMojo()

Method Summary

Modifier and Type	Method and Description
void	execute()
protected void	execute(File workDir, File execFile, OutputStream outputStream, Map<String,String> additionalEnv, int[] exitValues, String... args) Executes a program as child process.
protected void	executeCds(File workDir, String args, OutputStream output, Map<String,String> additionalEnv) Executes a cds command with given arguments in given working directory.
protected String	executeCdsVersion() Executes command cds version and returns console output.
protected File	findCdsWorkingDir() Finds the cds working directory by going upwards and looking for a .cdsrc.json file.
protected File	getWorkingDirectory()
void	setNpxExec(File npxExec) Gets called to inject parameter "npxExec".

Methods inherited from class com.sap.cds.maven.plugin.AbstractCdsMojo

ensureCliExecuted, findGoalExecution, findSrvProject, getReactorBaseDirectory, isCliExecuted, logDebug, logDebug, logError, logError, logError, logInfo, logWarn, logWarn, logWarn, scanDirectory, setProperty, strong

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_NODE_DIR

protected static final String PROP_NODE_DIR

See Also:

Constant Field Values

PROP_NODE_EXECUTABLE

protected static final String PROP_NODE_EXECUTABLE

See Also:

Constant Field Values

PROP_NPM_EXECUTABLE

protected static final String PROP_NPM_EXECUTABLE

See Also:

Constant Field Values

PROP_NPX_EXECUTABLE

protected static final String PROP_NPX_EXECUTABLE

See Also:

Constant Field Values

PARAM_NODE_DIR

protected static final String PARAM_NODE_DIR

See Also:

Constant Field Values

PARAM_NPX_EXECUTABLE

protected static final String PARAM_NPX_EXECUTABLE

See Also:

Constant Field Values

PARAM_NPM_EXECUTABLE

protected static final String PARAM_NPM_EXECUTABLE

See Also:

Constant Field Values

repositorySystemSession

@Parameter(defaultValue="${repositorySystemSession}",
           required=true,
           readonly=true)
protected org.eclipse.aether.RepositorySystemSession repositorySystemSession

Defines settings and components that control the repository system.

Constructor Detail

CdsMojo

public CdsMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

setNpxExec

public void setNpxExec(File npxExec)

Gets called to inject parameter "npxExec".

Parameters:

npxExec - a File pointing to npx executable

executeCds

protected void executeCds(File workDir,
                          String args,
                          OutputStream output,
                          Map<String,String> additionalEnv)
                   throws IOException

Executes a cds command with given arguments in given working directory.

Parameters:

workDir - the working directory to use

args - the cds command line arguments

output - an optional OutputStream

Throws:

org.apache.commons.exec.ExecuteException - if CDS execution failed with an error

IOException - if an I/O error occurred

getWorkingDirectory

protected File getWorkingDirectory()

executeCdsVersion

protected String executeCdsVersion()
                            throws org.apache.maven.plugin.MojoExecutionException

Executes command cds version and returns console output.

Returns:

the console output of the cds version command

Throws:

org.apache.maven.plugin.MojoExecutionException - if execution fails

execute

protected void execute(File workDir,
                       File execFile,
                       OutputStream outputStream,
                       Map<String,String> additionalEnv,
                       int[] exitValues,
                       String... args)
                throws IOException

Executes a program as child process.

Parameters:

workDir - the working directory of child process

execFile - the executable to use

outputStream - an optional standard output stream

additionalEnv - additional environment variables, can be null

exitValues - an optional list with exit values of the process to be considered successful, can be null

args - an optional command line arguments passed to the process

Throws:

IOException - if an I/O exception occurred

org.apache.commons.exec.ExecuteException - if process execution failed

findCdsWorkingDir

protected File findCdsWorkingDir()

Finds the cds working directory by going upwards and looking for a .cdsrc.json file. It stops at the top-most project directory.

Returns:

the cds working directory or null if not found.