View Javadoc
1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  
29  package org.apache.hc.client5.http.protocol;
30  
31  
32  import static org.junit.jupiter.api.Assertions.assertThrows;
33  import static org.mockito.Answers.RETURNS_DEEP_STUBS;
34  import static org.mockito.Mockito.mock;
35  import static org.mockito.Mockito.when;
36  
37  import org.apache.hc.core5.http.EntityDetails;
38  import org.apache.hc.core5.http.Header;
39  import org.apache.hc.core5.http.HttpHeaders;
40  import org.apache.hc.core5.http.HttpRequest;
41  import org.apache.hc.core5.http.ProtocolException;
42  import org.apache.hc.core5.http.protocol.HttpContext;
43  import org.junit.jupiter.api.BeforeEach;
44  import org.junit.jupiter.api.Test;
45  import org.mockito.Mock;
46  import org.mockito.MockitoAnnotations;
47  
48  class TestRequestIfRange {
49      @Mock
50      private HttpRequest request;
51  
52      @Mock
53      private EntityDetails entity;
54  
55      @Mock
56      private HttpContext context;
57  
58      private RequestIfRange requestIfRange;
59  
60      @BeforeEach
61      void setUp() {
62          MockitoAnnotations.openMocks(this);
63          requestIfRange = new RequestIfRange();
64      }
65  
66      @Test
67      void testNoIfRangeHeader() throws Exception {
68          when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(null);
69          requestIfRange.process(request, entity, context);
70          // No exception should be thrown
71      }
72  
73      @Test
74      void testIfRangeWithoutRangeHeader() {
75          when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class));
76          when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(false);
77  
78          assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context));
79      }
80  
81      @Test
82      void testWeakETagInIfRange() {
83          when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class));
84          when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true);
85          when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
86          when(request.getFirstHeader(HttpHeaders.ETAG).getValue()).thenReturn("W/\"weak-etag\"");
87  
88          assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context));
89      }
90  
91  
92      @Test
93      void testDateHeaderWithStrongValidator() throws Exception {
94          when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class));
95          when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true);
96          when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
97          when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:31 GMT");
98          when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
99          when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT");
100 
101         requestIfRange.process(request, entity, context);
102         // No exception should be thrown
103     }
104 
105     @Test
106     void testSmallDifferenceWithETagPresent() {
107         when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class));
108         when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true);
109         when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
110         when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT"); // Same as Last-Modified
111         when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
112         when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT");
113         final Header mockETagHeader = mock(Header.class);
114         when(mockETagHeader.getValue()).thenReturn("\"some-value\""); // Mocking a weak ETag value
115         when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(mockETagHeader);
116 
117         assertThrows(ProtocolException.class, () -> requestIfRange.process(request, entity, context));
118     }
119 
120     @Test
121     void testSmallDifferenceWithETagAbsent() throws Exception {
122         when(request.getFirstHeader(HttpHeaders.IF_RANGE)).thenReturn(mock(Header.class));
123         when(request.containsHeader(HttpHeaders.RANGE)).thenReturn(true);
124         when(request.getFirstHeader(HttpHeaders.DATE)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
125         when(request.getFirstHeader(HttpHeaders.DATE).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:31 GMT");
126         when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED)).thenReturn(mock(Header.class, RETURNS_DEEP_STUBS));
127         when(request.getFirstHeader(HttpHeaders.LAST_MODIFIED).getValue()).thenReturn("Tue, 15 Nov 2022 08:12:30 GMT");
128         when(request.getFirstHeader(HttpHeaders.ETAG)).thenReturn(null);
129 
130         requestIfRange.process(request, entity, context);
131         // No exception should be thrown
132     }
133 
134 }