Jenkins : JMS Messaging Plugin

The JMS Messaging Plugin provides the following functionality:

• A build trigger to submit jenkins jobs upon receipt of a matching message.
• A post-build action that may be used to submit a message to the topic upon the completion of a job

JMS Messaging Providers

• This plugin supports the following JMS Message Provider types
  • ActiveMQ
  • FedMsg

Set Up

Global Configuration

Before the plugin may be used, you must add a JMS Messaging Provider. This will provide the ability to send and receive messages. Below is a list of currently supported JMS Message Providers:

• ActiveMQ
• FedMsg

Triggering

To enable the CI trigger, go to the job configuration page and add click the check box "CI Event" under the Build Triggers section. Enabling the trigger on a job requires two additional pieces of information:

• Provider Name
• JMS Selector

The complete documentation for JMS selectors can be found here: http://activemq.apache.org/selectors.html

Message Types

In the image above, the selector contains CI_TYPE = '<message-type>'

The valid values for '<message-type>' can be found in the "Type" column in the table below:

Build Steps

CI Notifier

This plugin provides a build step for publishing messages to the topic upon job completion. To add the CI Notifier build step, go to the job configuration page and select the "CI Notifier" option.

Adding the step to the job requires some additional information:

• Provider name
• Message type
• Message properties
• Message content.

The full list of message types available in the drop-down menu can be found in the Message Type table above.

CI Subscriber

This plugin provides a build step to wait for a specific message. To add the CI Subscriber build step, go to the job configuration page and select the "CI Subscriber" option.

Adding the step to the job requires some additional information:

• Provider name
• JMS Selector
• Variable
• Timeout

The build step will set an environment variable with the name from Variable with a value of the message content.

Post-build steps

CI Notifier

See above.

Pipeline Support

Triggers

The CI trigger is available via properties in the root of a Jenkins declarative pipeline (outside the `pipeline` block):

properties([
  pipelineTriggers([
    [
      $class: 'CIBuildTrigger',
      noSquash: false,
      providerData: [
        $class: 'ActiveMQSubscriberProviderData',
        checks: [
          [
            expectedValue: '^foo.*bar$',
            field: '$.msg.tag'
          ]
        ],
        name: 'Red Hat UMB',
        overrides: [
          topic: 'Consumer.rh-jenkins-ci-plugin.da3c13a1-021d-4629-81a1-5f522dc1a9e3.VirtualTopic.qe.ci.>'
        ],
        selector: 'name = \'my-job\'',
        timeout: 30
      ]
    ]
  ])
])

Steps

This plugin provides the steps when using the Jenkins Pipeline feature:

• sendCIMessage
  • This is the Freestyle CI Notifier Build and Publisher step sibling.
• waitForCIMessage
  • This is the Freestyle CI Subscriber Build step sibling.

Here are some examples:

node('master') {
   // Send a message that CodeQualityChecksDone
    def sendResult = sendCIMessage \
        providerName: 'default', \
        messageContent: 'some content', \
        messageProperties: 'CI_STATUS = passed', \
        messageType: 'CodeQualityChecksDone'
	// echo sent message id and content
	echo sendResult.getMessageId()
	echo sendResult.getMessageContent()
}

and

node('master') {
    // Wait for message and store message content in variable
    def msgContent = waitForCIMessage \
         providerName: 'default', \
         selector: "CI_TYPE = 'code-quality-checks-done' and CI_STATUS = 'passed'"
    echo "msgContent = " + msgContent
}

Change Log

Version 1.1.9 (July 16, 2019) 

