/*
    * ====================================================================
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you under the Apache License, Version 2.0 (the
    * "License"); you may not use this file except in compliance
    * with the License.  You may obtain a copy of the License at
   *
   *   http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing,
   * software distributed under the License is distributed on an
   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   * KIND, either express or implied.  See the License for the
   * specific language governing permissions and limitations
   * under the License.
   * ====================================================================
   *
   * This software consists of voluntary contributions made by many
   * individuals on behalf of the Apache Software Foundation.  For more
   * information on the Apache Software Foundation, please see
   * <http://www.apache.org/>.
   *
   */
  package org.apache.hc.client5.http.impl.cache;
  
  import static org.mockito.ArgumentMatchers.isA;
  import static org.mockito.ArgumentMatchers.same;
  import static org.mockito.Mockito.mock;
  import static org.mockito.Mockito.verify;
  import static org.mockito.Mockito.when;
  
  import java.time.Instant;
  
  import org.apache.hc.client5.http.async.methods.SimpleHttpResponse;
  import org.apache.hc.client5.http.cache.HttpCacheEntry;
  import org.apache.hc.core5.http.ClassicHttpRequest;
  import org.apache.hc.core5.http.Header;
  import org.apache.hc.core5.util.TimeValue;
  import org.junit.jupiter.api.Assertions;
  import org.junit.jupiter.api.BeforeEach;
  import org.junit.jupiter.api.Test;
  
  @SuppressWarnings({"boxing","static-access"}) // test code
  public class TestCachedHttpResponseGenerator {
  
      private HttpCacheEntry entry;
      private ClassicHttpRequest request;
      private CacheValidityPolicy mockValidityPolicy;
      private CachedHttpResponseGenerator impl;
  
      @BeforeEach
      public void setUp() {
          entry = HttpTestUtils.makeCacheEntry();
          request = HttpTestUtils.makeDefaultRequest();
          mockValidityPolicy = mock(CacheValidityPolicy.class);
          impl = new CachedHttpResponseGenerator(mockValidityPolicy);
      }
  
      @Test
      public void testResponseHasContentLength() throws Exception {
          final byte[] buf = new byte[] { 1, 2, 3, 4, 5 };
          final HttpCacheEntry entry1 = HttpTestUtils.makeCacheEntry(buf);
  
          final SimpleHttpResponse response = impl.generateResponse(request, entry1);
  
          final Header length = response.getFirstHeader("Content-Length");
          Assertions.assertNotNull(length, "Content-Length Header is missing");
  
          Assertions.assertEquals(buf.length, Integer.parseInt(length.getValue()), "Content-Length does not match buffer length");
      }
  
      @Test
      public void testResponseStatusCodeMatchesCacheEntry() throws Exception {
          final SimpleHttpResponse response = impl.generateResponse(request, entry);
  
          Assertions.assertEquals(entry.getStatus(), response.getCode());
      }
  
      @Test
      public void testAgeHeaderIsPopulatedWithCurrentAgeOfCacheEntryIfNonZero() throws Exception {
          currentAge(TimeValue.ofSeconds(10L));
  
          final SimpleHttpResponse response = impl.generateResponse(request, entry);
  
          verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class));
  
          final Header ageHdr = response.getFirstHeader("Age");
          Assertions.assertNotNull(ageHdr);
          Assertions.assertEquals(10L, Long.parseLong(ageHdr.getValue()));
      }
  
      @Test
      public void testAgeHeaderIsNotPopulatedIfCurrentAgeOfCacheEntryIsZero() throws Exception {
          currentAge(TimeValue.ofSeconds(0L));
  
          final SimpleHttpResponse response = impl.generateResponse(request, entry);
 
         verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class));
 
         final Header ageHdr = response.getFirstHeader("Age");
         Assertions.assertNull(ageHdr);
     }
 
     @Test
     public void testAgeHeaderIsPopulatedWithMaxAgeIfCurrentAgeTooBig() throws Exception {
         currentAge(TimeValue.ofSeconds(CacheSupport.MAX_AGE.toSeconds() + 1L));
 
         final SimpleHttpResponse response = impl.generateResponse(request, entry);
 
         verify(mockValidityPolicy).getCurrentAge(same(entry), isA(Instant.class));
 
         final Header ageHdr = response.getFirstHeader("Age");
         Assertions.assertNotNull(ageHdr);
         Assertions.assertEquals(CacheSupport.MAX_AGE.toSeconds(), Long.parseLong(ageHdr.getValue()));
     }
 
     private void currentAge(final TimeValue age) {
         when(
                 mockValidityPolicy.getCurrentAge(same(entry),
                         isA(Instant.class))).thenReturn(age);
     }
 
     @Test
     public void testResponseContainsEntityToServeGETRequestIfEntryContainsResource() throws Exception {
         final SimpleHttpResponse response = impl.generateResponse(request, entry);
 
         Assertions.assertNotNull(response.getBody());
     }
 
     @Test
     public void testResponseDoesNotContainEntityToServeHEADRequestIfEntryContainsResource() throws Exception {
         final ClassicHttpRequest headRequest = HttpTestUtils.makeDefaultHEADRequest();
         final SimpleHttpResponse response = impl.generateResponse(headRequest, entry);
 
         Assertions.assertNull(response.getBody());
     }
 
 }