summaryrefslogtreecommitdiff
path: root/rows_test.go
diff options
context:
space:
mode:
authorVeniamin Albaev <albenik@gmail.com>2019-03-06 16:40:45 +0300
committerxuri <xuri.me@gmail.com>2019-03-06 21:40:45 +0800
commit12c1e2481e3f9f3c3c12a938484f04b12d5dede8 (patch)
tree30c84b5ae2f26e0b97aa965307dad50c2b4d60aa /rows_test.go
parentf66212da9bab1c39ab791d41881c70ae7ba00c20 (diff)
Implement consistent row addressing by Excel row number starting with 1 (#350)
* Implement consistent row addressing by Excel row number starting with 1 1. Added second versions for all row manipulation methods with zero-based row addressing. 2. Fixed methods documentation to explicitly describe which row addressing used in method. 3. Added WARNING to README.md. 4. Cosmetic change: All row test moved to file `rows_test.go`. * TravisCI: go1.12 added to tests matrix * BACKWARD INCOMPARTIBLE: Use only Excel numbering logic from 1 row * README updated
Diffstat (limited to 'rows_test.go')
-rw-r--r--rows_test.go507
1 files changed, 507 insertions, 0 deletions
diff --git a/rows_test.go b/rows_test.go
new file mode 100644
index 0000000..26fcb47
--- /dev/null
+++ b/rows_test.go
@@ -0,0 +1,507 @@
+package excelize
+
+import (
+ "fmt"
+ "path/filepath"
+ "strconv"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+)
+
+func TestRows(t *testing.T) {
+ xlsx, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
+ if !assert.NoError(t, err) {
+ t.FailNow()
+ }
+
+ rows, err := xlsx.Rows("Sheet2")
+ if !assert.NoError(t, err) {
+ t.FailNow()
+ }
+
+ rowStrs := make([][]string, 0)
+ var i = 0
+ for rows.Next() {
+ i++
+ columns := rows.Columns()
+ rowStrs = append(rowStrs, columns)
+ }
+
+ if !assert.NoError(t, rows.Error()) {
+ t.FailNow()
+ }
+
+ dstRows := xlsx.GetRows("Sheet2")
+ if !assert.Equal(t, len(rowStrs), len(dstRows)) {
+ t.FailNow()
+ }
+
+ for i := 0; i < len(rowStrs); i++ {
+ if !assert.Equal(t, trimSliceSpace(dstRows[i]), trimSliceSpace(rowStrs[i])) {
+ t.FailNow()
+ }
+ }
+}
+
+func TestRowsError(t *testing.T) {
+ xlsx, err := OpenFile(filepath.Join("test", "Book1.xlsx"))
+ if !assert.NoError(t, err) {
+ t.FailNow()
+ }
+ _, err = xlsx.Rows("SheetN")
+ assert.EqualError(t, err, "Sheet SheetN is not exist")
+}
+
+func TestRowHeight(t *testing.T) {
+ xlsx := NewFile()
+ sheet1 := xlsx.GetSheetName(1)
+
+ xlsx.SetRowHeight(sheet1, 0, defaultRowHeightPixels+1.0) // should no effect
+ assert.Equal(t, defaultRowHeightPixels, xlsx.GetRowHeight("Sheet1", 0))
+
+ xlsx.SetRowHeight(sheet1, 1, 111.0)
+ assert.Equal(t, 111.0, xlsx.GetRowHeight(sheet1, 1))
+
+ xlsx.SetRowHeight(sheet1, 4, 444.0)
+ assert.Equal(t, 444.0, xlsx.GetRowHeight(sheet1, 4))
+
+ err := xlsx.SaveAs(filepath.Join("test", "TestRowHeight.xlsx"))
+ if !assert.NoError(t, err) {
+ t.FailNow()
+ }
+
+ convertColWidthToPixels(0)
+}
+
+func TestRemoveRow(t *testing.T) {
+ xlsx := NewFile()
+ sheet1 := xlsx.GetSheetName(1)
+ r := xlsx.workSheetReader(sheet1)
+
+ const (
+ cellCount = 10
+ rowCount = 10
+ )
+ for j := 1; j <= cellCount; j++ {
+ for i := 1; i <= rowCount; i++ {
+ axis := ToAlphaString(i) + strconv.Itoa(j)
+ xlsx.SetCellStr(sheet1, axis, axis)
+ }
+ }
+ xlsx.SetCellHyperLink(sheet1, "A5", "https://github.com/360EntSecGroup-Skylar/excelize", "External")
+
+ xlsx.RemoveRow(sheet1, -1)
+ if !assert.Len(t, r.SheetData.Row, rowCount) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 0)
+ if !assert.Len(t, r.SheetData.Row, rowCount) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 4)
+ if !assert.Len(t, r.SheetData.Row, rowCount-1) {
+ t.FailNow()
+ }
+
+ xlsx.MergeCell(sheet1, "B3", "B5")
+
+ xlsx.RemoveRow(sheet1, 2)
+ if !assert.Len(t, r.SheetData.Row, rowCount-2) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 4)
+ if !assert.Len(t, r.SheetData.Row, rowCount-3) {
+ t.FailNow()
+ }
+
+ err := xlsx.AutoFilter(sheet1, "A2", "A2", `{"column":"A","expression":"x != blanks"}`)
+ if !assert.NoError(t, err) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 1)
+ if !assert.Len(t, r.SheetData.Row, rowCount-4) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 2)
+ if !assert.Len(t, r.SheetData.Row, rowCount-5) {
+ t.FailNow()
+ }
+
+ xlsx.RemoveRow(sheet1, 1)
+ if !assert.Len(t, r.SheetData.Row, rowCount-6) {
+ t.FailNow()
+ }
+
+ assert.NoError(t, xlsx.SaveAs(filepath.Join("test", "TestRemoveRow.xlsx")))
+}
+
+func TestInsertRow(t *testing.T) {
+ xlsx := NewFile()
+ sheet1 := xlsx.GetSheetName(1)
+ r := xlsx.workSheetReader(sheet1)
+
+ const (
+ cellCount = 10
+ rowCount = 10
+ )
+ for j := 1; j <= cellCount; j++ {
+ for i := 1; i < rowCount; i++ {
+ axis := ToAlphaString(i) + strconv.Itoa(j)
+ xlsx.SetCellStr(sheet1, axis, axis)
+ }
+ }
+ xlsx.SetCellHyperLink(sheet1, "A5", "https://github.com/360EntSecGroup-Skylar/excelize", "External")
+
+ xlsx.InsertRow(sheet1, -1)
+ if !assert.Len(t, r.SheetData.Row, rowCount) {
+ t.FailNow()
+ }
+
+ xlsx.InsertRow(sheet1, 0)
+ if !assert.Len(t, r.SheetData.Row, rowCount) {
+ t.FailNow()
+ }
+
+ xlsx.InsertRow(sheet1, 1)
+ if !assert.Len(t, r.SheetData.Row, rowCount+1) {
+ t.FailNow()
+ }
+
+ xlsx.InsertRow(sheet1, 4)
+ if !assert.Len(t, r.SheetData.Row, rowCount+2) {
+ t.FailNow()
+ }
+
+ assert.NoError(t, xlsx.SaveAs(filepath.Join("test", "TestInsertRow.xlsx")))
+}
+
+// Testing internal sructure state after insert operations.
+// It is important for insert workflow to be constant to avoid side effect with functions related to internal structure.
+func TestInsertRowInEmptyFile(t *testing.T) {
+ xlsx := NewFile()
+ sheet1 := xlsx.GetSheetName(1)
+ r := xlsx.workSheetReader(sheet1)
+ xlsx.InsertRow(sheet1, 1)
+ assert.Len(t, r.SheetData.Row, 0)
+ xlsx.InsertRow(sheet1, 2)
+ assert.Len(t, r.SheetData.Row, 0)
+ xlsx.InsertRow(sheet1, 99)
+ assert.Len(t, r.SheetData.Row, 0)
+ assert.NoError(t, xlsx.SaveAs(filepath.Join("test", "TestInsertRowInEmptyFile.xlsx")))
+}
+
+func TestDuplicateRow(t *testing.T) {
+ const sheet = "Sheet1"
+ outFile := filepath.Join("test", "TestDuplicateRow.%s.xlsx")
+
+ cells := map[string]string{
+ "A1": "A1 Value",
+ "A2": "A2 Value",
+ "A3": "A3 Value",
+ "B1": "B1 Value",
+ "B2": "B2 Value",
+ "B3": "B3 Value",
+ }
+
+ newFileWithDefaults := func() *File {
+ f := NewFile()
+ for cell, val := range cells {
+ f.SetCellStr(sheet, cell, val)
+
+ }
+ return f
+ }
+
+ t.Run("FromSingleRow", func(t *testing.T) {
+ xlsx := NewFile()
+ xlsx.SetCellStr(sheet, "A1", cells["A1"])
+ xlsx.SetCellStr(sheet, "B1", cells["B1"])
+
+ xlsx.DuplicateRow(sheet, 1)
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.FromSingleRow_1"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A1"], "B2": cells["B1"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+
+ xlsx.DuplicateRow(sheet, 2)
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.FromSingleRow_2"))) {
+ t.FailNow()
+ }
+ expect = map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A1"], "B2": cells["B1"],
+ "A3": cells["A1"], "B3": cells["B1"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("UpdateDuplicatedRows", func(t *testing.T) {
+ xlsx := NewFile()
+ xlsx.SetCellStr(sheet, "A1", cells["A1"])
+ xlsx.SetCellStr(sheet, "B1", cells["B1"])
+
+ xlsx.DuplicateRow(sheet, 1)
+
+ xlsx.SetCellStr(sheet, "A2", cells["A2"])
+ xlsx.SetCellStr(sheet, "B2", cells["B2"])
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.UpdateDuplicatedRows"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A2"], "B2": cells["B2"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("FirstOfMultipleRows", func(t *testing.T) {
+ xlsx := newFileWithDefaults()
+
+ xlsx.DuplicateRow(sheet, 1)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.FirstOfMultipleRows"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A1"], "B2": cells["B1"],
+ "A3": cells["A2"], "B3": cells["B2"],
+ "A4": cells["A3"], "B4": cells["B3"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("ZeroWithNoRows", func(t *testing.T) {
+ xlsx := NewFile()
+
+ xlsx.DuplicateRow(sheet, 0)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.ZeroWithNoRows"))) {
+ t.FailNow()
+ }
+ assert.Equal(t, "", xlsx.GetCellValue(sheet, "A1"))
+ assert.Equal(t, "", xlsx.GetCellValue(sheet, "B1"))
+ assert.Equal(t, "", xlsx.GetCellValue(sheet, "A2"))
+ assert.Equal(t, "", xlsx.GetCellValue(sheet, "B2"))
+ expect := map[string]string{
+ "A1": "", "B1": "",
+ "A2": "", "B2": "",
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("MiddleRowOfEmptyFile", func(t *testing.T) {
+ xlsx := NewFile()
+
+ xlsx.DuplicateRow(sheet, 99)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.MiddleRowOfEmptyFile"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A98": "",
+ "A99": "",
+ "A100": "",
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("WithLargeOffsetToMiddleOfData", func(t *testing.T) {
+ xlsx := newFileWithDefaults()
+
+ xlsx.DuplicateRowTo(sheet, 1, 3)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.WithLargeOffsetToMiddleOfData"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A2"], "B2": cells["B2"],
+ "A3": cells["A1"], "B3": cells["B1"],
+ "A4": cells["A3"], "B4": cells["B3"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("WithLargeOffsetToEmptyRows", func(t *testing.T) {
+ xlsx := newFileWithDefaults()
+
+ xlsx.DuplicateRowTo(sheet, 1, 7)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.WithLargeOffsetToEmptyRows"))) {
+ t.FailNow()
+ }
+ expect := map[string]string{
+ "A1": cells["A1"], "B1": cells["B1"],
+ "A2": cells["A2"], "B2": cells["B2"],
+ "A3": cells["A3"], "B3": cells["B3"],
+ "A7": cells["A1"], "B7": cells["B1"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("InsertBefore", func(t *testing.T) {
+ xlsx := newFileWithDefaults()
+
+ xlsx.DuplicateRowTo(sheet, 2, 1)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.InsertBefore"))) {
+ t.FailNow()
+ }
+
+ expect := map[string]string{
+ "A1": cells["A2"], "B1": cells["B2"],
+ "A2": cells["A1"], "B2": cells["B1"],
+ "A3": cells["A2"], "B3": cells["B2"],
+ "A4": cells["A3"], "B4": cells["B3"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell), cell) {
+ t.FailNow()
+ }
+ }
+ })
+
+ t.Run("InsertBeforeWithLargeOffset", func(t *testing.T) {
+ xlsx := newFileWithDefaults()
+
+ xlsx.DuplicateRowTo(sheet, 3, 1)
+
+ if !assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, "TestDuplicateRow.InsertBeforeWithLargeOffset"))) {
+ t.FailNow()
+ }
+
+ expect := map[string]string{
+ "A1": cells["A3"], "B1": cells["B3"],
+ "A2": cells["A1"], "B2": cells["B1"],
+ "A3": cells["A2"], "B3": cells["B2"],
+ "A4": cells["A3"], "B4": cells["B3"],
+ }
+ for cell, val := range expect {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, cell)) {
+ t.FailNow()
+ }
+ }
+ })
+}
+
+func TestDuplicateRowInvalidRownum(t *testing.T) {
+ const sheet = "Sheet1"
+ outFile := filepath.Join("test", "TestDuplicateRowInvalidRownum.%s.xlsx")
+
+ cells := map[string]string{
+ "A1": "A1 Value",
+ "A2": "A2 Value",
+ "A3": "A3 Value",
+ "B1": "B1 Value",
+ "B2": "B2 Value",
+ "B3": "B3 Value",
+ }
+
+ testRows := []int{-2, -1}
+
+ testRowPairs := []struct {
+ row1 int
+ row2 int
+ }{
+ {-1, -1},
+ {-1, 0},
+ {-1, 1},
+ {0, -1},
+ {0, 0},
+ {0, 1},
+ {1, -1},
+ {1, 1},
+ {1, 0},
+ }
+
+ for i, row := range testRows {
+ name := fmt.Sprintf("TestRow_%d", i+1)
+ t.Run(name, func(t *testing.T) {
+ xlsx := NewFile()
+ for col, val := range cells {
+ xlsx.SetCellStr(sheet, col, val)
+ }
+ xlsx.DuplicateRow(sheet, row)
+
+ for col, val := range cells {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, col)) {
+ t.FailNow()
+ }
+ }
+ assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, name)))
+ })
+ }
+
+ for i, pair := range testRowPairs {
+ name := fmt.Sprintf("TestRowPair_%d", i+1)
+ t.Run(name, func(t *testing.T) {
+ xlsx := NewFile()
+ for col, val := range cells {
+ xlsx.SetCellStr(sheet, col, val)
+ }
+ xlsx.DuplicateRowTo(sheet, pair.row1, pair.row2)
+
+ for col, val := range cells {
+ if !assert.Equal(t, val, xlsx.GetCellValue(sheet, col)) {
+ t.FailNow()
+ }
+ }
+ assert.NoError(t, xlsx.SaveAs(fmt.Sprintf(outFile, name)))
+ })
+ }
+}
+
+func trimSliceSpace(s []string) []string {
+ for {
+ if len(s) > 0 && s[len(s)-1] == "" {
+ s = s[:len(s)-1]
+ } else {
+ break
+ }
+ }
+ return s
+}
generated by cgit v1.2.1 (git 2.18.0) at 2025-04-21 06:14:56 +0000