• Ensure default values are used for build parameters when triggering builds (#138)
• Support Boolean Parameters (#135)
• Issue #133: Message properties should do variable substitution on entire set of properties, not by line. (#136)

Version 1.1.8 (June 5, 2019) 

• Support Multi-line String parameter for CI_MESSAGE definition (#124)
  • Fixes JENKINS-57642
• Ensure timestamp is set when sending FedMsg (#131)

Version 1.1.7 (May 21, 2019) 

• add pipeline syntax support for CIBuildTrigger (#106)
• waitForCIMessage does not work correctly with message checks (#114)
• sendCIMessage gets stuck running when given nonexistent provider (#116)
• "CI event" build trigger keeps creating threads on Jenkins when given invalid client name (#118)
• Give users some sort of notification when a trigger has a fatal error (#121)

Version 1.1.6 (Mar 05, 2019) 

• Trigger on multiple topics. (#111)
• Fix pipeline snippet generator (#113)

Version 1.1.5 (Feb 27, 2019) 

• Fix fedmsg topic override problem and test (#108)

Version 1.1.4 (Feb 21, 2019) 

• Bump jackson-databind to address security issues (#105)

Version 1.1.3 (Feb 15, 2019) 

• getMsgId() for Fedmsg in jms-messaging plugin discrepancy.  (#103)

Version 1.1.2 (Feb 11, 2019) 

• Ensure only admins can perform testConnection() (#104)

• The jms-messaging-plugin defaults to org.fedoraproject if no topic override is specified (#101)
• Trigger thread is dying with an unhandled exception. (#100)
• Do not override PATH variable (#88)

Version 1.1.1 (June 20, 2018) 

• Fix defaults to work. Remove obsolete code. Some general cleanup. (#87)

• MESSAGE_HEADERS should include all message headers. (#82)

• Update pom to new parent and fix deps (#86)

Version 1.1.0 (June 12, 2018) 

• MESSAGE_HEADERS should include all message headers. (#83)

• Change provider selection to use a dropdownDescriptorSelector. (#79)

Version 1.0.40 (May 25, 2018)

• Correct possible empty CI_MESSAGE using ActiveMQ.

Version 1.0.39 (May 17, 2018) 

• Fully implement message checks for AMQ messages.
• Remove JMS selector and message properties from Fedmsg messages.
• Only support JSON path for all message checks.
• Fix issue where plugin was overwriting CI_MESSAGE while jobs are queued. 

Version 1.0.38

• not released

Version 1.0.37

• not released

Version 1.0.36

• Support global node properties in topics names for triggers (#62)

Version 1.0.35

• Force trigger thread to be stopped on trigger removal, project disable, and project delete. (#61)

Version 1.0.34

Version 1.0.32

Version 1.0.31

Version 1.0.30

Version 1.0.29

Version 1.0.28

Version 1.0.27

Version 1.0.26

Version 1.0.24

Version 1.0.23

Version 1.0.22

Version 1.0.21

Version 1.0.20

• Do not block Jenkins load when previous plugin's ancestor's descriptor has been detected.

• Improve interpolation of environment variables in messages

• Add logging for pipeline steps

• Add failOnError support for sending messages

• Add support for replacing tokens using previously defined properties

• Refactor pipeline steps so logging and aborting works properly.

Version 1.0.19

• fix missing fillProviderMethod for waitForCIMessage

• fix NPE for GlobalCIConfiguration.getFirstProviderOverrides

Version 1.0.18

• Improve interruptions of connection threads by ensuring that provider is connected before trying to interrupt and join trigger thread.

Version 1.0.17

• Add topic provider.
• Fix Tests for new selections

Version 1.0.16

• Variable expansion now supported for override topics.

Version 1.0.15

• (ActiveMQ) Improve resiliency by better cleanup failed connections.

Version 1.0.14

• Upgrade ActiveMQ client to version 5.14.5.

Version 1.0.13

• Allow a job to re-subscribe if job was previously disabled.
• Fix migration steps to ensure null providers are fixed on startup.

Version 1.0.12

• Fix for double-quotes in FedMsg selectors
• Add MESSAGE_HEADERS to the env for triggered jobs.
• Allow topic configuration at build steps

Version 1.0.11

• (JENKINS-42401) Enable trigger to work with Pipeline jobs

Version 1.0.10

• Added Message Check support.

Version 1.0.9

• Deleting project does not unsubscribe job nor shutdown subscriber thread.
• Renaming project does not stop/start subscriber thread.

Version 1.0.8

• Correct migration bug when plugins are installed that implement SaveableListener.

Version 1.0.7

• Improve persistence of Keystore and Truststore config values.

Version 1.0.6

• Support variable expansion in Keystore and Truststore config values.

Version 1.0.5

• Introduction of SSL Certificate Authentication for ActiveMQ.

Version 1.0.4

• FedMsg Message Provider
  • Supports triggering
  • Supports sending and receiving
  • Signing of messages not yet implemented.

Version 1.0.3

• Remove un-necessary dependencies

Version 1.0.2

• Reduce required version of Jenkins Core

Version 1.0.1

• Fix startup crash for project types Project and MatrixProject

Version 1.0.0

• Initial release