com.redhat.jenkins.plugins.ci.messaging.JMSMessagingProvider.java Source code

Introduction

Here is the source code for com.redhat.jenkins.plugins.ci.messaging.JMSMessagingProvider.java

Source

package com.redhat.jenkins.plugins.ci.messaging;

import hudson.ExtensionList;
import hudson.model.Describable;
import hudson.model.Descriptor;

import java.io.Serializable;
import java.util.List;
import java.util.logging.Logger;
import java.util.regex.Pattern;

import jenkins.model.Jenkins;

import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.PathNotFoundException;
import com.redhat.jenkins.plugins.ci.messaging.checks.MsgCheck;
import com.redhat.jenkins.plugins.ci.provider.data.ProviderData;

/*
 * The MIT License
 *
 * Copyright (c) Red Hat, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
public abstract class JMSMessagingProvider implements Describable<JMSMessagingProvider>, Serializable {

    private static final long serialVersionUID = -4572907003185115933L;

    protected String name;
    protected String topic;
    protected static final Logger log = Logger.getLogger(JMSMessagingProvider.class.getName());
    public final static String DEFAULT_PROVIDERNAME = "default";

    public String getName() {
        return name;
    }

    public String getTopic() {
        return topic;
    }

    public abstract JMSMessagingWorker createWorker(ProviderData pdata, String jobname);

    public abstract JMSMessageWatcher createWatcher();

    public boolean verify(String json, List<MsgCheck> checks) {
        if (checks != null && checks.size() > 0) {
            if (StringUtils.isBlank(json)) {
                // There are checks, but the json is empty. Must be false.
                return false;
            }

            DocumentContext context = JsonPath.parse(json);
            for (MsgCheck check : checks) {
                if (!verify(context, check)) {
                    log.fine("msg check: " + check.toString() + " failed against: " + json);
                    return false;
                }
            }
            log.fine("All msg checks have passed.");
        }
        return true;
    }

    private boolean verify(DocumentContext context, MsgCheck check) {
        String aVal = "";

        String field = StringUtils.prependIfMissing(check.getField(), "$.");
        try {
            aVal = context.read(field).toString();
        } catch (PathNotFoundException pnfe) {
            log.fine(pnfe.getMessage());
            return false;
        }
        String eVal = StringUtils.defaultString(check.getExpectedValue());
        return Pattern.compile(eVal).matcher(aVal).find();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o)
            return true;

        if (o == null || getClass() != o.getClass())
            return false;

        JMSMessagingProvider that = (JMSMessagingProvider) o;

        return new EqualsBuilder().append(name, that.name).isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder(17, 37).append(name).toHashCode();
    }

    public abstract static class MessagingProviderDescriptor extends Descriptor<JMSMessagingProvider> {

        public static ExtensionList<MessagingProviderDescriptor> all() {
            return Jenkins.getInstance().getExtensionList(MessagingProviderDescriptor.class);
        }
    }
}