/*
    * 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.
   */
  package org.apache.commons.imaging.formats.bmp;
  
  import static org.junit.jupiter.api.Assertions.assertNotNull;
  import static org.junit.jupiter.api.Assertions.assertThrows;
  
  import java.awt.image.BufferedImage;
  import java.io.File;
  import java.io.IOException;
  import java.util.Collection;
  
  import org.apache.commons.imaging.ImageInfo;
  import org.apache.commons.imaging.Imaging;
  import org.apache.commons.imaging.ImagingException;
  import org.apache.commons.imaging.ImagingTestConstants;
  import org.apache.commons.imaging.bytesource.ByteSource;
  import org.apache.commons.imaging.test.TestResources;
  import org.junit.jupiter.api.Disabled;
  import org.junit.jupiter.api.Test;
  import org.junit.jupiter.params.ParameterizedTest;
  import org.junit.jupiter.params.provider.MethodSource;
  
  public class BmpReadTest extends AbstractBmpTest {
  
      public static Collection<File> data() throws Exception {
          return getBmpImages();
      }
  
      @ParameterizedTest
      @MethodSource("data")
      public void testBufferedImage(final File imageFile) throws Exception {
          final BufferedImage image = Imaging.getBufferedImage(imageFile);
          assertNotNull(image);
          // TODO assert more
      }
  
      /**
       * Test that when the value of the mask parameter is zero, getMaskShift won't get stuck in one of its while loops.
       *
       * @throws IOException
       * @throws ImagingException
       */
      @Test
      public void testGetMaskShiftZeroMask() throws ImagingException, IOException {
          final File inputFile = new File(ImagingTestConstants.TEST_IMAGE_FOLDER + "/bmp/5/@broken/timeout-bd15dbfa26b4e88070de540c6603039e8a88626f");
          new BmpImageParser().dumpImageFile(ByteSource.file(inputFile));
      }
  
      @ParameterizedTest
      @MethodSource("data")
      public void testImageInfo(final File imageFile) throws ImagingException, IOException {
          final ImageInfo imageInfo = Imaging.getImageInfo(imageFile);
          assertNotNull(imageInfo);
          // TODO assert more
      }
  
      @Disabled(value = "RoundtripTest has to be fixed before implementation can throw UnsupportedOperationException")
      @ParameterizedTest
      @MethodSource("data")
      public void testMetaData(final File imageFile) {
          assertThrows(UnsupportedOperationException.class, () -> Imaging.getMetadata(imageFile));
      }
  
      @Test
      public void testNegativePaletteLength() {
          final File inputFile = TestResources.resourceToFile("/images/bmp/IMAGING-325/crash-3afb569de74522535ef65922233e1920455cdc14.bmp");
          assertThrows(ImagingException.class, () -> new BmpImageParser().dumpImageFile(ByteSource.file(inputFile)));
      }
  }