fix

README

fix - Golden Files Testing library for Go

This library, like Ruby's vcr, serializes the results once executed and saves them as a file. You can easily write tests to verify that the code outputs the same results as in the past, even after modifying the code.

go get github.com/juntaki/fix

How to use

Append code like below to your tests. and Run test twice.

err := fix.Fix(&output) // output is dumped to a file.
if err != nil {
  t.Fatal(err)
}

First test will fail, because juntaki/fix writes serialized data to file. From the second time, the test will pass, if output is the same as first output.

Documentation

Index

• Variables
• func DefaultOutputPath(funcName string, additional ...string) string
• func Fix(target interface{}, additional ...string) error
• func SetOutputPathFunc(in func(funcName string, additional ...string) string)
• type Codec
  • func (c *Codec) Fix(target interface{}, additional ...string) error

Variables

var (
	// JSON is a Codec that uses the json package.
	JSON = Codec{jsonMarshal, jsonCompare}
	// PP is a Codec that uses the pp package.
	PP = Codec{ppMarshal, ppCompare}
)

Functions

func DefaultOutputPath

func DefaultOutputPath(funcName string, additional ...string) string

DefaultOutputPath is ./testdata/<caller_func_name>

func Fix

func Fix(target interface{}, additional ...string) error

Fix uses PP codec as default

func SetOutputPathFunc

func SetOutputPathFunc(in func(funcName string, additional ...string) string)

SetOutputPathFunc overwrite DefaultOutputPath

Types

type Codec

type Codec struct {
	Marshal func(interface{}) ([]byte, error)
	Compare func(old, new []byte) error
}

Codec is functions to store structure to file.

func (*Codec) Fix

func (c *Codec) Fix(target interface{}, additional ...string) error

Fix target pointer as codec encoded data file. if file doesn't exist, just write data to file and return error. if file exist, test if the target is the same as file's data.