docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document the intended behavior of each function in the storage 

interface.

Signed-off-by: Ying Li <ying.li@docker.com>
This commit is contained in:
Ying Li 2015-10-10 18:44:44 -07:00
parent 99cac889b1
commit 01f7adc80c
2 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
server/storage/database_test.go
View File

@ -260,10 +260,6 @@ func TestMySQLGetCurrent(t *testing.T) {
func TestMySQLDelete(t *testing.T) {
gormDB, dbStore := SetUpSQLite(t)
// Not testing deleting from an empty table, because that's not an error
// in SQLite3
// use UpdateCurrent to create one and test GetCurrent
tuf := SampleTUF(0)
query := gormDB.Create(&tuf)
assert.NoError(t, query.Error, "Creating a row in an empty DB failed.")

21
server/storage/interface.go
View File

@ -4,10 +4,31 @@ import "github.com/endophage/gotuf/data"
// MetaStore holds the methods that are used for a Metadata Store
type MetaStore interface {
// UpdateCurrent adds new metadata version for the given GUN if and only
// if it's a new role, or the version is greater than the current version
// for the role. Otherwise an error is returned.
UpdateCurrent(gun string, update MetaUpdate) error
// UpdateMany adds multiple new metadata for the given GUN. It can even
// add multiple versions for the same role, so long as those versions are
// all unique and greater than any current versions. Otherwise,
// none of the metadata is added, and an error is be returned.
UpdateMany(gun string, updates []MetaUpdate) error
// GetCurrent returns the data part of the metadata for the latest version
// of the given GUN and role. If there is no data for the given GUN and
// role, an error is returned.
GetCurrent(gun, tufRole string) (data []byte, err error)
// Delete removes all metadata for a given GUN. It does not return an
// error if no metadata exists for the given GUN.
Delete(gun string) error
// GetTimestampKey returns the algorithm and public key for the given GUN.
// If the GUN doesn't exist, returns an error.
GetTimestampKey(gun string) (algorithm data.KeyAlgorithm, public []byte, err error)
// SetTimeStampKey sets the algorithm and public key for the given GUN if
// it doesn't already exist. Otherwise an error is returned.
SetTimestampKey(gun string, algorithm data.KeyAlgorithm, public []byte) error
}