Skip to content

Commit

Permalink
test: adding stdlib tests
Browse files Browse the repository at this point in the history
  • Loading branch information
samber committed Dec 5, 2024
1 parent 743d5ad commit 445ad7e
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![Contributors](https://img.shields.io/github/contributors/samber/go-safe-csv-writer)](https://github.com/samber/go-safe-csv-writer/graphs/contributors)
[![License](https://img.shields.io/github/license/samber/go-safe-csv-writer)](./LICENSE)

A fork of `encoding/csv` package from Go stdlib, preventing CSV injection and data exfiltration, while maintaining compatibility with the original library.
A fork of `encoding/csv` (go v1.23.4) package from Go stdlib, preventing CSV injection and data exfiltration, while maintaining compatibility with the original library.

## 🥷 Attack vector

Expand Down
File renamed without changes.
109 changes: 109 additions & 0 deletions writer_stdlib_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
package csv

import (
"bytes"
"errors"
"strings"
"testing"
)

var writeTests = []struct {
Input [][]string
Output string
Error error
UseCRLF bool
Comma rune
}{
{Input: [][]string{{"abc"}}, Output: "abc\n"},
{Input: [][]string{{"abc"}}, Output: "abc\r\n", UseCRLF: true},
{Input: [][]string{{`"abc"`}}, Output: `"""abc"""` + "\n"},
{Input: [][]string{{`a"b`}}, Output: `"a""b"` + "\n"},
{Input: [][]string{{`"a"b"`}}, Output: `"""a""b"""` + "\n"},
{Input: [][]string{{" abc"}}, Output: `" abc"` + "\n"},
{Input: [][]string{{"abc,def"}}, Output: `"abc,def"` + "\n"},
{Input: [][]string{{"abc", "def"}}, Output: "abc,def\n"},
{Input: [][]string{{"abc"}, {"def"}}, Output: "abc\ndef\n"},
{Input: [][]string{{"abc\ndef"}}, Output: "\"abc\ndef\"\n"},
{Input: [][]string{{"abc\ndef"}}, Output: "\"abc\r\ndef\"\r\n", UseCRLF: true},
{Input: [][]string{{"abc\rdef"}}, Output: "\"abcdef\"\r\n", UseCRLF: true},
{Input: [][]string{{"abc\rdef"}}, Output: "\"abc\rdef\"\n", UseCRLF: false},
{Input: [][]string{{""}}, Output: "\n"},
{Input: [][]string{{"", ""}}, Output: ",\n"},
{Input: [][]string{{"", "", ""}}, Output: ",,\n"},
{Input: [][]string{{"", "", "a"}}, Output: ",,a\n"},
{Input: [][]string{{"", "a", ""}}, Output: ",a,\n"},
{Input: [][]string{{"", "a", "a"}}, Output: ",a,a\n"},
{Input: [][]string{{"a", "", ""}}, Output: "a,,\n"},
{Input: [][]string{{"a", "", "a"}}, Output: "a,,a\n"},
{Input: [][]string{{"a", "a", ""}}, Output: "a,a,\n"},
{Input: [][]string{{"a", "a", "a"}}, Output: "a,a,a\n"},
{Input: [][]string{{`\.`}}, Output: "\"\\.\"\n"},
{Input: [][]string{{"x09\x41\xb4\x1c", "aktau"}}, Output: "x09\x41\xb4\x1c,aktau\n"},
{Input: [][]string{{",x09\x41\xb4\x1c", "aktau"}}, Output: "\",x09\x41\xb4\x1c\",aktau\n"},
{Input: [][]string{{"a", "a", ""}}, Output: "a|a|\n", Comma: '|'},
{Input: [][]string{{",", ",", ""}}, Output: ",|,|\n", Comma: '|'},
{Input: [][]string{{"foo"}}, Comma: '"', Error: errInvalidDelim},
}

func TestWrite(t *testing.T) {
for n, tt := range writeTests {
b := &strings.Builder{}
f := NewSafeWriter(b, SafetyOpts{})
f.UseCRLF = tt.UseCRLF
if tt.Comma != 0 {
f.Comma = tt.Comma
}
err := f.WriteAll(tt.Input)
if err != tt.Error {
t.Errorf("Unexpected error:\ngot %v\nwant %v", err, tt.Error)
}
out := b.String()
if out != tt.Output {
t.Errorf("#%d: out=%q want %q", n, out, tt.Output)
}
}
}

type errorWriter struct{}

func (e errorWriter) Write(b []byte) (int, error) {
return 0, errors.New("Test")
}

func TestError(t *testing.T) {
b := &bytes.Buffer{}
f := NewSafeWriter(b, SafetyOpts{})
f.Write([]string{"abc"})

Check failure on line 76 in writer_stdlib_test.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `f.Write` is not checked (errcheck)
f.Flush()
err := f.Error()

if err != nil {
t.Errorf("Unexpected error: %s\n", err)
}

f = NewSafeWriter(errorWriter{}, SafetyOpts{})
f.Write([]string{"abc"})

Check failure on line 85 in writer_stdlib_test.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `f.Write` is not checked (errcheck)
f.Flush()
err = f.Error()

if err == nil {
t.Error("Error should not be nil")
}
}

var benchmarkWriteData = [][]string{
{"abc", "def", "12356", "1234567890987654311234432141542132"},
{"abc", "def", "12356", "1234567890987654311234432141542132"},
{"abc", "def", "12356", "1234567890987654311234432141542132"},
}

func BenchmarkWrite(b *testing.B) {
for i := 0; i < b.N; i++ {
w := NewSafeWriter(&bytes.Buffer{}, SafetyOpts{})
err := w.WriteAll(benchmarkWriteData)
if err != nil {
b.Fatal(err)
}
w.Flush()
}
}

0 comments on commit 445ad7e

Please sign in to comment.