hudson.plugins.view.dashboard.test.TestTrendChart Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dashboard-view Show documentation
Hudson view that shows various cuts of build information via configured portlets.
The newest version!
package hudson.plugins.view.dashboard.test;

import hudson.Extension;
import hudson.model.Descriptor;
import hudson.model.Job;
import hudson.model.Run;
import hudson.plugins.view.dashboard.DashboardPortlet;
import hudson.util.ColorPalette;
import hudson.util.DataSetBuilder;
import hudson.util.Graph;
import hudson.util.ShiftedCategoryAxis;
import hudson.util.StackedAreaRenderer2;

import java.awt.Color;
import java.util.Comparator;
import java.util.Map;
import java.util.TreeMap;

import org.jfree.chart.ChartFactory;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.axis.CategoryLabelPositions;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.renderer.category.StackedAreaRenderer;
import org.jfree.data.category.CategoryDataset;
import org.jfree.ui.RectangleInsets;
import org.joda.time.LocalDate;
import org.kohsuke.stapler.DataBoundConstructor;

import hudson.plugins.view.dashboard.Messages;

public class TestTrendChart extends DashboardPortlet {

  private int graphWidth = 300;
  private int graphHeight = 220;
  private int dateRange = 365;

	@DataBoundConstructor
	public TestTrendChart(String name, int graphWidth, int graphHeight, int dateRange) {
		super(name);
    this.graphWidth = graphWidth;
    this.graphHeight = graphHeight;
    this.dateRange = dateRange;
	}

  public int getDateRange() {
    return dateRange;
  }

  public int getGraphWidth() {
    return graphWidth <= 0 ? 300 : graphWidth;
  }

  public int getGraphHeight() {
    return graphHeight <= 0 ? 220 : graphHeight;
  }

	/**
	 * Graph of duration of tests over time.
	 */
	public Graph getSummaryGraph() {
    // The standard equals doesn't work because two LocalDate objects can
    // be differente even if the date is the same (different internal timestamp)
    Comparator localDateComparator = new Comparator() {
        @Override public int compare(LocalDate d1, LocalDate d2) {
            if(d1.isEqual(d2))
              return 0;
            if(d1.isAfter(d2))
              return 1;
            return -1;
        }
    };

		// We need a custom comparator for LocalDate objects
		final Map summaries = //new HashMap();
            new TreeMap(localDateComparator);
		LocalDate today = new LocalDate();
 		LocalDate firstDay = new LocalDate().minusDays(dateRange);
		
		// for each job, for each day, add last build of the day to summary
		for (Job job : getDashboard().getJobs()) {
			Run run = job.getFirstBuild();

//      job.getBuildsByTimestamp(dateRange, dateRange);
      if (run != null) { // execute only if job has builds
        LocalDate lastRunDay = new LocalDate(run.getTimestamp());
        if (dateRange > 0 && firstDay.isAfter(lastRunDay)) {
          lastRunDay = new LocalDate().minusDays(dateRange);
        }

        while (run != null) {
          Run nextRun = run.getNextBuild();
          LocalDate runDay = new LocalDate(run.getTimestamp());

            if (nextRun != null) {
              if (runDay.isAfter(firstDay)) { // skip run before firstDay
                // if next run is the next day, use this test to summarize
                if (new LocalDate(nextRun.getTimestamp()).isAfter(runDay)) {
                  summarize(summaries, run, lastRunDay, runDay);
                  lastRunDay = runDay.plusDays(1);
                }
              }
            } else {
              // use this run's test result from last run to today
              summarize(summaries, run, lastRunDay, today);
            }

          run = nextRun;
        }
      }
		}
		
		return new Graph(-1, getGraphWidth(), getGraphHeight()) {

			@Override
			protected JFreeChart createGraph() {
				final JFreeChart chart = ChartFactory.createStackedAreaChart(
		            null,                   // chart title
		            Messages.Dashboard_Date(),                   // unused
		            Messages.Dashboard_Count(),                  // range axis label
		            buildDataSet(summaries), // data
		            PlotOrientation.VERTICAL, // orientation
		            false,                     // include legend
		            false,                     // tooltips
		            false                     // urls
		        );

		        chart.setBackgroundPaint(Color.white);

		        final CategoryPlot plot = chart.getCategoryPlot();

		        plot.setBackgroundPaint(Color.WHITE);
		        plot.setOutlinePaint(null);
		        plot.setForegroundAlpha(0.8f);
		        plot.setRangeGridlinesVisible(true);
		        plot.setRangeGridlinePaint(Color.black);

		        CategoryAxis domainAxis = new ShiftedCategoryAxis(null);
		        plot.setDomainAxis(domainAxis);
		        domainAxis.setCategoryLabelPositions(CategoryLabelPositions.UP_90);
		        domainAxis.setLowerMargin(0.0);
		        domainAxis.setUpperMargin(0.0);
		        domainAxis.setCategoryMargin(0.0);

		        final NumberAxis rangeAxis = (NumberAxis) plot.getRangeAxis();
		        rangeAxis.setStandardTickUnits(NumberAxis.createIntegerTickUnits());

		        StackedAreaRenderer ar = new StackedAreaRenderer2();
		        plot.setRenderer(ar);
		        ar.setSeriesPaint(0,ColorPalette.RED); // Failures.
		        ar.setSeriesPaint(1,ColorPalette.YELLOW); // Skips.
		        ar.setSeriesPaint(2,ColorPalette.BLUE); // Total.

		        // crop extra space around the graph
		        plot.setInsets(new RectangleInsets(0,0,0,5.0));
		        
				return chart;
			}

		};
	}
	
	private CategoryDataset buildDataSet(Map summaries) {
        DataSetBuilder dsb = new DataSetBuilder();

        for (Map.Entry entry : summaries.entrySet()) {
            dsb.add( entry.getValue().getFailed(), Messages.Dashboard_Failed(), entry.getKey());
            dsb.add( entry.getValue().getSkipped(), Messages.Dashboard_Skipped(), entry.getKey());
            dsb.add( entry.getValue().getSuccess(), Messages.Dashboard_Total(), entry.getKey());
        }
        return dsb.build();
    }
	
	private void summarize(Map summaries,
			Run run, LocalDate firstDay, LocalDate lastDay) {
		TestResult testResult = TestUtil.getTestResult(run);
		
		// for every day between first day and last day inclusive
		for (LocalDate curr = firstDay; curr.compareTo(lastDay) <= 0; curr = curr.plusDays(1)) {
      if (testResult.getTests() != 0) {
        TestResultSummary trs = summaries.get(curr);
        if (trs == null) {
          trs = new TestResultSummary();
          summaries.put(curr, trs);
        }

        trs.addTestResult(testResult);
      }
		}
	}

	@Extension
    public static class DescriptorImpl extends Descriptor {

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