From 0fc1e4c93319cb2615ee0d33eab97ddbf2819f13 Mon Sep 17 00:00:00 2001
From: wp_xxyyzz <wp_xxyyzz@8e941d3f-bd1b-0410-a28a-d453659cc2b4>
Date: Tue, 8 Mar 2016 13:38:04 +0000
Subject: [PATCH] fpspreadsheet: Add tests for Excel being able to read files
 containing commens, images, header/footer images, and hyperlinks.

git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@4533 8e941d3f-bd1b-0410-a28a-d453659cc2b4
---
 components/fpspreadsheet/tests/exceltests.pas | 391 ++++++++++++++++++
 .../fpspreadsheet/tests/lazarus32x32.png      | Bin 0 -> 2088 bytes
 .../fpspreadsheet/tests/spreadtestgui.lpi     |   6 +-
 .../fpspreadsheet/tests/spreadtestgui.lpr     |   2 +-
 4 files changed, 397 insertions(+), 2 deletions(-)
 create mode 100644 components/fpspreadsheet/tests/exceltests.pas
 create mode 100644 components/fpspreadsheet/tests/lazarus32x32.png

diff --git a/components/fpspreadsheet/tests/exceltests.pas b/components/fpspreadsheet/tests/exceltests.pas
new file mode 100644
index 000000000..4d51c2f06
--- /dev/null
+++ b/components/fpspreadsheet/tests/exceltests.pas
@@ -0,0 +1,391 @@
+unit exceltests;
+
+{$mode objfpc}{$H+}
+
+interface
+
+{ Tests which require Excel.
+  Will be skipped if Excel is not available.
+}
+
+uses
+  // Not using Lazarus package as the user may be working with multiple versions
+  // Instead, add .. to unit search path
+  Classes, SysUtils, fpcunit, testregistry,
+  fpstypes, fpspreadsheet, xlsbiff2, xlsbiff5, xlsbiff8 {and a project requirement for lclbase for utf8 handling},
+  testsutility;
+
+type
+  { TSpreadExcelTests }
+  // Write "something" to Excel file and open it in Excel
+  TSpreadExcelTests = class(TTestCase)
+  private
+    FExcelApp: OleVariant;
+    FExcelAvail: Boolean;
+
+  protected
+    // Set up expected values:
+    procedure SetUp; override;
+    procedure TearDown; override;
+
+    // Comments in several sheets (index of sheets specified)
+    procedure Test_Comments(const ASheets: array of Integer; AFormat: TsSpreadsheetFormat);
+    // Header/footer images in several sheets
+    procedure Test_HeaderFooterImages(const ASheets: array of Integer;
+      AddToFooter: Boolean; AFormat: TsSpreadsheetFormat);
+    // Images in several sheets
+    procedure Test_Images(const ASheets: array of Integer;
+      AFormat: TsSpreadsheetFormat);
+    // Comments, images, header/footer images, and hyperlinks
+    procedure Test_All(const ASheets: array of Integer;
+      AFormat: TsSpreadsheetFormat);
+
+  published
+    // OOXML test cases
+    procedure Test_Comments0_OOXML;
+    procedure Test_Comments01_OOXML;
+    procedure Test_Comments02_OOXML;
+    procedure Test_HeaderImages0_OOXML;
+    procedure Test_HeaderImages01_OOXML;
+    procedure Test_HeaderImages12_OOXML;
+    procedure Test_FooterImages0_OOXML;
+    procedure Test_FooterImages01_OOXML;
+    procedure Test_FooterImages12_OOXML;
+    procedure Test_Images0_OOXML;
+    procedure Test_Images01_OOXML;
+    procedure Test_Images12_OOXML;
+
+    procedure Test_All0_OOXML;
+    procedure Test_All01_OOXML;
+    procedure Test_All12_OOXML;
+
+  end;
+
+implementation
+
+uses
+  TypInfo, comobj;
+
+const
+  SheetName = 'Excel-Test';
+
+
+{ TSpreadExcelTexts }
+
+procedure TSpreadExcelTests.SetUp;
+begin
+  inherited SetUp;
+  try
+    FExcelApp := CreateOleObject('Excel.Application');  // creates an Excel Object
+    FExcelApp.Visible := False;         // hides Excel window
+    FExcelApp.ScreenUpdating := False;  // turns off screen updating of Excel
+    FExcelApp.DisplayAlerts := False;   // no excel warnings and error messages
+    FExcelAvail := true;
+  except
+    FExcelAvail := false;
+  end;
+end;
+
+procedure TSpreadExcelTests.TearDown;
+begin
+  FExcelApp.Quit;
+  FExcelApp := UnAssigned;
+  inherited TearDown;
+end;
+
+procedure TSpreadExcelTests.Test_Comments(
+  const ASheets: array of Integer; AFormat: TsSpreadsheetFormat);
+var
+  MyWorksheet: TsWorksheet;
+  MyWorkbook: TsWorkbook;
+  TempFile: string; //write xls/xml to this file and read back from it
+  varFile: variant; // filename as variant for Excel
+  i, j: Integer;
+  book: OleVariant;
+begin
+  if not FExcelAvail then
+  begin
+    exit;
+  end;
+
+  TempFile := NewTempFile;
+
+  MyWorkbook := TsWorkbook.Create;
+  try
+    MyWorkbook.Options := MyWorkbook.Options + [boCalcBeforeSaving];
+
+    for i:=0 to ASheets[High(ASheets)] do
+    begin
+      MyWorkSheet:= MyWorkBook.AddWorksheet(SheetName + IntToStr(i+1));
+      for j:=0 to High(ASheets) do
+        if ASheets[j] = i then
+        begin
+          MyWorksheet.WriteText(0, 0, 'This is a text');
+          MyWorksheet.WriteComment(0, 0, 'This is a comment');
+        end;
+    end;
+
+    MyWorkBook.WriteToFile(TempFile, AFormat, true);
+  finally
+    MyWorkbook.Free;
+  end;
+
+  // Open the spreadsheet in Excel
+
+  try
+    varFile := TempFile;
+    book := FExcelApp.Workbooks.Open(varFile);
+    book.Close;
+  except
+    Fail('Excel fails to open the file.');
+  end;
+
+  DeleteFile(TempFile);
+end;
+
+procedure TSpreadExcelTests.Test_HeaderFooterImages(
+  const ASheets: array of Integer; AddToFooter: Boolean;
+  AFormat: TsSpreadsheetFormat);
+var
+  MyWorksheet: TsWorksheet;
+  MyWorkbook: TsWorkbook;
+  TempFile: string; // write xls/xml to this file and read back from it
+  varFile: variant; // filename as variants for Excel
+  i, j: Integer;
+  book: OleVariant;
+begin
+  if not FExcelAvail then
+  begin
+    exit;
+  end;
+
+  TempFile := NewTempFile;
+
+  MyWorkbook := TsWorkbook.Create;
+  try
+    MyWorkbook.Options := MyWorkbook.Options + [boCalcBeforeSaving];
+
+    for i:=0 to ASheets[High(ASheets)] do
+    begin
+      MyWorkSheet:= MyWorkBook.AddWorksheet(SheetName + IntToStr(i+1));
+      for j:=0 to High(ASheets) do
+        if ASheets[j] = i then
+        begin
+          MyWorksheet.WriteText(0, 0, 'This is a text');
+          if AddToFooter then
+            MyWorksheet.PageLayout.AddFooterImage(1, hfsCenter, 'lazarus32x32.png')
+          else
+            MyWorksheet.PageLayout.AddHeaderImage(1, hfsCenter, 'lazarus32x32.png');
+        end;
+    end;
+
+    MyWorkBook.WriteToFile(TempFile, AFormat, true);
+  finally
+    MyWorkbook.Free;
+  end;
+
+  // Open the spreadsheet in Excel
+
+  try
+    varFile := TempFile;
+    book := FExcelApp.Workbooks.Open(varFile);
+    book.Close;
+  except
+    Fail(Format('Excel fails to open file "%s".', [TempFile]));
+  end;
+
+  DeleteFile(TempFile);
+end;
+
+procedure TSpreadExcelTests.Test_Images(const ASheets: array of Integer;
+  AFormat: TsSpreadsheetFormat);
+var
+  MyWorksheet: TsWorksheet;
+  MyWorkbook: TsWorkbook;
+  TempFile: string; // write xls/xml to this file and read back from it
+  varFile: variant; // filename as variants for Excel
+  i, j: Integer;
+  book: OleVariant;
+begin
+  if not FExcelAvail then
+  begin
+    exit;
+  end;
+
+  TempFile := NewTempFile;
+
+  MyWorkbook := TsWorkbook.Create;
+  try
+    MyWorkbook.Options := MyWorkbook.Options + [boCalcBeforeSaving];
+
+    for i:=0 to ASheets[High(ASheets)] do
+    begin
+      MyWorkSheet:= MyWorkBook.AddWorksheet(SheetName + IntToStr(i+1));
+      for j:=0 to High(ASheets) do
+        if ASheets[j] = i then
+        begin
+          MyWorksheet.WriteText(0, 0, 'This is a text');
+          MyWorksheet.WriteImage(0, 1, 'lazarus32x32.png')
+        end;
+    end;
+
+    MyWorkBook.WriteToFile(TempFile, AFormat, true);
+  finally
+    MyWorkbook.Free;
+  end;
+
+  // Open the spreadsheet in Excel
+
+  try
+    varFile := TempFile;
+    book := FExcelApp.Workbooks.Open(varFile);
+    book.Close;
+  except
+    Fail(Format('Excel fails to open file "%s".', [TempFile]));
+  end;
+
+  DeleteFile(TempFile);
+end;
+
+procedure TSpreadExcelTests.Test_All(const ASheets: array of Integer;
+  AFormat: TsSpreadsheetFormat);
+var
+  MyWorksheet: TsWorksheet;
+  MyWorkbook: TsWorkbook;
+  TempFile: string; // write xls/xml to this file and read back from it
+  varFile: variant; // filename as variants for Excel
+  i, j: Integer;
+  book: OleVariant;
+begin
+  if not FExcelAvail then
+  begin
+    exit;
+  end;
+
+  TempFile := NewTempFile;
+
+  MyWorkbook := TsWorkbook.Create;
+  try
+    MyWorkbook.Options := MyWorkbook.Options + [boCalcBeforeSaving];
+
+    for i:=0 to ASheets[High(ASheets)] do
+    begin
+      MyWorkSheet:= MyWorkBook.AddWorksheet(SheetName + IntToStr(i+1));
+      for j:=0 to High(ASheets) do
+        if ASheets[j] = i then
+        begin
+          MyWorksheet.WriteText(0, 0, 'This is a text');
+          MyWorksheet.WriteComment(0, 0, 'This is a comment');
+          MyWorksheet.WriteHyperlink(0, 0, 'http://www.lazarus-ide.org/');
+          MyWorksheet.WriteImage(0, 1, 'lazarus32x32.png');
+          MyWorksheet.PageLayout.AddFooterImage(1, hfsCenter, 'lazarus32x32.png');
+          MyWorksheet.PageLayout.AddHeaderImage(1, hfsCenter, 'lazarus32x32.png');
+        end;
+    end;
+
+    MyWorkBook.WriteToFile(TempFile, AFormat, true);
+  finally
+    MyWorkbook.Free;
+  end;
+
+  // Open the spreadsheet in Excel
+
+  try
+    varFile := TempFile;
+    book := FExcelApp.Workbooks.Open(varFile);
+    book.Close;
+  except
+    Fail(Format('Excel fails to open file "%s".', [TempFile]));
+  end;
+
+  DeleteFile(TempFile);
+end;
+
+
+{ OOXML }
+
+procedure TSpreadExcelTests.Test_Comments0_OOXML;
+begin
+  Test_Comments([0], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_Comments01_OOXML;
+begin
+  Test_Comments([0,1], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_Comments02_OOXML;
+begin
+  Test_Comments([0,2], sfOOXML);
+end;
+
+
+procedure TSpreadExcelTests.Test_HeaderImages0_OOXML;
+begin
+  Test_HeaderFooterImages([0], false, sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_HeaderImages01_OOXML;
+begin
+  Test_HeaderFooterImages([0,1], false, sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_HeaderImages12_OOXML;
+begin
+  Test_HeaderFooterImages([1,2], false, sfOOXML);
+end;
+
+
+procedure TSpreadExcelTests.Test_FooterImages0_OOXML;
+begin
+  Test_HeaderFooterImages([0], true, sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_FooterImages01_OOXML;
+begin
+  Test_HeaderFooterImages([0,1], true, sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_FooterImages12_OOXML;
+begin
+  Test_HeaderFooterImages([1,2], true, sfOOXML);
+end;
+
+
+procedure TSpreadExcelTests.Test_Images0_OOXML;
+begin
+  Test_Images([0], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_Images01_OOXML;
+begin
+  Test_Images([0,1], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_Images12_OOXML;
+begin
+  Test_Images([1,2], sfOOXML);
+end;
+
+
+procedure TSpreadExcelTests.Test_All0_OOXML;
+begin
+  Test_All([0], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_All01_OOXML;
+begin
+  Test_All([0,1], sfOOXML);
+end;
+
+procedure TSpreadExcelTests.Test_All12_OOXML;
+begin
+  Test_All([1,2], sfOOXML);
+end;
+
+
+initialization
+  RegisterTest(TSpreadExcelTests);
+
+end.
+
diff --git a/components/fpspreadsheet/tests/lazarus32x32.png b/components/fpspreadsheet/tests/lazarus32x32.png
new file mode 100644
index 0000000000000000000000000000000000000000..51cb13e68843b52f7848521a826586261b56ef7b
GIT binary patch
literal 2088
zcmV+@2-o+CP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800001b5ch_0Itp)
z=>Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2iyh}
z4<8S&su!*R00*c^L_t(o!?l-xj1|=t$3OSZ%zJO&{(g(>E-eTaN-L$iNTHN~NJ}dz
zi$yFe{Q<ODEkbQkphQ|ojG=-Q+So|hiZoiQ=!8HUAu%ZhDODmrWceYY1O>Ot!tVOk
z{rTRTnR{>lnB8?@mo(5i$t07>J@<Ui_niAZ=L&A{DY#?VtVv}fcJ}_aYya^qYBr~@
zXCM29yq7O3np8Go=TpD@A&xE4#&EHrMFFW@EE+`3=6XKOr(#L9IsM_srY@;W-ABsQ
zC6&39ROaZrmrcczYV+wc0A$6Yw57oq5CVjRcs%R6_p$q-R{*8dY`%D{=zmc)({D*R
zju#jVAOK53cEq}F0OBg=vSLb^x~i~ZfUKBO)(Nm`(QGB`LM!D%s-ul)RvalT5RjJz
z$4(wMJNFzByPkYNTsH$1Q_9ruR#fWZ!hD(XH1$m%8z2p^ylR#zD#){v9gY>G6b7ij
z_#yF}d=djnkV4Sh2IXJ6RW!G!J*YOj_8*tjY&N|D4E@z?4*D=qv839pUN|EdJz|iZ
z$_P5sh7J#WW$*$+dm4g3p^QQ4kowwl?{K;PJYShO9i-?=g<wFgprf-zKk@WV*<aMX
z+38^*+0uUEmd_6OvhoEP59%&Aa`MzE8XJ=|H#akC%p^(&4?`(~HU?wB^8<>ChY|!D
zAq7H!(SpWSftM0;^@H<?Ihu$g$#NVbw%}qzg8@u82)m1#$e`lFVj*nO3Oaqogi$4Z
zkgr_-XC{9AZhQsCDB?N!Xk+k{LTC`e;_%*WtX+A3AKR0)iW~t$N(P3G$32i89Ioz=
zT{-d6X}@^S!IRqaG|EVheh{$ZU$p=jV=%_>LiJ;Kfk7!n5NP7L1F-CDf<O}l8l@C#
zSKi;V9^h|pTxP?ccH;$xj1SG7uynzlOrKcZenkpGN~+CGiF`^+Z^jFtAW_2h19b@T
zNkOY1Kq-SVVJhrs7G9u`LZDPCEUd2e?rU{q<>YbOgm2N7hL%oEeq2y8ps@c_&<)~=
z<qPlv2cs0(xrOXH(vGJzv%i{0DxF4H5wtcKqcJ)ZAuS|+COpC0_9qdR#8Z-s$)Kxd
zBqa%pVk^yxjW3Ztf1u%-N~n~=7#m~2XoJ=Utu+809j(N35-4Q|ltCL!OGiLco1&#N
z1aRnF2T|K07PW{u7SX66kt2xFNY$^Np{V1uPDJ&pYXT4=JZ74(+PhzXXe=A83_)P%
z^nDJ!+e*gMIJQkRVs`~#P?km;i8f&kl@|D{-uNs-GN;aBv%q!Tg8;IBeRSwn57YH^
zsrFo$Gbe^J;3=Os-)W_(HG>yuln!5j=1b>#K<lm@ymSjPc_sj6bUW`0pnOp&K+3<8
z7-bAUyLT*q*m1hY=z~ic+S38O)n5V&HlF19)l;vW9pZxO7k85v@ea7IdzPzgx}A@x
zm{N9e{jwkQG?-8-1@6|z0VpggMgXZyh7-r$z<90LQq$S=9)79`AtkX`4gjh4j}QVR
zf{fpz#)tat1p}u&GH3j#q3)(t^GT~HmNKES2-WSSE$evru`NhT&{SW`(z&<wO`C)}
z=KYp0PMA%_Pq(n?!O=YWawAeeMup+DW-O<#S@|Ms{HUSsvumozipH=7*is-wsO>_A
z#$TH{3n3+eQ_Rq^Z}jn>C>_bjad+X^l3PYi2EdXM%eJwFVA*|@6bzrdw5#3s0#LJA
z0Yof;CBc?qZ;x0YEDLl<UrVRYdvzWSZBVgzD_@xS-JVSbkGh?ER_r7ijSz7xY%8n`
z+Y(q(AT2>-N1TTj%%oyUneMj+S~}81BsdmC9EjM^mV);iLjbQIJct))BDPIdEW)?%
zdy>&p=TSPmoVy=-p4{Agq7fU%vN-mSrvY#r8^@B^wnPfZ$sfr4yC&=2W1HPIblePF
zc<$F#IF5xKXp{<22Bc-NYU^><RF(1QwpyZ*7?u(Qfnmz*Wu#Lr#G_G!5ZHFe;y(8`
ztlWAcbnZy9V~`!Qun-I>Et36CM4$QQ@`Yn=9bWzO?@#0RFYf7CuyF33WaLe}Rda^K
zpwHv`0YR5KDy=|BWS9O+DX@e=`JLqDC2%5=?5HFWw<ydJloY^2k3U1CZePug?JtkH
zLJ8~szTuCK|KsSo_xEooi0UR=ntuXsKfbnRX3?<naf|2A;ar1-lmc5Dl-3yaNif2a
z<i;$96$^yY_?aeRu?Si51OP=jhVvILgtSYuzW<pJsI06MuIpYgT92JRe|+i4iEsX7
z-dz5jjD(#~nNVgi2m~ehkZU(lz3tULCuG5QZbxaKzr1pgc>Uh}z%<u&gMI;A>xqq9
zICk2^F-PWo??<$!z}KdyKMYP7&YV8VYlq(^UcdJ=upW5Db=~AWbM76J88r1RfO!4h
zSAp5C>!z;Bz<;}tJhHfoWIK3Dp*0vFPd2jYh26yK_pSq0cSm;>voS!quIv9#7n1?G
z;o#{h8?6ml4y<`<H&)%g1MYTr<+bcw*G>OlZbq%GNd^|?0imi&5e5{M=C3z$!@4d2
zyY?S1K7aQ3b3;dzP4E3beg1V7kFxzn0Eings;sOW3CsXK2V4S9x~_Xe4EzT-%X~b_
SVOmN60000<MNUMnLSTYq>)oyZ

literal 0
HcmV?d00001

diff --git a/components/fpspreadsheet/tests/spreadtestgui.lpi b/components/fpspreadsheet/tests/spreadtestgui.lpi
index 96a83295e..64a77e915 100644
--- a/components/fpspreadsheet/tests/spreadtestgui.lpi
+++ b/components/fpspreadsheet/tests/spreadtestgui.lpi
@@ -40,7 +40,7 @@
         <PackageName Value="FCL"/>
       </Item4>
     </RequiredPackages>
-    <Units Count="25">
+    <Units Count="26">
       <Unit0>
         <Filename Value="spreadtestgui.lpr"/>
         <IsPartOfProject Value="True"/>
@@ -142,6 +142,10 @@
         <Filename Value="pagelayouttests.pas"/>
         <IsPartOfProject Value="True"/>
       </Unit24>
+      <Unit25>
+        <Filename Value="exceltests.pas"/>
+        <IsPartOfProject Value="True"/>
+      </Unit25>
     </Units>
   </ProjectOptions>
   <CompilerOptions>
diff --git a/components/fpspreadsheet/tests/spreadtestgui.lpr b/components/fpspreadsheet/tests/spreadtestgui.lpr
index 0d6c7d347..ecdce40d0 100644
--- a/components/fpspreadsheet/tests/spreadtestgui.lpr
+++ b/components/fpspreadsheet/tests/spreadtestgui.lpr
@@ -10,7 +10,7 @@ uses
  {$ENDIF}
   Interfaces, Forms, GuiTestRunner, datetests, stringtests, numberstests,
   manualtests, testsutility, internaltests, formattests, colortests, fonttests,
-  optiontests, numformatparsertests, formulatests, rpnFormulaUnit,
+  optiontests, numformatparsertests, formulatests, rpnFormulaUnit, exceltests,
   emptycelltests, errortests, virtualmodetests, insertdeletetests,
   celltypetests, sortingtests, copytests, enumeratortests, commenttests,
   hyperlinktests, pagelayouttests;