Validation if status codes comparators parameters were provided

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to AET will be documented in this file.
 ## Unreleased
 **List of changes that are finished but not yet released in any final version.**
 
+- [PR-296](https://github.com/Cognifide/aet/pull/296) The behavior of StatusCodesComparator was changed
 - [PR-289](https://github.com/Cognifide/aet/pull/289) User now stays on the same tab while navigating between URLs
 - [PR-271](https://github.com/Cognifide/aet/pull/271) Added possibility to override name parameter from the aet client
 - [PR-268](https://github.com/Cognifide/aet/pull/268) Bobcat upgrade to version 1.4.0

core/jobs/src/main/java/com/cognifide/aet/job/common/comparators/statuscodes/StatusCodesComparator.java

@@ -40,6 +40,8 @@ public class StatusCodesComparator implements ComparatorJob {
 
   private static final Logger LOGGER = LoggerFactory.getLogger(StatusCodesComparator.class);
 
+  private static final int DEFAULT_FILTER_RANGE_LOWER_BOUND = 400;
+
   private static final int DEFAULT_FILTER_RANGE_UPPER_BOUND = 600;
 
   public static final String COMPARATOR_TYPE = "status-codes";
@@ -53,14 +55,15 @@ public class StatusCodesComparator implements ComparatorJob {
   private static final String PARAM_DELIMITER = ",";
 
   private static final String PARAM_SHOW_EXCLUDED = "showExcluded";
+
   private static final Type RESULT_TYPE = new TypeToken<StatusCodesCollectorResult>() {
   }.getType();
 
   private final ArtifactsDAO artifactsDAO;
 
   private final ComparatorProperties properties;
 
-  private int filterRangeLowerBound;
+  private int filterRangeLowerBound = DEFAULT_FILTER_RANGE_LOWER_BOUND;
 
   private int filterRangeUpperBound = DEFAULT_FILTER_RANGE_UPPER_BOUND;
 

core/jobs/src/main/java/com/cognifide/aet/job/common/comparators/statuscodes/StatusCodesFilter.java

@@ -42,19 +42,22 @@ private class StatusCodeFilterPredicate implements Predicate<StatusCode> {
 
     @Override
     public boolean apply(StatusCode statusCode) {
-      if (statusCode.getCode() < lowerBound) {
-        return false;
-      }
-      if (statusCode.getCode() > upperBound) {
-        return false;
-      }
-      if (!filterCodes.isEmpty() && !filterCodes.contains(statusCode.getCode())) {
-        return false;
-      }
+
       if (statusCode.getCode() < 0) {
         return false;
       }
-      return true;
+      if (isCodeInRange(statusCode) || isCodeInFilterCodes(statusCode)) {
+        return true;
+      }
+      return false;
+    }
+
+    private boolean isCodeInFilterCodes(StatusCode statusCode) {
+      return !filterCodes.isEmpty() && filterCodes.contains(statusCode.getCode());
+    }
+
+    private boolean isCodeInRange(StatusCode statusCode) {
+      return statusCode.getCode() >= lowerBound && statusCode.getCode() <= upperBound;
     }
   }
 }

core/jobs/src/test/java/com/cognifide/aet/job/common/comparators/statuscodes/StatusCodesComparatorTest.java

@@ -96,7 +96,7 @@ public void setUp() {
   @Test
   public void compareTest() throws ProcessingException {
     result = tested.compare();
-    assertEquals(ComparatorStepResult.Status.FAILED, result.getStatus());
+    assertEquals(ComparatorStepResult.Status.PASSED, result.getStatus());
   }
 
   @Test
@@ -105,7 +105,7 @@ public void compareTest_filterRange() throws ProcessingException {
     when(params.containsKey(PARAM_FILTER_RANGE)).thenReturn(true);
     when(params.get(PARAM_FILTER_RANGE)).thenReturn(FILTER_RANGE);
     result = tested.compare();
-    assertEquals(ComparatorStepResult.Status.FAILED, result.getStatus());
+    assertEquals(ComparatorStepResult.Status.PASSED, result.getStatus());
   }
 
   @Test
@@ -115,7 +115,7 @@ public void compareTest_filterCodes() throws ProcessingException {
     when(params.get(PARAM_FILTER_CODES)).thenReturn(FILTER_CODES_MULTIPLE);
 
     result = tested.compare();
-    assertEquals(ComparatorStepResult.Status.FAILED, result.getStatus());
+    assertEquals(ComparatorStepResult.Status.PASSED, result.getStatus());
   }
 
   @Test

core/jobs/src/test/java/com/cognifide/aet/job/common/comparators/statuscodes/StatusCodesFilterTest.java

@@ -93,7 +93,7 @@ public void testFilter_bounds(int lowerBound, int upperBound, int expectedSize)
     assertThat(result.size(), is(expectedSize));
   }
 
-  @TestWith({"100;200;201,3", "400;401;499,3", "404,3"})
+  @TestWith({"100;200;201,18", "400;401;499,18", "404,18"})
   public void testFilter_filterCodes(String filterCodesParam, int expectedSize) {
     tested = getTested(0, 600, prepareFilterCodes(filterCodesParam));
 
@@ -102,7 +102,7 @@ public void testFilter_filterCodes(String filterCodesParam, int expectedSize) {
     assertThat(result.size(), is(expectedSize));
   }
 
-  @TestWith({"100;200;201,100,200,2", "400;401;499,100,400,1"})
+  @TestWith({"100;200;201,100,200,5", "400;401;499,100,400,12"})
   public void testFilter_boundsWithfilterCodes(String filterCodesParam, int lowerBound,
       int upperBound,
       int expectedSize) {

documentation/src/main/wiki/StatusCodesComparator.md

@@ -12,10 +12,14 @@ Resource name: status-codes
 
 | Parameter | Value | Example | Description | Mandatory |
 | --------- | ----- | ------- | ----------- | --------- |
-| `filterRange` | x,y | 400,500 | Defines range of status codes that should be processed | yes, if `filterCodes` is not present |
-| `filterCodes` | x,y,z | 400,401,404 | List of status codes that should be processed | yes, if `filterRange` is not present |
+| `filterRange` | x,y (default: `400,600`) | 400,500 | Defines range of status codes that should be processed | no |
+| `filterCodes` | x,y,z | 400,401,404 | List of status codes that should be processed | no |
 | `showExcluded` | boolean (default: `true`) | true | Flag that says if excluded codes (see [[Status Codes Data Filters | StatusCodesDataFilters]]) should be displayed in report. By default set to `true`. | no |
 
+If you provide both `filterRange` and `filterCodes`, it will be used as logical sum. It means that:
+ - `<status-codes filterRange="400,500" filterCodes="501,502" />` is equivalent to `<status-codes filterRange="400,502" />`
+ - `<status-codes filterRange="300,400" filterCodes="404" />` won't check `401-403` codes.
+
 ##### Example Usage
 
 ```xml

documentation/src/main/wiki/StatusCodesDataFilters.md

@@ -1,5 +1,7 @@
 #### Status Codes Data Filters
 
+Data filters will be apply only for codes contained in the `filterange`. If the `filterRange` isn't provided, default range will be used.
+
 ##### Exclude Filter
 
 Exclude Filter removes from reports Status Codes results that match specified parameters.  

integration-tests/sanity-functional/src/test/java/com/cognifide/aet/sanity/functional/HomePageTilesTest.java

@@ -29,13 +29,13 @@
 @Modules(GuiceModule.class)
 public class HomePageTilesTest {
 
-  private static final int TESTS = 113;
+  private static final int TESTS = 114;
 
   private static final int EXPECTED_TESTS_SUCCESS = 66;
 
   private static final int EXPECTED_TESTS_WARN = 5;
 
-  private static final int EXPECTED_TESTS_FAIL = 42;
+  private static final int EXPECTED_TESTS_FAIL = 43;
 
   @Inject
   private ReportHomePage page;

integration-tests/sanity-functional/src/test/resources/features/filtering.feature

@@ -55,8 +55,8 @@ Feature: Tests Results Filtering
   Scenario: Filtering Tests Results: status-codes
     Given I have opened sample tests report page
     When I search for tests containing "status"
-    Then There are 20 tiles visible
-    And Statistics text contains "20 ( 8 / 0 / 12 / 0 )"
+    Then There are 21 tiles visible
+    And Statistics text contains "21 ( 9 / 0 / 12 / 0 )"
 
   Scenario: Filtering Tests Results: w3c-html5
     Given I have opened sample tests report page

integration-tests/test-suite/partials/status-codes.xml

@@ -32,11 +32,24 @@
 		</compare>
 		<urls>
 			<url href="comparators/statuscodes/failed.jsp"/>
-			<url href="comparators/statuscodes/success.jsp"/>
 			<url href="comparators/statuscodes/noneexistingPage.jsp"/>
 		</urls>
 	</test>
 
+	<test name="F-comparator-StatusCodes-200-success" useProxy="rest">
+		<collect>
+			<open/>
+			<status-codes/>
+			<sleep duration="3000"/>
+		</collect>
+		<compare>
+			<status-codes filterCodes="200" showExcluded="true"/>
+		</compare>
+		<urls>
+			<url href="comparators/statuscodes/success.jsp"/>
+		</urls>
+	</test>
+
 	<test name="S-comparator-StatusCodes-filter-300-505" useProxy="rest">
 		<collect>
 			<open/>
@@ -255,7 +268,7 @@
 			<sleep duration="3000"/>
 		</collect>
 		<compare>
-			<status-codes showExcluded="true">
+			<status-codes filterCodes="200,404" showExcluded="true">
 				<exclude url="/sample-site/NonExistingResourceFile.png"/>
 			</status-codes>
 		</compare>
@@ -304,7 +317,7 @@
 			<sleep duration="3000"/>
 		</collect>
 		<compare>
-			<status-codes showExcluded="true">
+			<status-codes filterCodes="200" showExcluded="true">
 				<include pattern="^.*css$"/>
 			</status-codes>
 		</compare>