0c7f6da936
* database: add wt_public_id domain type * static-hosts: add migrations * Rename migrations * migrations: add description column and fix foreign keys * Add protobuf for static host * Add HostCatalog and HostSet * Add Options * Add foreign key constraint * Add package doc * Add copied scanner code * Add NewHostCatalog with tests * Override default table name for static host catalog * WIP: save static host catalog to database * WIP: Print db url for debugging * Add iam test helper function * Make gorm default to null for names and descriptions * Add foreign key constraint from host catalog to scope * Names are not needed for the test org and project * Avoid an ordering dependency in down migrations * Use wt_timestamp * Add check constraint on host address column * Add Host * Add HostSet * Add HostSetMember * Test a HostSetMember can be written to the database * Move the getters and setters for table name to a new file The TableName methods are needed by gorm and the SetTableName methods are for oplog. Moving them to a new file so related functionality is in the same file. * Add repository * Add NewRepository * Close connection before cleanup of database * Add comments to protobuf file and regenerate * Define repository methods for HostCatalog * Assign PublicId when resource is inserted into the database * Wrap a nil parameter error * Add oplog tickets for static host types * WIP: first cut at CreateCatalog * CreateHostCatalog: more tests * Detect unique constraint violation * Use const for PublicId prefixes * Use PostgreSQL error name instead of error code * Add TODO comments * Fix comments * Use PublicId not PublicID * Refactor: move error variables from host/static to db The error variables defined in host/static are generic and can be reused by other packages. * Create a new repository for each test * Validate CreateCatalog returns a new HostCatalog * Do not modify the HostCatalog passed in * Implement UpdateCatalog * Minor cleanup to make folds work * Implement LookupCatalog * Refactor: extract allocCatalog function * Add comment * Refactor: extract newCatalogMetadata function * Make error strings more consistent * Move database specific error check to internal/db package * Change signature of DeleteCatalog and update docs * Implement DeleteCatalog * Make error strings more consistent * Add examples * Update docs * Add package level doc and example for repository * No need for using reflect.DeepEqual * Remove redundant comment * Clarify ErrMultipleRecords results in the transaction being rolled back * Remove redundant error checks * Remove unnecessary check * Return early instead of using nested 'else' statements * Update and Delete must return a row count * catch err on defers (#82) Co-authored-by: Jim Lambert <jimlambrt@Jims-MBP-3.home> * Remove 'if assert' pattern * Use assert package in test helper function * Add test for updating a non existent catalog * Use a single assert when a specific error is expected * Use assert package when it clarifies the check * Catch errors in cleanup functions * Update comments in protobuf file * Update doc for UpdateCatalog to reflect the new behavior * Add common error values for field mask errors * Require a field mask when calling update methods * Add TODO for removing direct call to gorm * Export Public ID prefixes * Add db timestamp guards * Remove unused option Co-authored-by: Jim <jlambert@hashicorp.com> Co-authored-by: Jim Lambert <jimlambrt@Jims-MBP-3.home>
35 lines
1.4 KiB
Go
35 lines
1.4 KiB
Go
// Package static provides a host, a host catalog, and a host set suitable
|
|
// for hosts with a static address.
|
|
//
|
|
// A host catalog contains a collection of hosts with static addresses.
|
|
// These hosts can be grouped into host sets allowing them to be used in a
|
|
// target. Hosts and host sets are owned by a single host catalog. If a
|
|
// host catalog is deleted, all hosts and host sets owned by it are also
|
|
// deleted. A host set contains references to zero or more hosts but does
|
|
// not own them. Deleting a host set does not effect any of the hosts it
|
|
// referenced. A host set can only reference hosts from the host catalog
|
|
// that owns it. Host addresses must be unique within a host catalog.
|
|
//
|
|
// Repository
|
|
//
|
|
// A repository provides methods for creating, updating, retrieving, and
|
|
// deleting host catalogs, host sets, and hosts. A new repository should be
|
|
// created for each transaction. For example:
|
|
//
|
|
// var wrapper wrapping.Wrapper
|
|
// ... init wrapper...
|
|
//
|
|
// // db implements both the reader and writer interfaces.
|
|
// db, _ := db.Open(db.Postgres, url)
|
|
//
|
|
// var repo *static.Repository
|
|
//
|
|
// repo, _ = static.NewRepository(db, db, wrapper)
|
|
// catalog, _ := repo.LookupCatalog(ctx, catalogId)
|
|
//
|
|
// catalog.Name = "new name"
|
|
//
|
|
// repo, _ = static.NewRepository(db, db, wrapper)
|
|
// catalog, _ := repo.UpdateCatalog(ctx, catalog, []string{"Name"})
|
|
package static
|