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.JsonObject;
42  import org.hamcrest.MatcherAssert;
43  import org.hamcrest.Matchers;
44  import org.junit.Rule;
45  import org.junit.Test;
46  
47  /**
48   * Test case for {@link RtPagination}.
49   *
50   * @author Giang Le (giang@vn-smartsolutions.com)
51   * @version $Id: 1c62754c9d7e0dc7ab14e134bf2a120fa2578e29 $
52   */
53  public final class RtPaginationTest {
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       *
64       * @throws Exception if there is any problem
65       */
66      @Test
67      public void jumpNextPage() throws Exception {
68          try (
69              final MkContainer container = new MkGrizzlyContainer().next(
70                  RtPaginationTest.simple("Hi Jeff")
71                      .withHeader(
72                          "Link",
73                          "</s?page=3&per_page=100>; rel=\"next\""
74                      )
75              ).next(RtPaginationTest.simple("Hi Mark"))
76              .start(this.resource.port())
77          ) {
78              final Request request = new ApacheRequest(container.home());
79              final RtPagination<JsonObject> page = new RtPagination<JsonObject>(
80                  request,
81                  new RtValuePagination.Mapping<JsonObject, JsonObject>() {
82                      @Override
83                      public JsonObject map(final JsonObject object) {
84                          return object;
85                      }
86                  }
87              );
88              final Iterator<JsonObject> iterator = page.iterator();
89              MatcherAssert.assertThat(
90                  iterator.next().toString(),
91                  Matchers.containsString("Jeff")
92              );
93              MatcherAssert.assertThat(
94                  iterator.next().toString(),
95                  Matchers.containsString("Mark")
96              );
97              container.stop();
98          }
99      }
100 
101     /**
102      * RtPagination can throw if there is no more elements in pagination.
103      *
104      * @throws Exception if there is any problem
105      */
106     @Test(expected = NoSuchElementException.class)
107     public void throwsIfNoMoreElement() throws Exception {
108         try (
109             final MkContainer container = new MkGrizzlyContainer()
110                 .next(simple("Hi there")).start(this.resource.port())
111         ) {
112             final Request request = new ApacheRequest(container.home());
113             final RtPagination<JsonObject> page = new RtPagination<JsonObject>(
114                 request,
115                 new RtValuePagination.Mapping<JsonObject, JsonObject>() {
116                     @Override
117                     public JsonObject map(final JsonObject object) {
118                         return object;
119                     }
120                 }
121             );
122             final Iterator<JsonObject> iterator = page.iterator();
123             iterator.next();
124             MatcherAssert.assertThat(
125                 iterator.next(),
126                 Matchers.notNullValue()
127             );
128             container.stop();
129         }
130     }
131 
132     /**
133      * Create and return MkAnswer.Simple to test.
134      * @param msg Message to build MkAnswer.Simple
135      * @return MkAnswer.Simple
136      * @throws Exception If some problem inside
137      */
138     private static  MkAnswer.Simple simple(final String msg) throws Exception {
139         final String message = Json.createArrayBuilder()
140             .add(Json.createObjectBuilder().add("msg", msg))
141             .build().toString();
142         return new MkAnswer.Simple(HttpURLConnection.HTTP_OK, message);
143     }
144 }