1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
|
package goldie
import (
"bytes"
"encoding/json"
"encoding/xml"
"errors"
"fmt"
"io/ioutil"
"os"
"testing"
"text/template"
)
// Assert compares the actual data received with the expected data in the
// golden files. If the update flag is set, it will also update the golden
// file.
//
// `name` refers to the name of the test and it should typically be unique
// within the package. Also it should be a valid file name (so keeping to
// `a-z0-9\-\_` is a good idea).
func (g *Goldie) Assert(t *testing.T, name string, actualData []byte) {
t.Helper()
if *update {
err := g.Update(t, name, actualData)
if err != nil {
t.Error(err)
t.FailNow()
}
}
err := g.compare(t, name, actualData)
if err != nil {
{
var e *errFixtureNotFound
if errors.As(err, &e) {
t.Error(err)
t.FailNow()
return
}
}
{
var e *errFixtureMismatch
if errors.As(err, &e) {
t.Error(err)
return
}
}
t.Error(err)
}
}
// AssertJson compares the actual json data received with expected data in the
// golden files. If the update flag is set, it will also update the golden
// file.
//
// `name` refers to the name of the test and it should typically be unique
// within the package. Also it should be a valid file name (so keeping to
// `a-z0-9\-\_` is a good idea).
func (g *Goldie) AssertJson(t *testing.T, name string, actualJsonData interface{}) {
t.Helper()
js, err := json.MarshalIndent(actualJsonData, "", " ")
if err != nil {
t.Error(err)
t.FailNow()
}
g.Assert(t, name, normalizeLF(js))
}
// AssertXml compares the actual xml data received with expected data in the
// golden files. If the update flag is set, it will also update the golden
// file.
//
// `name` refers to the name of the test and it should typically be unique
// within the package. Also it should be a valid file name (so keeping to
// `a-z0-9\-\_` is a good idea).
func (g *Goldie) AssertXml(t *testing.T, name string, actualXmlData interface{}) {
t.Helper()
x, err := xml.MarshalIndent(actualXmlData, "", " ")
if err != nil {
t.Error(err)
t.FailNow()
}
g.Assert(t, name, normalizeLF(x))
}
// normalizeLF normalizes line feed character set across os (es)
// \r\n (windows) & \r (mac) into \n (unix)
func normalizeLF(d []byte) []byte {
// if empty / nil return as is
if len(d) == 0 {
return d
}
// replace CR LF \r\n (windows) with LF \n (unix)
d = bytes.Replace(d, []byte{13, 10}, []byte{10}, -1)
// replace CF \r (mac) with LF \n (unix)
d = bytes.Replace(d, []byte{13}, []byte{10}, -1)
return d
}
// Assert compares the actual data received with the expected data in the
// golden files after executing it as a template with data parameter. If the
// update flag is set, it will also update the golden file. `name` refers to
// the name of the test and it should typically be unique within the package.
// Also it should be a valid file name (so keeping to `a-z0-9\-\_` is a good
// idea).
func (g *Goldie) AssertWithTemplate(t *testing.T, name string, data interface{}, actualData []byte) {
t.Helper()
if *update {
err := g.Update(t, name, actualData)
if err != nil {
t.Error(err)
t.FailNow()
}
}
err := g.compareTemplate(t, name, data, actualData)
if err != nil {
{
var e *errFixtureNotFound
if errors.As(err, &e) {
t.Error(err)
t.FailNow()
return
}
}
{
var e *errFixtureMismatch
if errors.As(err, &e) {
t.Error(err)
return
}
}
t.Error(err)
}
}
// compare is reading the golden fixture file and compare the stored data with
// the actual data.
func (g *Goldie) compare(t *testing.T, name string, actualData []byte) error {
expectedData, err := ioutil.ReadFile(g.GoldenFileName(t, name))
if err != nil {
if os.IsNotExist(err) {
return newErrFixtureNotFound()
}
return fmt.Errorf("expected %s to be nil", err.Error())
}
if !bytes.Equal(actualData, expectedData) {
msg := "Result did not match the golden fixture. Diff is below:\n\n"
actual := string(actualData)
expected := string(expectedData)
if g.diffFn != nil {
msg += g.diffFn(actual, expected)
} else {
msg += Diff(g.diffEngine, actual, expected)
}
return newErrFixtureMismatch(msg)
}
return nil
}
// compareTemplate is reading the golden fixture file and compare the stored
// data with the actual data.
func (g *Goldie) compareTemplate(t *testing.T, name string, data interface{}, actualData []byte) error {
expectedDataTmpl, err := ioutil.ReadFile(g.GoldenFileName(t, name))
if err != nil {
if os.IsNotExist(err) {
return newErrFixtureNotFound()
}
return fmt.Errorf("expected %s to be nil", err.Error())
}
missingKey := "error"
if g.ignoreTemplateErrors {
missingKey = "default"
}
tmpl, err := template.New("test").Option("missingkey=" + missingKey).Parse(string(expectedDataTmpl))
if err != nil {
return fmt.Errorf("expected %s to be nil", err.Error())
}
var expectedData bytes.Buffer
err = tmpl.Execute(&expectedData, data)
if err != nil {
return newErrMissingKey(fmt.Sprintf("Template error: %s", err.Error()))
}
if !bytes.Equal(actualData, expectedData.Bytes()) {
msg := "Result did not match the golden fixture. Diff is below:\n\n"
actual := string(actualData)
expected := expectedData.String()
if g.diffFn != nil {
msg += g.diffFn(actual, expected)
} else {
msg += Diff(g.diffEngine, actual, expected)
}
return newErrFixtureMismatch(msg)
}
return nil
}
|