Merge pull request #110 from TanyaEf/bugFix

Bug fixing of Report service

Author: yaroslav-kovalchyk

README.md

@@ -204,6 +204,16 @@ OperationResult<InputStream> result = client
         .run();
 InputStream report = result.getEntity();
 ```
+You can set format of report as String as well(name of format is case insensitive):
+```java
+OperationResult<InputStream> result = client
+        .authenticate("jasperadmin", "jasperadmin")
+        .reportingService()
+        .report("/reports/samples/Cascading_multi_select_report")
+        .prepareForRun("HTML", 1)
+        .parameter("Cascading_name_single_select", "A & U Stalker Telecommunications, Inc")
+        .run();
+```
 Also you can use this method to run report with several values for the same parameter. In this case new values of the parameter are added to the previous ones (new values do not replace previous values of the parameter): 
 ```java
 OperationResult<InputStream> result = client
@@ -217,6 +227,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:
@@ -226,7 +237,7 @@ ReportExecutionRequest request = new ReportExecutionRequest();
 request.setReportUnitUri("/reports/samples/StandardChartsReport");
 request
         .setAsync(true)                         //this means that report will be run on server asynchronously
-        .setOutputFormat("html");               //report can be requested in different formats e.g. html, pdf, etc.
+        .setOutputFormat(ReportOutputFormat.HTML);               //report can be requested in different formats e.g. html, pdf, etc.
 
 OperationResult<ReportExecutionDescriptor> operationResult =
         session                                 //pay attention to this, all requests are in the same session!!!
@@ -236,6 +247,14 @@ OperationResult<ReportExecutionDescriptor> operationResult =
 reportExecutionDescriptor = operationResult.getEntity();
 ```
 In the above code we've created `ReportExecutionRequest` instance and sent it to JR server through the `newReportExecutionRequest` method. As a response we've got `OperationResult` instance which contains HTTP response wrapper and instance of `ReportExecutionDescriptor` which we can get with `operationResult.getEntity()`.
+Also you can set output format as String:
+```java
+ReportExecutionRequest request = new ReportExecutionRequest();
+request.setReportUnitUri("/reports/samples/StandardChartsReport");
+request
+        .setAsync(true)                         
+        .setOutputFormat("html");               
+```
 ####Requesting report execution status:
 After you've got `ReportExecutionDescriptor` you can request for the report execution status:
 ```java
@@ -294,7 +313,7 @@ for(AttachmentDescriptor attDescriptor : htmlExportDescriptor.getAttachments()){
 After running a report and downloading its content in a given format, you can request the same report in other formats. As with exporting report formats through the user interface, the report does not run again because the export process is independent of the report.
 ```java
 ExportExecutionOptions exportExecutionOptions = new ExportExecutionOptions()
-        .setOutputFormat("pdf")
+        .setOutputFormat(ReportOutputFormat.PDF)
         .setPages("3");
 
 OperationResult<ExportExecutionDescriptor> operationResult =

src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportingServiceIT.java

@@ -2,7 +2,10 @@
 
 import com.jaspersoft.jasperserver.jaxrs.client.core.JasperserverRestClient;
 import com.jaspersoft.jasperserver.jaxrs.client.core.RestClientConfiguration;
+import com.jaspersoft.jasperserver.jaxrs.client.core.Session;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResult;
+import com.jaspersoft.jasperserver.jaxrs.client.dto.reports.ReportExecutionDescriptor;
+import com.jaspersoft.jasperserver.jaxrs.client.dto.reports.ReportExecutionRequest;
 import java.io.InputStream;
 import junit.framework.Assert;
 import org.testng.annotations.AfterMethod;
@@ -17,19 +20,20 @@ public class ReportingServiceIT {
 
     private RestClientConfiguration configuration;
     private JasperserverRestClient client;
+    private Session session;
 
     @BeforeMethod
     public void before() {
         configuration = new RestClientConfiguration("http://localhost:4444/jasperserver-pro");
         client = new JasperserverRestClient(configuration);
+        session = client.authenticate("superuser", "superuser");
     }
 
     @Test
-    public void should_return_proper_entity_if_pass_jrprint_report_output_format() {
+    public void should_return_proper_entity_if_pass_pdf_report_output_format() {
 
         /** When **/
-        OperationResult<InputStream> result = client
-                .authenticate("superuser", "superuser")
+        OperationResult<InputStream> result = session
                 .reportingService()
                 .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
                 .prepareForRun(ReportOutputFormat.PDF, 1)
@@ -45,6 +49,158 @@ public void should_return_proper_entity_if_pass_jrprint_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() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun(ReportOutputFormat.PDF)
+                .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_with_page_range() {
+
+        /** When **/
+        OperationResult<InputStream> result = session
+                .reportingService()
+                .report("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic")
+                .prepareForRun(ReportOutputFormat.PDF)
+                .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_in_async_mode() {
+
+        /** When **/
+        ReportExecutionRequest request = new ReportExecutionRequest();
+        request.setReportUnitUri("/organizations/organization_1/adhoc/topics/Cascading_multi_select_topic");
+        request
+                .setAsync(true)
+                .setOutputFormat(ReportOutputFormat.HTML);
+
+        OperationResult<ReportExecutionDescriptor> operationResult = session
+                .reportingService()
+                .newReportExecutionRequest(request);
+
+        ReportExecutionDescriptor reportExecutionDescriptor = operationResult.getEntity();
+        /** Then **/
+        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;

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportsAdapter.java

@@ -35,27 +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(String format) {
+        return new RunReportAdapter(sessionStorage, reportUnitUri, format);
+    }
+
+
 }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/RunReportAdapter.java

@@ -28,42 +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;
 
-/**
- * @author
- * @author Tetiana Iefimenko
- * */
 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];
 
-    private 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()};
@@ -106,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]);