Added report's format as String option, IT, unitTests and verification of numbers of pages for RunReportAdapter

TanyaEf · TanyaEf · commit 9cb5c7cca1ef · 2015-09-07T12:58:40.000+03:00
diff --git a/README.md b/README.md
@@ -217,6 +217,7 @@ OperationResult<InputStream> result = client
         .parameter("Country_multi_select", "USA")
         .run();
 ```
+Please notice, if you pass zero as number of page, you  will get all  pages of report.
 In this mode you don't need to work in one session. In the above code we specified report URI, format in which we want to get a report and some report parameters. As we a result we got `InputStream` instance. In synchronous mode as a response you get a report itself while in asynchronous you get just a descriptor with report ID which you can use to download report afer it will be ready.
 
 In order to run a report in asynchronous mode, you need firstly build `ReportExecutionRequest` instance and specify all the parameters needed to launch a report. The response from the server is the `ReportExecutionDescriptor` instance which contains the request ID needed to track the execution until completion and others report parameters. Here's the code to run a report:
diff --git a/src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportingServiceIT.java b/src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportingServiceIT.java
@@ -49,6 +49,82 @@ public void should_return_proper_entity_if_pass_pdf_report_output_format() {
 
     }
 
+    @Test
+    public void should_return_proper_entity_if_passed_number_of_pages_zero() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun(ReportOutputFormat.PDF, 0)
+                .parameter("Cascading_state_multi_select", "CA")
+                .parameter("Cascading_state_multi_select", "OR", "WA")
+                .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
+                .parameter("Country_multi_select", "USA")
+                .run();
+
+        InputStream entity = result.getEntity();
+        /** Then **/
+        Assert.assertNotNull(entity);
+
+    }
+    @Test
+    public void should_return_proper_entity_if_pass_string_output_format() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun("PDF", 1)
+                .parameter("Cascading_state_multi_select", "CA")
+                .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
+                .parameter("Country_multi_select", "USA")
+                .run();
+
+        InputStream entity = result.getEntity();
+        /** Then **/
+        Assert.assertNotNull(entity);
+
+    }
+
+    @Test
+    public void should_return_proper_entity_if_passed_wrong_number_of_pages() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun("PDF", 0,-1,1)
+                .parameter("Cascading_state_multi_select", "CA")
+                .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
+                .parameter("Country_multi_select", "USA")
+                .run();
+
+        InputStream entity = result.getEntity();
+        /** Then **/
+        Assert.assertNotNull(entity);
+
+    }
+
+    @Test
+    public void should_return_proper_entity_if_passed_all_wrong_number_of_pages() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun("PDF", 0,-1)
+                .parameter("Cascading_state_multi_select", "CA")
+                .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
+                .parameter("Country_multi_select", "USA")
+                .run();
+
+        InputStream entity = result.getEntity();
+        /** Then **/
+        Assert.assertNotNull(entity);
+
+    }
+
     @Test
     public void should_return_proper_entity_without_numbers_of_pages() {
 
@@ -58,7 +134,6 @@ public void should_return_proper_entity_without_numbers_of_pages() {
                 .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
                 .prepareForRun(ReportOutputFormat.PDF)
                 .parameter("Cascading_state_multi_select", "CA")
-                .parameter("Cascading_state_multi_select", "OR", "WA")
                 .parameter("Cascading_name_single_select", "Adams-Steen Transportation Holdings")
                 .parameter("Country_multi_select", "USA")
                 .run();
@@ -88,6 +163,25 @@ public void should_return_proper_entity_in_async_mode() {
         Assert.assertNotNull(reportExecutionDescriptor);
     }
 
+    @Test
+    public void should_return_proper_entity_in_async_mode_if_format_is_string() {
+
+        /** When **/
+        ReportExecutionRequest request = new ReportExecutionRequest();
+        request.setReportUnitUri("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic");
+        request
+                .setAsync(true)
+                .setOutputFormat("html");
+
+        OperationResult<ReportExecutionDescriptor> operationResult = session
+                .reportingService()
+                .newReportExecutionRequest(request);
+
+        ReportExecutionDescriptor reportExecutionDescriptor = operationResult.getEntity();
+        /** Then **/
+        Assert.assertNotNull(reportExecutionDescriptor);
+    }
+
     @AfterMethod
     public void after() {
         client = null;
diff --git a/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportsAdapter.java b/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportsAdapter.java
@@ -35,31 +35,43 @@ public class ReportsAdapter extends AbstractAdapter {
 
     private final String reportUnitUri;
 
-    public ReportsAdapter(SessionStorage sessionStorage, String reportUnitUri){
+    public ReportsAdapter(SessionStorage sessionStorage, String reportUnitUri) {
         super(sessionStorage);
         this.reportUnitUri = reportUnitUri;
     }
 
-    public ReorderingReportParametersAdapter reportParameters(){
+    public ReorderingReportParametersAdapter reportParameters() {
         return new ReorderingReportParametersAdapter(sessionStorage, reportUnitUri);
     }
 
-    public ReportParametersAdapter reportParameters(String mandatoryId, String... otherIds){
+    public ReportParametersAdapter reportParameters(String mandatoryId, String... otherIds) {
         List<String> ids = new ArrayList<String>(Arrays.asList(otherIds));
         ids.add(0, mandatoryId);
         return new ReportParametersAdapter(sessionStorage, reportUnitUri, ReportParametersUtils.toPathSegment(ids));
     }
 
-    public RunReportAdapter prepareForRun(ReportOutputFormat format, Integer... pages){
+    public RunReportAdapter prepareForRun(ReportOutputFormat format, Integer... pages) {
+        return new RunReportAdapter(sessionStorage, reportUnitUri, format.toString().toLowerCase(), pages);
+    }
+
+    public RunReportAdapter prepareForRun(ReportOutputFormat format, PageRange range) {
+        return new RunReportAdapter(sessionStorage, reportUnitUri, format.toString().toLowerCase(), range);
+    }
+
+    public RunReportAdapter prepareForRun(ReportOutputFormat format) {
+        return new RunReportAdapter(sessionStorage, reportUnitUri, format.toString().toLowerCase());
+    }
+    public RunReportAdapter prepareForRun(String format, Integer... pages) {
         return new RunReportAdapter(sessionStorage, reportUnitUri, format, pages);
     }
 
-    public RunReportAdapter prepareForRun(ReportOutputFormat format, PageRange range){
+    public RunReportAdapter prepareForRun(String format, PageRange range) {
         return new RunReportAdapter(sessionStorage, reportUnitUri, format, range);
     }
 
-    public RunReportAdapter prepareForRun(ReportOutputFormat format){
+    public RunReportAdapter prepareForRun(String format) {
         return new RunReportAdapter(sessionStorage, reportUnitUri, format);
     }
 
+
 }
diff --git a/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/RunReportAdapter.java b/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/RunReportAdapter.java
@@ -28,38 +28,53 @@
 import com.jaspersoft.jasperserver.jaxrs.client.core.SessionStorage;
 import com.jaspersoft.jasperserver.jaxrs.client.core.ThreadPoolUtil;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResult;
-
-import javax.ws.rs.core.MultivaluedHashMap;
-import javax.ws.rs.core.MultivaluedMap;
 import java.io.InputStream;
 import java.util.Arrays;
+import java.util.Iterator;
+import java.util.LinkedList;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import javax.ws.rs.core.MultivaluedHashMap;
+import javax.ws.rs.core.MultivaluedMap;
 
 import static java.util.regex.Pattern.compile;
 
 public class RunReportAdapter extends AbstractAdapter {
 
     private final MultivaluedMap<String, String> params;
     private final String reportUnitUri;
-    private final ReportOutputFormat format;
-    private String[] pages;
+    private final String format;
+    private String[] pages = new String[0];
 
-    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, ReportOutputFormat format) {
+    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, String format) {
         super(sessionStorage);
         this.params = new MultivaluedHashMap<String, String>();
         this.reportUnitUri = reportUnitUri;
-        this.format = format;
+        this.format = format.toLowerCase();
     }
 
-    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, ReportOutputFormat format, 
+    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, String format,
                             Integer[] pages) {
         this(sessionStorage, reportUnitUri, format);
-        this.pages = toStringArray(pages);
+        if (pages != null && !(pages.length == 1 && pages[0] == 0)) {
+            this.pages = toStringArray(validArray(pages));
+        }
+    }
+
+    private Integer[] validArray (Integer[] pages) {
+        List<Integer> list = new LinkedList<Integer>(Arrays.asList(pages));
+        Iterator<Integer> iterator = list.iterator();
+        while (iterator.hasNext()) {
+            Integer next =  iterator.next();
+            if (next <= 0) {
+                iterator.remove();
+            }
+        }
+        return list.toArray(new Integer[list.size()]);
     }
 
-    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, ReportOutputFormat format,
+    public RunReportAdapter(SessionStorage sessionStorage, String reportUnitUri, String format,
                             PageRange range) {
         this(sessionStorage, reportUnitUri, format);
         this.pages = new String[]{range.getRange()};
@@ -102,12 +117,12 @@ private JerseyRequest<InputStream> prepareRunRequest() {
         JerseyRequest<InputStream> request = JerseyRequest.buildRequest(
                 sessionStorage,
                 InputStream.class,
-                new String[]{"/reports", reportUnitUri + "." + format.toString().toLowerCase()},
+                new String[]{"/reports", reportUnitUri + "." + format},
                 new RunReportErrorHandler());
 
         request.addParams(params);
 
-        if (pages != null && pages.length > 0) {
+        if (pages.length > 0) {
             if (pages.length == 1) {
                 Pattern pattern = compile("^(\\d+)-(\\d+)$");
                 Matcher matcher = pattern.matcher(pages[0]);
diff --git a/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/dto/reports/ExportExecutionOptions.java b/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/dto/reports/ExportExecutionOptions.java
@@ -66,6 +66,11 @@ public ExportExecutionOptions setOutputFormat(ReportOutputFormat outputFormat) {
         return this;
     }
 
+    public ExportExecutionOptions setOutputFormat(String outputFormat) {
+        this.outputFormat = outputFormat.toLowerCase();
+        return this;
+    }
+
     public String getBaseUrl() {
         return baseUrl;
     }
diff --git a/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/dto/reports/ReportExecutionRequest.java b/src/main/java/com/jaspersoft/jasperserver/jaxrs/client/dto/reports/ReportExecutionRequest.java
@@ -117,6 +117,10 @@ public ReportExecutionRequest setOutputFormat(ReportOutputFormat outputFormat) {
         this.outputFormat = outputFormat.toString().toLowerCase();
         return this;
     }
+    public ReportExecutionRequest setOutputFormat(String outputFormat) {
+        this.outputFormat = outputFormat.toLowerCase();
+        return this;
+    }
 
     public String getAttachmentsPrefix() {
         return attachmentsPrefix;
diff --git a/src/test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportsAdapterTest.java b/src/test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportsAdapterTest.java
@@ -96,6 +96,20 @@ public void should_convert_params_into_the_adapter_with_pages() throws Exception
         assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
         assertEquals(Whitebox.getInternalState(retrieved, "pages"), new String[]{"1", "2", "3"});
     }
+    @Test
+    public void should_convert_params_into_the_adapter_with_format() throws Exception {
+
+        /* Given */
+        ReportsAdapter adapterSpy = new ReportsAdapter(sessionStorageMock, "reportUnitUri");
+
+        /* When */
+        RunReportAdapter retrieved = adapterSpy.prepareForRun(ReportOutputFormat.PDF);
+
+        /* Then */
+        assertSame(retrieved.getSessionStorage(), sessionStorageMock);
+        assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
+        assertEquals(Whitebox.getInternalState(retrieved, "format"), new String("pdf"));
+    }
 
     @Test
     public void should_convert_params_into_the_adapter_without_pages() throws Exception {
@@ -110,6 +124,69 @@ public void should_convert_params_into_the_adapter_without_pages() throws Except
         assertSame(retrieved.getSessionStorage(), sessionStorageMock);
         assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
         assertEquals(Whitebox.getInternalState(retrieved, "pages"), new String[]{"1-10"});
+
+    }
+
+    @Test
+    public void should_convert_params_into_the_adapter_with_pages_and_format_as_string() throws Exception {
+
+        /* Given */
+        ReportsAdapter adapterSpy = new ReportsAdapter(sessionStorageMock, "reportUnitUri");
+
+        /* When */
+        RunReportAdapter retrieved = adapterSpy.prepareForRun("PDF", 1, 2, 3);
+
+        /* Then */
+        assertSame(retrieved.getSessionStorage(), sessionStorageMock);
+        assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
+        assertEquals(Whitebox.getInternalState(retrieved, "pages"), new String[]{"1", "2", "3"});
+        assertEquals(Whitebox.getInternalState(retrieved, "format"), "pdf");
+    }
+    @Test
+    public void should_convert_params_into_the_adapter_with_format_as_string_in_uppercase() throws Exception {
+
+        /* Given */
+        ReportsAdapter adapterSpy = new ReportsAdapter(sessionStorageMock, "reportUnitUri");
+
+        /* When */
+        RunReportAdapter retrieved = adapterSpy.prepareForRun("HTML");
+
+        /* Then */
+        assertSame(retrieved.getSessionStorage(), sessionStorageMock);
+        assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
+        assertEquals(Whitebox.getInternalState(retrieved, "format"), "html");
+
+    }
+    @Test
+    public void should_convert_params_into_the_adapter_with_format_as_string() throws Exception {
+
+        /* Given */
+        ReportsAdapter adapterSpy = new ReportsAdapter(sessionStorageMock, "reportUnitUri");
+
+        /* When */
+        RunReportAdapter retrieved = adapterSpy.prepareForRun("pdf");
+
+        /* Then */
+        assertSame(retrieved.getSessionStorage(), sessionStorageMock);
+        assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
+        assertEquals(Whitebox.getInternalState(retrieved, "format"), "pdf");
+
+    }
+
+    @Test
+    public void should_convert_params_into_the_adapter_without_pages_as_string() throws Exception {
+
+        /* Given */
+        ReportsAdapter adapterSpy = new ReportsAdapter(sessionStorageMock, "reportUnitUri");
+
+        /* When */
+        RunReportAdapter retrieved = adapterSpy.prepareForRun("pdf", new PageRange(1, 10));
+
+        /* Then */
+        assertSame(retrieved.getSessionStorage(), sessionStorageMock);
+        assertEquals(Whitebox.getInternalState(retrieved, "reportUnitUri"), "reportUnitUri");
+        assertEquals(Whitebox.getInternalState(retrieved, "pages"), new String[]{"1-10"});
+        assertEquals(Whitebox.getInternalState(retrieved, "format"), "pdf");
     }
 
     @AfterMethod
diff --git a/src/test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/RunReportAdapterTest.java b/src/test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/RunReportAdapterTest.java

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,11 @@ public ExportExecutionOptions setOutputFormat(ReportOutputFormat outputFormat) {`
`66`	`66`	`return this;`
`67`	`67`	`}`
`68`	`68`
	`69`	`+ public ExportExecutionOptions setOutputFormat(String outputFormat) {`
	`70`	`+ this.outputFormat = outputFormat.toLowerCase();`
	`71`	`+ return this;`
	`72`	`+ }`
	`73`	`+`
`69`	`74`	`public String getBaseUrl() {`
`70`	`75`	`return baseUrl;`
`71`	`76`	`}`