Skip to content

Commit

Permalink
[JENKINS-13458] Added test cases to verify the delta computation.
Browse files Browse the repository at this point in the history 
Two tests: one to verify the existing and one to verify the new behavior.
  • Loading branch information
@uhafner
uhafner committed Jan 4, 2015
1 parent 4a3fd08 commit 2b967fc
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 21 deletions.
110 changes: 89 additions & 21 deletions src/test/java/plugins/PmdPluginTest.java
View file
@@ -1,7 +1,6 @@
package plugins;

import javax.xml.parsers.ParserConfigurationException;

import java.io.IOException;
import java.util.SortedMap;
import java.util.TreeMap;
Expand All @@ -18,9 +17,11 @@
import org.jenkinsci.test.acceptance.plugins.pmd.PmdMavenBuildSettings;
import org.jenkinsci.test.acceptance.plugins.pmd.PmdWarningsPerProjectDashboardViewPortlet;
import org.jenkinsci.test.acceptance.po.Build;
import org.jenkinsci.test.acceptance.po.Build.Result;
import org.jenkinsci.test.acceptance.po.FreeStyleJob;
import org.jenkinsci.test.acceptance.po.ListView;
import org.jenkinsci.test.acceptance.po.Node;
import org.jenkinsci.test.acceptance.po.PageObject;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.experimental.categories.Category;
Expand All @@ -37,10 +38,11 @@
*/
@WithPlugins("pmd")
public class PmdPluginTest extends AbstractAnalysisTest {
private static final String PMD_FILE_WITHOUT_WARNINGS = "/pmd_plugin/pmd.xml";

private static final String PMD_PLUGIN_ROOT = "/pmd_plugin/";
private static final String PATTERN_WITHOUT_WARNINGS = "pmd.xml";
private static final String PMD_FILE_WITHOUT_WARNINGS = PMD_PLUGIN_ROOT + PATTERN_WITHOUT_WARNINGS;
private static final String PATTERN_WITH_9_WARNINGS = "pmd-warnings.xml";
private static final String FILE_WITH_9_WARNINGS = "/pmd_plugin/" + PATTERN_WITH_9_WARNINGS;
private static final String FILE_WITH_9_WARNINGS = PMD_PLUGIN_ROOT + PATTERN_WITH_9_WARNINGS;

/**
* Checks that the plug-in sends a mail after a build has been failed. The content of the mail
Expand Down Expand Up @@ -77,7 +79,7 @@ public void configure_a_job_with_PMD_post_build_steps() {
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd.xml");
settings.pattern.set(PATTERN_WITHOUT_WARNINGS);
}
};

Expand Down Expand Up @@ -107,7 +109,7 @@ public void configure_a_job_with_PMD_post_build_steps_run_always() {
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd.xml");
settings.pattern.set(PATTERN_WITHOUT_WARNINGS);
settings.setCanRunOnFailed(true);
}
};
Expand All @@ -130,14 +132,14 @@ public void configure_a_job_with_PMD_post_build_steps_which_display_some_warning
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd-warnings.xml");
settings.pattern.set(PATTERN_WITH_9_WARNINGS);
}
};

FreeStyleJob job = createFreeStyleJob(FILE_WITH_9_WARNINGS, buildConfigurator);

Build lastBuild = buildJobWithSuccess(job);
assertThat(lastBuild, hasAction("PMD Warnings"));
assertThatPageHasPmdResults(lastBuild);

lastBuild.open();

Expand Down Expand Up @@ -194,15 +196,15 @@ public void xml_api_report_depth_0() throws IOException, SAXException, ParserCon
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd-warnings.xml");
settings.pattern.set(PATTERN_WITH_9_WARNINGS);
}
};

FreeStyleJob job = createFreeStyleJob(FILE_WITH_9_WARNINGS, buildConfigurator);

Build build = buildJobWithSuccess(job);
String apiUrl = "pmdResult/api/xml?depth=0";
String expectedXmlPath = "/pmd_plugin/api_depth_0.xml";
String expectedXmlPath = PMD_PLUGIN_ROOT + "api_depth_0.xml";
assertXmlApiMatchesExpected(build, apiUrl, expectedXmlPath);
}

Expand All @@ -214,9 +216,9 @@ public void configure_a_job_with_PMD_post_build_steps_which_display_some_warning
FreeStyleJob job = setUpPmdFreestyleJob();
buildJobAndWait(job);

editJob("/pmd_plugin/forSecondRun/pmd-warnings.xml", false, job);
editJob(PMD_PLUGIN_ROOT + "forSecondRun/pmd-warnings.xml", false, job);
Build lastBuild = buildJobWithSuccess(job);
assertThat(lastBuild, hasAction("PMD Warnings"));
assertThatPageHasPmdResults(lastBuild);
lastBuild.open();

PmdAction action = new PmdAction(job);
Expand All @@ -240,7 +242,7 @@ public void configure_a_job_with_PMD_post_build_steps_which_display_some_warning
public void view_pmd_report_job_graph_links() {
FreeStyleJob job = setUpPmdFreestyleJob();
buildJobAndWait(job);
editJob("/pmd_plugin/forSecondRun/pmd-warnings.xml", false, job);
editJob(PMD_PLUGIN_ROOT + "forSecondRun/pmd-warnings.xml", false, job);
buildJobWithSuccess(job);

assertAreaLinksOfJobAreLike(job, "^\\d+/pmdResult");
Expand All @@ -255,7 +257,7 @@ public void build_with_warning_threshold_set_should_be_unstable() {
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd-warnings.xml");
settings.pattern.set(PATTERN_WITH_9_WARNINGS);
settings.setBuildUnstableTotalAll("0");
settings.setNewWarningsThresholdFailed("0");
settings.setUseDeltaValues(true);
Expand All @@ -272,7 +274,7 @@ private MavenModuleSet setupSimpleMavenJob() {
}

private MavenModuleSet setupSimpleMavenJob(AnalysisConfigurator<PmdMavenBuildSettings> configurator) {
String projectPath = "/pmd_plugin/sample_pmd_project";
String projectPath = PMD_PLUGIN_ROOT + "sample_pmd_project";
String goal = "clean package pmd:pmd";
return setupMavenJob(projectPath, goal, PmdMavenBuildSettings.class, configurator);
}
Expand All @@ -288,10 +290,10 @@ public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("target/pmd.xml");
}
};
FreeStyleJob job = setupJob("/pmd_plugin/sample_pmd_project", FreeStyleJob.class, PmdFreestyleSettings.class, buildConfigurator, "clean package pmd:pmd"
FreeStyleJob job = setupJob(PMD_PLUGIN_ROOT + "sample_pmd_project", FreeStyleJob.class, PmdFreestyleSettings.class, buildConfigurator, "clean package pmd:pmd"
);
Build lastBuild = buildJobWithSuccess(job);
assertThat(lastBuild, hasAction("PMD Warnings"));
assertThatPageHasPmdResults(lastBuild);
lastBuild.open();
PmdAction pmd = new PmdAction(job);
assertThat(pmd.getNewWarningNumber(), is(2));
Expand All @@ -311,12 +313,16 @@ public void configure(PmdFreestyleSettings settings) {
public void build_simple_maven_project() {
MavenModuleSet job = setupSimpleMavenJob();
Build lastBuild = buildJobWithSuccess(job);
assertThat(lastBuild, hasAction("PMD Warnings"));
assertThatPageHasPmdResults(lastBuild);
lastBuild.open();
PmdAction pmd = new PmdAction(job);
assertThat(pmd.getNewWarningNumber(), is(2));
}

private void assertThatPageHasPmdResults(final PageObject page) {
assertThat(page, hasAction("PMD Warnings"));
}

/**
* Builds a maven project and checks if it is unstable.
*/
Expand Down Expand Up @@ -359,8 +365,8 @@ public void configure_a_job_with_PMD_post_build_steps_build_on_slave() throws Ex
Node slave = makeASlaveAndConfigureJob(job);
Build build = buildJobOnSlaveWithSuccess(job, slave);
assertThat(build.getNode(), is(slave));
assertThat(build, hasAction("PMD Warnings"));
assertThat(job, hasAction("PMD Warnings"));
assertThatPageHasPmdResults(build);
assertThatPageHasPmdResults(job);
}

