Skip to content

Allow scripting in files #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ under the License.

<name>Apache Maven Scripting Plugin</name>
<description>
The Maven Scripting Plugin is a plugin that wrapped the Scripting API accoring to JSR223
The Maven Scripting Plugin is a plugin that wrapped the Scripting API according to JSR223.
Add the scripting engines as dependencies of this plugin on its use.
</description>
<inceptionYear>2016</inceptionYear>

Expand Down Expand Up @@ -92,13 +93,6 @@ under the License.
<scope>provided</scope>
</dependency>

<!-- ScriptEngines -->
<dependency>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be an important change for users, it should be another ticket, please create a separate patch.
Btw why don't you want this one on the classpath?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that the groovy script interpreter is not necessary for the compilation and running of the plugin/ Instead it imposes the download of a significant graph of dependencies. The plugin allows using other than groovy languages and should treat them equally.
The groovy sccript interpreter is moved to the test poms.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, there is no previous version of the plugin published on Maven Central, its version is 3.0.0-SNAPSHOT which assumes interface changes, that are not finalized. Now is the time to avoid using groovy.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For Maven the versioning scheme works a bit different. The 3.x.x means this plugin requires at least Maven 3. If we break backwords compatibility it is for the next Maven version.
This scheme has proven itself over the years, now there's no confusion anymore if a certain plugin works with Maven 2 or not.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rpopov as we never released this plugin to the public I am fine with dropping the dependency now

<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>

<!-- Test -->
<dependency>
<groupId>junit</groupId>
Expand Down
51 changes: 51 additions & 0 deletions src/it/groovy-script-file-name/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?xml version='1.0' encoding='UTF-8'?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.plugins.scripting.its</groupId>
<artifactId>groovy-script</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scripting-plugin</artifactId>
<version>@project.version@</version>
<configuration>
<engineName>groovy</engineName>
<scriptFile>test.groov</scriptFile>
</configuration>
<dependencies>
<!-- ScriptEngines -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
21 changes: 21 additions & 0 deletions src/it/groovy-script-file-name/test.groov
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/


(1..10).sum() + ' ' + project.artifactId
51 changes: 51 additions & 0 deletions src/it/groovy-script-file/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?xml version='1.0' encoding='UTF-8'?>

<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.apache.maven.plugins.scripting.its</groupId>
<artifactId>groovy-script</artifactId>
<version>1.0.0-SNAPSHOT</version>
<packaging>pom</packaging>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scripting-plugin</artifactId>
<version>@project.version@</version>
<configuration>
<!--engineName>groovy</engineName-->
<scriptFile>test.groovy</scriptFile>
</configuration>
<dependencies>
<!-- ScriptEngines -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
21 changes: 21 additions & 0 deletions src/it/groovy-script-file/test.groovy
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/


(1..10).sum() + ' ' + project.artifactId
8 changes: 8 additions & 0 deletions src/it/groovy-script/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ under the License.
]]>
</script>
</configuration>
<dependencies>
<!-- ScriptEngines -->
<dependency>
<groupId>org.codehaus.groovy</groupId>
<artifactId>groovy-jsr223</artifactId>
<version>2.4.7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
Expand Down
117 changes: 64 additions & 53 deletions src/main/java/org/apache/maven/plugins/scripting/EvalMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
* under the License.
*/

import javax.script.ScriptContext;
import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;
import javax.script.ScriptException;
import java.io.File;

import javax.script.Bindings;
import javax.script.SimpleBindings;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
Expand All @@ -33,77 +33,88 @@

/**
* Evaluate the specified script
*
*
* @author Robert Scholte
* @since 3.0.0
*/
@Mojo( name = "eval" )
public class EvalMojo
extends AbstractMojo
{
@Parameter( required = true )
private String engineName; // or map extension to engineName??
@Parameter
private String engineName;

/**
* When used, also specify the engineName
*/
@Parameter
private String script;

/**
* Provide the script as an external file as an alternative to &lt;script&gt;.
* When scriptFile provided the script is ignored.
* The file name extension identifies the script language to use, as of javax.script.ScriptEngineManager
* and {@linkplain "https://jcp.org/aboutJava/communityprocess/final/jsr223/index.html"}
*/
@Parameter
private File scriptFile;

// script variables
@Parameter( defaultValue = "${project}", readonly = true )
private MavenProject project;

private ScriptEngineManager manager = new ScriptEngineManager();

@Override
public void execute()
throws MojoExecutionException, MojoFailureException
{
ScriptEngine engine = null;

if ( script != null )
{
engine = getScriptEngine( engineName );

if ( engine == null )
{
throw new MojoFailureException( "Missing scriptEngine" );
}
}
else
{
// from file
}

try
{
ScriptContext context = engine.getContext();
context.setAttribute( "project", project, ScriptContext.GLOBAL_SCOPE );

Object result = engine.eval( script );

getLog().info( "Result:" );
if ( result != null )
{
getLog().info( result.toString() );
}
}
catch ( ScriptException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
Execute execute;
Object result;
Bindings bindings;

try
{
execute = constructExecute();

bindings = new SimpleBindings();
bindings.put( "project", project );
bindings.put( "log", getLog() );

result = execute.run( bindings );

getLog().info( "Result:" );
if ( result != null )
{
getLog().info( result.toString() );
}
}
catch ( IllegalArgumentException e ) // configuring the plugin failed
{
throw new MojoExecutionException( e.getMessage(), e );
}
catch ( Exception e ) // execution failure
{
throw new MojoFailureException( e.getMessage(), e );
}
}
private ScriptEngine getScriptEngine( String name )

private Execute constructExecute() throws IllegalArgumentException
{
if ( name == null )
{
return null;
}
else
{
return manager.getEngineByName( engineName );
}
Execute execute;

if ( scriptFile != null )
{
execute = new ExecuteFile( engineName, scriptFile );

}
else if ( script != null )
{
execute = new ExecuteString( engineName, script );

}
else
{
throw new IllegalArgumentException( "Missing script or scriptFile provided" );
}
return execute;
}
}
}
Loading