/* ==================================================================== 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 java.io.File; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.util.Iterator; import java.util.List; import junit.framework.AssertionFailedError; import junit.framework.TestCase; import org.apache.poi.hssf.HSSFTestDataSamples; import org.apache.poi.hssf.model.Workbook; 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.aggregates.FormulaRecordAggregate; import org.apache.poi.hssf.record.formula.DeletedArea3DPtg; import org.apache.poi.hssf.record.formula.Ptg; import org.apache.poi.hssf.util.CellRangeAddress; import org.apache.poi.util.TempFile; /** * Testcases for bugs entered in bugzilla * the Test name contains the bugzilla bug id * @author Avik Sengupta * @author Yegor Kozlov */ public final class TestBugs extends TestCase { private static HSSFWorkbook openSample(String sampleFileName) { return HSSFTestDataSamples.openSampleWorkbook(sampleFileName); } private static HSSFWorkbook writeOutAndReadBack(HSSFWorkbook original) { return HSSFTestDataSamples.writeOutAndReadBack(original); } private static void writeTestOutputFileForViewing(HSSFWorkbook wb, String simpleFileName) { if (true) { // set to false to output test files return; } 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*/ public void test15228() { 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"); } public void test13796() { 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 writing a hyperlink * Open resulting sheet in Excel and check that A1 contains a hyperlink*/ public void test23094() { HSSFWorkbook wb = new HSSFWorkbook(); HSSFSheet s = wb.createSheet(); HSSFRow r = s.createRow(0); r.createCell(0).setCellFormula("HYPERLINK( \"http://jakarta.apache.org\", \"Jakarta\" )"); writeTestOutputFileForViewing(wb, "test23094"); } /** test hyperlinks * open resulting file in excel, and check that there is a link to Google */ public void test15353() { 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 **/ public void test14460() { HSSFWorkbook wb = openSample("14460.xls"); wb.getSheetAt(0); } public void test14330() { 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!*/ public void test15375() { 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!*/ public void test15375_2() throws Exception{ HSSFWorkbook wb = new HSSFWorkbook(); HSSFSheet sheet = wb.createSheet(); String tmp1 = null; String tmp2 = null; String tmp3 = null; for (int i = 0; i < 6000; i++) { tmp1 = "Test1" + i; tmp2 = "Test2" + i; tmp3 = "Test3" + i; HSSFRow row = sheet.createRow(i); HSSFCell cell = row.createCell(0); setCellText(cell, tmp1); cell = row.createCell(1); setCellText(cell, tmp2); cell = row.createCell(2); setCellText(cell, tmp3); } writeTestOutputFileForViewing(wb, "test15375-2"); } /** another test for the number of unique strings issue *test opening the resulting file in Excel*/ public void test22568() { int r=2000;int c=3; HSSFWorkbook wb = new HSSFWorkbook() ; HSSFSheet sheet = wb.createSheet("ExcelTest") ; int col_cnt=0, rw_cnt=0 ; col_cnt = c; rw_cnt = r; HSSFRow rw ; rw = sheet.createRow(0) ; //Header row for(int j=0; j=0; i--) { clone.removeMergedRegion(i); } assertEquals("Original Sheet's Merged Regions were removed", originalMerged, template.getNumMergedRegions()); // check if template's merged regions are OK if (template.getNumMergedRegions()>0) { // fetch the first merged region...EXCEPTION OCCURS HERE template.getMergedRegion(0); } //make sure we dont exception } /**Tests read and write of Unicode strings in formula results * bug and testcase submitted by Sompop Kumnoonsate * The file contains THAI unicode characters. */ public void testUnicodeStringFormulaRead() { 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 0) { throw new AssertionFailedError("identified bug 44306"); } } } /** * Something up with the FileSharingRecord */ public void test43251() { // Used to blow up with an IllegalArgumentException // when creating a FileSharingRecord HSSFWorkbook wb; try { wb = openSample("43251.xls"); } catch (IllegalArgumentException e) { throw new AssertionFailedError("identified bug 43251"); } assertEquals(1, wb.getNumberOfSheets()); } /** * Crystal reports generates files with short * StyleRecords, which is against the spec */ public void test44471() { // 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 */ public void test44536() { // 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 */ public void test44593() { // 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 */ public void test44643() { // 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 */ public void test44693() { 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(); ) { HSSFRow r = (HSSFRow)i.next(); assertNotNull(r); rowsSeen++; } assertEquals(713, rowsSeen); } /** * Bug 28774: Excel will crash when opening xls-files with images. */ public void test28774() { 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... */ public void test44891() { 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. */ public void test44235() { HSSFWorkbook wb = openSample("44235.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } /** * Bug 21334: "File error: data may have been lost" with a file * that contains macros and this formula: * {=SUM(IF(FREQUENCY(IF(LEN(V4:V220)>0,MATCH(V4:V220,V4:V220,0),""),IF(LEN(V4:V220)>0,MATCH(V4:V220,V4:V220,0),""))>0,1))} */ public void test21334() { HSSFWorkbook wb = new HSSFWorkbook(); HSSFSheet sh = wb.createSheet(); HSSFCell cell = sh.createRow(0).createCell(0); String formula = "SUM(IF(FREQUENCY(IF(LEN(V4:V220)>0,MATCH(V4:V220,V4:V220,0),\"\"),IF(LEN(V4:V220)>0,MATCH(V4:V220,V4:V220,0),\"\"))>0,1))"; cell.setCellFormula(formula); HSSFWorkbook wb_sv = writeOutAndReadBack(wb); HSSFCell cell_sv = wb_sv.getSheetAt(0).getRow(0).getCell(0); assertEquals(formula, cell_sv.getCellFormula()); } public void test36947() { HSSFWorkbook wb = openSample("36947.xls"); assertTrue("no errors reading sample xls", true); writeOutAndReadBack(wb); assertTrue("no errors writing sample xls", true); } /** * Bug 42448: Can't parse SUMPRODUCT(A!C7:A!C67, B8:B68) / B69 */ public void test42448(){ HSSFWorkbook wb = new HSSFWorkbook(); HSSFCell cell = wb.createSheet().createRow(0).createCell(0); cell.setCellFormula("SUMPRODUCT(A!C7:A!C67, B8:B68) / B69"); assertTrue("no errors parsing formula", true); } public void test39634() { 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 */ public void test44840() { HSSFWorkbook wb = openSample("WithCheckBoxes.xls"); // Take a look at the embeded 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.field_6_stream_id); // WRONG! assertEquals("Forms.CheckBox.1", rec.field_5_ole_classname); assertEquals(12, rec.remainingBytes.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) { // expectd 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. */ public void test30978() { HSSFWorkbook wb = openSample("30978-alt.xls"); assertEquals(1, wb.getNumberOfNames()); assertEquals(3, wb.getNumberOfSheets()); // Check all names fit within range, and use // DeletedArea3DPtg Workbook w = wb.getWorkbook(); for(int i=0; i