/**
Expand Down Expand Up @@ -408,10 +414,72 @@ private FreeStyleJob setUpPmdFreestyleJob() {
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.pattern.set("pmd-warnings.xml");
settings.pattern.set(PATTERN_WITH_9_WARNINGS);
}
};
return createFreeStyleJob(FILE_WITH_9_WARNINGS, buildConfigurator);
}

/**
* Creates a sequence of Freestyle builds and checks if the build result is set correctly. New warning threshold is
* set to zero, e.g. a new warning should mark a build as unstable.
* <p/>
* <ol>
* <li>Build 1: 1 new warning (SUCCESS since no reference build is set)</li>
* <li>Build 2: 2 new warnings (UNSTABLE since threshold is reached)</li>
* <li>Build 3: 1 new warning (UNSTABLE since still one warning is new based on delta with reference build)</li>
* <li>Build 4: 1 new warning (SUCCESS since there are no warnings)</li>
* </ol>
*/
@Test
public void should_set_build_status_in_build_sequence_compare_to_reference_build() {
FreeStyleJob job = setupJob(FILE_WITH_9_WARNINGS, FreeStyleJob.class, PmdFreestyleSettings.class, null);

runBuild(job, 1, Result.SUCCESS, 1, false);
runBuild(job, 2, Result.UNSTABLE, 2, false);
runBuild(job, 3, Result.UNSTABLE, 1, false);
runBuild(job, 4, Result.SUCCESS, 0, false);
}

