From 28a4fa86e1110e2b95fc6ed8804561d0f94ef9d0 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Wed, 23 Jan 2013 10:40:09 -0800 Subject: [PATCH] Initial proof of concept for zmq event publisher. It works, but isn't very useful yet. --- .gitignore | 2 + LICENSE | 202 ++++++++++ pom.xml | 360 ++++++++++++++++++ run-fast | 2 + .../ZMQEventPublisher/RunListenerImpl.java | 71 ++++ src/main/resources/index.jelly | 3 + .../plugins/ZMQEventPublisher/config.jelly | 2 + 7 files changed, 642 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 pom.xml create mode 100755 run-fast create mode 100644 src/main/java/org/jenkinsci/plugins/ZMQEventPublisher/RunListenerImpl.java create mode 100644 src/main/resources/index.jelly create mode 100644 src/main/resources/org/jenkinsci/plugins/ZMQEventPublisher/config.jelly diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..654f3f0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +target/ +work/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75b5248 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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/pom.xml b/pom.xml new file mode 100644 index 0000000..6b91ca4 --- /dev/null +++ b/pom.xml @@ -0,0 +1,360 @@ + + + + + + + 4.0.0 + + + org.jenkins-ci.plugins + plugin + 1.460 + + + org.jenkins-ci.plugins + zmq-event-publisher + hpi + 1.0 + + Jenkins Event Publisher (via ZMQ PUB SUB) + https://github.com/cboylan/zmq-event-publisher + + + + Apache License, Version 2.0 + https://github.com/cboylan/zmq-event-publisher/raw/master/LICENSE + repo + + + + + + clarkb + Clark Boylan + clark.boylan@gmail.com + + + + + scm:git:git://github.com/cboylan/zmq-event-publisher.git + scm:git:git@github.com:cboylan/zmq-event-publisher.git + https://github.com/cboylan/zmq-event-publisher + + + + + repo.jenkins-ci.org + http://repo.jenkins-ci.org/public/ + + + + + + org.zeromq + jzmq + 2.1.0-SNAPSHOT + compile + + + + org.zeromq + jzmq + 2.1.0-SNAPSHOT + native-${os.arch}-${native.os} + + + + + + Windows + + + windows + + + + Windows + + + + + + + repo.jenkins-ci.org + http://repo.jenkins-ci.org/public/ + + + + + + java.net-m2-repository + http://maven.jenkins-ci.org/content/repositories/releases/ + + + github-project-site + gitsite:git@github.com/jenkinsci/hello-world-plugin + + + + + ${os.name} + + UTF-8 + 1.6 + + 3.0.1 + 1.6 + 2.2 + 2.2 + 2.6 + 2.4.1 + 2.3.2 + 2.1 + 2.5 + 1.0 + 2.8 + 1.0 + 2.1.1 + 2.3.1 + 2.7 + 2.3.1 + 6.1.26 + 2.2 + 2.5 + 2.3.1 + 2.4.3 + 1.0 + 2.1 + 1.1 + 2.4.3 + 2.1.1 + 2.1.2 + 2.7.2 + 2.7.2 + 2.1.1 + 1.0-alpha-4 + 1.4 + 1.0-beta-4 + 1.5 + 1.0.5 + 2.4 + 1.2 + 2.3.1 + 2.1.0-1 + 2.0 + 2.0-beta-2 + 1.2 + 2.4 + 1.2 + 1.0-beta-3 + + + + + + org.apache.maven.scm + maven-scm-provider-gitexe + 1.3 + + + org.apache.maven.scm + maven-scm-manager-plexus + 1.3 + + + org.kathrynhuxtable.maven.wagon + wagon-gitsite + 0.3.1 + + + + + + maven-clean-plugin + ${maven-clean-plugin.version} + + + maven-compiler-plugin + ${maven-compiler-plugin.version} + + ${compileSource} + ${compileTarget} + true + true + + + + maven-deploy-plugin + ${maven-deploy-plugin.version} + + + maven-enforcer-plugin + ${maven-enforcer-plugin.version} + + + maven-install-plugin + ${maven-install-plugin.version} + + + maven-jar-plugin + ${maven-jar-plugin.version} + + + maven-release-plugin + ${maven-release-plugin.version} + + true + true + clean deploy + clean deploy + release + + + + maven-remote-resources-plugin + ${maven-remote-resources-plugin.version} + + + maven-resources-plugin + ${maven-resources-plugin.version} + + + maven-site-plugin + ${maven-site-plugin.version} + + + maven-source-plugin + ${maven-source-plugin.version} + + + maven-surefire-plugin + ${maven-surefire-plugin.version} + + methods + true + 4 + + + + + + + maven-doap-plugin + ${maven-doap-plugin.version} + + + site + pre-site + + generate + + + + + ${project.reporting.outputDirectory}/doap.rdf + + false + + + + + maven-site-plugin + ${maven-site-plugin.version} + + + + + + + + maven-changelog-plugin + ${maven-changelog-plugin.version} + + + maven-checkstyle-plugin + ${maven-checkstyle-plugin.version} + + + maven-javadoc-plugin + ${maven-javadoc-plugin.version} + + + maven-jxr-plugin + ${maven-jxr-plugin.version} + + + maven-pmd-plugin + ${maven-pmd-plugin.version} + + + maven-plugin-plugin + ${maven-plugin-plugin.version} + + + maven-project-info-reports-plugin + ${maven-project-info-reports-plugin.version} + + + + cim + distribution-management + index + issue-tracking + license + mailing-list + project-team + scm + summary + + + + + + maven-surefire-report-plugin + ${maven-surefire-report-plugin.version} + + + org.codehaus.mojo + cobertura-maven-plugin + ${cobertura-maven-plugin.version} + + + org.codehaus.mojo + findbugs-maven-plugin + ${findbugs-maven-plugin.version} + + + org.codehaus.mojo + javancss-maven-plugin + ${javancss-maven-plugin.version} + + + org.codehaus.mojo + jdepend-maven-plugin + ${jdepend-maven-plugin.version} + + + org.codehaus.mojo + taglist-maven-plugin + ${taglist-maven-plugin.version} + + + + + + diff --git a/run-fast b/run-fast new file mode 100755 index 0000000..4a22fcb --- /dev/null +++ b/run-fast @@ -0,0 +1,2 @@ +rm -rf work/plugins +mvn -Dmaven.test.skip=true -DskipTests=true clean hpi:run diff --git a/src/main/java/org/jenkinsci/plugins/ZMQEventPublisher/RunListenerImpl.java b/src/main/java/org/jenkinsci/plugins/ZMQEventPublisher/RunListenerImpl.java new file mode 100644 index 0000000..75be5d2 --- /dev/null +++ b/src/main/java/org/jenkinsci/plugins/ZMQEventPublisher/RunListenerImpl.java @@ -0,0 +1,71 @@ +package org.jenkinsci.plugins.ZMQEventPublisher; + +import hudson.Extension; +import hudson.EnvVars; +import hudson.model.AbstractBuild; +import hudson.model.TaskListener; +import hudson.model.listeners.RunListener; + +import org.zeromq.ZMQ; + +import java.io.IOException; +import java.lang.InterruptedException; + +/* + * Listener to publish Jenkins build events through ZMQ + * + * @author Clark Boylan + */ +@Extension +public class RunListenerImpl extends RunListener { + private final int port; + private ZMQ.Context context; + private ZMQ.Socket publisher; + private final String bind_addr; + + public RunListenerImpl() { + super(AbstractBuild.class); + this.port = 8888; + this.context = ZMQ.context(1); + this.publisher = context.socket(ZMQ.PUB); + + bind_addr = String.format("tcp://*:%d", this.port); + this.publisher.bind(bind_addr); + } + + @Override + public void onCompleted(AbstractBuild build, TaskListener listener) { + String update = String.format("onCompleted"); + try { + EnvVars env = build.getEnvironment(listener); + update = update + " " + env.toString(); + } catch (IOException e) { + } catch (InterruptedException e) { + } + this.publisher.send(update.getBytes(), 0); + } + + @Override + public void onDeleted(AbstractBuild build) { + String update = String.format("onDeleted"); + this.publisher.send(update.getBytes(), 0); + } + + @Override + public void onFinalized(AbstractBuild build) { + String update = String.format("onFinalized"); + this.publisher.send(update.getBytes(), 0); + } + + @Override + public void onStarted(AbstractBuild build, TaskListener listener) { + String update = String.format("onStarted"); + try { + EnvVars env = build.getEnvironment(listener); + update = update + " " + env.toString(); + } catch (IOException e) { + } catch (InterruptedException e) { + } + this.publisher.send(update.getBytes(), 0); + } +} diff --git a/src/main/resources/index.jelly b/src/main/resources/index.jelly new file mode 100644 index 0000000..e53f0ac --- /dev/null +++ b/src/main/resources/index.jelly @@ -0,0 +1,3 @@ +
+ This plugin publishes Jenkins build events in JSON as a ZMQ Publisher. +
diff --git a/src/main/resources/org/jenkinsci/plugins/ZMQEventPublisher/config.jelly b/src/main/resources/org/jenkinsci/plugins/ZMQEventPublisher/config.jelly new file mode 100644 index 0000000..a7e9295 --- /dev/null +++ b/src/main/resources/org/jenkinsci/plugins/ZMQEventPublisher/config.jelly @@ -0,0 +1,2 @@ + +