123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292 |
- /* ====================================================================
- 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.File;
- import java.io.FileInputStream;
- import java.io.FileOutputStream;
- import java.io.IOException;
- import java.io.InputStream;
-
- import org.apache.commons.io.output.UnsynchronizedByteArrayOutputStream;
- import org.apache.poi.hssf.HSSFTestDataSamples;
- import org.apache.poi.openxml4j.opc.OPCPackage;
- import org.apache.poi.ss.usermodel.Workbook;
- import org.apache.poi.util.TempFile;
- import org.apache.poi.xssf.usermodel.XSSFWorkbook;
-
- /**
- * Centralises logic for finding/opening sample files in the test-data/spreadsheet folder.
- */
- public class XSSFTestDataSamples {
- /**
- * Used by {@link #writeOutAndReadBack(Workbook, String)}. 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 File getSampleFile(String sampleFileName) {
- return HSSFTestDataSamples.getSampleFile(sampleFileName);
- }
- 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);
- }
- }
-
- /**
- * Write out workbook {@code wb} to {@link #TEST_OUTPUT_DIR}/testName.xlsx
- * (or create a temporary file if {@code TEST_OUTPUT_DIR} is not defined).
- *
- * @param wb the workbook to write
- * @param testName a fragment of the filename
- * @return the location where the workbook was saved
- * @throws IOException If writing the file fails
- */
- public static <R extends Workbook> File writeOut(R wb, String testName) throws IOException {
- final File file = getOutputFile(testName);
- writeOut(wb, file);
- return file;
- }
-
- private static <R extends Workbook> void writeOut(R wb, File file) throws IOException {
- try (FileOutputStream out = new FileOutputStream(file)) {
- wb.write(out);
- }
- }
-
- // Anticipates the location of where a workbook will be written to
- // Note that if TEST_OUTPUT_DIR is not set, this will create temporary files
- // with unique names. Subsequent calls with the same argument may return a different file.
- // Gets a test data sample file, deleting the file if it exists.
- // This is used in preparation for writing a workbook out to the returned output file.
- // testName is a filename fragment and should not include the extension
- private static File getOutputFile(String testName) throws IOException {
- final String testOutputDir = System.getProperty(TEST_OUTPUT_DIR);
- final File file;
- if (testOutputDir != null) {
- // In case user provided testName with a file extension, don't repeat the file extension a second time
- final String testNameWithExtension = (testName.endsWith(".xlsx") || testName.endsWith(".xlsxm")) ? testName : testName + ".xlsx";
- // FIXME: may want to defer to the TempFile with a persistent file creation strategy to the test output dir
- // This would add the random value in the middle of the filename so that test runs wouldn't overwrite files
- file = new File(testOutputDir, testNameWithExtension);
- }
- else {
- file = TempFile.createTempFile(testName, ".xlsx");
- }
- if (file.exists()) {
- if(!file.delete()) {
- throw new IOException("Could not delete file " + file);
- }
- }
- return file;
- }
-
- /**
- * Write out workbook {@code wb} to a memory buffer
- *
- * @param wb the workbook to write
- * @return the memory buffer
- * @throws IOException If writing the file fails
- */
- public static <R extends Workbook> UnsynchronizedByteArrayOutputStream writeOut(R wb) throws IOException {
- UnsynchronizedByteArrayOutputStream out = new UnsynchronizedByteArrayOutputStream(8192);
- wb.write(out);
- return out;
- }
-
- /**
- * Write out the workbook then closes the workbook.
- * This should be used when there is insufficient memory to have
- * both workbooks open.
- *
- * Make sure there are no references to any objects in the workbook
- * so that garbage collection may free the workbook.
- *
- * After calling this method, null the reference to {@code wb},
- * then call {@link #readBack(File)} or {@link #readBackAndDelete(File)} to re-read the file.
- *
- * Alternatively, use {@link #writeOutAndClose(Workbook)} to use a UnsynchronizedByteArrayOutputStream/ByteArrayInputStream
- * to avoid creating a temporary file. However, this may complicate the calling
- * code to avoid having the workbook, BAOS, and BAIS open at the same time.
- *
- * @param wb The workbook to write out, it is closed after the call.
- * @param testName file name to be used to write to a file. This file will be cleaned up by a call to readBack(String)
- * @return workbook location
- * @throws IllegalStateException if {@link #TEST_OUTPUT_DIR} System property is not set
- */
- public static <R extends Workbook> File writeOutAndClose(R wb, String testName) {
- try {
- File file = writeOut(wb, testName);
- // Do not close the workbook if there was a problem writing the workbook
- wb.close();
- return file;
- }
- catch (final IOException e) {
- throw new RuntimeException(e);
- }
- }
-
-
- /**
- * Write out workbook {@code wb} to a memory buffer,
- * then close the workbook
- *
- * @param wb the workbook to write
- * @return the memory buffer
- * @throws IllegalStateException If writing the file fails
- */
- public static <R extends Workbook> UnsynchronizedByteArrayOutputStream writeOutAndClose(R wb) throws IOException {
- UnsynchronizedByteArrayOutputStream out = writeOut(wb);
- // Do not close the workbook if there was a problem writing the workbook
- wb.close();
- return out;
- }
-
- /**
- * Read back a workbook that was written out to a file with
- * {@link #writeOut(Workbook, String))} or {@link #writeOutAndClose(Workbook, String)}.
- * Deletes the file after reading back the file.
- * Does not delete the file if an exception is raised.
- *
- * @param file the workbook file to read and delete
- * @return the read back workbook
- * @throws IOException If reading or deleting the file fails
- */
- public static XSSFWorkbook readBackAndDelete(File file) throws IOException {
- XSSFWorkbook wb = readBack(file);
- // do not delete the file if there's an error--might be helpful for debugging
- if(!file.delete()) {
- throw new IOException("Could not delete file " + file + " after reading");
- }
- return wb;
- }
-
- /**
- * Read back a workbook that was written out to a file with
- * {@link #writeOut(Workbook, String)} or {@link #writeOutAndClose(Workbook, String)}.
- *
- * @param file the workbook file to read
- * @return the read back workbook
- * @throws IOException If reading the file fails
- */
- public static XSSFWorkbook readBack(File file) throws IOException {
- try (InputStream in = new FileInputStream(file)) {
- return new XSSFWorkbook(in);
- }
- }
-
- /**
- * Read back a workbook that was written out to a memory buffer with
- * {@link #writeOut(Workbook)} or {@link #writeOutAndClose(Workbook)}.
- *
- * @param out the output stream to read back from
- * @return the read back workbook
- * @throws IOException If reading the file fails
- */
- public static XSSFWorkbook readBack(UnsynchronizedByteArrayOutputStream out) throws IOException {
- try (InputStream is = out.toInputStream()) {
- out.close();
- return new XSSFWorkbook(is);
- }
- }
-
- /**
- * Write out and read back using a memory buffer to avoid disk I/O.
- * If there is not enough memory to have two workbooks open at the same time,
- * consider using:
- *
- * Workbook wb = new XSSFWorkbook();
- * String testName = "example";
- *
- * {@code
- * File file = writeOutAndClose(wb, testName);
- * // clear all references that would prevent the workbook from getting garbage collected
- * wb = null;
- * Workbook wbBack = readBackAndDelete(file);
- * }
- *
- * @param wb the workbook to write out
- * @return the read back workbook
- */
- public static <R extends Workbook> R writeOutAndReadBack(R wb) {
- Workbook result;
- try {
- result = readBack(writeOut(wb));
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- @SuppressWarnings("unchecked")
- R r = (R) result;
- return r;
- }
-
- /**
- * Write out, close, and read back the workbook using a memory buffer to avoid disk I/O.
- *
- * @param wb the workbook to write out and close
- * @return the read back workbook
- */
- public static <R extends Workbook> R writeOutCloseAndReadBack(R wb) {
- Workbook result;
- try {
- result = readBack(writeOutAndClose(wb));
- } 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.
- * If TEST_OUTPUT_DIR is set, the file will NOT be deleted at the end of this function.
- * @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) {
- if (System.getProperty(TEST_OUTPUT_DIR) == null) {
- return writeOutAndReadBack(wb);
- } else {
- try {
- Workbook result = readBack(writeOut(wb, testName));
- @SuppressWarnings("unchecked")
- R r = (R) result;
- return r;
- } catch (IOException e) {
- throw new RuntimeException(e);
- }
- }
- }
- }
|