example-simpleSshCommand
Change-Id: I0d50fa6ea6b568b213f434ee1f33c856cf7195a1
diff --git a/README b/README
new file mode 100644
index 0000000..b8a2844
--- /dev/null
+++ b/README
@@ -0,0 +1,82 @@
+Build
+=====
+
+This plugin is built with Buck.
+
+Two build modes are supported: Standalone and in Gerrit tree. Standalone
+build mode is recommended, as this mode doesn't require local Gerrit
+tree to exist.
+
+Build standalone
+----------------
+
+Clone bucklets library:
+
+
+ git clone https://gerrit.googlesource.com/bucklets
+
+
+and link it to examples directory:
+
+
+ cd examples && ln -s ../bucklets .
+
+
+To build a specific example plugin, issue the following command:
+
+
+ cd example-<example> && buck build plugin
+
+
+The output or each example is created in
+
+
+ buck-out/gen/example-<example>.jar
+
+To execute the tests run:
+
+
+ buck test
+
+
+Build in Gerrit tree
+--------------------
+
+Clone or link this plugin to the plugins directory of Gerrit's source
+tree, and issue the command:
+
+
+ buck build plugins/examples/example-<example>
+
+
+The output is created in
+
+
+ buck-out/gen/plugins/examples/example-<example>/example-<example>.jar
+
+
+This project can be imported into the Eclipse IDE:
+
+
+ ./tools/eclipse/project.py
+
+
+To execute the tests run:
+
+
+ buck test --include examples/example-<example>
+
+Note that for compatibility reasons a Maven build is provided, but is considered
+to be deprecated and will be removed in a future version of this plugin.
+
+To build with Maven, change directory to the specific example plugin folder and
+issue the command:
+
+
+ mvn clean package
+
+
+When building with Maven, the Gerrit Plugin API must be available.
+
+How to build the Gerrit Plugin API is described in the Gerrit
+documentation (../../../Documentation/dev-buck.html#_extension_and_plugin_api_jar_files).
diff --git a/example-simpleSshCommand/.buckconfig b/example-simpleSshCommand/.buckconfig
new file mode 100644
index 0000000..31d8382
--- /dev/null
+++ b/example-simpleSshCommand/.buckconfig
@@ -0,0 +1,15 @@
+[alias]
+ plugin = //:example-simpleSshCommand
+
+[java]
+ src_roots = java, resources
+ source_level = 8
+ target_level = 8
+
+[project]
+ ignore = .git
+
+[cache]
+ mode = dir
+ dir = buck-out/cache
+
diff --git a/example-simpleSshCommand/.buckversion b/example-simpleSshCommand/.buckversion
new file mode 120000
index 0000000..6203e53
--- /dev/null
+++ b/example-simpleSshCommand/.buckversion
@@ -0,0 +1 @@
+bucklets/buckversion
\ No newline at end of file
diff --git a/example-simpleSshCommand/.gitignore b/example-simpleSshCommand/.gitignore
new file mode 100644
index 0000000..db1c934
--- /dev/null
+++ b/example-simpleSshCommand/.gitignore
@@ -0,0 +1,8 @@
+/target
+/.classpath
+/.settings
+/.project
+/.buckd
+/buck-cache
+/buck-out
+*.iml
diff --git a/example-simpleSshCommand/BUCK b/example-simpleSshCommand/BUCK
new file mode 100644
index 0000000..fd4375e
--- /dev/null
+++ b/example-simpleSshCommand/BUCK
@@ -0,0 +1,21 @@
+include_defs('//bucklets/gerrit_plugin.bucklet')
+
+gerrit_plugin(
+ name = 'example-simpleSshCommand',
+ srcs = glob(['src/main/java/**/*.java']),
+ resources = glob(['src/main/**/*']),
+ manifest_entries = [
+ 'Gerrit-PluginName: example-simpleSshCommand',
+ 'Gerrit-SshModule: com.googlesource.gerrit.plugins.examples.simplesshcommand.SshModule',
+ 'Implementation-Title: Example Simple Ssh Command',
+ 'Implementation-URL: https://gerrit-review.googlesource.com/#/admin/projects/plugins/examples',
+ ],
+)
+
+# TODO(davido): is this needed?
+# requires for bucklets/tools/eclipse/project.py to work
+# not sure, if this does something useful in standalone context
+java_library(
+ name = 'classpath',
+ deps = [':example-simpleSshCommand__plugin'],
+)
diff --git a/example-simpleSshCommand/LICENSE b/example-simpleSshCommand/LICENSE
new file mode 100644
index 0000000..11069ed
--- /dev/null
+++ b/example-simpleSshCommand/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/example-simpleSshCommand/bucklets b/example-simpleSshCommand/bucklets
new file mode 120000
index 0000000..faeb10e
--- /dev/null
+++ b/example-simpleSshCommand/bucklets
@@ -0,0 +1 @@
+../bucklets
\ No newline at end of file
diff --git a/example-simpleSshCommand/lib/gerrit/BUCK b/example-simpleSshCommand/lib/gerrit/BUCK
new file mode 100644
index 0000000..b54f677
--- /dev/null
+++ b/example-simpleSshCommand/lib/gerrit/BUCK
@@ -0,0 +1,12 @@
+include_defs('//bucklets/maven_jar.bucklet')
+
+VER = '2.14-SNAPSHOT'
+REPO = MAVEN_LOCAL
+
+maven_jar(
+ name = 'plugin-api',
+ id = 'com.google.gerrit:gerrit-plugin-api:' + VER,
+ license = 'Apache2.0',
+ attach_source = False,
+ repository = REPO,
+)
diff --git a/example-simpleSshCommand/pom.xml b/example-simpleSshCommand/pom.xml
new file mode 100644
index 0000000..6e6cf89
--- /dev/null
+++ b/example-simpleSshCommand/pom.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+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.
+-->
+<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/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <groupId>com.googlesource.gerrit.plugins</groupId>
+ <artifactId>example-simpleSshCommand</artifactId>
+ <packaging>jar</packaging>
+ <version>2.14-SNAPSHOT</version>
+ <properties>
+ <Gerrit-ApiType>plugin</Gerrit-ApiType>
+ <Gerrit-ApiVersion>${project.version}</Gerrit-ApiVersion>
+ </properties>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jar-plugin</artifactId>
+ <version>2.4</version>
+ <configuration>
+ <archive>
+ <manifestEntries>
+ <Gerrit-PluginName>example-simpleSshCommand</Gerrit-PluginName>
+ <Gerrit-SshModule>com.googlesource.gerrit.plugins.examples.simplesshcommand.SshModule</Gerrit-SshModule>
+
+ <Implementation-Vendor>Gerrit Code Review</Implementation-Vendor>
+ <Implementation-URL>https://gerrit-review.googlesource.com/#/admin/projects/plugins/examples</Implementation-URL>
+
+ <Implementation-Title>Example Simple Ssh Command</Implementation-Title>
+ <Implementation-Version>${project.version}</Implementation-Version>
+
+ <Gerrit-ApiType>${Gerrit-ApiType}</Gerrit-ApiType>
+ <Gerrit-ApiVersion>${Gerrit-ApiVersion}</Gerrit-ApiVersion>
+ </manifestEntries>
+ </archive>
+ </configuration>
+ </plugin>
+
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-compiler-plugin</artifactId>
+ <version>2.3.2</version>
+ <configuration>
+ <source>1.8</source>
+ <target>1.8</target>
+ <encoding>UTF-8</encoding>
+ </configuration>
+ </plugin>
+ </plugins>
+
+ </build>
+
+ <dependencies>
+ <dependency>
+ <groupId>com.google.gerrit</groupId>
+ <artifactId>gerrit-${Gerrit-ApiType}-api</artifactId>
+ <version>${Gerrit-ApiVersion}</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <repositories>
+ <repository>
+ <id>maven.org</id>
+ <url>http://repo1.maven.org/maven2</url>
+ </repository>
+ </repositories>
+</project>
diff --git a/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/PrintHelloWorldCommand.java b/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/PrintHelloWorldCommand.java
new file mode 100644
index 0000000..3d6f704
--- /dev/null
+++ b/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/PrintHelloWorldCommand.java
@@ -0,0 +1,39 @@
+// 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.examples.simplesshcommand;
+
+import com.google.gerrit.sshd.CommandMetaData;
+import com.google.gerrit.sshd.SshCommand;
+
+import org.kohsuke.args4j.Argument;
+import org.kohsuke.args4j.Option;
+
+@CommandMetaData(name = "print", description = "Print greeting in different languages")
+public final class PrintHelloWorldCommand extends SshCommand {
+
+ @Argument(usage = "name of user")
+ private String name = "world";
+
+ @Option(name = "--french", usage = "output in French?")
+ private boolean french;
+
+ @Override
+ public void run() {
+ final String greeting = (french ? "Bonjour " : "Hello ");
+ // Note the use of '\n' instead of println to keep platform-agnostic line
+ // terminator.
+ stdout.print(greeting + name + "!\n");
+ }
+}
diff --git a/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/SshModule.java b/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/SshModule.java
new file mode 100644
index 0000000..0de60de
--- /dev/null
+++ b/example-simpleSshCommand/src/main/java/com/googlesource/gerrit/plugins/examples/simplesshcommand/SshModule.java
@@ -0,0 +1,24 @@
+// 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.examples.simplesshcommand;
+
+import com.google.gerrit.sshd.PluginCommandModule;
+
+public class SshModule extends PluginCommandModule {
+ @Override
+ protected void configureCommands() {
+ command(PrintHelloWorldCommand.class);
+ }
+}
diff --git a/example-simpleSshCommand/src/main/resources/Documentation/about.md b/example-simpleSshCommand/src/main/resources/Documentation/about.md
new file mode 100644
index 0000000..63ae6fd
--- /dev/null
+++ b/example-simpleSshCommand/src/main/resources/Documentation/about.md
@@ -0,0 +1 @@
+Sample plugin to demonstrate the simpleSshCommand feature of Gerrit's plugin API.
diff --git a/example-simpleSshCommand/src/main/resources/Documentation/cmd-print.md b/example-simpleSshCommand/src/main/resources/Documentation/cmd-print.md
new file mode 100644
index 0000000..8b9a0ae
--- /dev/null
+++ b/example-simpleSshCommand/src/main/resources/Documentation/cmd-print.md
@@ -0,0 +1,62 @@
+@PLUGIN@ print
+==============
+
+NAME
+----
+@PLUGIN@ print - Print our "Hello world" message
+
+SYNOPSIS
+--------
+> ssh -p <port> <host> @PLUGIN@ print
+> [--french]
+> [name]
+
+DESCRIPTION
+-----------
+Prints "Hello world!" or optionally "Bonjour world!".
+
+OPTIONS
+-------
+
+--french
+> Translate to French.
+
+--help
+
+-h
+> Display usage information.
+
+name
+> Display given name instead of 'world'.
+
+ACCESS
+------
+Any user who has configured an SSH key.
+
+SCRIPTING
+---------
+This command is intended to be used in scripts.
+
+EXAMPLES
+--------
+
+Have the server say hi to the world.
+
+> $ ssh -p 29418 review.example.com @PLUGIN@ print
+
+Have the server say hi to the world in French.
+
+> $ ssh -p 29418 review.example.com @PLUGIN@ print --french
+
+Have the server say hi to you in French.
+
+> $ ssh -p 29418 review.example.com @PLUGIN@ print --french \'Revi Ewer\'
+
+SEE ALSO
+--------
+
+* [Plugin Development](../../../Documentation/dev-plugins.html)
+
+GERRIT
+------
+Part of [Gerrit Code Review](../../../Documentation/index.html)
