testfixtures

README

Go Test Fixtures

Warning: this package will wipe the database data before loading the fixtures! It is supposed to be used on a test database. Please, double check if you are running it against the correct database.

Writing tests is hard, even more when you have to deal with an SQL database. This package aims to make writing functional tests for web apps written in Go easier.

Basically this package mimics the "Rails' way" of writing tests for database applications, where sample data is kept in fixtures files. Before the execution of every test, the test database is cleaned and the fixture data is loaded in the database.

The idea is running tests in a real database, instead of relying in mocks, which is boring to setup and may lead to production bugs not to being catch in the tests.

Installation

First, get it:

go get gopkg.in/testfixtures.v1

Usage

Create a folder for the fixture files. Each file should contain data for a single table and have the name <table-name>.yml:

myapp
  - myapp.go
  - myapp_test.go
  - ...
  - fixtures:
    - posts.yml
    - comments.yml
    - tags.yml
    - posts_tags.yml
    - ...

The file would look like this (it can have as many record you want):

# comments.yml
-
    id: 1
    post_id: 1
    content: This post is awesome!
    author_name: John Doe
    author_email: john@doe.com
    created_at: 2016-01-01 12:30:12
    updated_at: 2016-01-01 12:30:12

-
    id: 1
    post_id: 2
    content: Are you kidding me?
    author_name: John Doe
    author_email: john@doe.com
    created_at: 2016-01-01 12:30:12
    updated_at: 2016-01-01 12:30:12

Your tests would look like this:

package myapp

import (
    "database/sql"
    "log"

    _ "github.com/lib/pq"
    "gopkg.in/testfixtures.v1"
)

const FIXTURES_PATH = "fixtures"

func TestMain(m *testing.M) {
    // Open connection with the test database.
    // Do NOT import fixtures in a production database!
    // Existing data would be deleted
    db, _ := sql.Open("postgres", "dbname=myapp_test")

    os.Exit(m.Run())
}

func prepareTestDatabase() {
    err = testfixtures.LoadFixtures(FIXTURES_PATH, db, &testfixtures.PostgreSQLHelper{})
    if err != nil {
        log.Fatal(err)
    }
}

func TestX(t *testing.T) {
    prepareTestDatabase()
    // your test here ...
}

func TestY(t *testing.T) {
    prepareTestDatabase()
    // your test here ...
}

func TestZ(t *testing.T) {
    prepareTestDatabase()
    // your test here ...
}

Compatible databases

For now, only PostgreSQL. Contributions are welcome to add support for more.

Documentation

Index

• func LoadFixtures(foldername string, db *sql.DB, h DataBaseHelper) error
• type DataBaseHelper
• type FixtureFile
  • func (f *FixtureFile) Delete(tx *sql.Tx) error
  • func (f *FixtureFile) FileNameWithoutExtension() string
  • func (f *FixtureFile) Insert(tx *sql.Tx) error
• type PostgreSQLHelper
  • func (h *PostgreSQLHelper) AfterLoad(db *sql.DB) error
  • func (h *PostgreSQLHelper) BeforeLoad(db *sql.DB) error
  • func (h *PostgreSQLHelper) DisableTriggers(db *sql.DB) error
  • func (h *PostgreSQLHelper) EnableTriggers(db *sql.DB) error
  • func (h *PostgreSQLHelper) GetSequences(db *sql.DB) ([]string, error)
  • func (h *PostgreSQLHelper) GetTables(db *sql.DB) ([]string, error)
  • func (h *PostgreSQLHelper) ResetSequences(db *sql.DB) error

Functions

func LoadFixtures

func LoadFixtures(foldername string, db *sql.DB, h DataBaseHelper) error

LoadFixtures loads all fixtures in a given folder in the database

Types

type DataBaseHelper

type DataBaseHelper interface {
	DisableTriggers(db *sql.DB) error
	EnableTriggers(db *sql.DB) error
	BeforeLoad(db *sql.DB) error
	AfterLoad(db *sql.DB) error
}

DataBaseHelper is the generic interface for the database helper

type FixtureFile

type FixtureFile struct {
	Path     string
	FileName string
	Content  []byte
}

FixtureFile represents a fixture file

func (*FixtureFile) Delete

func (f *FixtureFile) Delete(tx *sql.Tx) error

Delete deletes all records of the table

func (*FixtureFile) FileNameWithoutExtension

func (f *FixtureFile) FileNameWithoutExtension() string

FileNameWithoutExtension returns the filename without the extension e.g.: posts.yml -> posts

func (*FixtureFile) Insert

func (f *FixtureFile) Insert(tx *sql.Tx) error

Insert insert the records in the file in the database

type PostgreSQLHelper

type PostgreSQLHelper struct {
}

PostgreSQLHelper is the PG helper for this package

func (*PostgreSQLHelper) AfterLoad

func (h *PostgreSQLHelper) AfterLoad(db *sql.DB) error

AfterLoad runs after the fixture load

func (*PostgreSQLHelper) BeforeLoad

func (h *PostgreSQLHelper) BeforeLoad(db *sql.DB) error

BeforeLoad runs before the fixture load by now, does nothing

func (*PostgreSQLHelper) DisableTriggers

func (h *PostgreSQLHelper) DisableTriggers(db *sql.DB) error

DisableTriggers disable referential integrity triggers

func (*PostgreSQLHelper) EnableTriggers

func (h *PostgreSQLHelper) EnableTriggers(db *sql.DB) error

EnableTriggers enable referential integrity triggers

func (*PostgreSQLHelper) GetSequences

func (h *PostgreSQLHelper) GetSequences(db *sql.DB) ([]string, error)

GetSequences get all sequences of the database

func (*PostgreSQLHelper) GetTables

func (h *PostgreSQLHelper) GetTables(db *sql.DB) ([]string, error)

GetTables get all tables of the database

func (*PostgreSQLHelper) ResetSequences

func (h *PostgreSQLHelper) ResetSequences(db *sql.DB) error

ResetSequences resets the sequences of "id"s columns assumes the primery key is "id" and sequence is "<tablename>_id_seq", the default when using the SERIAL column type