/*
    * 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
    *
   *   https://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.
   */
  package org.apache.commons.compress.compressors.gzip;
  
  import static org.junit.jupiter.api.Assertions.assertEquals;
  import static org.junit.jupiter.api.Assertions.assertNotEquals;
  import static org.junit.jupiter.api.Assertions.assertNull;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  import static org.junit.jupiter.api.Assertions.assertTrue;
  
  import java.io.IOException;
  import java.nio.charset.Charset;
  import java.nio.charset.StandardCharsets;
  import java.util.zip.Deflater;
  
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.params.ParameterizedTest;
  import org.junit.jupiter.params.provider.CsvSource;
  
  /**
   * Tests {@link GzipParameters}.
   */
  class GzipParametersTest {
  
      @Test
      void testDeflaterStrategy() {
          final GzipParameters gzipParameters = new GzipParameters();
          assertEquals(Deflater.DEFAULT_STRATEGY, gzipParameters.getDeflateStrategy());
          gzipParameters.setDeflateStrategy(Deflater.HUFFMAN_ONLY);
          assertEquals(Deflater.HUFFMAN_ONLY, gzipParameters.getDeflateStrategy());
      }
  
      @Test
      void testEquals() throws IOException {
          final GzipParameters gzipParameters1 = new GzipParameters();
          final GzipParameters gzipParameters2 = new GzipParameters();
          assertEquals(gzipParameters1, gzipParameters2);
          gzipParameters1.setExtraField(new ExtraField().addSubField("AA", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          gzipParameters2.setExtraField(new ExtraField().addSubField("AA", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          assertEquals(gzipParameters1, gzipParameters1);
          assertEquals(gzipParameters1, gzipParameters2);
          assertEquals(gzipParameters2, gzipParameters1);
          // not equals
          gzipParameters2.setExtraField(new ExtraField().addSubField("BB", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          assertNotEquals(gzipParameters1, gzipParameters2);
      }
  
      @Test
      void testHashCode() throws IOException {
          final GzipParameters gzipParameters1 = new GzipParameters();
          final GzipParameters gzipParameters2 = new GzipParameters();
          assertEquals(gzipParameters1.hashCode(), gzipParameters2.hashCode());
          gzipParameters1.setExtraField(new ExtraField().addSubField("AA", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          gzipParameters2.setExtraField(new ExtraField().addSubField("AA", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          assertEquals(gzipParameters1.hashCode(), gzipParameters1.hashCode());
          assertEquals(gzipParameters1.hashCode(), gzipParameters2.hashCode());
          assertEquals(gzipParameters2.hashCode(), gzipParameters1.hashCode());
          // not equals
          gzipParameters2.setExtraField(new ExtraField().addSubField("BB", "XXXX".getBytes(StandardCharsets.ISO_8859_1)));
          assertNotEquals(gzipParameters1.hashCode(), gzipParameters2.hashCode());
      }
  
      @ParameterizedTest
      // @formatter:off
      @CsvSource({
          "          , hello\0world, false",
          "ISO-8859-1, hello\0world, false",
          "UTF-8     , hello\0world, false",
          "UTF-16BE  , helloworld, false"
      })
      // @formatter:on
      void testIllegalCommentOrFileName(final Charset charset, final String text) {
          final GzipParameters gzipParameters = new GzipParameters();
          // null resets to default value
          gzipParameters.setFileNameCharset(charset);
          assertThrows(IllegalArgumentException.class, () -> gzipParameters.setComment(text));
          assertNull(gzipParameters.getComment());
          assertThrows(IllegalArgumentException.class, () -> gzipParameters.setFilename(text));
          assertNull(gzipParameters.getFileName());
          assertThrows(IllegalArgumentException.class, () -> gzipParameters.setFileName(text));
          assertNull(gzipParameters.getFileName());
          assertEquals(gzipParameters, gzipParameters);
      }
 
     @ParameterizedTest
     // @formatter:off
     @CsvSource({
         "          , helloworld",
         "          , helloéworld",
         "ISO-8859-1, helloworld",
         "ISO-8859-1, helloéworld",
         "UTF-8     , helloworld",
         "UTF-8     , helloéworld"
     })
     // @formatter:on
     void testLegalCommentOrFileName(final Charset charset, final String text) {
         final GzipParameters gzipParameters = new GzipParameters();
         // null resets to default value
         gzipParameters.setFileNameCharset(charset);
         gzipParameters.setComment(text);
         assertEquals(text, gzipParameters.getComment());
         gzipParameters.setFilename(text);
         assertEquals(text, gzipParameters.getFileName());
         gzipParameters.setFileName(text);
         assertEquals(text, gzipParameters.getFileName());
         assertEquals(gzipParameters, gzipParameters);
     }
 
     @Test
     void testToString() {
         final GzipParameters gzipParameters = new GzipParameters();
         assertTrue(gzipParameters.toString().contains("UNKNOWN"));
         gzipParameters.setOS(GzipParameters.OS.Z_SYSTEM);
         assertTrue(gzipParameters.toString().contains("Z_SYSTEM"));
         assertEquals(gzipParameters, gzipParameters);
     }
 }