featurebase/db_test.go

package pilosa_test

import (
	"io/ioutil"
	"os"
	"testing"

	"github.com/pilosa/pilosa"
)

// Ensure database can open and retrieve a frame.
func TestDB_CreateFrameIfNotExists(t *testing.T) {
	db := MustOpenDB()
	defer db.Close()

	// Create frame.
	f, err := db.CreateFrameIfNotExists("f", pilosa.FrameOptions{})
	if err != nil {
		t.Fatal(err)
	} else if f == nil {
		t.Fatal("expected frame")
	}

	// Retrieve existing frame.
	other, err := db.CreateFrameIfNotExists("f", pilosa.FrameOptions{})
	if err != nil {
		t.Fatal(err)
	} else if f.Frame != other.Frame {
		t.Fatal("frame mismatch")
	}

	if f.Frame != db.Frame("f") {
		t.Fatal("frame mismatch")
	}
}

// Ensure database defaults the time quantum on new frames.
func TestDB_CreateFrame_TimeQuantum(t *testing.T) {
	db := MustOpenDB()
	defer db.Close()

	// Set database time quantum.
	if err := db.SetTimeQuantum(pilosa.TimeQuantum("YM")); err != nil {
		t.Fatal(err)
	}

	// Create frame.
	f, err := db.CreateFrame("f", pilosa.FrameOptions{})
	if err != nil {
		t.Fatal(err)
	} else if q := f.TimeQuantum(); q != pilosa.TimeQuantum("YM") {
		t.Fatalf("unexpected frame time quantum: %s", q)
	}
}

// Ensure database can delete a frame.
func TestDB_DeleteFrame(t *testing.T) {
	db := MustOpenDB()
	defer db.Close()

	// Create frame.
	if _, err := db.CreateFrameIfNotExists("f", pilosa.FrameOptions{}); err != nil {
		t.Fatal(err)
	}

	// Delete frame & verify it's gone.
	if err := db.DeleteFrame("f"); err != nil {
		t.Fatal(err)
	} else if db.Frame("f") != nil {
		t.Fatal("expected nil frame")
	}

	// Delete again to make sure it doesn't error.
	if err := db.DeleteFrame("f"); err != nil {
		t.Fatal(err)
	}
}

// Ensure database can set the default time quantum.
func TestDB_SetTimeQuantum(t *testing.T) {
	db := MustOpenDB()
	defer db.Close()

	// Set & retrieve time quantum.
	if err := db.SetTimeQuantum(pilosa.TimeQuantum("YMDH")); err != nil {
		t.Fatal(err)
	} else if q := db.TimeQuantum(); q != pilosa.TimeQuantum("YMDH") {
		t.Fatalf("unexpected quantum: %s", q)
	}

	// Reload database and verify that it is persisted.
	if err := db.Reopen(); err != nil {
		t.Fatal(err)
	} else if q := db.TimeQuantum(); q != pilosa.TimeQuantum("YMDH") {
		t.Fatalf("unexpected quantum (reopen): %s", q)
	}
}

// DB represents a test wrapper for pilosa.DB.
type DB struct {
	*pilosa.DB
}

// NewDB returns a new instance of DB d.
func NewDB() *DB {
	path, err := ioutil.TempDir("", "pilosa-db-")
	if err != nil {
		panic(err)
	}
	db, err := pilosa.NewDB(path, "d")
	if err != nil {
		panic(err)
	}
	return &DB{DB: db}
}

// MustOpenDB returns a new, opened database at a temporary path. Panic on error.
func MustOpenDB() *DB {
	db := NewDB()
	if err := db.Open(); err != nil {
		panic(err)
	}
	return db
}

// Close closes the database and removes the underlying data.
func (db *DB) Close() error {
	defer os.RemoveAll(db.Path())
	return db.DB.Close()
}

// Reopen closes the database and reopens it.
func (db *DB) Reopen() error {
	var err error
	if err := db.DB.Close(); err != nil {
		return err
	}

	path, name := db.Path(), db.Name()
	db.DB, err = pilosa.NewDB(path, name)
	if err != nil {
		return err
	}

	if err := db.Open(); err != nil {
		return err
	}
	return nil
}

// CreateFrame creates a frame with the given options.
func (db *DB) CreateFrame(name string, opt pilosa.FrameOptions) (*Frame, error) {
	f, err := db.DB.CreateFrame(name, opt)
	if err != nil {
		return nil, err
	}
	return &Frame{Frame: f}, nil
}

// CreateFrameIfNotExists creates a frame with the given options if it doesn't exist.
func (db *DB) CreateFrameIfNotExists(name string, opt pilosa.FrameOptions) (*Frame, error) {
	f, err := db.DB.CreateFrameIfNotExists(name, opt)
	if err != nil {
		return nil, err
	}
	return &Frame{Frame: f}, nil
}

// Ensure database can delete a frame.
func TestDB_InvalidName(t *testing.T) {
	path, err := ioutil.TempDir("", "pilosa-db-")
	if err != nil {
		panic(err)
	}
	db, err := pilosa.NewDB(path, "ABC")
	if db != nil {
		t.Fatalf("unexpected db name %s", db)
	}
}