centersl/docker-docs
1
0
Fork 0
mirror of https://github.com/docker/docs.git synced 2026-04-01 00:38:52 +07:00
Code Issues Packages Projects Releases Wiki Activity

Add a DB health check to the server storage DB

Browse Source 
Signed-off-by: Ying Li <ying.li@docker.com>
This commit is contained in:
Ying Li
2015-10-13 11:28:14 -07:00
parent 85a447f701
commit df95dc4564
2 changed files with 91 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
server/storage/database.go
View File

@@ -1,6 +1,8 @@
package storage
import (
"fmt"
"github.com/Sirupsen/logrus"
"github.com/endophage/gotuf/data"
"github.com/jinzhu/gorm"
@@ -143,3 +145,21 @@ func (db *SQLStorage) SetTimestampKey(gun string, algorithm data.KeyAlgorithm, p
return db.FirstOrCreate(&TimestampKey{}, &entry).Error
}
// CheckHealth asserts that both required tables are present
func (db *SQLStorage) CheckHealth() error {
interfaces := []interface{}{&TUFFile{}, &TimestampKey{}}
names := []string{TUFFile{}.TableName(), TimestampKey{}.TableName()}
for i, model := range interfaces {
tableOk := db.HasTable(model)
if db.Error != nil {
return db.Error
}
if !tableOk {
return fmt.Errorf(
"Cannot access table: %s", names[i])
}
}
return nil
}

93
server/storage/database_test.go
View File

@@ -31,23 +31,25 @@ func SampleUpdate(version int) MetaUpdate {
}
// SetUpSQLite creates a sqlite database for testing
func SetUpSQLite(dbDir string, t *testing.T) (*gorm.DB, *SQLStorage) {
func SetUpSQLite(dbDir string, t *testing.T, createTable bool) (*gorm.DB, *SQLStorage) {
dbStore, err := NewSQLStorage("sqlite3", dbDir+"test_db")
assert.NoError(t, err)
// Create the DB tables
err = CreateTUFTable(dbStore.DB)
assert.NoError(t, err)
if createTable {
// Create the DB tables
err = CreateTUFTable(dbStore.DB)
assert.NoError(t, err)
err = CreateTimestampTable(dbStore.DB)
assert.NoError(t, err)
err = CreateTimestampTable(dbStore.DB)
assert.NoError(t, err)
// verify that the tables are empty
var count int
for _, model := range [2]interface{}{&TUFFile{}, &TimestampKey{}} {
query := dbStore.DB.Model(model).Count(&count)
assert.NoError(t, query.Error)
assert.Equal(t, 0, count)
// verify that the tables are empty
var count int
for _, model := range [2]interface{}{&TUFFile{}, &TimestampKey{}} {
query := dbStore.DB.Model(model).Count(&count)
assert.NoError(t, query.Error)
assert.Equal(t, 0, count)
}
}
return &dbStore.DB, dbStore
@@ -57,7 +59,7 @@ func SetUpSQLite(dbDir string, t *testing.T) (*gorm.DB, *SQLStorage) {
// if no previous version existed.
func TestMySQLUpdateCurrentNew(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
// Adding a new TUF file should succeed
@@ -78,7 +80,7 @@ func TestMySQLUpdateCurrentNew(t *testing.T) {
// new (higher) version of an existing TUF file
func TestMySQLUpdateCurrentNewVersion(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
// insert row
@@ -106,7 +108,7 @@ func TestMySQLUpdateCurrentNewVersion(t *testing.T) {
// trying to update to an older version of a TUF file.
func TestMySQLUpdateCurrentOldVersionError(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
// insert row
@@ -136,7 +138,7 @@ func TestMySQLUpdateCurrentOldVersionError(t *testing.T) {
// updates do not conflict with each.
func TestMySQLUpdateMany(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
err = dbStore.UpdateMany("testGUN", []MetaUpdate{
@@ -171,7 +173,7 @@ func TestMySQLUpdateMany(t *testing.T) {
// non-monotonic versions still succeeds.
func TestMySQLUpdateManyVersionOrder(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
err = dbStore.UpdateMany(
@@ -197,7 +199,7 @@ func TestMySQLUpdateManyVersionOrder(t *testing.T) {
// updates fails.
func TestMySQLUpdateManyDuplicateRollback(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
update := SampleUpdate(0)
@@ -219,7 +221,7 @@ func TestMySQLUpdateManyDuplicateRollback(t *testing.T) {
func TestMySQLGetCurrent(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
byt, err := dbStore.GetCurrent("testGUN", "root")
@@ -240,7 +242,7 @@ func TestMySQLGetCurrent(t *testing.T) {
func TestMySQLDelete(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
tuf := SampleTUF(0)
@@ -261,7 +263,7 @@ func TestMySQLDelete(t *testing.T) {
func TestMySQLGetTimestampKeyNoKey(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
cipher, public, err := dbStore.GetTimestampKey("testGUN")
@@ -286,7 +288,7 @@ func TestMySQLGetTimestampKeyNoKey(t *testing.T) {
func TestMySQLSetTimestampKeyExists(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
gormDB, dbStore := SetUpSQLite(tempBaseDir, t)
gormDB, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
err = dbStore.SetTimestampKey("testGUN", "testCipher", []byte("1"))
@@ -309,3 +311,50 @@ func TestMySQLSetTimestampKeyExists(t *testing.T) {
dbStore.DB.Close()
}
// TestDBCheckHealthTableMissing asserts that the health check fails if one or
// both the tables are missing.
func TestDBCheckHealthTableMissing(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
_, dbStore := SetUpSQLite(tempBaseDir, t, false)
defer os.RemoveAll(tempBaseDir)
// No tables, health check fails
err = dbStore.CheckHealth()
assert.Error(t, err, "Cannot access table:")
// only one table existing causes health check to fail
CreateTUFTable(dbStore.DB)
err = dbStore.CheckHealth()
assert.Error(t, err, "Cannot access table:")
dbStore.DropTable(&TUFFile{})
CreateTimestampTable(dbStore.DB)
err = dbStore.CheckHealth()
assert.Error(t, err, "Cannot access table:")
}
// TestDBCheckHealthDBCOnnection asserts that if the DB is not connectable, the
// health check fails.
func TestDBCheckHealthDBConnectionFail(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
_, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
err = dbStore.Close()
assert.NoError(t, err)
err = dbStore.CheckHealth()
assert.Error(t, err, "Cannot access table:")
}
// TestDBCheckHealthSuceeds asserts that if the DB is connectable and both
// tables exist, the health check succeeds.
func TestDBCheckHealthSucceeds(t *testing.T) {
tempBaseDir, err := ioutil.TempDir("", "notary-test-")
_, dbStore := SetUpSQLite(tempBaseDir, t, true)
defer os.RemoveAll(tempBaseDir)
err = dbStore.CheckHealth()
assert.NoError(t, err)
}