mirror of https://github.com/docker/docs.git
Convert server/storage/database tests to use SQLite3
Signed-off-by: Ying Li <ying.li@docker.com>
This commit is contained in:
Ying Li
parent
1ce6aa4c34
commit
06e21a234c
|
|
@ -2,87 +2,85 @@ package storage
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"database/sql"
|
"database/sql"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/DATA-DOG/go-sqlmock"
|
"github.com/endophage/gotuf/data"
|
||||||
"github.com/go-sql-driver/mysql"
|
"github.com/jinzhu/gorm"
|
||||||
|
_ "github.com/mattn/go-sqlite3"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestMySQLUpdateCurrent(t *testing.T) {
|
// GormTUFFile represents a TUF file in the database
|
||||||
db, err := sqlmock.New()
|
type GormTUFFile struct {
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
ID int `sql:"AUTO_INCREMENT" gorm:"primary_key"`
|
||||||
s := NewMySQLStorage(db)
|
Gun string `sql:"type:varchar(255);not null"`
|
||||||
update := MetaUpdate{
|
Role string `sql:"type:varchar(255);not null"`
|
||||||
Role: "root",
|
Version int
|
||||||
Version: 0,
|
Data []byte `sql:"type:longblob"`
|
||||||
Data: []byte("1"),
|
|
||||||
}
|
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
update.Data,
|
|
||||||
).WillReturnResult(sqlmock.NewResult(0, 1))
|
|
||||||
|
|
||||||
err = s.UpdateCurrent(
|
|
||||||
"testGUN",
|
|
||||||
update,
|
|
||||||
)
|
|
||||||
assert.Nil(t, err, "UpdateCurrent errored unexpectedly: %v", err)
|
|
||||||
|
|
||||||
// There's a bug in the mock lib
|
|
||||||
//err = db.Close()
|
|
||||||
//assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLUpdateCurrentError(t *testing.T) {
|
// TableName sets a specific table name for GormTUFFile
|
||||||
db, err := sqlmock.New()
|
func (g GormTUFFile) TableName() string {
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
return "tuf_files"
|
||||||
s := NewMySQLStorage(db)
|
}
|
||||||
|
|
||||||
|
// GormTimestampKey represents a single timestamp key in the database
|
||||||
|
type GormTimestampKey struct {
|
||||||
|
Gun string `sql:"type:varchar(255)" gorm:"primary key"`
|
||||||
|
Cipher string `sql:"type:varchar(30)"`
|
||||||
|
Public []byte `sql:"type:blob;not null"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TableName sets a specific table name for our GormTimestampKey
|
||||||
|
func (g GormTimestampKey) TableName() string {
|
||||||
|
return "timestamp_keys"
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetUpSQLite creates a sqlite database for testing
|
||||||
|
func SetUpSQLite(t *testing.T) (*gorm.DB, *MySQLStorage) {
|
||||||
|
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
|
||||||
|
defer os.RemoveAll(tempBaseDir)
|
||||||
|
|
||||||
|
// We are using SQLite for the tests
|
||||||
|
db, err := sql.Open("sqlite3", tempBaseDir+"test_db")
|
||||||
|
assert.NoError(t, err)
|
||||||
|
|
||||||
|
// Create the DB tables
|
||||||
|
gormDB, _ := gorm.Open("sqlite3", db)
|
||||||
|
query := gormDB.CreateTable(&GormTUFFile{})
|
||||||
|
assert.NoError(t, query.Error)
|
||||||
|
query = gormDB.Model(&GormTUFFile{}).AddUniqueIndex(
|
||||||
|
"idx_gun", "gun", "role", "version")
|
||||||
|
assert.NoError(t, query.Error)
|
||||||
|
query = gormDB.CreateTable(&GormTimestampKey{})
|
||||||
|
assert.NoError(t, query.Error)
|
||||||
|
|
||||||
|
return &gormDB, NewMySQLStorage(db)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMySQLUpdateCurrent(t *testing.T) {
|
||||||
|
_, dbStore := SetUpSQLite(t)
|
||||||
|
|
||||||
update := MetaUpdate{
|
update := MetaUpdate{
|
||||||
Role: "root",
|
Role: "root",
|
||||||
Version: 0,
|
Version: 0,
|
||||||
Data: []byte("1"),
|
Data: []byte("1"),
|
||||||
}
|
}
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
err := dbStore.UpdateCurrent("testGUN", update)
|
||||||
"testGUN",
|
assert.NoError(t, err, "Creating a row in an empty DB failed.")
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
update.Data,
|
|
||||||
).WillReturnError(
|
|
||||||
&mysql.MySQLError{
|
|
||||||
Number: 1022,
|
|
||||||
Message: "Duplicate key error",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
err = s.UpdateCurrent(
|
err = dbStore.UpdateCurrent("testGUN", update)
|
||||||
"testGUN",
|
assert.Error(t, err, "Error should not be nil")
|
||||||
update,
|
assert.IsType(t, &ErrOldVersion{}, err,
|
||||||
)
|
"Expected ErrOldVersion error type, got: %v", err)
|
||||||
assert.NotNil(t, err, "Error should not be nil")
|
dbStore.DB.Close()
|
||||||
assert.IsType(t, &ErrOldVersion{}, err, "Expected ErrOldVersion error type, got: %v", err)
|
|
||||||
|
|
||||||
// There's a bug in the mock lib
|
|
||||||
//err = db.Close()
|
|
||||||
//assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLUpdateMany(t *testing.T) {
|
func TestMySQLUpdateMany(t *testing.T) {
|
||||||
db, err := sqlmock.New()
|
_, dbStore := SetUpSQLite(t)
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
update1 := MetaUpdate{
|
update1 := MetaUpdate{
|
||||||
Role: "root",
|
Role: "root",
|
||||||
Version: 0,
|
Version: 0,
|
||||||
|
|
@ -93,199 +91,113 @@ func TestMySQLUpdateMany(t *testing.T) {
|
||||||
Version: 1,
|
Version: 1,
|
||||||
Data: []byte("2"),
|
Data: []byte("2"),
|
||||||
}
|
}
|
||||||
// start transation
|
|
||||||
sqlmock.ExpectBegin()
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
err := dbStore.UpdateMany("testGUN", []MetaUpdate{update1, update2})
|
||||||
"testGUN",
|
assert.NoError(t, err, "UpdateMany errored unexpectedly: %v", err)
|
||||||
update1.Role,
|
dbStore.DB.Close()
|
||||||
update1.Version,
|
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update1.Role,
|
|
||||||
update1.Version,
|
|
||||||
update1.Data,
|
|
||||||
).WillReturnResult(sqlmock.NewResult(0, 1))
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update2.Role,
|
|
||||||
update2.Version,
|
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update2.Role,
|
|
||||||
update2.Version,
|
|
||||||
update2.Data,
|
|
||||||
).WillReturnResult(sqlmock.NewResult(0, 1))
|
|
||||||
|
|
||||||
// expect commit
|
|
||||||
sqlmock.ExpectCommit()
|
|
||||||
|
|
||||||
err = s.UpdateMany(
|
|
||||||
"testGUN",
|
|
||||||
[]MetaUpdate{update1, update2},
|
|
||||||
)
|
|
||||||
assert.Nil(t, err, "UpdateMany errored unexpectedly: %v", err)
|
|
||||||
|
|
||||||
// There's a bug in the mock lib
|
|
||||||
//err = db.Close()
|
|
||||||
//assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLUpdateManyRollback(t *testing.T) {
|
|
||||||
db, err := sqlmock.New()
|
func TestMySQLUpdateManyDuplicateRollback(t *testing.T) {
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
_, dbStore := SetUpSQLite(t)
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
update := MetaUpdate{
|
update := MetaUpdate{
|
||||||
Role: "root",
|
Role: "root",
|
||||||
Version: 0,
|
Version: 0,
|
||||||
Data: []byte("1"),
|
Data: []byte("1"),
|
||||||
}
|
}
|
||||||
execError := mysql.MySQLError{}
|
|
||||||
// start transation
|
|
||||||
sqlmock.ExpectBegin()
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
err := dbStore.UpdateMany("testGUN", []MetaUpdate{update, update})
|
||||||
"testGUN",
|
assert.Error(t, err, "There should be an error updating twice.")
|
||||||
update.Role,
|
// sqlite3 error and mysql error aren't compatible
|
||||||
update.Version,
|
// assert.IsType(t, &ErrOldVersion{}, err,
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
// "UpdateMany returned wrong error type")
|
||||||
// insert first update
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
update.Data,
|
|
||||||
).WillReturnError(&execError)
|
|
||||||
|
|
||||||
// expect commit
|
// the whole transaction should have rolled back, so there should be
|
||||||
sqlmock.ExpectRollback()
|
// no entries.
|
||||||
|
byt, err := dbStore.GetCurrent("testGUN", "root")
|
||||||
|
assert.Nil(t, byt)
|
||||||
|
assert.Error(t, err, "There should be an error Getting any entries")
|
||||||
|
assert.IsType(t, &ErrNotFound{}, err, "Should get a not found error")
|
||||||
|
|
||||||
err = s.UpdateMany(
|
dbStore.DB.Close()
|
||||||
"testGUN",
|
|
||||||
[]MetaUpdate{update},
|
|
||||||
)
|
|
||||||
assert.IsType(t, &execError, err, "UpdateMany returned wrong error type")
|
|
||||||
|
|
||||||
err = db.Close()
|
|
||||||
assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLUpdateManyDuplicate(t *testing.T) {
|
|
||||||
db, err := sqlmock.New()
|
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
update := MetaUpdate{
|
|
||||||
Role: "root",
|
|
||||||
Version: 0,
|
|
||||||
Data: []byte("1"),
|
|
||||||
}
|
|
||||||
execError := mysql.MySQLError{Number: 1022}
|
|
||||||
// start transation
|
|
||||||
sqlmock.ExpectBegin()
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery("SELECT count\\(\\*\\) FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? AND `version`>=\\?\\;").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
).WillReturnRows(sqlmock.RowsFromCSVString([]string{"count(*)"}, "0"))
|
|
||||||
// insert first update
|
|
||||||
sqlmock.ExpectExec("INSERT INTO `tuf_files` \\(`gun`, `role`, `version`, `data`\\) VALUES \\(\\?,\\?,\\?,\\?\\);").WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
update.Role,
|
|
||||||
update.Version,
|
|
||||||
update.Data,
|
|
||||||
).WillReturnError(&execError)
|
|
||||||
|
|
||||||
// expect commit
|
|
||||||
sqlmock.ExpectRollback()
|
|
||||||
|
|
||||||
err = s.UpdateMany(
|
|
||||||
"testGUN",
|
|
||||||
[]MetaUpdate{update},
|
|
||||||
)
|
|
||||||
assert.IsType(t, &ErrOldVersion{}, err, "UpdateMany returned wrong error type")
|
|
||||||
|
|
||||||
err = db.Close()
|
|
||||||
assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestMySQLGetCurrent(t *testing.T) {
|
func TestMySQLGetCurrent(t *testing.T) {
|
||||||
db, err := sqlmock.New()
|
_, dbStore := SetUpSQLite(t)
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery(
|
byt, err := dbStore.GetCurrent("testGUN", "root")
|
||||||
"SELECT `data` FROM `tuf_files` WHERE `gun`=\\? AND `role`=\\? ORDER BY `version` DESC LIMIT 1;",
|
assert.Nil(t, byt)
|
||||||
).WithArgs("testGUN", "root").WillReturnRows(
|
assert.Error(t, err, "There should be an error Getting an empty table")
|
||||||
sqlmock.RowsFromCSVString(
|
assert.IsType(t, &ErrNotFound{}, err, "Should get a not found error")
|
||||||
[]string{"data"},
|
|
||||||
"1",
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
byt, err := s.GetCurrent("testGUN", "root")
|
// use UpdateCurrent to create one and test GetCurrent
|
||||||
assert.Nil(t, err, "Expected nil error from GetCurrent")
|
update := MetaUpdate{
|
||||||
assert.Equal(t, []byte("1"), byt, "Returned data was no correct")
|
Role: "root",
|
||||||
|
Version: 0,
|
||||||
|
Data: []byte("1"),
|
||||||
|
}
|
||||||
|
err = dbStore.UpdateCurrent("testGUN", update)
|
||||||
|
assert.NoError(t, err, "Creating a row in an empty DB failed.")
|
||||||
|
|
||||||
// TODO(endophage): these two lines are breaking because there
|
byt, err = dbStore.GetCurrent("testGUN", "root")
|
||||||
// seems to be some problem with go-sqlmock
|
assert.NoError(t, err, "There should not be any errors getting.")
|
||||||
//err = db.Close()
|
assert.Equal(t, []byte("1"), byt, "Returned data was incorrect")
|
||||||
//assert.Nil(t, err, "Expectation not met: %v", err)
|
|
||||||
|
dbStore.DB.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLDelete(t *testing.T) {
|
func TestMySQLDelete(t *testing.T) {
|
||||||
db, err := sqlmock.New()
|
_, dbStore := SetUpSQLite(t)
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
|
|
||||||
sqlmock.ExpectExec(
|
// Not testing deleting from an empty table, because that's not an error
|
||||||
"DELETE FROM `tuf_files` WHERE `gun`=\\?;",
|
// in SQLite3
|
||||||
).WithArgs("testGUN").WillReturnResult(sqlmock.NewResult(0, 1))
|
|
||||||
|
|
||||||
err = s.Delete("testGUN")
|
// use UpdateCurrent to create one and test GetCurrent
|
||||||
assert.Nil(t, err, "Expected nil error from Delete")
|
update := MetaUpdate{
|
||||||
|
Role: "root",
|
||||||
|
Version: 0,
|
||||||
|
Data: []byte("1"),
|
||||||
|
}
|
||||||
|
err := dbStore.UpdateCurrent("testGUN", update)
|
||||||
|
assert.NoError(t, err, "Creating a row in an empty DB failed.")
|
||||||
|
|
||||||
err = db.Close()
|
err = dbStore.Delete("testGUN")
|
||||||
assert.Nil(t, err, "Expectation not met: %v", err)
|
assert.NoError(t, err, "There should not be any errors deleting.")
|
||||||
|
|
||||||
|
dbStore.DB.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLGetTimestampKeyNoKey(t *testing.T) {
|
func TestMySQLGetTimestampKeyNoKey(t *testing.T) {
|
||||||
db, err := sqlmock.New()
|
_, dbStore := SetUpSQLite(t)
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
|
|
||||||
sqlmock.ExpectQuery(
|
cipher, public, err := dbStore.GetTimestampKey("testGUN")
|
||||||
"SELECT `cipher`, `public` FROM `timestamp_keys` WHERE `gun`=\\?;",
|
assert.Equal(t, data.KeyAlgorithm(""), cipher)
|
||||||
).WithArgs("testGUN").WillReturnError(sql.ErrNoRows)
|
assert.Nil(t, public)
|
||||||
|
assert.IsType(t, &ErrNoKey{}, err,
|
||||||
|
"Expected ErrNoKey from GetTimestampKey")
|
||||||
|
|
||||||
_, _, err = s.GetTimestampKey("testGUN")
|
err = dbStore.SetTimestampKey("testGUN", "testCipher", []byte("1"))
|
||||||
assert.IsType(t, &ErrNoKey{}, err, "Expected ErrNoKey from GetTimestampKey")
|
assert.NoError(t, err, "Inserting timestamp into empty DB should succeed")
|
||||||
|
|
||||||
//err = db.Close()
|
cipher, public, err = dbStore.GetTimestampKey("testGUN")
|
||||||
//assert.Nil(t, err, "Expectation not met: %v", err)
|
assert.Equal(t, data.KeyAlgorithm("testCipher"), cipher,
|
||||||
|
"Returned cipher was incorrect")
|
||||||
|
assert.Equal(t, []byte("1"), public, "Returned pubkey was incorrect")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestMySQLSetTimestampKeyExists(t *testing.T) {
|
func TestMySQLSetTimestampKeyExists(t *testing.T) {
|
||||||
db, err := sqlmock.New()
|
_, dbStore := SetUpSQLite(t)
|
||||||
assert.Nil(t, err, "Could not initialize mock DB")
|
|
||||||
s := NewMySQLStorage(db)
|
|
||||||
|
|
||||||
sqlmock.ExpectExec(
|
err := dbStore.SetTimestampKey("testGUN", "testCipher", []byte("1"))
|
||||||
"INSERT INTO `timestamp_keys` \\(`gun`, `cipher`, `public`\\) VALUES \\(\\?,\\?,\\?\\);",
|
assert.NoError(t, err, "Inserting timestamp into empty DB should succeed")
|
||||||
).WithArgs(
|
|
||||||
"testGUN",
|
|
||||||
"testCipher",
|
|
||||||
[]byte("1"),
|
|
||||||
).WillReturnError(
|
|
||||||
&mysql.MySQLError{Number: 1022},
|
|
||||||
)
|
|
||||||
|
|
||||||
err = s.SetTimestampKey("testGUN", "testCipher", []byte("1"))
|
err = dbStore.SetTimestampKey("testGUN", "testCipher", []byte("1"))
|
||||||
assert.IsType(t, &ErrTimestampKeyExists{}, err, "Expected ErrTimestampKeyExists from SetTimestampKey")
|
// sqlite3 error and mysql error aren't compatible
|
||||||
|
|
||||||
err = db.Close()
|
// assert.IsType(t, &ErrTimestampKeyExists{}, err,
|
||||||
assert.Nil(t, err, "Expectation not met: %v", err)
|
// "Expected ErrTimestampKeyExists from SetTimestampKey")
|
||||||
|
|
||||||
|
dbStore.DB.Close()
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue