poi/poi/src/test/java/org/apache/poi/hssf/model/TestRVA.java

/* ====================================================================
   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.hssf.model;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.util.ArrayList;
import java.util.List;
import java.util.stream.Stream;

import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.hssf.usermodel.FormulaExtractor;
import org.apache.poi.hssf.usermodel.HSSFCell;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.apache.poi.ss.formula.ptg.AttrPtg;
import org.apache.poi.ss.formula.ptg.Ptg;
import org.apache.poi.ss.usermodel.CellType;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;

/**
 * Tests 'operand class' transformation performed by
 * {@code OperandClassTransformer} by comparing its results with those
 * directly produced by Excel (in a sample spreadsheet).
 */
final class TestRVA {

    private static final String NEW_LINE = System.getProperty("line.separator");
    private static POIFSFileSystem poifs;
    private static HSSFWorkbook workbook;


    @AfterAll
    public static void closeResource() throws Exception {
        workbook.close();
        poifs.close();
    }

    public static Stream<Arguments> data() throws Exception {
        poifs = new POIFSFileSystem(HSSFTestDataSamples.getSampleFile("testRVA.xls"), true);
        workbook = new HSSFWorkbook(poifs);
        HSSFSheet sheet = workbook.getSheetAt(0);

        List<Arguments> data = new ArrayList<>();

        for (int rowIdx = 0; true; rowIdx++) {
            HSSFRow row = sheet.getRow(rowIdx);
            if (row == null) {
                break;
            }
            HSSFCell cell = row.getCell(0);
            if (cell == null || cell.getCellType() == CellType.BLANK) {
                break;
            }

            String formula = cell.getCellFormula();
            data.add(Arguments.of(cell,formula));
        }

        return data.stream();
    }

    @ParameterizedTest
    @MethodSource("data")
    void confirmCell(HSSFCell formulaCell, String formula) {
        Ptg[] excelPtgs = FormulaExtractor.getPtgs(formulaCell);
        Ptg[] poiPtgs = HSSFFormulaParser.parse(formula, workbook);
        int nExcelTokens = excelPtgs.length;
        int nPoiTokens = poiPtgs.length;
        if (nExcelTokens != nPoiTokens) {
            assertTrue(nExcelTokens == nPoiTokens + 1 && excelPtgs[0].getClass() == AttrPtg.class,
                "Expected " + nExcelTokens + " tokens but got " + nPoiTokens);

            // compensate for missing tAttrVolatile, which belongs in any formula
            // involving OFFSET() et al. POI currently does not insert where required
            Ptg[] temp = new Ptg[nExcelTokens];
            temp[0] = excelPtgs[0];
            System.arraycopy(poiPtgs, 0, temp, 1, nPoiTokens);
            poiPtgs = temp;
        }
        boolean hasMismatch = false;
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < nExcelTokens; i++) {
            Ptg poiPtg = poiPtgs[i];
            Ptg excelPtg = excelPtgs[i];
            if (excelPtg.getClass() != poiPtg.getClass()) {
                hasMismatch = true;
                sb.append("  mismatch token type[").append(i).append("] ").append(getShortClassName(excelPtg)).append(" ").append(excelPtg.getRVAType()).append(" - ").append(getShortClassName(poiPtg)).append(" ").append(poiPtg.getRVAType());
                sb.append(NEW_LINE);
                continue;
            }
            if (poiPtg.isBaseToken()) {
                continue;
            }
            sb.append("  token[").append(i).append("] ").append(excelPtg).append(" ").append(excelPtg.getRVAType());

            if (excelPtg.getPtgClass() != poiPtg.getPtgClass()) {
                hasMismatch = true;
                sb.append(" - was ").append(poiPtg.getRVAType());
            }
            sb.append(NEW_LINE);
        }
        assertFalse(hasMismatch);
    }

    private String getShortClassName(Object o) {
        String cn = o.getClass().getName();
        int pos = cn.lastIndexOf('.');
        return cn.substring(pos + 1);
    }
}