sheet_readstream_test.go

// Copyright (c) 2017 Andrey Gayvoronsky <plandem@gmail.com>
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package xlsx_test

import (
	"github.com/plandem/xlsx"
	"github.com/plandem/xlsx/types/options/sheet"
	"github.com/stretchr/testify/require"
	"testing"
)

//load content using multi phases or normal mode - must be same for both
func testSheetReadFull(t *testing.T, sheet xlsx.Sheet) {
	cols, rows := sheet.Dimension()
	require.Equal(t, 14, cols)
	require.Equal(t, 28, rows)

	emptyRow := []string{"", "", "", "", "", "", "", "", "", "", "", "", "", ""}
	values := [][]string{
		emptyRow,
		{"    with leading space", "", "merged rows", "", "merged cols", "merged cols", "merged cols", "", "", "", "", "", "", ""},
		{"", "", "merged rows", "", "", "", "", "", "", "", "", "", "", ""},
		{"", "", "merged rows", "", "merged rows+cols", "merged rows+cols", "merged rows+cols", "", "", "", "", "", "", ""},
		{"with trailing space   ", "", "merged rows", "", "merged rows+cols", "merged rows+cols", "merged rows+cols", "", "", "", "", "", "", ""},
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		{"", "", "", "1", "2", "3", "4", "5", "", "", "", "", "", ""},
		{"", "", "", "6", "7", "8", "9", "10", "", "", "", "", "", ""},
		{"", "", "", "11", "12", "13", "14", "15", "", "", "", "", "", ""},
		{"", "", "", "16", "17", "18", "19", "20", "", "", "", "", "", ""},
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		{"", "", "", "", "", "", "", "", "", "", "", "", "", "last cell"},
	}

	for rowIdx, rv := range values {
		require.Equal(t, rv, sheet.Row(rowIdx).Values())
	}
}

//load content using single phase only - it will be without merged cells info - only first cell from range will be output
func testSheetReadLimited(t *testing.T, sheet xlsx.Sheet) {
	cols, rows := sheet.Dimension()
	require.Equal(t, 14, cols)
	require.Equal(t, 28, rows)

	emptyRow := []string{"", "", "", "", "", "", "", "", "", "", "", "", "", ""}
	values := [][]string{
		emptyRow,
		{"    with leading space", "", "merged rows", "", "merged cols", "", "", "", "", "", "", "", "", ""},
		emptyRow,
		{"", "", "", "", "merged rows+cols", "", "", "", "", "", "", "", "", ""},
		{"with trailing space   ", "", "", "", "", "", "", "", "", "", "", "", "", ""},
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		{"", "", "", "1", "2", "3", "4", "5", "", "", "", "", "", ""},
		{"", "", "", "6", "7", "8", "9", "10", "", "", "", "", "", ""},
		{"", "", "", "11", "12", "13", "14", "15", "", "", "", "", "", ""},
		{"", "", "", "16", "17", "18", "19", "20", "", "", "", "", "", ""},
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		emptyRow,
		{"", "", "", "", "", "", "", "", "", "", "", "", "", "last cell"},
	}

	for rowIdx, rv := range values {
		require.Equal(t, rv, sheet.Row(rowIdx).Values())
	}
}

func TestSpreadsheet(t *testing.T) {
	xl, err := xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}

	defer xl.Close()

	type beforeTestFn func(t *testing.T, xl *xlsx.Spreadsheet) xlsx.Sheet
	type testFn func(t *testing.T, sheet xlsx.Sheet)

	sheetTests := []struct {
		name     string
		open     beforeTestFn
		callback testFn
	}{
		{
			"SheetReadStream_SinglePhased", func(t *testing.T, xl *xlsx.Spreadsheet) xlsx.Sheet { return xl.Sheet(0, xlsx.SheetModeStream) }, testSheetReadLimited,
		},
		{
			"SheetReadStream_MultiPhased", func(t *testing.T, xl *xlsx.Spreadsheet) xlsx.Sheet {
				return xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase)
			}, testSheetReadFull,
		},
		{
			"SheetReadWrite", func(t *testing.T, xl *xlsx.Spreadsheet) xlsx.Sheet { return xl.Sheet(0) }, testSheetReadFull,
		},
	}

	for _, info := range sheetTests {
		t.Run(info.name, func(tt *testing.T) {
			sheet := info.open(tt, xl)
			info.callback(tt, sheet)
		})
	}
}

func TestSheetReadStream_notImplemented(t *testing.T) {
	xl, err := xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}
	defer xl.Close()

	sheet := xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase)
	defer sheet.Close()

	require.Panics(t, func() { sheet.Col(0) })
	require.Panics(t, func() { sheet.Cols() })
	require.Panics(t, func() { sheet.InsertCol(0) })
	require.Panics(t, func() { sheet.InsertRow(0) })
	require.Panics(t, func() { sheet.DeleteRow(0) })
	require.Panics(t, func() { sheet.DeleteCol(0) })
	require.Panics(t, func() { sheet.SetDimension(100, 100) })
	require.Panics(t, func() { sheet.SetActive() })
	require.Panics(t, func() { sheet.SetOptions(options.New(options.Visibility(options.VisibilityVisible))) })
	require.Panics(t, func() { sheet.SetName("aaa") })
}

func TestSheetReadStream_access(t *testing.T) {
	xl, err := xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}

	defer xl.Close()

	sheet := xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase)
	defer sheet.Close()

	require.Equal(t, "8", sheet.CellByRef("F11").Value())
	require.Equal(t, "", sheet.CellByRef("F10").Value())
	require.Equal(t, "8", sheet.Cell(5, 10).Value())
	require.Equal(t, []string{"", "", "", "", "", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20"}, sheet.RangeByRef("D10:H13").Values())
}

func TestSheetReadStream_unsupported(t *testing.T) {
	xl, err := xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}

	defer xl.Close()
	sheet := xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase)
	defer sheet.Close()

	//SetString must not work in read-only mode
	require.Panics(t, func() { sheet.CellByRef("A1").SetText("a") })

	//SetValueWithStyles must not work in read-only mode
	require.Panics(t, func() { sheet.CellByRef("A1").SetValueWithFormat("a", "@") })

	//CopyTo/CopyToRef must not work in read-only mode
	require.Panics(t, func() { sheet.RangeByRef("A1:B1").CopyToRef("C2") })
}

func TestSheetReadStream_modes(t *testing.T) {
	xl, err := xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}

	//open as read-write and after as read-stream
	_ = xl.Sheet(0)
	require.Panics(t, func() { xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase) })
	xl.Close()

	xl, err = xlsx.Open("./test_files/example_simple.xlsx")
	if err != nil {
		panic(err)
	}
	defer xl.Close()

	//open as read-stream and after as read-write
	sheet := xl.Sheet(0, xlsx.SheetModeStream, xlsx.SheetModeMultiPhase)
	defer sheet.Close()
}