This plug-in adds job triggering based on XMPP Pub/Sub events.
This plugin allows Jenkins jobs to:
It is required to set up or to have access to an XMPP server in charge of handling the events and messages. There exist several available servers that could be used. Follow this website to find some examples.
To install ElOyente, just follow these easy steps:
1. Start Jenkins, and once in the dashboard, click on Manage Jenkins
2. Then select Manage Plugins
3. Select the Available tab.
4. Scroll down to the section Build Triggers, there you’ll find ElOyente.
5. After clicking Download and install after restart the plug-in will be installed and ready to be used.
In order to set the plug-in to work it is necessary to fill the parameters of the server we are going to use, this is done in the main configuration.
This will open a menu like the one below, search for the section XMPP job triggering. There you can specify the server address of your XMPP server, a user and a password.
As you can see the interface will give you feedback about the connection and authentication. In the example, as the server is not valid, it cannot connect, and as the user and password are not correct it shows that you are not authenticated.
NOTE:: If these values are empty or not correct, still you'll be able to use the plug-in in the projects, but of course the connection won't be created and they won't react to any possible events. You can set the main configuration parameters later and once you click Save, you'll start receiving the XMPP events.
These are the steps needed to create a job and set up ElOyente plug-in for listening to XMPP events.
First create the job and give it a name, it doesn't matter the type of job you're creating, the plug-in will always be available.
Once created, you'll see the configuration screen, scroll down to the section Triggers, and click on the checkbox labelled as XMPP triggered plug-in to activate it. Then click on Add subscriptions and you are ready to subscribe to the nodes from which you'll receive your events.
NOTE: It is possible to subscribe to nodes that still don't exist, once they are created the plugin will start listening when clicking on the Save button in the configuration of that particular job, or in the Save button of the main configuration.
There are 3 types of Pub/Sub systems: topic based, attribute based and content based. Topic based is the easiest, and any Pub/Sub system supports it. El Oyente is designed to put minimal requirements on the messaging infrastructure, but provide fine grained triggering capabilities. As such, El Oyente only uses topic-based subscriptions, but provides client-side filters to have a full content-based Pub/Sub infrastructure.
The plug-in also allows you to save information from the event into environment variables that can be referred in the rest of the job, you can add as many as you want.
To test the plugin, the following tool can be used to send XMPP events to a server: xmpp_publisher.
-s <server> -> URL of the XMPP server
-u <username> -> User name to connect to the XMPP server
-p <password> -> Password to connect to the XMPP server
-n <node> -> Name of the node to publish to
-m <message> -> Message to publish
-d -> Enable the debugger
-h -> Show this help
Skip to end of metadata Go to start of metadata