/* ====================================================================
   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.poi.ddf;

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotSame;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.util.Arrays;
import java.util.List;

import org.apache.poi.POIDataSamples;
import org.apache.poi.util.HexDump;
import org.apache.poi.util.HexRead;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.parallel.Isolated;

/**
 * Tests for {@link EscherContainerRecord}
 */
@Isolated   // this test changes global static MAX_NUMBER_OF_CHILDREN
final class TestEscherContainerRecord {
    private static final POIDataSamples _samples = POIDataSamples.getDDFInstance();

    @Test
    void testFillFields() {
        EscherRecordFactory f = new DefaultEscherRecordFactory();
        byte[] data = HexRead.readFromString("0F 02 11 F1 00 00 00 00");
        EscherRecord r = f.createRecord(data, 0);
        r.fillFields(data, 0, f);
        assertInstanceOf(EscherContainerRecord.class, r);
        assertEquals((short) 0x020F, r.getOptions());
        assertEquals((short) 0xF111, r.getRecordId());

        data = HexRead.readFromString("0F 02 11 F1 08 00 00 00" +
                " 02 00 22 F2 00 00 00 00");
        r = f.createRecord(data, 0);
        r.fillFields(data, 0, f);
        EscherRecord c = r.getChild(0);
        assertFalse(c instanceof EscherContainerRecord);
        assertEquals((short) 0x0002, c.getOptions());
        assertEquals((short) 0xF222, c.getRecordId());
    }

    @Test
    void testSerialize() {
        UnknownEscherRecord r = new UnknownEscherRecord();
        r.setOptions((short) 0x123F);
        r.setRecordId((short) 0xF112);
        byte[] data = new byte[8];
        r.serialize(0, data, new NullEscherSerializationListener());

        assertEquals("[3F, 12, 12, F1, 00, 00, 00, 00]", HexDump.toHex(data));

        EscherRecord childRecord = new UnknownEscherRecord();
        childRecord.setOptions((short) 0x9999);
        childRecord.setRecordId((short) 0xFF01);
        r.addChildRecord(childRecord);
        data = new byte[16];
        r.serialize(0, data, new NullEscherSerializationListener());

        assertEquals("[3F, 12, 12, F1, 08, 00, 00, 00, 99, 99, 01, FF, 00, 00, 00, 00]", HexDump.toHex(data));

    }

    @Test
    void testToString() {
        EscherContainerRecord r = new EscherContainerRecord();
        r.setRecordId(EscherContainerRecord.SP_CONTAINER);
        r.setOptions((short) 0x000F);
        String expected =
            "{   /* SP_CONTAINER */\n" +
            "\t  \"recordId\": -4092 /* 0xf004 */\n" +
            "\t, \"version\": 15 /* 0x000f */\n" +
            "\t, \"instance\": 0\n" +
            "\t, \"options\": 15 /* 0x000f */\n" +
            "\t, \"recordSize\": 8\n" +
            "\t, \"isContainer\": true\n" +
            "}";
        expected = expected.replace("\n", System.lineSeparator());
        assertEquals(expected, r.toString());

        EscherOptRecord r2 = new EscherOptRecord();
        // don't try to shoot in foot, please -- vlsergey
        // r2.setOptions((short) 0x9876);
        r2.setRecordId(EscherOptRecord.RECORD_ID);

        r.addChildRecord(r2);
        expected =
            "{   /* SP_CONTAINER */\n" +
            "\t  \"recordId\": -4092 /* 0xf004 */\n" +
            "\t, \"version\": 15 /* 0x000f */\n" +
            "\t, \"instance\": 0\n" +
            "\t, \"options\": 15 /* 0x000f */\n" +
            "\t, \"recordSize\": 16 /* 0x00000010 */\n" +
            "\t, \"isContainer\": true\n" +
            "\t, \"children\": [\n" +
            "\t\t{   /* OPT */\n" +
            "\t\t\t  \"recordId\": -4085 /* 0xf00b */\n" +
            "\t\t\t, \"version\": 3\n" +
            "\t\t\t, \"instance\": 0\n" +
            "\t\t\t, \"options\": 3\n" +
            "\t\t\t, \"recordSize\": 8\n" +
            "\t\t\t, \"isContainer\": false\n" +
            "\t\t\t, \"properties\": [\n" +
            "\t\t\t]\n" +
            "\t\t}\n" +
            "\t]\n" +
            "}";
        expected = expected.replace("\n", System.lineSeparator());
        assertEquals(expected, r.toString());

        r.addChildRecord(r2);
        expected =
            "{   /* SP_CONTAINER */\n" +
            "\t  \"recordId\": -4092 /* 0xf004 */\n" +
            "\t, \"version\": 15 /* 0x000f */\n" +
            "\t, \"instance\": 0\n" +
            "\t, \"options\": 15 /* 0x000f */\n" +
            "\t, \"recordSize\": 24 /* 0x00000018 */\n" +
            "\t, \"isContainer\": true\n" +
            "\t, \"children\": [\n" +
            "\t\t{   /* OPT */\n" +
            "\t\t\t  \"recordId\": -4085 /* 0xf00b */\n" +
            "\t\t\t, \"version\": 3\n" +
            "\t\t\t, \"instance\": 0\n" +
            "\t\t\t, \"options\": 3\n" +
            "\t\t\t, \"recordSize\": 8\n" +
            "\t\t\t, \"isContainer\": false\n" +
            "\t\t\t, \"properties\": [\n" +
            "\t\t\t]\n" +
            "\t\t},\t\t{   /* OPT - index: 1 */\n" +
            "\t\t\t  \"recordId\": -4085 /* 0xf00b */\n" +
            "\t\t\t, \"version\": 3\n" +
            "\t\t\t, \"instance\": 0\n" +
            "\t\t\t, \"options\": 3\n" +
            "\t\t\t, \"recordSize\": 8\n" +
            "\t\t\t, \"isContainer\": false\n" +
            "\t\t\t, \"properties\": [\n" +
            "\t\t\t]\n" +
            "\t\t}\n" +
            "\t]\n" +
            "}";
        expected = expected.replace("\n", System.lineSeparator());
        assertEquals(expected, r.toString());
    }

