XSSFTestDataSamples

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

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;

import org.apache.poi.hssf.HSSFTestDataSamples;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.openxml4j.opc.OPCPackage;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

/**
 * Centralises logic for finding/opening sample files in the test-data/spreadsheet folder.
 *
 * @author Josh Micich
 */
public class XSSFTestDataSamples {
   /**
    * Used by {@link writeOutAndReadBack(R wb, String testName)}.  If a
    * value is set for this in the System Properties, the xlsx file
    * will be written out to that directory.
    */
   public static final String TEST_OUTPUT_DIR = "poi.test.xssf.output.dir";

   public static OPCPackage openSamplePackage(String sampleName) {
      try {
         return OPCPackage.open(
               HSSFTestDataSamples.openSampleFileStream(sampleName)
         );
      } catch(Exception e) {
         throw new RuntimeException(e);
      }
   }
    public static XSSFWorkbook openSampleWorkbook(String sampleName) {
        InputStream is = HSSFTestDataSamples.openSampleFileStream(sampleName);
        try {
            return new XSSFWorkbook(is);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }
    public static <R extends Workbook> R writeOutAndReadBack(R wb) {
        Workbook result;
        try {
            ByteArrayOutputStream baos = new ByteArrayOutputStream(8192);
            wb.write(baos);
            wb.close();
            InputStream is = new ByteArrayInputStream(baos.toByteArray());
            if (wb instanceof HSSFWorkbook) {
                result = new HSSFWorkbook(is);
            } else if (wb instanceof XSSFWorkbook) {
                result = new XSSFWorkbook(is);
            } else {
                throw new RuntimeException("Unexpected workbook type ("
                        + wb.getClass().getName() + ")");
            }
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        @SuppressWarnings("unchecked")
        R r = (R) result;
        return r;
    }

    /**
     * Writes the Workbook either into a file or into a byte array, depending on presence of
     * the system property {@value #TEST_OUTPUT_DIR}, and reads it in a new instance of the Workbook back.
     * @param wb workbook to write
     * @param testName file name to be used if writing into a file. The old file with the same name will be overridden.
     * @return new instance read from the stream written by the wb parameter.
     */
    public static <R extends Workbook> R writeOutAndReadBack(R wb, String testName) {
        XSSFWorkbook result = null;
        if (System.getProperty(TEST_OUTPUT_DIR) != null) {
            try {
                File file = new File(System.getProperty(TEST_OUTPUT_DIR), testName + ".xlsx");
                if (file.exists()) {
                    file.delete();
                }
                FileOutputStream out = new FileOutputStream(file);
                try {
                    wb.write(out);
                } finally {
                    out.close();
                }
                FileInputStream in = new FileInputStream(file);
                try {
                    result = new XSSFWorkbook(in);
                } finally {
                    in.close();
                }
                wb.close();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
        } else {
            return writeOutAndReadBack(wb);
        }
        @SuppressWarnings("unchecked")
        R r = (R) result;
        return r;
    }
}