DescriptionSetterHelper.java

package hudson.plugins.descriptionsetter;

import hudson.model.AbstractBuild;
import hudson.model.BuildListener;
import hudson.model.ParameterValue;
import hudson.model.ParametersAction;
import hudson.model.StringParameterValue;
import java.io.BufferedReader;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import jenkins.model.Jenkins;

/**
 * Helper class that performs common functionality used by both
 * DescriptionSetterBuilder and DescriptionSetterPublisher.
 *
 */
public class DescriptionSetterHelper {

    private static final String LOG_PREFIX = "[description-setter]";

    /**
     * Sets the description on the given build based on the specified regular
     * expression and description.
     *
     * @param build the build whose description to set.
     * @param listener the build listener to report events to.
     * @param regexp the regular expression to apply to the build log.
     * @param description the description to set.
     * @return true, regardless of if the regular expression matched and a
     *         description could be set or not.
     * @throws InterruptedException if the build is interrupted by the user.
     */
    public static boolean setDescription(
            AbstractBuild<?, ?> build, BuildListener listener, String regexp, String description)
            throws InterruptedException {
        return setDescription(build, listener, regexp, description, true, true);
    }

    /**
     * Sets the description on the given build based on the specified regular
     * expression and description.
     *
     * @param build the build whose description to set.
     * @param listener the build listener to report events to.
     * @param regexp the regular expression to apply to the build log.
     * @param description the description to set.
     * @param appendMode if true, description is added to the current one
     * @param envVariable if true, environment variable containing the
     *         description is set.
     * @return true, regardless of if the regular expression matched and a
     *         description could be set or not.
     * @throws InterruptedException if the build is interrupted by the user.
     */
    public static boolean setDescription(
            AbstractBuild<?, ?> build,
            BuildListener listener,
            String regexp,
            String description,
            boolean appendMode,
            boolean envVariable)
            throws InterruptedException {
        try {
            String result = null;

            Matcher matcher = parseLog(build, regexp);
            if (matcher != null) {
                result = getExpandedDescription(matcher, description);
                result = build.getEnvironment(listener).expand(result);
            } else {
                if (regexp == null && description != null) {
                    result = description;
                }
            }

            if (result == null) {
                listener.getLogger().println(LOG_PREFIX + " Could not determine description.");
                return true;
            }

            result = urlify(result);

            build.addAction(new DescriptionSetterAction(result));

            /* Don't want a runtime dependency on OWASP markup formatter plugin */
            String formatter = Jenkins.get().getMarkupFormatter().getClass().getName();
            String htmlBreak = formatter.contains("HtmlMarkup") ? "<br>" : " ";

            if (build.getDescription() == null) build.setDescription(result);
            else build.setDescription((appendMode ? build.getDescription() + htmlBreak : "") + result);

            if (envVariable) {
                setEnvironmentVariable(result, build);
            }

            listener.getLogger().println(LOG_PREFIX + " Description set: " + result);
        } catch (IOException e) {
            e.printStackTrace(listener.error(LOG_PREFIX + " Error while parsing logs for description-setter"));
        }

        return true;
    }

    private static void setEnvironmentVariable(String result, AbstractBuild<?, ?> build) {
        List<ParameterValue> params = new ArrayList<ParameterValue>();
        params.add(new StringParameterValue("DESCRIPTION_SETTER_DESCRIPTION", result));
        build.addAction(new ParametersAction(params));
    }

    private static Matcher parseLog(AbstractBuild<?, ?> build, String regexp) throws IOException {

        if (regexp == null) {
            return null;
        }

        // Assume default encoding and text files
        String line;
        Pattern pattern = Pattern.compile(regexp);
        try (BufferedReader reader = new BufferedReader(build.getLogReader())) {
            while ((line = reader.readLine()) != null) {
                Matcher matcher = pattern.matcher(line);
                if (matcher.find()) {
                    return matcher;
                }
            }
        }
        return null;
    }

    private static String getExpandedDescription(Matcher matcher, String description) {
        String result = description;
        if (result == null) {
            if (matcher.groupCount() == 0) {
                result = "\\0";
            } else {
                result = "\\1";
            }
        }

        // Expand all groups: 1..Count, as well as 0 for the entire pattern
        for (int i = matcher.groupCount(); i >= 0; i--) {
            result = result.replace("\\" + i, matcher.group(i) == null ? "" : matcher.group(i));
        }
        return result;
    }

    private static String urlify(String text) {
        try {
            new URL(text);
            return "<a href=\"%s\">%s</a>".formatted(text, text);
        } catch (MalformedURLException e) {
            return text;
        }
    }
}