View Javadoc
1   /**
2    * Copyright (c) 2013-2022, jcabi.com
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met: 1) Redistributions of source code must retain the above
8    * copyright notice, this list of conditions and the following
9    * disclaimer. 2) Redistributions in binary form must reproduce the above
10   * copyright notice, this list of conditions and the following
11   * disclaimer in the documentation and/or other materials provided
12   * with the distribution. 3) Neither the name of the jcabi.com nor
13   * the names of its contributors may be used to endorse or promote
14   * products derived from this software without specific prior written
15   * permission.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
19   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
22   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28   * OF THE POSSIBILITY OF SUCH DAMAGE.
29   */
30  package com.jcabi.github;
31  
32  import com.jcabi.http.Request;
33  import com.jcabi.http.mock.MkAnswer;
34  import com.jcabi.http.mock.MkContainer;
35  import com.jcabi.http.mock.MkGrizzlyContainer;
36  import com.jcabi.http.request.ApacheRequest;
37  import java.net.HttpURLConnection;
38  import java.util.Iterator;
39  import java.util.NoSuchElementException;
40  import javax.json.Json;
41  import javax.json.JsonArray;
42  import javax.json.JsonObject;
43  import org.hamcrest.MatcherAssert;
44  import org.hamcrest.Matchers;
45  import org.junit.Rule;
46  import org.junit.Test;
47  
48  /**
49   * Test case for {@link RtValuePagination}.
50   * @author Paul Polishchuk (ppol@ua.fm)
51   * @version $Id: 8c9a96892b1c6da5d960dc61f7002e6a26b7ca84 $
52   */
53  public final class RtValuePaginationTest {
54      /**
55       * The rule for skipping test if there's BindException.
56       * @checkstyle VisibilityModifierCheck (3 lines)
57       */
58      @Rule
59      public final transient RandomPort resource = new RandomPort();
60  
61      /**
62       * RtPagination can jump to next page of results.
63       * @throws Exception if there is any problem
64       */
65      @Test
66      public void jumpNextPage() throws Exception {
67          final String jeff = "Jeff";
68          final String mark = "Mark";
69          final String judy = "Judy";
70          final String jessy = "Jessy";
71          final MkContainer container = new MkGrizzlyContainer().next(
72              RtValuePaginationTest.simple(jeff, mark)
73                  .withHeader("Link", "</s?page=3&per_page=100>; rel=\"next\"")
74          ).next(RtValuePaginationTest.simple(judy, jessy))
75              .start(this.resource.port());
76          final Request request = new ApacheRequest(container.home());
77          final RtValuePagination<JsonObject, JsonArray> page =
78              new RtValuePagination<JsonObject, JsonArray>(
79                  request,
80                  new RtValuePagination.Mapping<JsonObject, JsonArray>() {
81                      @Override
82                      public JsonObject map(final JsonArray object) {
83                          return Json.createObjectBuilder()
84                              .add("id1", object.getString(0))
85                              .add("id2", object.getString(1))
86                              .build();
87                      }
88                  }
89              );
90          final Iterator<JsonObject> iterator = page.iterator();
91          MatcherAssert.assertThat(
92              iterator.next().toString(),
93              Matchers.allOf(
94                  Matchers.containsString(jeff),
95                  Matchers.containsString(mark)
96              )
97          );
98          MatcherAssert.assertThat(
99              iterator.next().toString(),
100             Matchers.allOf(
101                 Matchers.containsString(judy),
102                 Matchers.containsString(jessy)
103             )
104         );
105         container.stop();
106     }
107 
108     /**
109      * RtValuePagination can throw if there is no more elements in pagination.
110      * @throws Exception if there is any problem
111      */
112     @Test(expected = NoSuchElementException.class)
113     public void throwsIfNoMoreElement() throws Exception {
114         final String jeff = "other Jeff";
115         final String mark = "other Mark";
116         final MkContainer container = new MkGrizzlyContainer().next(
117             RtValuePaginationTest.simple(jeff, mark)
118         ).start(this.resource.port());
119         try {
120             final Request request = new ApacheRequest(container.home());
121             final RtValuePagination<JsonObject, JsonArray> page =
122                 new RtValuePagination<JsonObject, JsonArray>(
123                     request,
124                     new RtValuePagination.Mapping<JsonObject, JsonArray>() {
125                         @Override
126                         public JsonObject map(final JsonArray object) {
127                             return Json.createObjectBuilder()
128                                 .add("id3", object.getString(0))
129                                 .add("id4", object.getString(1))
130                                 .build();
131                         }
132                     }
133                 );
134             final Iterator<JsonObject> iterator = page.iterator();
135             iterator.next();
136             MatcherAssert.assertThat(
137                 iterator.next(),
138                 Matchers.notNullValue()
139             );
140         } finally {
141             container.stop();
142         }
143     }
144 
145     /**
146      * Create and return MkAnswer.Simple to test.
147      * @param one First array element
148      * @param another Second array element
149      * @return MkAnswer.Simple
150      * @throws Exception If some problem inside
151      */
152     private static MkAnswer.Simple simple(final String one,
153         final String another
154     ) throws Exception {
155         final String message = Json.createArrayBuilder()
156             .add(Json.createArrayBuilder().add(one).add(another))
157             .build().toString();
158         return new MkAnswer.Simple(HttpURLConnection.HTTP_OK, message);
159     }
160 }