jenkins.plugins.logstash.persistence.BuildData.java Source code

Java tutorial

Introduction

Here is the source code for jenkins.plugins.logstash.persistence.BuildData.java

Source

/*
 * The MIT License
 *
 * Copyright 2014 Rusty Gerard
 *
 * 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 jenkins.plugins.logstash.persistence;

import hudson.model.Action;
import hudson.model.Environment;
import hudson.model.Result;
import hudson.model.AbstractBuild;
import hudson.model.Node;
import hudson.tasks.test.AbstractTestResultAction;
import hudson.tasks.test.TestResult;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import net.sf.json.JSONObject;

import org.apache.commons.lang.StringUtils;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

/**
 * POJO for mapping build info to JSON.
 *
 * @author Rusty Gerard
 * @since 1.0.0
 */
public class BuildData {
    // ISO 8601 date format
    public transient static final DateFormat DATE_FORMATTER = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");

    public static class TestData {
        int totalCount, skipCount, failCount;
        List<String> failedTests;

        public TestData() {
            this(null);
        }

        public TestData(Action action) {
            AbstractTestResultAction<?> testResultAction = null;
            if (action instanceof AbstractTestResultAction) {
                testResultAction = (AbstractTestResultAction<?>) action;
            }

            if (testResultAction == null) {
                totalCount = skipCount = failCount = 0;
                failedTests = Collections.emptyList();
                return;
            }

            totalCount = testResultAction.getTotalCount();
            skipCount = testResultAction.getSkipCount();
            failCount = testResultAction.getFailCount();

            failedTests = new ArrayList<String>(testResultAction.getFailedTests().size());
            for (TestResult result : testResultAction.getFailedTests()) {
                failedTests.add(result.getFullName());
            }
        }
    }

    protected String id;
    protected String result;
    protected String projectName;
    protected String displayName;
    protected String fullDisplayName;
    protected String description;
    protected String url;
    protected String buildHost;
    protected String buildLabel;
    protected int buildNum;
    protected long buildDuration;
    protected transient String timestamp; // This belongs in the root object
    protected String rootProjectName;
    protected String rootProjectDisplayName;
    protected int rootBuildNum;
    protected Map<String, String> buildVariables;
    protected TestData testResults = null;

    BuildData() {
    }

    public BuildData(AbstractBuild<?, ?> build, Date currentTime) {
        result = build.getResult() == null ? null : build.getResult().toString();
        id = build.getId();
        projectName = build.getProject().getName();
        displayName = build.getDisplayName();
        fullDisplayName = build.getFullDisplayName();
        description = build.getDescription();
        url = build.getUrl();

        Action testResultAction = build.getAction(AbstractTestResultAction.class);
        if (testResultAction != null) {
            testResults = new TestData(testResultAction);
        }

        Node node = build.getBuiltOn();
        if (node == null) {
            buildHost = "master";
            buildLabel = "master";
        } else {
            buildHost = StringUtils.isBlank(node.getDisplayName()) ? "master" : node.getDisplayName();
            buildLabel = StringUtils.isBlank(node.getLabelString()) ? "master" : node.getLabelString();
        }

        buildNum = build.getNumber();
        // build.getDuration() is always 0 in Notifiers
        buildDuration = currentTime.getTime() - build.getStartTimeInMillis();
        timestamp = DATE_FORMATTER.format(build.getTimestamp().getTime());
        rootProjectName = build.getRootBuild().getProject().getName();
        rootProjectDisplayName = build.getRootBuild().getDisplayName();
        rootBuildNum = build.getRootBuild().getNumber();
        buildVariables = build.getBuildVariables();

        // Get environment build variables and merge them into the buildVariables map
        Map<String, String> buildEnvVariables = new HashMap<String, String>();
        List<Environment> buildEnvironments = build.getEnvironments();
        if (buildEnvironments != null) {
            for (Environment env : buildEnvironments) {
                if (env == null) {
                    continue;
                }

                env.buildEnvVars(buildEnvVariables);
                if (!buildEnvVariables.isEmpty()) {
                    buildVariables.putAll(buildEnvVariables);
                    buildEnvVariables.clear();
                }
            }
        }
    }

    @Override
    public String toString() {
        Gson gson = new GsonBuilder().create();
        return gson.toJson(this);
    }

    public JSONObject toJson() {
        String data = toString();
        return JSONObject.fromObject(data);
    }

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getResult() {
        return result;
    }

    public void setResult(Result result) {
        this.result = result.toString();
    }

    public String getProjectName() {
        return projectName;
    }

    public void setProjectName(String projectName) {
        this.projectName = projectName;
    }

    public String getDisplayName() {
        return displayName;
    }

    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }

    public String getFullDisplayName() {
        return fullDisplayName;
    }

    public void setFullDisplayName(String fullDisplayName) {
        this.fullDisplayName = fullDisplayName;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getUrl() {
        return url;
    }

    public void setUrl(String url) {
        this.url = url;
    }

    public String getBuildHost() {
        return buildHost;
    }

    public void setBuildHost(String buildHost) {
        this.buildHost = buildHost;
    }

    public String getBuildLabel() {
        return buildLabel;
    }

    public void setBuildLabel(String buildLabel) {
        this.buildLabel = buildLabel;
    }

    public int getBuildNum() {
        return buildNum;
    }

    public void setBuildNum(int buildNum) {
        this.buildNum = buildNum;
    }

    public long getBuildDuration() {
        return buildDuration;
    }

    public void setBuildDuration(long buildDuration) {
        this.buildDuration = buildDuration;
    }

    public String getTimestamp() {
        return timestamp;
    }

    public void setTimestamp(Calendar timestamp) {
        this.timestamp = DATE_FORMATTER.format(timestamp.getTime());
    }

    public String getRootProjectName() {
        return rootProjectName;
    }

    public void setRootProjectName(String rootProjectName) {
        this.rootProjectName = rootProjectName;
    }

    public String getRootProjectDisplayName() {
        return rootProjectDisplayName;
    }

    public void setRootProjectDisplayName(String rootProjectDisplayName) {
        this.rootProjectDisplayName = rootProjectDisplayName;
    }

    public int getRootBuildNum() {
        return rootBuildNum;
    }

    public void setRootBuildNum(int rootBuildNum) {
        this.rootBuildNum = rootBuildNum;
    }

    public Map<String, String> getBuildVariables() {
        return buildVariables;
    }

    public void setBuildVariables(Map<String, String> buildVariables) {
        this.buildVariables = buildVariables;
    }

    public TestData getTestResults() {
        return testResults;
    }

    public void setTestResults(TestData testResults) {
        this.testResults = testResults;
    }
}