excelize_test.go 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323
  1. package excelize
  2. import (
  3. "bytes"
  4. "compress/gzip"
  5. "encoding/xml"
  6. "fmt"
  7. "image/color"
  8. _ "image/gif"
  9. _ "image/jpeg"
  10. _ "image/png"
  11. "io/ioutil"
  12. "math"
  13. "os"
  14. "path/filepath"
  15. "strconv"
  16. "strings"
  17. "testing"
  18. "time"
  19. "github.com/stretchr/testify/assert"
  20. )
  21. func TestOpenFile(t *testing.T) {
  22. // Test update a XLSX file.
  23. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  24. assert.NoError(t, err)
  25. // Test get all the rows in a not exists worksheet.
  26. _, err = f.GetRows("Sheet4")
  27. assert.EqualError(t, err, "sheet Sheet4 is not exist")
  28. // Test get all the rows in a worksheet.
  29. rows, err := f.GetRows("Sheet2")
  30. assert.NoError(t, err)
  31. for _, row := range rows {
  32. for _, cell := range row {
  33. t.Log(cell, "\t")
  34. }
  35. t.Log("\r\n")
  36. }
  37. assert.NoError(t, f.UpdateLinkedValue())
  38. assert.NoError(t, f.SetCellDefault("Sheet2", "A1", strconv.FormatFloat(float64(100.1588), 'f', -1, 32)))
  39. assert.NoError(t, f.SetCellDefault("Sheet2", "A1", strconv.FormatFloat(float64(-100.1588), 'f', -1, 64)))
  40. // Test set cell value with illegal row number.
  41. assert.EqualError(t, f.SetCellDefault("Sheet2", "A", strconv.FormatFloat(float64(-100.1588), 'f', -1, 64)),
  42. `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  43. assert.NoError(t, f.SetCellInt("Sheet2", "A1", 100))
  44. // Test set cell integer value with illegal row number.
  45. assert.EqualError(t, f.SetCellInt("Sheet2", "A", 100), `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  46. assert.NoError(t, f.SetCellStr("Sheet2", "C11", "Knowns"))
  47. // Test max characters in a cell.
  48. assert.NoError(t, f.SetCellStr("Sheet2", "D11", strings.Repeat("c", 32769)))
  49. f.NewSheet(":\\/?*[]Maximum 31 characters allowed in sheet title.")
  50. // Test set worksheet name with illegal name.
  51. f.SetSheetName("Maximum 31 characters allowed i", "[Rename]:\\/?* Maximum 31 characters allowed in sheet title.")
  52. assert.EqualError(t, f.SetCellInt("Sheet3", "A23", 10), "sheet Sheet3 is not exist")
  53. assert.EqualError(t, f.SetCellStr("Sheet3", "b230", "10"), "sheet Sheet3 is not exist")
  54. assert.EqualError(t, f.SetCellStr("Sheet10", "b230", "10"), "sheet Sheet10 is not exist")
  55. // Test set cell string value with illegal row number.
  56. assert.EqualError(t, f.SetCellStr("Sheet1", "A", "10"), `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  57. f.SetActiveSheet(2)
  58. // Test get cell formula with given rows number.
  59. _, err = f.GetCellFormula("Sheet1", "B19")
  60. assert.NoError(t, err)
  61. // Test get cell formula with illegal worksheet name.
  62. _, err = f.GetCellFormula("Sheet2", "B20")
  63. assert.NoError(t, err)
  64. _, err = f.GetCellFormula("Sheet1", "B20")
  65. assert.NoError(t, err)
  66. // Test get cell formula with illegal rows number.
  67. _, err = f.GetCellFormula("Sheet1", "B")
  68. assert.EqualError(t, err, `cannot convert cell "B" to coordinates: invalid cell name "B"`)
  69. // Test get shared cell formula
  70. _, err = f.GetCellFormula("Sheet2", "H11")
  71. assert.NoError(t, err)
  72. _, err = f.GetCellFormula("Sheet2", "I11")
  73. assert.NoError(t, err)
  74. getSharedForumula(&xlsxWorksheet{}, "")
  75. // Test read cell value with given illegal rows number.
  76. _, err = f.GetCellValue("Sheet2", "a-1")
  77. assert.EqualError(t, err, `cannot convert cell "A-1" to coordinates: invalid cell name "A-1"`)
  78. _, err = f.GetCellValue("Sheet2", "A")
  79. assert.EqualError(t, err, `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  80. // Test read cell value with given lowercase column number.
  81. _, err = f.GetCellValue("Sheet2", "a5")
  82. assert.NoError(t, err)
  83. _, err = f.GetCellValue("Sheet2", "C11")
  84. assert.NoError(t, err)
  85. _, err = f.GetCellValue("Sheet2", "D11")
  86. assert.NoError(t, err)
  87. _, err = f.GetCellValue("Sheet2", "D12")
  88. assert.NoError(t, err)
  89. // Test SetCellValue function.
  90. assert.NoError(t, f.SetCellValue("Sheet2", "F1", " Hello"))
  91. assert.NoError(t, f.SetCellValue("Sheet2", "G1", []byte("World")))
  92. assert.NoError(t, f.SetCellValue("Sheet2", "F2", 42))
  93. assert.NoError(t, f.SetCellValue("Sheet2", "F3", int8(1<<8/2-1)))
  94. assert.NoError(t, f.SetCellValue("Sheet2", "F4", int16(1<<16/2-1)))
  95. assert.NoError(t, f.SetCellValue("Sheet2", "F5", int32(1<<32/2-1)))
  96. assert.NoError(t, f.SetCellValue("Sheet2", "F6", int64(1<<32/2-1)))
  97. assert.NoError(t, f.SetCellValue("Sheet2", "F7", float32(42.65418)))
  98. assert.NoError(t, f.SetCellValue("Sheet2", "F8", float64(-42.65418)))
  99. assert.NoError(t, f.SetCellValue("Sheet2", "F9", float32(42)))
  100. assert.NoError(t, f.SetCellValue("Sheet2", "F10", float64(42)))
  101. assert.NoError(t, f.SetCellValue("Sheet2", "F11", uint(1<<32-1)))
  102. assert.NoError(t, f.SetCellValue("Sheet2", "F12", uint8(1<<8-1)))
  103. assert.NoError(t, f.SetCellValue("Sheet2", "F13", uint16(1<<16-1)))
  104. assert.NoError(t, f.SetCellValue("Sheet2", "F14", uint32(1<<32-1)))
  105. assert.NoError(t, f.SetCellValue("Sheet2", "F15", uint64(1<<32-1)))
  106. assert.NoError(t, f.SetCellValue("Sheet2", "F16", true))
  107. assert.NoError(t, f.SetCellValue("Sheet2", "F17", complex64(5+10i)))
  108. // Test on not exists worksheet.
  109. assert.EqualError(t, f.SetCellDefault("SheetN", "A1", ""), "sheet SheetN is not exist")
  110. assert.EqualError(t, f.SetCellFloat("SheetN", "A1", 42.65418, 2, 32), "sheet SheetN is not exist")
  111. assert.EqualError(t, f.SetCellBool("SheetN", "A1", true), "sheet SheetN is not exist")
  112. assert.EqualError(t, f.SetCellFormula("SheetN", "A1", ""), "sheet SheetN is not exist")
  113. assert.EqualError(t, f.SetCellHyperLink("SheetN", "A1", "Sheet1!A40", "Location"), "sheet SheetN is not exist")
  114. // Test boolean write
  115. booltest := []struct {
  116. value bool
  117. expected string
  118. }{
  119. {false, "0"},
  120. {true, "1"},
  121. }
  122. for _, test := range booltest {
  123. assert.NoError(t, f.SetCellValue("Sheet2", "F16", test.value))
  124. val, err := f.GetCellValue("Sheet2", "F16")
  125. assert.NoError(t, err)
  126. assert.Equal(t, test.expected, val)
  127. }
  128. assert.NoError(t, f.SetCellValue("Sheet2", "G2", nil))
  129. assert.EqualError(t, f.SetCellValue("Sheet2", "G4", time.Now()), "only UTC time expected")
  130. assert.NoError(t, f.SetCellValue("Sheet2", "G4", time.Now().UTC()))
  131. // 02:46:40
  132. assert.NoError(t, f.SetCellValue("Sheet2", "G5", time.Duration(1e13)))
  133. // Test completion column.
  134. assert.NoError(t, f.SetCellValue("Sheet2", "M2", nil))
  135. // Test read cell value with given axis large than exists row.
  136. _, err = f.GetCellValue("Sheet2", "E231")
  137. assert.NoError(t, err)
  138. // Test get active worksheet of XLSX and get worksheet name of XLSX by given worksheet index.
  139. f.GetSheetName(f.GetActiveSheetIndex())
  140. // Test get worksheet index of XLSX by given worksheet name.
  141. f.GetSheetIndex("Sheet1")
  142. // Test get worksheet name of XLSX by given invalid worksheet index.
  143. f.GetSheetName(4)
  144. // Test get worksheet map of workbook.
  145. f.GetSheetMap()
  146. for i := 1; i <= 300; i++ {
  147. assert.NoError(t, f.SetCellStr("Sheet2", "c"+strconv.Itoa(i), strconv.Itoa(i)))
  148. }
  149. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestOpenFile.xlsx")))
  150. }
  151. func TestSaveFile(t *testing.T) {
  152. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  153. if !assert.NoError(t, err) {
  154. t.FailNow()
  155. }
  156. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSaveFile.xlsx")))
  157. f, err = OpenFile(filepath.Join("test", "TestSaveFile.xlsx"))
  158. if !assert.NoError(t, err) {
  159. t.FailNow()
  160. }
  161. assert.NoError(t, f.Save())
  162. }
  163. func TestSaveAsWrongPath(t *testing.T) {
  164. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  165. if assert.NoError(t, err) {
  166. // Test write file to not exist directory.
  167. err = f.SaveAs("")
  168. if assert.Error(t, err) {
  169. assert.True(t, os.IsNotExist(err), "Error: %v: Expected os.IsNotExists(err) == true", err)
  170. }
  171. }
  172. }
  173. func TestCharsetTranscoder(t *testing.T) {
  174. f := NewFile()
  175. f.CharsetTranscoder(*new(charsetTranscoderFn))
  176. }
  177. func TestOpenReader(t *testing.T) {
  178. _, err := OpenReader(strings.NewReader(""))
  179. assert.EqualError(t, err, "zip: not a valid zip file")
  180. _, err = OpenReader(bytes.NewReader([]byte{
  181. 0x3c, 0x00, 0x00, 0x00, 0x4d, 0x00, 0x69, 0x00, 0x63, 0x00, 0x72, 0x00, 0x6f, 0x00, 0x73, 0x00,
  182. 0x6f, 0x00, 0x66, 0x00, 0x74, 0x00, 0x2e, 0x00, 0x43, 0x00, 0x6f, 0x00, 0x6e, 0x00, 0x74, 0x00,
  183. 0x61, 0x00, 0x69, 0x00, 0x6e, 0x00, 0x65, 0x00, 0x72, 0x00, 0x2e, 0x00, 0x44, 0x00, 0x61, 0x00,
  184. 0x74, 0x00, 0x61, 0x00, 0x53, 0x00, 0x70, 0x00, 0x61, 0x00, 0x63, 0x00, 0x65, 0x00, 0x73, 0x00,
  185. 0x01, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00,
  186. }))
  187. assert.EqualError(t, err, "not support encrypted file currently")
  188. // Test unexpected EOF.
  189. var b bytes.Buffer
  190. w := gzip.NewWriter(&b)
  191. defer w.Close()
  192. w.Flush()
  193. r, _ := gzip.NewReader(&b)
  194. defer r.Close()
  195. _, err = OpenReader(r)
  196. assert.EqualError(t, err, "unexpected EOF")
  197. }
  198. func TestBrokenFile(t *testing.T) {
  199. // Test write file with broken file struct.
  200. f := File{}
  201. t.Run("SaveWithoutName", func(t *testing.T) {
  202. assert.EqualError(t, f.Save(), "no path defined for file, consider File.WriteTo or File.Write")
  203. })
  204. t.Run("SaveAsEmptyStruct", func(t *testing.T) {
  205. // Test write file with broken file struct with given path.
  206. assert.NoError(t, f.SaveAs(filepath.Join("test", "BrokenFile.SaveAsEmptyStruct.xlsx")))
  207. })
  208. t.Run("OpenBadWorkbook", func(t *testing.T) {
  209. // Test set active sheet without BookViews and Sheets maps in xl/workbook.xml.
  210. f3, err := OpenFile(filepath.Join("test", "BadWorkbook.xlsx"))
  211. f3.GetActiveSheetIndex()
  212. f3.SetActiveSheet(2)
  213. assert.NoError(t, err)
  214. })
  215. t.Run("OpenNotExistsFile", func(t *testing.T) {
  216. // Test open a XLSX file with given illegal path.
  217. _, err := OpenFile(filepath.Join("test", "NotExistsFile.xlsx"))
  218. if assert.Error(t, err) {
  219. assert.True(t, os.IsNotExist(err), "Expected os.IsNotExists(err) == true")
  220. }
  221. })
  222. }
  223. func TestNewFile(t *testing.T) {
  224. // Test create a XLSX file.
  225. f := NewFile()
  226. f.NewSheet("Sheet1")
  227. f.NewSheet("XLSXSheet2")
  228. f.NewSheet("XLSXSheet3")
  229. assert.NoError(t, f.SetCellInt("XLSXSheet2", "A23", 56))
  230. assert.NoError(t, f.SetCellStr("Sheet1", "B20", "42"))
  231. f.SetActiveSheet(0)
  232. // Test add picture to sheet with scaling and positioning.
  233. err := f.AddPicture("Sheet1", "H2", filepath.Join("test", "images", "excel.gif"),
  234. `{"x_scale": 0.5, "y_scale": 0.5, "positioning": "absolute"}`)
  235. if !assert.NoError(t, err) {
  236. t.FailNow()
  237. }
  238. // Test add picture to worksheet without formatset.
  239. err = f.AddPicture("Sheet1", "C2", filepath.Join("test", "images", "excel.png"), "")
  240. if !assert.NoError(t, err) {
  241. t.FailNow()
  242. }
  243. // Test add picture to worksheet with invalid formatset.
  244. err = f.AddPicture("Sheet1", "C2", filepath.Join("test", "images", "excel.png"), `{`)
  245. if !assert.Error(t, err) {
  246. t.FailNow()
  247. }
  248. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestNewFile.xlsx")))
  249. }
  250. func TestAddDrawingVML(t *testing.T) {
  251. // Test addDrawingVML with illegal cell coordinates.
  252. f := NewFile()
  253. assert.EqualError(t, f.addDrawingVML(0, "", "*", 0, 0), `cannot convert cell "*" to coordinates: invalid cell name "*"`)
  254. }
  255. func TestSetCellHyperLink(t *testing.T) {
  256. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  257. if err != nil {
  258. t.Log(err)
  259. }
  260. // Test set cell hyperlink in a work sheet already have hyperlinks.
  261. assert.NoError(t, f.SetCellHyperLink("Sheet1", "B19", "https://github.com/360EntSecGroup-Skylar/excelize", "External"))
  262. // Test add first hyperlink in a work sheet.
  263. assert.NoError(t, f.SetCellHyperLink("Sheet2", "C1", "https://github.com/360EntSecGroup-Skylar/excelize", "External"))
  264. // Test add Location hyperlink in a work sheet.
  265. assert.NoError(t, f.SetCellHyperLink("Sheet2", "D6", "Sheet1!D8", "Location"))
  266. assert.EqualError(t, f.SetCellHyperLink("Sheet2", "C3", "Sheet1!D8", ""), `invalid link type ""`)
  267. assert.EqualError(t, f.SetCellHyperLink("Sheet2", "", "Sheet1!D60", "Location"), `invalid cell name ""`)
  268. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellHyperLink.xlsx")))
  269. f = NewFile()
  270. _, err = f.workSheetReader("Sheet1")
  271. assert.NoError(t, err)
  272. f.Sheet["xl/worksheets/sheet1.xml"].Hyperlinks = &xlsxHyperlinks{Hyperlink: make([]xlsxHyperlink, 65530)}
  273. assert.EqualError(t, f.SetCellHyperLink("Sheet1", "A65531", "https://github.com/360EntSecGroup-Skylar/excelize", "External"), "over maximum limit hyperlinks in a worksheet")
  274. f = NewFile()
  275. _, err = f.workSheetReader("Sheet1")
  276. assert.NoError(t, err)
  277. f.Sheet["xl/worksheets/sheet1.xml"].MergeCells = &xlsxMergeCells{Cells: []*xlsxMergeCell{{Ref: "A:A"}}}
  278. err = f.SetCellHyperLink("Sheet1", "A1", "https://github.com/360EntSecGroup-Skylar/excelize", "External")
  279. assert.EqualError(t, err, `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  280. }
  281. func TestGetCellHyperLink(t *testing.T) {
  282. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  283. if !assert.NoError(t, err) {
  284. t.FailNow()
  285. }
  286. _, _, err = f.GetCellHyperLink("Sheet1", "")
  287. assert.EqualError(t, err, `invalid cell name ""`)
  288. link, target, err := f.GetCellHyperLink("Sheet1", "A22")
  289. assert.NoError(t, err)
  290. t.Log(link, target)
  291. link, target, err = f.GetCellHyperLink("Sheet2", "D6")
  292. assert.NoError(t, err)
  293. t.Log(link, target)
  294. link, target, err = f.GetCellHyperLink("Sheet3", "H3")
  295. assert.EqualError(t, err, "sheet Sheet3 is not exist")
  296. t.Log(link, target)
  297. f = NewFile()
  298. _, err = f.workSheetReader("Sheet1")
  299. assert.NoError(t, err)
  300. f.Sheet["xl/worksheets/sheet1.xml"].Hyperlinks = &xlsxHyperlinks{
  301. Hyperlink: []xlsxHyperlink{{Ref: "A1"}},
  302. }
  303. link, target, err = f.GetCellHyperLink("Sheet1", "A1")
  304. assert.NoError(t, err)
  305. assert.Equal(t, link, true)
  306. assert.Equal(t, target, "")
  307. f.Sheet["xl/worksheets/sheet1.xml"].MergeCells = &xlsxMergeCells{Cells: []*xlsxMergeCell{{Ref: "A:A"}}}
  308. link, target, err = f.GetCellHyperLink("Sheet1", "A1")
  309. assert.EqualError(t, err, `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  310. assert.Equal(t, link, false)
  311. assert.Equal(t, target, "")
  312. }
  313. func TestSetCellFormula(t *testing.T) {
  314. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  315. if !assert.NoError(t, err) {
  316. t.FailNow()
  317. }
  318. assert.NoError(t, f.SetCellFormula("Sheet1", "B19", "SUM(Sheet2!D2,Sheet2!D11)"))
  319. assert.NoError(t, f.SetCellFormula("Sheet1", "C19", "SUM(Sheet2!D2,Sheet2!D9)"))
  320. // Test set cell formula with illegal rows number.
  321. assert.EqualError(t, f.SetCellFormula("Sheet1", "C", "SUM(Sheet2!D2,Sheet2!D9)"), `cannot convert cell "C" to coordinates: invalid cell name "C"`)
  322. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellFormula1.xlsx")))
  323. f, err = OpenFile(filepath.Join("test", "CalcChain.xlsx"))
  324. if !assert.NoError(t, err) {
  325. t.FailNow()
  326. }
  327. // Test remove cell formula.
  328. assert.NoError(t, f.SetCellFormula("Sheet1", "A1", ""))
  329. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellFormula2.xlsx")))
  330. // Test remove all cell formula.
  331. assert.NoError(t, f.SetCellFormula("Sheet1", "B1", ""))
  332. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellFormula3.xlsx")))
  333. }
  334. func TestSetSheetBackground(t *testing.T) {
  335. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  336. if !assert.NoError(t, err) {
  337. t.FailNow()
  338. }
  339. err = f.SetSheetBackground("Sheet2", filepath.Join("test", "images", "background.jpg"))
  340. if !assert.NoError(t, err) {
  341. t.FailNow()
  342. }
  343. err = f.SetSheetBackground("Sheet2", filepath.Join("test", "images", "background.jpg"))
  344. if !assert.NoError(t, err) {
  345. t.FailNow()
  346. }
  347. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetSheetBackground.xlsx")))
  348. }
  349. func TestSetSheetBackgroundErrors(t *testing.T) {
  350. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  351. if !assert.NoError(t, err) {
  352. t.FailNow()
  353. }
  354. err = f.SetSheetBackground("Sheet2", filepath.Join("test", "not_exists", "not_exists.png"))
  355. if assert.Error(t, err) {
  356. assert.True(t, os.IsNotExist(err), "Expected os.IsNotExists(err) == true")
  357. }
  358. err = f.SetSheetBackground("Sheet2", filepath.Join("test", "Book1.xlsx"))
  359. assert.EqualError(t, err, "unsupported image extension")
  360. }
  361. // TestWriteArrayFormula tests the extended options of SetCellFormula by writing an array function
  362. // to a workbook. In the resulting file, the lines 2 and 3 as well as 4 and 5 should have matching
  363. // contents.
  364. func TestWriteArrayFormula(t *testing.T) {
  365. cell := func(col, row int) string {
  366. c, err := CoordinatesToCellName(col, row)
  367. if err != nil {
  368. t.Fatal(err)
  369. }
  370. return c
  371. }
  372. f := NewFile()
  373. sample := []string{"Sample 1", "Sample 2", "Sample 3"}
  374. values := []int{1855, 1709, 1462, 1115, 1524, 625, 773, 126, 1027, 1696, 1078, 1917, 1109, 1753, 1884, 659, 994, 1911, 1925, 899, 196, 244, 1488, 1056, 1986, 66, 784, 725, 767, 1722, 1541, 1026, 1455, 264, 1538, 877, 1581, 1098, 383, 762, 237, 493, 29, 1923, 474, 430, 585, 688, 308, 200, 1259, 622, 798, 1048, 996, 601, 582, 332, 377, 805, 250, 1860, 1360, 840, 911, 1346, 1651, 1651, 665, 584, 1057, 1145, 925, 1752, 202, 149, 1917, 1398, 1894, 818, 714, 624, 1085, 1566, 635, 78, 313, 1686, 1820, 494, 614, 1913, 271, 1016, 338, 1301, 489, 1733, 1483, 1141}
  375. assoc := []int{2, 0, 0, 0, 0, 1, 1, 0, 0, 1, 2, 2, 2, 1, 1, 1, 1, 0, 0, 0, 1, 0, 2, 0, 2, 1, 2, 2, 2, 1, 0, 1, 0, 1, 1, 2, 0, 2, 1, 0, 2, 1, 0, 1, 0, 0, 2, 0, 2, 2, 1, 2, 2, 1, 2, 2, 1, 2, 1, 2, 2, 1, 1, 1, 0, 1, 0, 2, 0, 0, 1, 2, 1, 0, 1, 0, 0, 2, 1, 1, 2, 0, 2, 1, 0, 2, 2, 2, 1, 0, 0, 1, 1, 1, 2, 0, 2, 0, 1, 1}
  376. if len(values) != len(assoc) {
  377. t.Fatal("values and assoc must be of same length")
  378. }
  379. // Average calculates the average of the n-th sample (0 <= n < len(sample)).
  380. average := func(n int) int {
  381. sum := 0
  382. count := 0
  383. for i := 0; i != len(values); i++ {
  384. if assoc[i] == n {
  385. sum += values[i]
  386. count++
  387. }
  388. }
  389. return int(math.Round(float64(sum) / float64(count)))
  390. }
  391. // Stdev calculates the standard deviation of the n-th sample (0 <= n < len(sample)).
  392. stdev := func(n int) int {
  393. avg := average(n)
  394. sum := 0
  395. count := 0
  396. for i := 0; i != len(values); i++ {
  397. if assoc[i] == n {
  398. sum += (values[i] - avg) * (values[i] - avg)
  399. count++
  400. }
  401. }
  402. return int(math.Round(math.Sqrt(float64(sum) / float64(count))))
  403. }
  404. // Line 2 contains the results of AVERAGEIF
  405. assert.NoError(t, f.SetCellStr("Sheet1", "A2", "Average"))
  406. // Line 3 contains the average that was calculated in Go
  407. assert.NoError(t, f.SetCellStr("Sheet1", "A3", "Average (calculated)"))
  408. // Line 4 contains the results of the array function that calculates the standard deviation
  409. assert.NoError(t, f.SetCellStr("Sheet1", "A4", "Std. deviation"))
  410. // Line 5 contains the standard deviations calculated in Go
  411. assert.NoError(t, f.SetCellStr("Sheet1", "A5", "Std. deviation (calculated)"))
  412. assert.NoError(t, f.SetCellStr("Sheet1", "B1", sample[0]))
  413. assert.NoError(t, f.SetCellStr("Sheet1", "C1", sample[1]))
  414. assert.NoError(t, f.SetCellStr("Sheet1", "D1", sample[2]))
  415. firstResLine := 8
  416. assert.NoError(t, f.SetCellStr("Sheet1", cell(1, firstResLine-1), "Result Values"))
  417. assert.NoError(t, f.SetCellStr("Sheet1", cell(2, firstResLine-1), "Sample"))
  418. for i := 0; i != len(values); i++ {
  419. valCell := cell(1, i+firstResLine)
  420. assocCell := cell(2, i+firstResLine)
  421. assert.NoError(t, f.SetCellInt("Sheet1", valCell, values[i]))
  422. assert.NoError(t, f.SetCellStr("Sheet1", assocCell, sample[assoc[i]]))
  423. }
  424. valRange := fmt.Sprintf("$A$%d:$A$%d", firstResLine, len(values)+firstResLine-1)
  425. assocRange := fmt.Sprintf("$B$%d:$B$%d", firstResLine, len(values)+firstResLine-1)
  426. for i := 0; i != len(sample); i++ {
  427. nameCell := cell(i+2, 1)
  428. avgCell := cell(i+2, 2)
  429. calcAvgCell := cell(i+2, 3)
  430. stdevCell := cell(i+2, 4)
  431. calcStdevCell := cell(i+2, 5)
  432. assert.NoError(t, f.SetCellInt("Sheet1", calcAvgCell, average(i)))
  433. assert.NoError(t, f.SetCellInt("Sheet1", calcStdevCell, stdev(i)))
  434. // Average can be done with AVERAGEIF
  435. assert.NoError(t, f.SetCellFormula("Sheet1", avgCell, fmt.Sprintf("ROUND(AVERAGEIF(%s,%s,%s),0)", assocRange, nameCell, valRange)))
  436. ref := stdevCell + ":" + stdevCell
  437. t := STCellFormulaTypeArray
  438. // Use an array formula for standard deviation
  439. f.SetCellFormula("Sheet1", stdevCell, fmt.Sprintf("ROUND(STDEVP(IF(%s=%s,%s)),0)", assocRange, nameCell, valRange),
  440. FormulaOpts{}, FormulaOpts{Type: &t}, FormulaOpts{Ref: &ref})
  441. }
  442. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestWriteArrayFormula.xlsx")))
  443. }
  444. func TestSetCellStyleAlignment(t *testing.T) {
  445. f, err := prepareTestBook1()
  446. if !assert.NoError(t, err) {
  447. t.FailNow()
  448. }
  449. var style int
  450. style, err = f.NewStyle(`{"alignment":{"horizontal":"center","ident":1,"justify_last_line":true,"reading_order":0,"relative_indent":1,"shrink_to_fit":true,"text_rotation":45,"vertical":"top","wrap_text":true}}`)
  451. if !assert.NoError(t, err) {
  452. t.FailNow()
  453. }
  454. assert.NoError(t, f.SetCellStyle("Sheet1", "A22", "A22", style))
  455. // Test set cell style with given illegal rows number.
  456. assert.EqualError(t, f.SetCellStyle("Sheet1", "A", "A22", style), `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  457. assert.EqualError(t, f.SetCellStyle("Sheet1", "A22", "A", style), `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  458. // Test get cell style with given illegal rows number.
  459. index, err := f.GetCellStyle("Sheet1", "A")
  460. assert.Equal(t, 0, index)
  461. assert.EqualError(t, err, `cannot convert cell "A" to coordinates: invalid cell name "A"`)
  462. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleAlignment.xlsx")))
  463. }
  464. func TestSetCellStyleBorder(t *testing.T) {
  465. f, err := prepareTestBook1()
  466. if !assert.NoError(t, err) {
  467. t.FailNow()
  468. }
  469. var style int
  470. // Test set border on overlapping area with vertical variants shading styles gradient fill.
  471. style, err = f.NewStyle(`{"border":[{"type":"left","color":"0000FF","style":2},{"type":"top","color":"00FF00","style":12},{"type":"bottom","color":"FFFF00","style":5},{"type":"right","color":"FF0000","style":6},{"type":"diagonalDown","color":"A020F0","style":9},{"type":"diagonalUp","color":"A020F0","style":8}]}`)
  472. if !assert.NoError(t, err) {
  473. t.FailNow()
  474. }
  475. assert.NoError(t, f.SetCellStyle("Sheet1", "J21", "L25", style))
  476. style, err = f.NewStyle(`{"border":[{"type":"left","color":"0000FF","style":2},{"type":"top","color":"00FF00","style":3},{"type":"bottom","color":"FFFF00","style":4},{"type":"right","color":"FF0000","style":5},{"type":"diagonalDown","color":"A020F0","style":6},{"type":"diagonalUp","color":"A020F0","style":7}],"fill":{"type":"gradient","color":["#FFFFFF","#E0EBF5"],"shading":1}}`)
  477. if !assert.NoError(t, err) {
  478. t.FailNow()
  479. }
  480. assert.NoError(t, f.SetCellStyle("Sheet1", "M28", "K24", style))
  481. style, err = f.NewStyle(`{"border":[{"type":"left","color":"0000FF","style":2},{"type":"top","color":"00FF00","style":3},{"type":"bottom","color":"FFFF00","style":4},{"type":"right","color":"FF0000","style":5},{"type":"diagonalDown","color":"A020F0","style":6},{"type":"diagonalUp","color":"A020F0","style":7}],"fill":{"type":"gradient","color":["#FFFFFF","#E0EBF5"],"shading":4}}`)
  482. if !assert.NoError(t, err) {
  483. t.FailNow()
  484. }
  485. assert.NoError(t, f.SetCellStyle("Sheet1", "M28", "K24", style))
  486. // Test set border and solid style pattern fill for a single cell.
  487. style, err = f.NewStyle(&Style{
  488. Border: []Border{
  489. {
  490. Type: "left",
  491. Color: "0000FF",
  492. Style: 8,
  493. },
  494. {
  495. Type: "top",
  496. Color: "00FF00",
  497. Style: 9,
  498. },
  499. {
  500. Type: "bottom",
  501. Color: "FFFF00",
  502. Style: 10,
  503. },
  504. {
  505. Type: "right",
  506. Color: "FF0000",
  507. Style: 11,
  508. },
  509. {
  510. Type: "diagonalDown",
  511. Color: "A020F0",
  512. Style: 12,
  513. },
  514. {
  515. Type: "diagonalUp",
  516. Color: "A020F0",
  517. Style: 13,
  518. },
  519. },
  520. Fill: Fill{
  521. Type: "pattern",
  522. Color: []string{"#E0EBF5"},
  523. Pattern: 1,
  524. },
  525. })
  526. if !assert.NoError(t, err) {
  527. t.FailNow()
  528. }
  529. assert.NoError(t, f.SetCellStyle("Sheet1", "O22", "O22", style))
  530. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleBorder.xlsx")))
  531. }
  532. func TestSetCellStyleBorderErrors(t *testing.T) {
  533. f, err := prepareTestBook1()
  534. if !assert.NoError(t, err) {
  535. t.FailNow()
  536. }
  537. // Set border with invalid style parameter.
  538. _, err = f.NewStyle("")
  539. if !assert.EqualError(t, err, "unexpected end of JSON input") {
  540. t.FailNow()
  541. }
  542. // Set border with invalid style index number.
  543. _, err = f.NewStyle(`{"border":[{"type":"left","color":"0000FF","style":-1},{"type":"top","color":"00FF00","style":14},{"type":"bottom","color":"FFFF00","style":5},{"type":"right","color":"FF0000","style":6},{"type":"diagonalDown","color":"A020F0","style":9},{"type":"diagonalUp","color":"A020F0","style":8}]}`)
  544. if !assert.NoError(t, err) {
  545. t.FailNow()
  546. }
  547. }
  548. func TestSetCellStyleNumberFormat(t *testing.T) {
  549. f, err := prepareTestBook1()
  550. if !assert.NoError(t, err) {
  551. t.FailNow()
  552. }
  553. // Test only set fill and number format for a cell.
  554. col := []string{"L", "M", "N", "O", "P"}
  555. data := []int{0, 1, 2, 3, 4, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49}
  556. value := []string{"37947.7500001", "-37947.7500001", "0.007", "2.1", "String"}
  557. for i, v := range value {
  558. for k, d := range data {
  559. c := col[i] + strconv.Itoa(k+1)
  560. var val float64
  561. val, err = strconv.ParseFloat(v, 64)
  562. if err != nil {
  563. assert.NoError(t, f.SetCellValue("Sheet2", c, v))
  564. } else {
  565. assert.NoError(t, f.SetCellValue("Sheet2", c, val))
  566. }
  567. style, err := f.NewStyle(`{"fill":{"type":"gradient","color":["#FFFFFF","#E0EBF5"],"shading":5},"number_format": ` + strconv.Itoa(d) + `}`)
  568. if !assert.NoError(t, err) {
  569. t.FailNow()
  570. }
  571. assert.NoError(t, f.SetCellStyle("Sheet2", c, c, style))
  572. t.Log(f.GetCellValue("Sheet2", c))
  573. }
  574. }
  575. var style int
  576. style, err = f.NewStyle(`{"number_format":-1}`)
  577. if !assert.NoError(t, err) {
  578. t.FailNow()
  579. }
  580. assert.NoError(t, f.SetCellStyle("Sheet2", "L33", "L33", style))
  581. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleNumberFormat.xlsx")))
  582. }
  583. func TestSetCellStyleCurrencyNumberFormat(t *testing.T) {
  584. t.Run("TestBook3", func(t *testing.T) {
  585. f, err := prepareTestBook3()
  586. if !assert.NoError(t, err) {
  587. t.FailNow()
  588. }
  589. assert.NoError(t, f.SetCellValue("Sheet1", "A1", 56))
  590. assert.NoError(t, f.SetCellValue("Sheet1", "A2", -32.3))
  591. var style int
  592. style, err = f.NewStyle(`{"number_format": 188, "decimal_places": -1}`)
  593. if !assert.NoError(t, err) {
  594. t.FailNow()
  595. }
  596. assert.NoError(t, f.SetCellStyle("Sheet1", "A1", "A1", style))
  597. style, err = f.NewStyle(`{"number_format": 188, "decimal_places": 31, "negred": true}`)
  598. if !assert.NoError(t, err) {
  599. t.FailNow()
  600. }
  601. assert.NoError(t, f.SetCellStyle("Sheet1", "A2", "A2", style))
  602. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleCurrencyNumberFormat.TestBook3.xlsx")))
  603. })
  604. t.Run("TestBook4", func(t *testing.T) {
  605. f, err := prepareTestBook4()
  606. if !assert.NoError(t, err) {
  607. t.FailNow()
  608. }
  609. assert.NoError(t, f.SetCellValue("Sheet1", "A1", 42920.5))
  610. assert.NoError(t, f.SetCellValue("Sheet1", "A2", 42920.5))
  611. _, err = f.NewStyle(`{"number_format": 26, "lang": "zh-tw"}`)
  612. if !assert.NoError(t, err) {
  613. t.FailNow()
  614. }
  615. style, err := f.NewStyle(`{"number_format": 27}`)
  616. if !assert.NoError(t, err) {
  617. t.FailNow()
  618. }
  619. assert.NoError(t, f.SetCellStyle("Sheet1", "A1", "A1", style))
  620. style, err = f.NewStyle(`{"number_format": 31, "lang": "ko-kr"}`)
  621. if !assert.NoError(t, err) {
  622. t.FailNow()
  623. }
  624. assert.NoError(t, f.SetCellStyle("Sheet1", "A2", "A2", style))
  625. style, err = f.NewStyle(`{"number_format": 71, "lang": "th-th"}`)
  626. if !assert.NoError(t, err) {
  627. t.FailNow()
  628. }
  629. assert.NoError(t, f.SetCellStyle("Sheet1", "A2", "A2", style))
  630. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleCurrencyNumberFormat.TestBook4.xlsx")))
  631. })
  632. }
  633. func TestSetCellStyleCustomNumberFormat(t *testing.T) {
  634. f := NewFile()
  635. assert.NoError(t, f.SetCellValue("Sheet1", "A1", 42920.5))
  636. assert.NoError(t, f.SetCellValue("Sheet1", "A2", 42920.5))
  637. style, err := f.NewStyle(`{"custom_number_format": "[$-380A]dddd\\,\\ dd\" de \"mmmm\" de \"yyyy;@"}`)
  638. if err != nil {
  639. t.Log(err)
  640. }
  641. assert.NoError(t, f.SetCellStyle("Sheet1", "A1", "A1", style))
  642. style, err = f.NewStyle(`{"custom_number_format": "[$-380A]dddd\\,\\ dd\" de \"mmmm\" de \"yyyy;@"}`)
  643. if err != nil {
  644. t.Log(err)
  645. }
  646. assert.NoError(t, f.SetCellStyle("Sheet1", "A2", "A2", style))
  647. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleCustomNumberFormat.xlsx")))
  648. }
  649. func TestSetCellStyleFill(t *testing.T) {
  650. f, err := prepareTestBook1()
  651. if !assert.NoError(t, err) {
  652. t.FailNow()
  653. }
  654. var style int
  655. // Test set fill for cell with invalid parameter.
  656. style, err = f.NewStyle(`{"fill":{"type":"gradient","color":["#FFFFFF","#E0EBF5"],"shading":6}}`)
  657. if !assert.NoError(t, err) {
  658. t.FailNow()
  659. }
  660. assert.NoError(t, f.SetCellStyle("Sheet1", "O23", "O23", style))
  661. style, err = f.NewStyle(`{"fill":{"type":"gradient","color":["#FFFFFF"],"shading":1}}`)
  662. if !assert.NoError(t, err) {
  663. t.FailNow()
  664. }
  665. assert.NoError(t, f.SetCellStyle("Sheet1", "O23", "O23", style))
  666. style, err = f.NewStyle(`{"fill":{"type":"pattern","color":[],"pattern":1}}`)
  667. if !assert.NoError(t, err) {
  668. t.FailNow()
  669. }
  670. assert.NoError(t, f.SetCellStyle("Sheet1", "O23", "O23", style))
  671. style, err = f.NewStyle(`{"fill":{"type":"pattern","color":["#E0EBF5"],"pattern":19}}`)
  672. if !assert.NoError(t, err) {
  673. t.FailNow()
  674. }
  675. assert.NoError(t, f.SetCellStyle("Sheet1", "O23", "O23", style))
  676. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleFill.xlsx")))
  677. }
  678. func TestSetCellStyleFont(t *testing.T) {
  679. f, err := prepareTestBook1()
  680. if !assert.NoError(t, err) {
  681. t.FailNow()
  682. }
  683. var style int
  684. style, err = f.NewStyle(`{"font":{"bold":true,"italic":true,"family":"Times New Roman","size":36,"color":"#777777","underline":"single"}}`)
  685. if !assert.NoError(t, err) {
  686. t.FailNow()
  687. }
  688. assert.NoError(t, f.SetCellStyle("Sheet2", "A1", "A1", style))
  689. style, err = f.NewStyle(`{"font":{"italic":true,"underline":"double"}}`)
  690. if !assert.NoError(t, err) {
  691. t.FailNow()
  692. }
  693. assert.NoError(t, f.SetCellStyle("Sheet2", "A2", "A2", style))
  694. style, err = f.NewStyle(`{"font":{"bold":true}}`)
  695. if !assert.NoError(t, err) {
  696. t.FailNow()
  697. }
  698. assert.NoError(t, f.SetCellStyle("Sheet2", "A3", "A3", style))
  699. style, err = f.NewStyle(`{"font":{"bold":true,"family":"","size":0,"color":"","underline":""}}`)
  700. if !assert.NoError(t, err) {
  701. t.FailNow()
  702. }
  703. assert.NoError(t, f.SetCellStyle("Sheet2", "A4", "A4", style))
  704. style, err = f.NewStyle(`{"font":{"color":"#777777","strike":true}}`)
  705. if !assert.NoError(t, err) {
  706. t.FailNow()
  707. }
  708. assert.NoError(t, f.SetCellStyle("Sheet2", "A5", "A5", style))
  709. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetCellStyleFont.xlsx")))
  710. }
  711. func TestSetCellStyleProtection(t *testing.T) {
  712. f, err := prepareTestBook1()
  713. if !assert.NoError(t, err) {
  714. t.FailNow()
  715. }
  716. var style int
  717. style, err = f.NewStyle(`{"protection":{"hidden":true, "locked":true}}`)
  718. if !assert.NoError(t, err) {
  719. t.FailNow()
  720. }
  721. assert.NoError(t, f.SetCellStyle("Sheet2", "A6", "A6", style))
  722. err = f.SaveAs(filepath.Join("test", "TestSetCellStyleProtection.xlsx"))
  723. if !assert.NoError(t, err) {
  724. t.FailNow()
  725. }
  726. }
  727. func TestSetDeleteSheet(t *testing.T) {
  728. t.Run("TestBook3", func(t *testing.T) {
  729. f, err := prepareTestBook3()
  730. if !assert.NoError(t, err) {
  731. t.FailNow()
  732. }
  733. f.DeleteSheet("XLSXSheet3")
  734. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetDeleteSheet.TestBook3.xlsx")))
  735. })
  736. t.Run("TestBook4", func(t *testing.T) {
  737. f, err := prepareTestBook4()
  738. if !assert.NoError(t, err) {
  739. t.FailNow()
  740. }
  741. f.DeleteSheet("Sheet1")
  742. assert.EqualError(t, f.AddComment("Sheet1", "A1", ""), "unexpected end of JSON input")
  743. assert.NoError(t, f.AddComment("Sheet1", "A1", `{"author":"Excelize: ","text":"This is a comment."}`))
  744. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetDeleteSheet.TestBook4.xlsx")))
  745. })
  746. }
  747. func TestSheetVisibility(t *testing.T) {
  748. f, err := prepareTestBook1()
  749. if !assert.NoError(t, err) {
  750. t.FailNow()
  751. }
  752. assert.NoError(t, f.SetSheetVisible("Sheet2", false))
  753. assert.NoError(t, f.SetSheetVisible("Sheet1", false))
  754. assert.NoError(t, f.SetSheetVisible("Sheet1", true))
  755. assert.Equal(t, true, f.GetSheetVisible("Sheet1"))
  756. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSheetVisibility.xlsx")))
  757. }
  758. func TestCopySheet(t *testing.T) {
  759. f, err := prepareTestBook1()
  760. if !assert.NoError(t, err) {
  761. t.FailNow()
  762. }
  763. idx := f.NewSheet("CopySheet")
  764. assert.NoError(t, f.CopySheet(1, idx))
  765. assert.NoError(t, f.SetCellValue("CopySheet", "F1", "Hello"))
  766. val, err := f.GetCellValue("Sheet1", "F1")
  767. assert.NoError(t, err)
  768. assert.NotEqual(t, "Hello", val)
  769. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestCopySheet.xlsx")))
  770. }
  771. func TestCopySheetError(t *testing.T) {
  772. f, err := prepareTestBook1()
  773. if !assert.NoError(t, err) {
  774. t.FailNow()
  775. }
  776. assert.EqualError(t, f.copySheet(0, -1), "sheet is not exist")
  777. if !assert.EqualError(t, f.CopySheet(0, -1), "invalid worksheet index") {
  778. t.FailNow()
  779. }
  780. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestCopySheetError.xlsx")))
  781. }
  782. func TestGetSheetComments(t *testing.T) {
  783. f := NewFile()
  784. assert.Equal(t, "", f.getSheetComments("sheet0"))
  785. }
  786. func TestSetActiveSheet(t *testing.T) {
  787. f := NewFile()
  788. f.WorkBook.BookViews = nil
  789. f.SetActiveSheet(1)
  790. f.WorkBook.BookViews = &xlsxBookViews{WorkBookView: []xlsxWorkBookView{}}
  791. f.Sheet["xl/worksheets/sheet1.xml"].SheetViews = &xlsxSheetViews{SheetView: []xlsxSheetView{}}
  792. f.SetActiveSheet(1)
  793. f.Sheet["xl/worksheets/sheet1.xml"].SheetViews = nil
  794. f.SetActiveSheet(1)
  795. }
  796. func TestSetSheetVisible(t *testing.T) {
  797. f := NewFile()
  798. f.WorkBook.Sheets.Sheet[0].Name = "SheetN"
  799. assert.EqualError(t, f.SetSheetVisible("Sheet1", false), "sheet SheetN is not exist")
  800. }
  801. func TestGetActiveSheetIndex(t *testing.T) {
  802. f := NewFile()
  803. f.WorkBook.BookViews = nil
  804. assert.Equal(t, 1, f.GetActiveSheetIndex())
  805. }
  806. func TestRelsWriter(t *testing.T) {
  807. f := NewFile()
  808. f.Relationships["xl/worksheets/sheet/rels/sheet1.xml.rel"] = &xlsxRelationships{}
  809. f.relsWriter()
  810. }
  811. func TestGetSheetView(t *testing.T) {
  812. f := NewFile()
  813. _, err := f.getSheetView("SheetN", 0)
  814. assert.EqualError(t, err, "sheet SheetN is not exist")
  815. }
  816. func TestConditionalFormat(t *testing.T) {
  817. f := NewFile()
  818. sheet1 := f.GetSheetName(1)
  819. fillCells(f, sheet1, 10, 15)
  820. var format1, format2, format3, format4 int
  821. var err error
  822. // Rose format for bad conditional.
  823. format1, err = f.NewConditionalStyle(`{"font":{"color":"#9A0511"},"fill":{"type":"pattern","color":["#FEC7CE"],"pattern":1}}`)
  824. if !assert.NoError(t, err) {
  825. t.FailNow()
  826. }
  827. // Light yellow format for neutral conditional.
  828. format2, err = f.NewConditionalStyle(`{"fill":{"type":"pattern","color":["#FEEAA0"],"pattern":1}}`)
  829. if !assert.NoError(t, err) {
  830. t.FailNow()
  831. }
  832. // Light green format for good conditional.
  833. format3, err = f.NewConditionalStyle(`{"font":{"color":"#09600B"},"fill":{"type":"pattern","color":["#C7EECF"],"pattern":1}}`)
  834. if !assert.NoError(t, err) {
  835. t.FailNow()
  836. }
  837. // conditional style with align and left border.
  838. format4, err = f.NewConditionalStyle(`{"alignment":{"wrap_text":true},"border":[{"type":"left","color":"#000000","style":1}]}`)
  839. if !assert.NoError(t, err) {
  840. t.FailNow()
  841. }
  842. // Color scales: 2 color.
  843. assert.NoError(t, f.SetConditionalFormat(sheet1, "A1:A10", `[{"type":"2_color_scale","criteria":"=","min_type":"min","max_type":"max","min_color":"#F8696B","max_color":"#63BE7B"}]`))
  844. // Color scales: 3 color.
  845. assert.NoError(t, f.SetConditionalFormat(sheet1, "B1:B10", `[{"type":"3_color_scale","criteria":"=","min_type":"min","mid_type":"percentile","max_type":"max","min_color":"#F8696B","mid_color":"#FFEB84","max_color":"#63BE7B"}]`))
  846. // Hightlight cells rules: between...
  847. assert.NoError(t, f.SetConditionalFormat(sheet1, "C1:C10", fmt.Sprintf(`[{"type":"cell","criteria":"between","format":%d,"minimum":"6","maximum":"8"}]`, format1)))
  848. // Hightlight cells rules: Greater Than...
  849. assert.NoError(t, f.SetConditionalFormat(sheet1, "D1:D10", fmt.Sprintf(`[{"type":"cell","criteria":">","format":%d,"value":"6"}]`, format3)))
  850. // Hightlight cells rules: Equal To...
  851. assert.NoError(t, f.SetConditionalFormat(sheet1, "E1:E10", fmt.Sprintf(`[{"type":"top","criteria":"=","format":%d}]`, format3)))
  852. // Hightlight cells rules: Not Equal To...
  853. assert.NoError(t, f.SetConditionalFormat(sheet1, "F1:F10", fmt.Sprintf(`[{"type":"unique","criteria":"=","format":%d}]`, format2)))
  854. // Hightlight cells rules: Duplicate Values...
  855. assert.NoError(t, f.SetConditionalFormat(sheet1, "G1:G10", fmt.Sprintf(`[{"type":"duplicate","criteria":"=","format":%d}]`, format2)))
  856. // Top/Bottom rules: Top 10%.
  857. assert.NoError(t, f.SetConditionalFormat(sheet1, "H1:H10", fmt.Sprintf(`[{"type":"top","criteria":"=","format":%d,"value":"6","percent":true}]`, format1)))
  858. // Top/Bottom rules: Above Average...
  859. assert.NoError(t, f.SetConditionalFormat(sheet1, "I1:I10", fmt.Sprintf(`[{"type":"average","criteria":"=","format":%d, "above_average": true}]`, format3)))
  860. // Top/Bottom rules: Below Average...
  861. assert.NoError(t, f.SetConditionalFormat(sheet1, "J1:J10", fmt.Sprintf(`[{"type":"average","criteria":"=","format":%d, "above_average": false}]`, format1)))
  862. // Data Bars: Gradient Fill.
  863. assert.NoError(t, f.SetConditionalFormat(sheet1, "K1:K10", `[{"type":"data_bar", "criteria":"=", "min_type":"min","max_type":"max","bar_color":"#638EC6"}]`))
  864. // Use a formula to determine which cells to format.
  865. assert.NoError(t, f.SetConditionalFormat(sheet1, "L1:L10", fmt.Sprintf(`[{"type":"formula", "criteria":"L2<3", "format":%d}]`, format1)))
  866. // Alignment/Border cells rules.
  867. assert.NoError(t, f.SetConditionalFormat(sheet1, "M1:M10", fmt.Sprintf(`[{"type":"cell","criteria":">","format":%d,"value":"0"}]`, format4)))
  868. // Test set invalid format set in conditional format.
  869. assert.EqualError(t, f.SetConditionalFormat(sheet1, "L1:L10", ""), "unexpected end of JSON input")
  870. // Set conditional format on not exists worksheet.
  871. assert.EqualError(t, f.SetConditionalFormat("SheetN", "L1:L10", "[]"), "sheet SheetN is not exist")
  872. err = f.SaveAs(filepath.Join("test", "TestConditionalFormat.xlsx"))
  873. if !assert.NoError(t, err) {
  874. t.FailNow()
  875. }
  876. // Set conditional format with illegal valid type.
  877. assert.NoError(t, f.SetConditionalFormat(sheet1, "K1:K10", `[{"type":"", "criteria":"=", "min_type":"min","max_type":"max","bar_color":"#638EC6"}]`))
  878. // Set conditional format with illegal criteria type.
  879. assert.NoError(t, f.SetConditionalFormat(sheet1, "K1:K10", `[{"type":"data_bar", "criteria":"", "min_type":"min","max_type":"max","bar_color":"#638EC6"}]`))
  880. // Set conditional format with file without dxfs element shold not return error.
  881. f, err = OpenFile(filepath.Join("test", "Book1.xlsx"))
  882. if !assert.NoError(t, err) {
  883. t.FailNow()
  884. }
  885. _, err = f.NewConditionalStyle(`{"font":{"color":"#9A0511"},"fill":{"type":"pattern","color":["#FEC7CE"],"pattern":1}}`)
  886. if !assert.NoError(t, err) {
  887. t.FailNow()
  888. }
  889. }
  890. func TestConditionalFormatError(t *testing.T) {
  891. f := NewFile()
  892. sheet1 := f.GetSheetName(1)
  893. fillCells(f, sheet1, 10, 15)
  894. // Set conditional format with illegal JSON string should return error.
  895. _, err := f.NewConditionalStyle("")
  896. if !assert.EqualError(t, err, "unexpected end of JSON input") {
  897. t.FailNow()
  898. }
  899. }
  900. func TestSharedStrings(t *testing.T) {
  901. f, err := OpenFile(filepath.Join("test", "SharedStrings.xlsx"))
  902. if !assert.NoError(t, err) {
  903. t.FailNow()
  904. }
  905. rows, err := f.GetRows("Sheet1")
  906. if !assert.NoError(t, err) {
  907. t.FailNow()
  908. }
  909. assert.Equal(t, "A", rows[0][0])
  910. rows, err = f.GetRows("Sheet2")
  911. if !assert.NoError(t, err) {
  912. t.FailNow()
  913. }
  914. assert.Equal(t, "Test Weight (Kgs)", rows[0][0])
  915. }
  916. func TestSetSheetRow(t *testing.T) {
  917. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  918. if !assert.NoError(t, err) {
  919. t.FailNow()
  920. }
  921. assert.NoError(t, f.SetSheetRow("Sheet1", "B27", &[]interface{}{"cell", nil, int32(42), float64(42), time.Now().UTC()}))
  922. assert.EqualError(t, f.SetSheetRow("Sheet1", "", &[]interface{}{"cell", nil, 2}),
  923. `cannot convert cell "" to coordinates: invalid cell name ""`)
  924. assert.EqualError(t, f.SetSheetRow("Sheet1", "B27", []interface{}{}), `pointer to slice expected`)
  925. assert.EqualError(t, f.SetSheetRow("Sheet1", "B27", &f), `pointer to slice expected`)
  926. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestSetSheetRow.xlsx")))
  927. }
  928. func TestThemeColor(t *testing.T) {
  929. t.Log(ThemeColor("000000", -0.1))
  930. t.Log(ThemeColor("000000", 0))
  931. t.Log(ThemeColor("000000", 1))
  932. }
  933. func TestHSL(t *testing.T) {
  934. var hsl HSL
  935. t.Log(hsl.RGBA())
  936. t.Log(hslModel(hsl))
  937. t.Log(hslModel(color.Gray16{Y: uint16(1)}))
  938. t.Log(HSLToRGB(0, 1, 0.4))
  939. t.Log(HSLToRGB(0, 1, 0.6))
  940. t.Log(hueToRGB(0, 0, -1))
  941. t.Log(hueToRGB(0, 0, 2))
  942. t.Log(hueToRGB(0, 0, 1.0/7))
  943. t.Log(hueToRGB(0, 0, 0.4))
  944. t.Log(hueToRGB(0, 0, 2.0/4))
  945. t.Log(RGBToHSL(255, 255, 0))
  946. t.Log(RGBToHSL(0, 255, 255))
  947. t.Log(RGBToHSL(250, 100, 50))
  948. t.Log(RGBToHSL(50, 100, 250))
  949. t.Log(RGBToHSL(250, 50, 100))
  950. }
  951. func TestProtectSheet(t *testing.T) {
  952. f := NewFile()
  953. assert.NoError(t, f.ProtectSheet("Sheet1", nil))
  954. assert.NoError(t, f.ProtectSheet("Sheet1", &FormatSheetProtection{
  955. Password: "password",
  956. EditScenarios: false,
  957. }))
  958. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestProtectSheet.xlsx")))
  959. // Test protect not exists worksheet.
  960. assert.EqualError(t, f.ProtectSheet("SheetN", nil), "sheet SheetN is not exist")
  961. }
  962. func TestUnprotectSheet(t *testing.T) {
  963. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  964. if !assert.NoError(t, err) {
  965. t.FailNow()
  966. }
  967. // Test unprotect not exists worksheet.
  968. assert.EqualError(t, f.UnprotectSheet("SheetN"), "sheet SheetN is not exist")
  969. assert.NoError(t, f.UnprotectSheet("Sheet1"))
  970. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestUnprotectSheet.xlsx")))
  971. }
  972. func TestSetDefaultTimeStyle(t *testing.T) {
  973. f := NewFile()
  974. // Test set default time style on not exists worksheet.
  975. assert.EqualError(t, f.setDefaultTimeStyle("SheetN", "", 0), "sheet SheetN is not exist")
  976. }
  977. func TestAddVBAProject(t *testing.T) {
  978. f := NewFile()
  979. assert.NoError(t, f.SetSheetPrOptions("Sheet1", CodeName("Sheet1")))
  980. assert.EqualError(t, f.AddVBAProject("macros.bin"), "stat macros.bin: no such file or directory")
  981. assert.EqualError(t, f.AddVBAProject(filepath.Join("test", "Book1.xlsx")), "unsupported VBA project extension")
  982. assert.NoError(t, f.AddVBAProject(filepath.Join("test", "vbaProject.bin")))
  983. // Test add VBA project twice.
  984. assert.NoError(t, f.AddVBAProject(filepath.Join("test", "vbaProject.bin")))
  985. assert.NoError(t, f.SaveAs(filepath.Join("test", "TestAddVBAProject.xlsm")))
  986. }
  987. func TestContentTypesReader(t *testing.T) {
  988. // Test unsupport charset.
  989. f := NewFile()
  990. f.ContentTypes = nil
  991. f.XLSX["[Content_Types].xml"] = MacintoshCyrillicCharset
  992. f.contentTypesReader()
  993. }
  994. func TestWorkbookReader(t *testing.T) {
  995. // Test unsupport charset.
  996. f := NewFile()
  997. f.WorkBook = nil
  998. f.XLSX["xl/workbook.xml"] = MacintoshCyrillicCharset
  999. f.workbookReader()
  1000. }
  1001. func TestWorkSheetReader(t *testing.T) {
  1002. // Test unsupport charset.
  1003. f := NewFile()
  1004. delete(f.Sheet, "xl/worksheets/sheet1.xml")
  1005. f.XLSX["xl/worksheets/sheet1.xml"] = MacintoshCyrillicCharset
  1006. _, err := f.workSheetReader("Sheet1")
  1007. assert.EqualError(t, err, "xml decode error: XML syntax error on line 1: invalid UTF-8")
  1008. // Test on no checked worksheet.
  1009. f = NewFile()
  1010. delete(f.Sheet, "xl/worksheets/sheet1.xml")
  1011. f.XLSX["xl/worksheets/sheet1.xml"] = []byte(`<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main"><sheetData/></worksheet>`)
  1012. f.checked = nil
  1013. _, err = f.workSheetReader("Sheet1")
  1014. assert.NoError(t, err)
  1015. }
  1016. func TestRelsReader(t *testing.T) {
  1017. // Test unsupport charset.
  1018. f := NewFile()
  1019. rels := "xl/_rels/workbook.xml.rels"
  1020. f.Relationships[rels] = nil
  1021. f.XLSX[rels] = MacintoshCyrillicCharset
  1022. f.relsReader(rels)
  1023. }
  1024. func TestDeleteSheetFromWorkbookRels(t *testing.T) {
  1025. f := NewFile()
  1026. rels := "xl/_rels/workbook.xml.rels"
  1027. f.Relationships[rels] = nil
  1028. assert.Equal(t, f.deleteSheetFromWorkbookRels("rID"), "")
  1029. }
  1030. func TestAttrValToInt(t *testing.T) {
  1031. _, err := attrValToInt("r", []xml.Attr{
  1032. {Name: xml.Name{Local: "r"}, Value: "s"}})
  1033. assert.EqualError(t, err, `strconv.Atoi: parsing "s": invalid syntax`)
  1034. }
  1035. func prepareTestBook1() (*File, error) {
  1036. f, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
  1037. if err != nil {
  1038. return nil, err
  1039. }
  1040. err = f.AddPicture("Sheet2", "I9", filepath.Join("test", "images", "excel.jpg"),
  1041. `{"x_offset": 140, "y_offset": 120, "hyperlink": "#Sheet2!D8", "hyperlink_type": "Location"}`)
  1042. if err != nil {
  1043. return nil, err
  1044. }
  1045. // Test add picture to worksheet with offset, external hyperlink and positioning.
  1046. err = f.AddPicture("Sheet1", "F21", filepath.Join("test", "images", "excel.png"),
  1047. `{"x_offset": 10, "y_offset": 10, "hyperlink": "https://github.com/360EntSecGroup-Skylar/excelize", "hyperlink_type": "External", "positioning": "oneCell"}`)
  1048. if err != nil {
  1049. return nil, err
  1050. }
  1051. file, err := ioutil.ReadFile(filepath.Join("test", "images", "excel.jpg"))
  1052. if err != nil {
  1053. return nil, err
  1054. }
  1055. err = f.AddPictureFromBytes("Sheet1", "Q1", "", "Excel Logo", ".jpg", file)
  1056. if err != nil {
  1057. return nil, err
  1058. }
  1059. return f, nil
  1060. }
  1061. func prepareTestBook3() (*File, error) {
  1062. f := NewFile()
  1063. f.NewSheet("Sheet1")
  1064. f.NewSheet("XLSXSheet2")
  1065. f.NewSheet("XLSXSheet3")
  1066. if err := f.SetCellInt("XLSXSheet2", "A23", 56); err != nil {
  1067. return nil, err
  1068. }
  1069. if err := f.SetCellStr("Sheet1", "B20", "42"); err != nil {
  1070. return nil, err
  1071. }
  1072. f.SetActiveSheet(0)
  1073. err := f.AddPicture("Sheet1", "H2", filepath.Join("test", "images", "excel.gif"),
  1074. `{"x_scale": 0.5, "y_scale": 0.5, "positioning": "absolute"}`)
  1075. if err != nil {
  1076. return nil, err
  1077. }
  1078. err = f.AddPicture("Sheet1", "C2", filepath.Join("test", "images", "excel.png"), "")
  1079. if err != nil {
  1080. return nil, err
  1081. }
  1082. return f, nil
  1083. }
  1084. func prepareTestBook4() (*File, error) {
  1085. f := NewFile()
  1086. if err := f.SetColWidth("Sheet1", "B", "A", 12); err != nil {
  1087. return f, err
  1088. }
  1089. if err := f.SetColWidth("Sheet1", "A", "B", 12); err != nil {
  1090. return f, err
  1091. }
  1092. if _, err := f.GetColWidth("Sheet1", "A"); err != nil {
  1093. return f, err
  1094. }
  1095. if _, err := f.GetColWidth("Sheet1", "C"); err != nil {
  1096. return f, err
  1097. }
  1098. return f, nil
  1099. }
  1100. func fillCells(f *File, sheet string, colCount, rowCount int) {
  1101. for col := 1; col <= colCount; col++ {
  1102. for row := 1; row <= rowCount; row++ {
  1103. cell, _ := CoordinatesToCellName(col, row)
  1104. if err := f.SetCellStr(sheet, cell, cell); err != nil {
  1105. fmt.Println(err)
  1106. }
  1107. }
  1108. }
  1109. }
  1110. func BenchmarkOpenFile(b *testing.B) {
  1111. for i := 0; i < b.N; i++ {
  1112. if _, err := OpenFile(filepath.Join("test", "Book1.xlsx")); err != nil {
  1113. b.Error(err)
  1114. }
  1115. }
  1116. }