CoverageSummaryTest.java

package io.jenkins.plugins.coverage;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

import org.junit.Test;
import org.openqa.selenium.WebDriver;

import org.jenkinsci.test.acceptance.po.Build;
import org.jenkinsci.test.acceptance.po.FreeStyleJob;

import static org.assertj.core.api.Assertions.*;

/**
 * Acceptance tests for Summary.
 */
public class CoverageSummaryTest extends UiTest {

    /**
     * Verifies if summary of first successful build of Project is correct.
     *
     * @param build
     *         Build of Project
     * @param expectedCoverage
     *         map of expected values to be present in summary
     */
    public static void verifySummaryOnSuccessfulBuild(Build build,
            HashMap<String, Double> expectedCoverage) {
        build.open();
        CoverageSummary cs = new CoverageSummary(build, "coverage");
        HashMap<String, Double> coverage = cs.getCoverage();

        assertThat(coverage).isEqualTo(expectedCoverage);
    }

    /**
     * Verifies if summary of second successful build of Project is correct and has reference.
     *
     * @param build
     *         Build of Project
     * @param expectedCoverage
     *         HashMap of expected values for coverage
     * @param expectedChanges
     *         List of expected values for coverage changes
     */
    public static void verifySummaryWithReferenceBuild(Build build,
            HashMap<String, Double> expectedCoverage, List<Double> expectedChanges) {
        build.open();
        CoverageSummary cs = new CoverageSummary(build, "coverage");

        HashMap<String, Double> coverage = cs.getCoverage();
        List<Double> changes = cs.getCoverageChanges();

        assertThat(coverage).isEqualTo(expectedCoverage);
        assertThat(changes).isEqualTo(expectedChanges);

        String referenceBuild = cs.getReferenceBuild();

        assertThat(referenceBuild).contains("/" + (build.getNumber() - 1) + "/");
    }

    /**
     * Verifies if summary of failed build of Project is correct.
     *
     * @param build
     *         Build of Project
     * @param expectedCoverage
     *         expected coverage of build
     */
    public static void verifySummaryOnFailedBuild(Build build, HashMap<String, Double> expectedCoverage) {
        build.open();
        CoverageSummary cs = new CoverageSummary(build, "coverage");
        HashMap<String, Double> coverage = cs.getCoverage();

        assertThat(coverage).isEqualTo(expectedCoverage);

    }

    /**
     * Verifies fail message on summary.
     *
     * @param build
     *         current build of project
     * @param unhealthyThreshold
     *         of project
     * @param unstableThreshold
     *         of project
     */
    public static void verifyFailMessage(Build build, float unhealthyThreshold,
            float unstableThreshold) {
        build.open();
        CoverageSummary cs = new CoverageSummary(build, "coverage");
        String failMsg = cs.getFailMsg();
        assertThat(failMsg).contains("unstableThreshold=" + unstableThreshold)
                .contains("unhealthyThreshold=" + unhealthyThreshold);
    }

    /**
     * Tests if summary is not visible if build with no report is enabled.
     */
    @Test
    public void testSummaryOnNoReport() {
        FreeStyleJob job = getJobWithoutAnyReports(InCaseNoReportsConfiguration.FAIL);
        Build build = buildWithErrors(job);
        WebDriver open = build.open();
        assertThat(CoverageSummary.isSummaryDisplayed(open, "coverage")).isFalse();

    }

    /**
     * Tests if coverage is correct if build is successful.
     */
    @Test
    public void testSuccessfulBuild() {
        FreeStyleJob job = jenkins.getJobs().create(FreeStyleJob.class);
        CoveragePublisher coveragePublisher = job.addPublisher(CoveragePublisher.class);
        Adapter jacocoAdapter = coveragePublisher.createAdapterPageArea("Jacoco");
        copyResourceFilesToWorkspace(job, RESOURCES_FOLDER);
        jacocoAdapter.setReportFilePath(JACOCO_ANALYSIS_MODEL_XML);
        job.save();
        Build build = buildSuccessfully(job);

        HashMap<String, Double> expectedCoverage = new HashMap<>();
        expectedCoverage.put("Line", 95.52);
        expectedCoverage.put("Branch", 88.59);

        verifySummaryOnSuccessfulBuild(build, expectedCoverage);
    }

    /**
     * Test if coverage reference is correct if both builds are successful.
     */
    @Test
    public void testReferenceBuild() {
        FreeStyleJob job = jenkins.getJobs().create(FreeStyleJob.class);
        CoveragePublisher coveragePublisher = job.addPublisher(CoveragePublisher.class);
        Adapter jacocoAdapter = coveragePublisher.createAdapterPageArea("Jacoco");
        copyResourceFilesToWorkspace(job, RESOURCES_FOLDER);
        jacocoAdapter.setReportFilePath(JACOCO_ANALYSIS_MODEL_XML);
        job.save();
        buildSuccessfully(job);
        job.configure();
        jacocoAdapter.setReportFilePath(JACOCO_CODINGSTYLE_XML);
        job.save();
        Build build = buildSuccessfully(job);

        HashMap<String, Double> expectedCoverage = new HashMap<>();
        expectedCoverage.put("Line", 91.02);
        expectedCoverage.put("Branch", 93.97);
        List<Double> expectedReferenceCoverage = new ArrayList<>();
        expectedReferenceCoverage.add(-4.5);
        expectedReferenceCoverage.add(5.38);

        verifySummaryWithReferenceBuild(build, expectedCoverage, expectedReferenceCoverage);
    }

    /**
     * Test if coverage is displayed correct if build fails.
     */
    @Test
    public void testFailedBuild() {
        FreeStyleJob job = jenkins.getJobs().create(FreeStyleJob.class);
        CoveragePublisher coveragePublisher = job.addPublisher(CoveragePublisher.class);
        Adapter jacocoAdapter = coveragePublisher.createAdapterPageArea("Jacoco");
        copyResourceFilesToWorkspace(job, RESOURCES_FOLDER);
        jacocoAdapter.setReportFilePath(JACOCO_ANALYSIS_MODEL_XML);
        job.save();
        buildSuccessfully(job);
        job.configure();
        jacocoAdapter.setReportFilePath(JACOCO_CODINGSTYLE_XML);
        coveragePublisher.setFailBuildIfCoverageDecreasedInChangeRequest(true);
        job.save();
        Build build = buildWithErrors(job);

        HashMap<String, Double> expectedCoverage = new HashMap<>();
        expectedCoverage.put("Line", 91.02);
        expectedCoverage.put("Branch", 93.97);

        verifySummaryOnFailedBuild(build, expectedCoverage);
    }
}