/*
 * 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.pdfbox.pdmodel.interactive.form;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

import java.io.File;
import java.io.IOException;

import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
 * Test for the PDButton class.
 *
 */
public class PDAcroFormTest
{
    
    private PDDocument document;
    private PDAcroForm acroForm;
    
    @Before
    public void setUp()
    {
        document = new PDDocument();
        acroForm = new PDAcroForm(document);
        document.getDocumentCatalog().setAcroForm(acroForm);
    }

    @Test
    public void testFieldsEntry()
    {
        // the /Fields entry has been created with the AcroForm
        // as this is a required entry
        assertNotNull(acroForm.getFields());
        assertEquals(acroForm.getFields().size(),0);
        
        // there shouldn't be an exception if there is no such field
        assertNull(acroForm.getField("foo"));
        
        // remove the required entry which is the case for some
        // PDFs (see PDFBOX-2965)
        acroForm.getCOSObject().removeItem(COSName.FIELDS);
        
        // ensure there is always an empty collection returned
        assertNotNull(acroForm.getFields());
        assertEquals(acroForm.getFields().size(),0);

        // there shouldn't be an exception if there is no such field
        assertNull(acroForm.getField("foo"));
    }
    
    @Test
    public void testAcroFormProperties()
    {
        assertTrue(acroForm.getDefaultAppearance().isEmpty());
        acroForm.setDefaultAppearance("/Helv 0 Tf 0 g");
        assertEquals(acroForm.getDefaultAppearance(),"/Helv 0 Tf 0 g");
    }
    
    @Test
    public void testFlatten() throws IOException
    {
        PDDocument testPdf = PDDocument.load(new File("src/test/resources/org/apache/pdfbox/pdmodel/interactive/form/AlignmentTests.pdf"));
        testPdf.getDocumentCatalog().getAcroForm().flatten();
        testPdf.save("target/test-output/AlignmentTests-flattened.pdf"); 
    }

    @After
    public void tearDown() throws IOException
    {
        document.close();
    }

}


@@ -1160,16 +1160,67 @@
 cument;%0A
+import org.apache.pdfbox.rendering.TestPDFToImage;%0A
 import o
@@ -1429,24 +1429,215 @@
 oForm;%0A    %0A
+    private static final File OUT_DIR = new File(%22target/test-output%22);%0A    private static final File IN_DIR = new File(%22src/test/resources/org/apache/pdfbox/pdmodel/interactive/form%22);%0A    %0A
     @Before%0A
@@ -3038,228 +3038,775 @@
 ile(
-%22src/test/resources/org/apache/pdfbox/pdmodel/interactive/form/AlignmentTests.pdf%22));%0A        testPdf.getDocumentCatalog().getAcroForm().flatten();%0A        testPdf.save(%22target/test-output/AlignmentTests-flattened.pdf%22);
+IN_DIR, %22AlignmentTests.pdf%22));%0A        testPdf.getDocumentCatalog().getAcroForm().flatten();%0A        assertTrue(testPdf.getDocumentCatalog().getAcroForm().getFields().isEmpty());%0A        File file = new File(OUT_DIR, %22AlignmentTests-flattened.pdf%22);%0A        testPdf.save(file);%0A        // compare rendering%0A        TestPDFToImage testPDFToImage = new TestPDFToImage(TestPDFToImage.class.getName());%0A        if (!testPDFToImage.doTestFile(file, IN_DIR.getAbsolutePath(), OUT_DIR.getAbsolutePath()))%0A        %7B%0A            // don't fail, rendering is different on different systems, result must be viewed manually%0A            System.out.println(%22Rendering of %22 + file + %22 failed or is not identical to expected rendering in %22 + IN_DIR + %22 directory%22);%0A        %7D%0A       
  %0A  

add render test