    private static final class DummyEscherRecord extends EscherRecord {
        public DummyEscherRecord() { }
        @Override
        public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) { return 0; }
        @Override
        public int serialize(int offset, byte[] data, EscherSerializationListener listener) { return 0; }
        @Override
        public int getRecordSize() { return 10; }
        @Override
        public String getRecordName() { return ""; }
        @Override
        public Enum<?> getGenericRecordType() { return EscherRecordTypes.UNKNOWN; }
        @Override
        public DummyEscherRecord copy() { return null; }
    }

    @Test
    void testGetRecordSize() {
        EscherContainerRecord r = new EscherContainerRecord();
        r.addChildRecord(new DummyEscherRecord());
        assertEquals(18, r.getRecordSize());
    }

    /**
     * We were having problems with reading too much data on an UnknownEscherRecord,
     *  but hopefully we now read the correct size.
     */
    @Test
    void testBug44857() {
        byte[] data = _samples.readFile("Container.dat");

        // This used to fail with an OutOfMemory
        EscherContainerRecord record = new EscherContainerRecord();
        record.fillFields(data, 0, new DefaultEscherRecordFactory());

        Class<?>[] exp = { EscherDggRecord.class, EscherContainerRecord.class, EscherOptRecord.class, EscherSplitMenuColorsRecord.class };
        Class<?>[] act = record.getChildRecords().stream().map(Object::getClass).toArray(Class[]::new);
        assertArrayEquals(exp, act);
    }

    /**
     * Ensure {@link EscherContainerRecord} doesn't spill its guts everywhere
     */
    @Test
    void testChildren() {
        EscherContainerRecord ecr = new EscherContainerRecord();
        List<EscherRecord> children0 = ecr.getChildRecords();
        assertEquals(0, children0.size());

        EscherRecord chA = new DummyEscherRecord();
        EscherRecord chB = new DummyEscherRecord();
        EscherRecord chC = new DummyEscherRecord();

        ecr.addChildRecord(chA);
        ecr.addChildRecord(chB);
        children0.add(chC);

        List<EscherRecord> children1 = ecr.getChildRecords();
        assertNotSame(children0, children1);
        assertEquals(2, children1.size());
        assertEquals(chA, children1.get(0));
        assertEquals(chB, children1.get(1));

        assertEquals(1, children0.size()); // first copy unchanged

        ecr.setChildRecords(children0);
        ecr.addChildRecord(chA);
        List<EscherRecord> children2 = ecr.getChildRecords();
        assertEquals(2, children2.size());
        assertEquals(chC, children2.get(0));
        assertEquals(chA, children2.get(1));
    }

    @Test
    void testTooManyChildren() {
        EscherContainerRecord ecr = new EscherContainerRecord();

        int before = EscherRecord.getMaxNumberOfChildren();
        try {
            EscherRecord.setMaxNumberOfChildren(2);

            ecr.addChildRecord(new EscherDgRecord());
            ecr.addChildRecord(new EscherDgRecord());
            assertThrows(IllegalStateException.class,
                    () -> ecr.addChildRecord(new EscherDgRecord()));

            ecr.setChildRecords(Arrays.asList(new EscherDgRecord(), new EscherDgRecord()));
            assertThrows(IllegalStateException.class,
                    () -> ecr.setChildRecords(Arrays.asList(new EscherDgRecord(), new EscherDgRecord(), new EscherDgRecord())));
        } finally {
            EscherRecord.setMaxNumberOfChildren(before);
        }
    }
}
