storj/satellite/satellitedb/satellitedbtest/run.go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.

package satellitedbtest

// This package should be referenced only in test files!

import (
	"crypto/rand"
	"encoding/hex"
	"flag"
	"os"
	"testing"

	"github.com/zeebo/errs"

	"storj.io/storj/satellite"
	"storj.io/storj/satellite/satellitedb"
)

const (
	// postgres connstring that works with docker-compose
	defaultPostgresConn = "postgres://storj:storj-pass@test-postgres/teststorj?sslmode=disable"
	defaultSqliteConn   = "sqlite3://file::memory:?mode=memory"
)

var (
	testPostgres = flag.String("postgres-test-db", os.Getenv("STORJ_POSTGRES_TEST"), "PostgreSQL test database connection string")
)

// Run method will iterate over all supported databases. Will establish
// connection and will create tables for each DB.
func Run(t *testing.T, test func(t *testing.T, db satellite.DB)) {
	for _, dbInfo := range []struct {
		dbName    string
		dbURL     string
		dbMessage string
	}{
		{"Sqlite", defaultSqliteConn, ""},
		{"Postgres", *testPostgres, "Postgres flag missing, example: -postgres-test-db=" + defaultPostgresConn},
	} {
		t.Run(dbInfo.dbName, func(t *testing.T) {
			if dbInfo.dbURL == "" {
				t.Skipf("Database %s connection string not provided. %s", dbInfo.dbName, dbInfo.dbMessage)
			}

			db, err := satellitedb.New(dbInfo.dbURL)
			if err != nil {
				t.Fatal(err)
			}

			schemaName := randomSchemaName() // TODO: create schema name based on t.Name()

			err = db.SetSchema(schemaName)
			if err != nil {
				t.Fatal(err)
			}

			defer func() {
				dropErr := db.DropSchema(schemaName)
				err := errs.Combine(dropErr, db.Close())
				if err != nil {
					t.Fatal(err)
				}
			}()

			err = db.CreateTables()
			if err != nil {
				t.Fatal(err)
			}

			test(t, db)
		})
	}
}

func randomSchemaName() string {
	var data [8]byte
	_, _ = rand.Read(data[:])
	return "s" + hex.EncodeToString(data[:])
}