/* ==================================================================== 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.usermodel; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; import static org.junit.Assert.fail; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.ArrayList; import java.util.Arrays; import java.util.Calendar; import java.util.Date; import java.util.Iterator; import java.util.List; import org.apache.poi.EncryptedDocumentException; import org.apache.poi.hssf.HSSFITestDataProvider; import org.apache.poi.hssf.HSSFTestDataSamples; import org.apache.poi.hssf.OldExcelFormatException; import org.apache.poi.hssf.extractor.ExcelExtractor; import org.apache.poi.hssf.model.InternalSheet; import org.apache.poi.hssf.model.InternalWorkbook; import org.apache.poi.hssf.record.CellValueRecordInterface; import org.apache.poi.hssf.record.EmbeddedObjectRefSubRecord; import org.apache.poi.hssf.record.NameRecord; import org.apache.poi.hssf.record.Record; import org.apache.poi.hssf.record.TabIdRecord; import org.apache.poi.hssf.record.UnknownRecord; import org.apache.poi.hssf.record.aggregates.FormulaRecordAggregate; import org.apache.poi.hssf.record.aggregates.PageSettingsBlock; import org.apache.poi.hssf.record.aggregates.RecordAggregate; import org.apache.poi.hssf.record.common.UnicodeString; import org.apache.poi.hssf.record.crypto.Biff8EncryptionKey; import org.apache.poi.poifs.filesystem.NPOIFSFileSystem; import org.apache.poi.poifs.filesystem.POIFSFileSystem; import org.apache.poi.ss.formula.ptg.Area3DPtg; import org.apache.poi.ss.formula.ptg.DeletedArea3DPtg; import org.apache.poi.ss.formula.ptg.Ptg; import org.apache.poi.ss.usermodel.BaseTestBugzillaIssues; import org.apache.poi.ss.usermodel.Cell; import org.apache.poi.ss.usermodel.CellStyle; import org.apache.poi.ss.usermodel.DataFormat; import org.apache.poi.ss.usermodel.DataFormatter; import org.apache.poi.ss.usermodel.FormulaEvaluator; import org.apache.poi.ss.usermodel.Name; import org.apache.poi.ss.usermodel.Row; import org.apache.poi.ss.usermodel.Sheet; import org.apache.poi.ss.usermodel.Workbook; import org.apache.poi.util.TempFile; import org.junit.Ignore; import org.junit.Test; /** * Testcases for bugs entered in bugzilla * the Test name contains the bugzilla bug id * * YK: If a bug can be tested in terms of common ss interfaces, * define the test in the base class {@link BaseTestBugzillaIssues} * * @author Avik Sengupta * @author Yegor Kozlov */ public final class TestBugs extends BaseTestBugzillaIssues { public TestBugs() { super(HSSFITestDataProvider.instance); } private static HSSFWorkbook openSample(String sampleFileName) { return HSSFITestDataProvider.instance.openSampleWorkbook(sampleFileName); } private static HSSFWorkbook writeOutAndReadBack(HSSFWorkbook original) { return HSSFITestDataProvider.instance.writeOutAndReadBack(original); } @SuppressWarnings("unused") private static void writeTestOutputFileForViewing(HSSFWorkbook wb, String simpleFileName) { if (true) { // set to false to output test files return; } System.setProperty("poi.keep.tmp.files", "true"); File file; try { file = TempFile.createTempFile(simpleFileName + "#", ".xls"); FileOutputStream out = new FileOutputStream(file); wb.write(out); out.close(); } catch (IOException e) { throw new RuntimeException(e); } if (!file.exists()) { throw new RuntimeException("File was not written"); } System.out.println("Open file '" + file.getAbsolutePath() + "' in Excel"); } /** Test reading AND writing a complicated workbook *Test opening resulting sheet in excel*/ @Test public void bug15228() { HSSFWorkbook wb = openSample("15228.xls"); HSSFSheet s = wb.getSheetAt(0); HSSFRow r = s.createRow(0); HSSFCell c = r.createCell(0); c.setCellValue(10); writeTestOutputFileForViewing(wb, "test15228"); } @Test public void bug13796() { HSSFWorkbook wb = openSample("13796.xls"); HSSFSheet s = wb.getSheetAt(0); HSSFRow r = s.createRow(0); HSSFCell c = r.createCell(0); c.setCellValue(10); writeOutAndReadBack(wb); } /** test hyperlinks * open resulting file in excel, and check that there is a link to Google */ @Test public void bug15353() { HSSFWorkbook wb = new HSSFWorkbook(); HSSFSheet sheet = wb.createSheet("My sheet"); HSSFRow row = sheet.createRow( 0 ); HSSFCell cell = row.createCell( 0 ); cell.setCellFormula("HYPERLINK(\"http://google.com\",\"Google\")"); writeOutAndReadBack(wb); } /** test reading of a formula with a name and a cell ref in one **/ @Test public void bug14460() { HSSFWorkbook wb = openSample("14460.xls"); wb.getSheetAt(0); } @Test public void bug14330() { HSSFWorkbook wb = openSample("14330-1.xls"); wb.getSheetAt(0); wb = openSample("14330-2.xls"); wb.getSheetAt(0); } private static void setCellText(HSSFCell cell, String text) { cell.setCellValue(new HSSFRichTextString(text)); } /** test rewriting a file with large number of unique strings *open resulting file in Excel to check results!*/ @Test public void bug15375() { HSSFWorkbook wb = openSample("15375.xls"); HSSFSheet sheet = wb.getSheetAt(0); HSSFRow row = sheet.getRow(5); HSSFCell cell = row.getCell(3); if (cell == null) cell = row.createCell(3); // Write test cell.setCellType(HSSFCell.CELL_TYPE_STRING); setCellText(cell, "a test"); // change existing numeric cell value HSSFRow oRow = sheet.getRow(14); HSSFCell oCell = oRow.getCell(4); oCell.setCellValue(75); oCell = oRow.getCell(5); setCellText(oCell, "0.3"); writeTestOutputFileForViewing(wb, "test15375"); } /** * test writing a file with large number of unique strings, * open resulting file in Excel to check results! */ @Test public void bug15375_2() { bug15375(6000); } /**Double byte strings*/ @Test public void bug15556() { HSSFWorkbook wb = openSample("15556.xls"); HSSFSheet sheet = wb.getSheetAt(0); HSSFRow row = sheet.getRow(45); assertNotNull("Read row fine!" , row); } /**Double byte strings */ @Test public void bug22742() { openSample("22742.xls"); } /**Double byte strings */ @Test public void bug12561_1() { openSample("12561-1.xls"); } /** Double byte strings */ @Test public void bug12561_2() { openSample("12561-2.xls"); } /** Double byte strings File supplied by jubeson*/ @Test public void bug12843_1() { openSample("12843-1.xls"); } /** Double byte strings File supplied by Paul Chung*/ @Test public void bug12843_2() { openSample("12843-2.xls"); } /** Reference to Name*/ @Test public void bug13224() { openSample("13224.xls"); } /** Illegal argument exception - cannot store duplicate value in Map*/ @Test public void bug19599() { openSample("19599-1.xls"); openSample("19599-2.xls"); } @Test public void bug24215() { HSSFWorkbook wb = openSample("24215.xls"); for (int sheetIndex = 0; sheetIndex < wb.getNumberOfSheets();sheetIndex++) { HSSFSheet sheet = wb.getSheetAt(sheetIndex); int rows = sheet.getLastRowNum(); for (int rowIndex = 0; rowIndex < rows; rowIndex++) { HSSFRow row = sheet.getRow(rowIndex); int cells = row.getLastCellNum(); for (int cellIndex = 0; cellIndex < cells; cellIndex++) { row.getCell(cellIndex); } } } } /**Tests read and write of Unicode strings in formula results * bug and testcase submitted by Sompop Kumnoonsate * The file contains THAI unicode characters. */ @Test public void bugUnicodeStringFormulaRead() { HSSFWorkbook w = openSample("25695.xls"); HSSFCell a1 = w.getSheetAt(0).getRow(0).getCell(0); HSSFCell a2 = w.getSheetAt(0).getRow(0).getCell(1); HSSFCell b1 = w.getSheetAt(0).getRow(1).getCell(0); HSSFCell b2 = w.getSheetAt(0).getRow(1).getCell(1); HSSFCell c1 = w.getSheetAt(0).getRow(2).getCell(0); HSSFCell c2 = w.getSheetAt(0).getRow(2).getCell(1); HSSFCell d1 = w.getSheetAt(0).getRow(3).getCell(0); HSSFCell d2 = w.getSheetAt(0).getRow(3).getCell(1); if (false) { // THAI code page System.out.println("a1="+unicodeString(a1)); System.out.println("a2="+unicodeString(a2)); // US code page System.out.println("b1="+unicodeString(b1)); System.out.println("b2="+unicodeString(b2)); // THAI+US System.out.println("c1="+unicodeString(c1)); System.out.println("c2="+unicodeString(c2)); // US+THAI System.out.println("d1="+unicodeString(d1)); System.out.println("d2="+unicodeString(d2)); } confirmSameCellText(a1, a2); confirmSameCellText(b1, b2); confirmSameCellText(c1, c2); confirmSameCellText(d1, d2); HSSFWorkbook rw = writeOutAndReadBack(w); HSSFCell ra1 = rw.getSheetAt(0).getRow(0).getCell(0); HSSFCell ra2 = rw.getSheetAt(0).getRow(0).getCell(1); HSSFCell rb1 = rw.getSheetAt(0).getRow(1).getCell(0); HSSFCell rb2 = rw.getSheetAt(0).getRow(1).getCell(1); HSSFCell rc1 = rw.getSheetAt(0).getRow(2).getCell(0); HSSFCell rc2 = rw.getSheetAt(0).getRow(2).getCell(1); HSSFCell rd1 = rw.getSheetAt(0).getRow(3).getCell(0); HSSFCell rd2 = rw.getSheetAt(0).getRow(3).getCell(1); confirmSameCellText(a1, ra1); confirmSameCellText(b1, rb1); confirmSameCellText(c1, rc1); confirmSameCellText(d1, rd1); confirmSameCellText(a1, ra2); confirmSameCellText(b1, rb2); confirmSameCellText(c1, rc2); confirmSameCellText(d1, rd2); } private static void confirmSameCellText(HSSFCell a, HSSFCell b) { assertEquals(a.getRichStringCellValue().getString(), b.getRichStringCellValue().getString()); } private static String unicodeString(HSSFCell cell) { String ss = cell.getRichStringCellValue().getString(); char s[] = ss.toCharArray(); StringBuffer sb = new StringBuffer(); for (int x=0;x it = sheet.rowIterator(); it.hasNext(); rownum++) { Row row = it.next(); assertEquals(rownum, row.getRowNum()); int cellNum = 0; for (Iterator it2 = row.cellIterator(); it2.hasNext(); cellNum++) { Cell cell = it2.next(); assertEquals(cellNum, cell.getColumnIndex()); } } } /** * Test bug 38266: NPE when adding a row break * * User's diagnosis: * 1. Manually (i.e., not using POI) create an Excel Workbook, making sure it * contains a sheet that doesn't have any row breaks * 2. Using POI, create a new HSSFWorkbook from the template in step #1 * 3. Try adding a row break (via sheet.setRowBreak()) to the sheet mentioned in step #1 * 4. Get a NullPointerException */ @Test public void bug38266() { String[] files = {"Simple.xls", "SimpleMultiCell.xls", "duprich1.xls"}; for (int i = 0; i < files.length; i++) { HSSFWorkbook wb = openSample(files[i]); HSSFSheet sheet = wb.getSheetAt( 0 ); int[] breaks = sheet.getRowBreaks(); assertEquals(0, breaks.length); //add 3 row breaks for (int j = 1; j <= 3; j++) { sheet.setRowBreak(j*20); } } } @Test public void bug40738() { HSSFWorkbook wb = openSample("SimpleWithAutofilter.xls"); writeOutAndReadBack(wb); } /** * Bug 44200: Sheet not cloneable when Note added to excel cell */ @Test public void bug44200() { HSSFWorkbook wb = openSample("44200.xls"); wb.cloneSheet(0); writeOutAndReadBack(wb); } /** * Bug 44201: Sheet not cloneable when validation added to excel cell */ @Test public void bug44201() { HSSFWorkbook wb = openSample("44201.xls"); writeOutAndReadBack(wb); } /** * Bug 37684 : Unhandled Continue Record Error */ @Test public void bug37684 () { HSSFWorkbook wb = openSample("37684-1.xls"); writeOutAndReadBack(wb); wb = openSample("37684-2.xls"); writeOutAndReadBack(wb); } /** * Bug 41139: Constructing HSSFWorkbook is failed,threw threw ArrayIndexOutOfBoundsException for creating UnknownRecord */ @Test public void bug41139() { HSSFWorkbook wb = openSample("41139.xls"); writeOutAndReadBack(wb); } /** * Bug 41546: Constructing HSSFWorkbook is failed, * Unknown Ptg in Formula: 0x1a (26) */ @Test public void bug41546() { HSSFWorkbook wb = openSample("41546.xls"); assertEquals(1, wb.getNumberOfSheets()); wb = writeOutAndReadBack(wb); assertEquals(1, wb.getNumberOfSheets()); } /** * Bug 42564: Some files from Access were giving a RecordFormatException * when reading the BOFRecord */ @Test public void bug42564() { HSSFWorkbook wb = openSample("ex42564-21435.xls"); writeOutAndReadBack(wb); } /** * Bug 42564: Some files from Access also have issues * with the NameRecord, once you get past the BOFRecord * issue. */ @Test public void bug42564Alt() { HSSFWorkbook wb = openSample("ex42564-21503.xls"); writeOutAndReadBack(wb); } /** * Bug 42618: RecordFormatException reading a file containing * =CHOOSE(2,A2,A3,A4) */ @Test public void bug42618() { HSSFWorkbook wb = openSample("SimpleWithChoose.xls"); wb = writeOutAndReadBack(wb); // Check we detect the string properly too HSSFSheet s = wb.getSheetAt(0); // Textual value HSSFRow r1 = s.getRow(0); HSSFCell c1 = r1.getCell(1); assertEquals("=CHOOSE(2,A2,A3,A4)", c1.getRichStringCellValue().toString()); // Formula Value HSSFRow r2 = s.getRow(1); HSSFCell c2 = r2.getCell(1); assertEquals(25, (int)c2.getNumericCellValue()); try { assertEquals("CHOOSE(2,A2,A3,A4)", c2.getCellFormula()); } catch (IllegalStateException e) { if (e.getMessage().startsWith("Too few arguments") && e.getMessage().indexOf("ConcatPtg") > 0) { fail("identified bug 44306"); } } } /** * Something up with the FileSharingRecord */ @Test public void bug43251() { // Used to blow up with an IllegalArgumentException // when creating a FileSharingRecord try { HSSFWorkbook wb = openSample("43251.xls"); assertEquals(1, wb.getNumberOfSheets()); } catch (IllegalArgumentException e) { fail("identified bug 43251"); } } /** * Crystal reports generates files with short * StyleRecords, which is against the spec */ @Test public void bug44471() { // Used to blow up with an ArrayIndexOutOfBounds // when creating a StyleRecord HSSFWorkbook wb; //try { wb = openSample("OddStyleRecord.xls"); //} catch (ArrayIndexOutOfBoundsException e) { // throw new AssertionFailedError("Identified bug 44471"); //} assertEquals(1, wb.getNumberOfSheets()); } /** * Files with "read only recommended" were giving * grief on the FileSharingRecord */ @Test public void bug44536() { // Used to blow up with an IllegalArgumentException // when creating a FileSharingRecord HSSFWorkbook wb = openSample("ReadOnlyRecommended.xls"); // Check read only advised assertEquals(3, wb.getNumberOfSheets()); assertTrue(wb.isWriteProtected()); // But also check that another wb isn't wb = openSample("SimpleWithChoose.xls"); assertFalse(wb.isWriteProtected()); } /** * Some files were having problems with the DVRecord, * probably due to dropdowns */ @Test public void bug44593() { // Used to blow up with an IllegalArgumentException // when creating a DVRecord // Now won't, but no idea if this means we have // rubbish in the DVRecord or not... HSSFWorkbook wb; //try { wb = openSample("44593.xls"); //} catch (IllegalArgumentException e) { // throw new AssertionFailedError("Identified bug 44593"); //} assertEquals(2, wb.getNumberOfSheets()); } /** * Used to give problems due to trying to read a zero * length string, but that's now properly handled */ @Test public void bug44643() { // Used to blow up with an IllegalArgumentException HSSFWorkbook wb; //try { wb = openSample("44643.xls"); //} catch (IllegalArgumentException e) { // throw new AssertionFailedError("identified bug 44643"); //} assertEquals(1, wb.getNumberOfSheets()); } /** * User reported the wrong number of rows from the * iterator, but we can't replicate that */ @Test public void bug44693() { HSSFWorkbook wb = openSample("44693.xls"); HSSFSheet s = wb.getSheetAt(0); // Rows are 1 to 713 assertEquals(0, s.getFirstRowNum()); assertEquals(712, s.getLastRowNum()); assertEquals(713, s.getPhysicalNumberOfRows()); // Now check the iterator int rowsSeen = 0; for(Iterator i = s.rowIterator(); i.hasNext(); ) { Row r = i.next(); assertNotNull(r); rowsSeen++; } assertEquals(713, rowsSeen); } /** * Bug 28774: Excel will crash when opening xls-files with images. */ @Test public void bug28774() { HSSFWorkbook wb = openSample("28774.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } /** * Had a problem apparently, not sure what as it * works just fine... */ @Test public void bug44891() { HSSFWorkbook wb = openSample("44891.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } /** * Bug 44235: Ms Excel can't open save as excel file * * Works fine with poi-3.1-beta1. */ @Test public void bug44235() { HSSFWorkbook wb = openSample("44235.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } @Test public void bug36947() { HSSFWorkbook wb = openSample("36947.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } @Test public void bug39634() { HSSFWorkbook wb = openSample("39634.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } /** * Problems with extracting check boxes from * HSSFObjectData * @throws Exception */ @Test public void bug44840() { HSSFWorkbook wb = openSample("WithCheckBoxes.xls"); // Take a look at the embedded objects List objects = wb.getAllEmbeddedObjects(); assertEquals(1, objects.size()); HSSFObjectData obj = (HSSFObjectData)objects.get(0); assertNotNull(obj); // Peek inside the underlying record EmbeddedObjectRefSubRecord rec = obj.findObjectRecord(); assertNotNull(rec); // assertEquals(32, rec.field_1_stream_id_offset); assertEquals(0, rec.getStreamId().intValue()); // WRONG! assertEquals("Forms.CheckBox.1", rec.getOLEClassName()); assertEquals(12, rec.getObjectData().length); // Doesn't have a directory assertFalse(obj.hasDirectoryEntry()); assertNotNull(obj.getObjectData()); assertEquals(12, obj.getObjectData().length); assertEquals("Forms.CheckBox.1", obj.getOLE2ClassName()); try { obj.getDirectory(); fail(); } catch(FileNotFoundException e) { // expected during successful test } catch (IOException e) { throw new RuntimeException(e); } } /** * Test that we can delete sheets without * breaking the build in named ranges * used for printing stuff. */ @Test public void bug30978() { HSSFWorkbook wb = openSample("30978-alt.xls"); assertEquals(1, wb.getNumberOfNames()); assertEquals(3, wb.getNumberOfSheets()); // Check all names fit within range, and use // DeletedArea3DPtg InternalWorkbook w = wb.getWorkbook(); for(int i=0; i