PluginCommentAddedContainsEvent.java

/*
 *  The MIT License
 *
 *  Copyright 2013 Criteo SA. All rights reserved.
 *
 *  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.
 */
package com.sonyericsson.hudson.plugins.gerrit.trigger.hudsontrigger.events;

import hudson.Extension;

import java.io.Serializable;
import java.util.regex.Pattern;

import org.jenkinsci.Symbol;
import org.kohsuke.stapler.DataBoundConstructor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sonyericsson.hudson.plugins.gerrit.trigger.Messages;
import com.sonymobile.tools.gerrit.gerritevents.dto.events.CommentAdded;
import com.sonymobile.tools.gerrit.gerritevents.dto.events.GerritTriggeredEvent;

/**
 * An event configuration that trigger the build when a comment is added and
 * contains a message matching a configurable RegEx.
 *
 * @author Francois Visconte <f.visconte@criteo.com>
 */
public class PluginCommentAddedContainsEvent extends PluginGerritEvent
        implements Serializable {

    /**
     * The descriptor for PluginCommentAddedContainsEvent.
     */
    @Extension
    @Symbol("commentAddedContains")
    public static class PluginCommentAddedContainsEventDescriptor extends
            PluginGerritEventDescriptor {

        @Override
        public String getDisplayName() {
            return Messages.CommentAddedContainsDisplayName();
        }
    }

    private static final long serialVersionUID = -1190562081236235820L;

    private String commentAddedCommentContains;

    private static final Logger logger = LoggerFactory
            .getLogger(PluginCommentAddedContainsEvent.class);

    /**
     * Empty constructor for serializer.
     */
    public PluginCommentAddedContainsEvent() {
    }

    /**
     * Standard DataBoundConstructor.
     *
     * @param commentAddedCommentContains a string containg a regular expression.
     */
    @DataBoundConstructor
    public PluginCommentAddedContainsEvent(String commentAddedCommentContains) {
        this.commentAddedCommentContains = commentAddedCommentContains;

    }

    /**
     * Get the regular expression to match against comment.
     * @return a string containg a regex.
     */
    public String getCommentAddedCommentContains() {
        return commentAddedCommentContains;
    }

    /**
     * Gets related event class.
     * @return a Class
     */
    @Override
    public Class getCorrespondingEventClass() {
        return CommentAdded.class;
    }

    /**
     * Check if the comment added match configured regular expression.
     * @param event a GerritTriggeredEvent.
     * @return true or false.
     */
    public boolean match(GerritTriggeredEvent event) {
        if (!super.shouldTriggerOn(event)) {
            return false;
        }
        Pattern p = Pattern
                .compile(commentAddedCommentContains, Pattern.DOTALL | Pattern.MULTILINE);
        CommentAdded ca = (CommentAdded)event;
        logger.debug("input comment: '{}'", ca.getComment());
        return p.matcher(ca.getComment()).find();
    }
}