Initial revision of Groovy scripting plugin support for Gerrit
Provides the ability to load Groovy scripts as external
ServerPlugin into Gerrit.
Supports both explicit Guice module definition and auto-discovery
of annotated classes.
Depends on the 'scripting-reloaded' topic changes.
Change-Id: I4e5c0de302499ce137ba7aaf6e5a1cc8f6b4ef57
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..fb96bc0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+/target
+/.classpath
+/.settings
+/.project
+
diff --git a/BUCK b/BUCK
new file mode 100644
index 0000000..f963c34
--- /dev/null
+++ b/BUCK
@@ -0,0 +1,23 @@
+include_defs('//lib/maven.defs')
+
+gerrit_plugin(
+ name = 'groovy-provider',
+ srcs = glob(['src/main/java/**/*.java']),
+ resources = glob(['src/main/**/*']),
+ manifest_entries = [
+ 'Implementation-Title: Groovy Provider',
+ 'Implementation-URL: https://gerrit.googlesource.com/plugins/scripting/groovy-provider',
+ 'Gerrit-PluginName: groovy-provider',
+ 'Gerrit-Module: com.googlesource.gerrit.plugins.scripting.groovyprovider.Module'
+ ],
+ deps = [
+ ':groovy',
+ ],
+)
+
+maven_jar(
+ name = 'groovy',
+ id = 'org.codehaus.groovy:groovy-all:2.2.1',
+ sha1 = '07ae565d50d24167c4e5d74b96f4126d4c56f16f',
+ license = 'Apache2.0',
+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..11069ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c2914a4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+Gerrit Groovy Provider Plugin
+=============================
+
+This plugin provides Groovy runtime environment for Gerrit plugins in Groovy.
+
+To test this series must be applied on top of Gerrit master [1].
+
+To build link this directory under Gerrit's tree plugins directory and run:
+
+```
+ buck build plugins/groovy-provider
+```
+
+The resulting artifact can be found under:
+
+```
+ buck-out/gen/plugins/groovy-provider/groovy-provider.jar
+```
+
+To test deploy the review plugin [2] and copy this Groovy Provider plugin
+under `$gerrit_site/plugins` directory.
+
+Review plugin in Groovy can be used:
+
+```
+ ssh gerrit review approve I59302cbb
+ Approve change: I59302cbb
+```
+
+* [1] https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit+branch:master+topic:plugin-dependencies
+* [2] https://github.com/davido/gerrit-groovy-plugin
diff --git a/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginProvider.java b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginProvider.java
new file mode 100644
index 0000000..8f5f68d
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginProvider.java
@@ -0,0 +1,90 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// 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 com.googlesource.gerrit.plugins.scripting.groovyprovider;
+
+import com.google.common.collect.Sets;
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.PluginUser;
+import com.google.gerrit.server.plugins.InvalidPluginException;
+import com.google.gerrit.server.plugins.ServerPlugin;
+import com.google.gerrit.server.plugins.ServerPluginProvider;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import org.eclipse.jgit.internal.storage.file.FileSnapshot;
+
+import java.io.File;
+import java.util.Set;
+
+/**
+ * Groovy scripting plugins.
+ *
+ * Allows to define a Groovy class to implement any type of Gerrit plugin.
+ *
+ * Example of Groovy SSH Plugin (hello-1.0.groovy):
+ * ------------------------------------------------ import
+ * com.google.gerrit.sshd.SshCommand import
+ * com.google.gerrit.extensions.annotations.Export
+ *
+ * @Export("groovy")
+ * class GroovyCommand extends SshCommand {
+ * public void run() {
+ * stdout.println("Hello Gerrit from Groovy !")
+ * }
+ *
+ * The above example add a "hello groovy" command to Gerrit
+ * SSH interface that displays "Hello Gerrit from Groovy !".
+ */
+@Listen
+class GroovyPluginProvider implements ServerPluginProvider {
+ private static final Set<String> GROOVY_EXTENSIONS = Sets.newHashSet(
+ "groovy", "gvy", "gy", "gsh");
+
+ private final Provider<GroovyPluginScriptEngine> scriptEngineProvider;
+
+ @Inject
+ public GroovyPluginProvider(Provider<GroovyPluginScriptEngine> scriptEngineProvider) {
+ this.scriptEngineProvider = scriptEngineProvider;
+ }
+
+
+ @Override
+ public ServerPlugin get(String name, File srcFile, PluginUser pluginUser,
+ FileSnapshot snapshot, String pluginCanonicalWebUrl, File pluginDataDir)
+ throws InvalidPluginException {
+ GroovyPluginScriptEngine scriptEngine = scriptEngineProvider.get();
+ return new ServerPlugin(getPluginName(srcFile), pluginCanonicalWebUrl,
+ pluginUser, srcFile, snapshot, new GroovyPluginScanner(
+ getPluginName(srcFile), scriptEngine,
+ srcFile), pluginDataDir,
+ scriptEngine.getGroovyClassLoader());
+ }
+
+ @Override
+ public boolean handles(File srcFile) {
+ String srcFileName = srcFile.getName();
+ String scriptExtension =
+ srcFileName.substring(srcFileName.lastIndexOf('.') + 1).toLowerCase();
+ return GROOVY_EXTENSIONS.contains(scriptExtension.toLowerCase());
+ }
+
+ @Override
+ public String getPluginName(File srcFile) {
+ String srcFileName = srcFile.getName();
+ int dashPos = srcFileName.lastIndexOf('-');
+ int dotPos = srcFileName.lastIndexOf('.');
+ return srcFileName.substring(0, dashPos > 0 ? dashPos:dotPos);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScanner.java b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScanner.java
new file mode 100644
index 0000000..7811df0
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScanner.java
@@ -0,0 +1,143 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// 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 com.googlesource.gerrit.plugins.scripting.groovyprovider;
+
+import com.google.common.collect.Sets;
+import com.google.gerrit.server.plugins.AbstractPreloadedPluginScanner;
+import com.google.gerrit.server.plugins.InvalidPluginException;
+import com.google.gerrit.server.plugins.Plugin.ApiType;
+
+import groovy.lang.Binding;
+import groovy.lang.Script;
+import groovy.util.ResourceException;
+import groovy.util.ScriptException;
+
+import org.codehaus.groovy.runtime.InvokerHelper;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.Set;
+
+public class GroovyPluginScanner extends AbstractPreloadedPluginScanner {
+
+ public GroovyPluginScanner(String pluginName, GroovyPluginScriptEngine scriptEngine, File srcFile)
+ throws InvalidPluginException {
+ super(pluginName, getPluginVersion(srcFile), load(scriptEngine, srcFile), ApiType.PLUGIN);
+ }
+
+ private static String getPluginVersion(File srcFile) {
+ String srcFileName = srcFile.getName();
+ int dashPos = srcFileName.lastIndexOf('-');
+ int dotPos = srcFileName.lastIndexOf('.');
+ return dashPos > 0 ? srcFileName.substring(dashPos + 1, dotPos) : "0";
+ }
+
+ @Override
+ public <T> T getResource(String resourcePath, Class<? extends T> resourceClass) {
+ return null;
+ }
+
+ @Override
+ public InputStream getResourceInputStream(String resourcePath)
+ throws IOException {
+ return null;
+ }
+
+ @Override
+ public <T> Enumeration<T> resources(Class<? extends T> resourceClass) {
+ return Collections.emptyEnumeration();
+ }
+
+ public static Set<Class<?>> load(GroovyPluginScriptEngine scriptEngine, File srcFile) throws InvalidPluginException {
+ try {
+ return scanGroovyScriptBindings(scriptEngine.loadScriptByName(srcFile
+ .getName()));
+ } catch (ResourceException | ScriptException e) {
+ throw new InvalidPluginException(
+ "Cannot compile and execute Groovy script " + srcFile, e);
+ }
+ }
+
+ private static Set<Class<?>> scanGroovyScriptBindings(Class<?> scriptClass)
+ throws InvalidPluginException {
+ Set<Class<?>> classes = Sets.newHashSet();
+
+ try {
+ Method mainMethod = scriptClass.getMethod("main", String[].class);
+ int modifiers = mainMethod.getModifiers();
+ if (mainMethod != null && Modifier.isPublic(modifiers)
+ && Modifier.isStatic(modifiers)) {
+ classes.addAll(getMainBindings(scriptClass));
+ }
+ } catch (NoSuchMethodException e) {
+ classes.add(scriptClass);
+
+ } catch (SecurityException e) {
+ throw new InvalidPluginException("Cannot access Groovy script class "
+ + scriptClass.getName(), e);
+ }
+ return classes;
+ }
+
+ private static Set<Class<?>> getMainBindings(Class<?> scriptClass)
+ throws InvalidPluginException {
+ Set<Class<?>> classes = Sets.newHashSet();
+ Binding binding = new Binding();
+ Script script = InvokerHelper.createScript(scriptClass, binding);
+ script.run();
+
+ for (Object variable : binding.getVariables().keySet()) {
+ Object value = binding.getVariable(variable.toString());
+ if (value == null) {
+ continue;
+ }
+
+ if (ArrayList.class.isAssignableFrom(value.getClass())) {
+ classes.addAll(scanArrayOfObjectOrClass(value));
+ } else {
+ classes.add(scanObjectOrClass(value));
+ }
+ }
+
+ return classes;
+ }
+
+ private static Set<Class<?>> scanArrayOfObjectOrClass(Object value)
+ throws InvalidPluginException {
+ Set<Class<?>> classes = Sets.newHashSet();
+ ArrayList<?> list = (ArrayList<?>) value;
+ for (Object element : list) {
+ if (element == null) {
+ continue;
+ }
+ classes.add(scanObjectOrClass(element));
+ }
+ return classes;
+ }
+
+ private static Class<?> scanObjectOrClass(Object element)
+ throws InvalidPluginException {
+ if (Class.class.isAssignableFrom(element.getClass())) {
+ return (Class<?>) element;
+ } else {
+ return element.getClass();
+ }
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScriptEngine.java b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScriptEngine.java
new file mode 100644
index 0000000..e26ca86
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/GroovyPluginScriptEngine.java
@@ -0,0 +1,31 @@
+// Copyright (C) 2014 The Android Open Source Project
+//
+// 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 com.googlesource.gerrit.plugins.scripting.groovyprovider;
+
+import com.google.gerrit.server.config.SitePaths;
+import com.google.inject.Inject;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+import groovy.util.GroovyScriptEngine;
+
+public class GroovyPluginScriptEngine extends GroovyScriptEngine {
+
+ @Inject
+ public GroovyPluginScriptEngine(SitePaths sitePaths)
+ throws MalformedURLException {
+ super(new URL[] {sitePaths.plugins_dir.toURI().toURL()});
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/Module.java b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/Module.java
new file mode 100644
index 0000000..512c67f
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/scripting/groovyprovider/Module.java
@@ -0,0 +1,29 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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 com.googlesource.gerrit.plugins.scripting.groovyprovider;
+
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.gerrit.server.plugins.ServerPluginProvider;
+import com.google.inject.AbstractModule;
+
+public class Module extends AbstractModule {
+
+ @Override
+ protected void configure() {
+ DynamicSet.bind(binder(), ServerPluginProvider.class)
+ .to(GroovyPluginProvider.class);
+ bind(GroovyPluginScriptEngine.class);
+ }
+}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
new file mode 100644
index 0000000..385be15
--- /dev/null
+++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,18 @@
+Gerrit Groovy Provider Plugin.
+
+This plugin provides Groovy runtime environment for Gerrit plugins in Groovy.
+
+To test this series must be applied on top of Gerrit master [1].
+
+To test deploy the review plugin [2] and copy this Groovy Provider plugin
+under `$gerrit_site/plugins` directory.
+
+Review plugin in Groovy can be used:
+
+```
+ ssh gerrit review approve I59302cbb
+ Approve change: I59302cbb
+```
+
+* [1] https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit+branch:master+topic:plugin-dependencies
+* [2] https://github.com/davido/gerrit-groovy-plugin
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md
new file mode 100644
index 0000000..a7afbc9
--- /dev/null
+++ b/src/main/resources/Documentation/build.md
@@ -0,0 +1,23 @@
+Build
+=====
+
+This plugin is built with Buck.
+
+Clone or link this plugin to the plugins directory of Gerrit's source
+tree, and issue the command:
+
+```
+ buck build plugins/cookbook-plugin
+```
+
+The output is created in
+
+```
+ buck-out/gen/plugins/groovy-provider/groovy-provider.jar
+```
+
+This project can be imported into the Eclipse IDE:
+
+```
+ ./tools/eclipse/project.py
+```