/**
* Creates a sequence of Freestyle builds and checks if the build result is set correctly. New warning threshold is
* set to zero, e.g. a new warning should mark a build as unstable.
* <p/>
* <ol>
* <li>Build 1: 1 new warning (SUCCESS since no reference build is set)</li>
* <li>Build 2: 2 new warnings (UNSTABLE since threshold is reached)</li>
* <li>Build 3: 1 new warning (SUCCESS since all warnings of previous build are fixed)</li>
* </ol>
*/
@Test
@Bug("13458")
public void should_set_build_status_in_build_sequence_compare_to_previous_build() {
FreeStyleJob job = setupJob(FILE_WITH_9_WARNINGS, FreeStyleJob.class, PmdFreestyleSettings.class, null);

runBuild(job, 1, Result.SUCCESS, 1, true);
runBuild(job, 2, Result.UNSTABLE, 2, true);
runBuild(job, 3, Result.SUCCESS, 0, true);
}

private void runBuild(final FreeStyleJob job, final int number, final Result expectedResult, final int expectedNewWarnings, final boolean usePreviousAsReference) {
final String fileName = "pmd-warnings-build" + number + ".xml";
AnalysisConfigurator<PmdFreestyleSettings> buildConfigurator = new AnalysisConfigurator<PmdFreestyleSettings>() {
@Override
public void configure(PmdFreestyleSettings settings) {
settings.setNewWarningsThresholdUnstable("0", usePreviousAsReference);
settings.pattern.set(fileName);
}
};

editJob(PMD_PLUGIN_ROOT + fileName, false, job,
PmdFreestyleSettings.class, buildConfigurator);
Build lastBuild = buildJobAndWait(job).shouldBe(expectedResult);

if (expectedNewWarnings > 0) {
assertThatPageHasPmdResults(lastBuild);
lastBuild.open();
PmdAction pmd = new PmdAction(job);
assertThat(pmd.getNewWarningNumber(), is(expectedNewWarnings));
}
}
}
9 changes: 9 additions & 0 deletions src/test/resources/pmd_plugin/pmd-warnings-build1.xml
View file
@@ -0,0 +1,9 @@
<pmd version="oclint-0.7dev">

<file name="/sample-project/ProductDetailAPIClient.m">
<violation begincolumn="1" beginline="37" priority="5" rule="long line">
Line with 115 characters exceeds limit of 100
</violation>
</file>

</pmd>
22 changes: 22 additions & 0 deletions src/test/resources/pmd_plugin/pmd-warnings-build2.xml
View file
@@ -0,0 +1,22 @@

<pmd version="oclint-0.7dev">

<file name="/sample-project/ProductDetailAPIClient.m">
<violation begincolumn="1" beginline="37" priority="5" rule="long line">
Line with 115 characters exceeds limit of 100
</violation>
</file>

<file name="/sample-project/ProductDetailAPIClient.m">
<violation begincolumn="1" beginline="38" priority="5" rule="long line">
Line with 113 characters exceeds limit of 100
</violation>
</file>

<file name="/sample-project/ChannelContentAPIClient.m">
<violation begincolumn="1" beginline="32" priority="5" rule="long line">
Line with 127 characters exceeds limit of 100
</violation>
</file>

</pmd>
9 changes: 9 additions & 0 deletions src/test/resources/pmd_plugin/pmd-warnings-build3.xml
View file
@@ -0,0 +1,9 @@
<pmd version="oclint-0.7dev">

<file name="/sample-project/ChannelContentAPIClient.m">
<violation begincolumn="1" beginline="32" priority="5" rule="long line">
Line with 127 characters exceeds limit of 100
</violation>
</file>

</pmd>
3 changes: 3 additions & 0 deletions src/test/resources/pmd_plugin/pmd-warnings-build4.xml
View file
@@ -0,0 +1,3 @@
<pmd version="oclint-0.7dev">

</pmd>

0 comments on commit 2b967fc

Please sign in to comment.