Static Host Catalog

Makefile

@@ -56,6 +56,7 @@ protobuild:
 	@protoc-go-inject-tag -input=./internal/oplog/oplog_test/oplog_test.pb.go
 	@protoc-go-inject-tag -input=./internal/iam/store/scope.pb.go
 	@protoc-go-inject-tag -input=./internal/db/db_test/db_test.pb.go
+	@protoc-go-inject-tag -input=./internal/host/static/store/static.pb.go
 	@rm -R ${TMP_DIR}
 
 protolint:

internal/db/error.go

@@ -1,6 +1,10 @@
 package db
 
-import "errors"
+import (
+	"errors"
+
+	"github.com/lib/pq"
+)
 
 // Errors returned from this package may be tested against these errors
 // with errors.Is.
@@ -12,6 +16,14 @@ var (
 	// an attribute on a struct contains illegal or invalid values.
 	ErrInvalidParameter = errors.New("invalid parameter")
 
+	// ErrInvalidFieldMask is returned by update methods if the field mask
+	// contains unknown fields or fields that cannot be updated.
+	ErrInvalidFieldMask = errors.New("invalid field mask")
+
+	// ErrEmptyFieldMask is returned by update methods if the field mask is
+	// empty.
+	ErrEmptyFieldMask = errors.New("empty field mask")
+
 	// ErrNotUnique is returned by create and update methods when a write
 	// to the repository resulted in a unique constraint violation.
 	ErrNotUnique = errors.New("unique constraint violation")
@@ -23,4 +35,26 @@ var (
 	// when attempting to read from the database into struct.
 	// When reading into a slice it won't return this error.
 	ErrRecordNotFound = errors.New("record not found")
+
+	// ErrMultipleRecords is returned by update and delete methods when a
+	// write to the repository would result in more than one record being
+	// changed resulting in the transaction being rolled back.
+	ErrMultipleRecords = errors.New("multiple records")
 )
+
+// IsUnique returns a boolean indicating whether the error is known to
+// report a unique constraint violation.
+func IsUnique(err error) bool {
+	if err == nil {
+		return false
+	}
+
+	var pqError *pq.Error
+	if errors.As(err, &pqError) {
+		if pqError.Code.Name() == "unique_violation" {
+			return true
+		}
+	}
+
+	return false
+}

internal/db/error_test.go

@@ -0,0 +1,45 @@
+package db
+
+import (
+	"testing"
+
+	"github.com/lib/pq"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestError_IsUnique(t *testing.T) {
+	var tests = []struct {
+		name string
+		in   error
+		want bool
+	}{
+		{
+			name: "nil-error",
+			in:   nil,
+			want: false,
+		},
+		{
+			name: "postgres-not-unique",
+			in: &pq.Error{
+				Code: pq.ErrorCode("23503"),
+			},
+			want: false,
+		},
+		{
+			name: "postgres-is-unique2",
+			in: &pq.Error{
+				Code: pq.ErrorCode("23505"),
+			},
+			want: true,
+		},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.name, func(t *testing.T) {
+			assert := assert.New(t)
+			err := tt.in
+			got := IsUnique(err)
+			assert.Equal(tt.want, got)
+		})
+	}
+}

internal/db/migrations/postgres/10_static_host.down.sql

@@ -0,0 +1,8 @@
+begin;
+
+  drop table static_host_set_member cascade;
+  drop table static_host_set cascade;
+  drop table static_host cascade;
+  drop table static_host_catalog cascade;
+
+commit;

internal/db/migrations/postgres/10_static_host.up.sql

@@ -0,0 +1,68 @@
+begin;
+
+  create table static_host_catalog (
+    public_id wt_public_id primary key,
+    scope_id wt_public_id not null
+      references iam_scope (public_id)
+      on delete cascade
+      on update cascade,
+    name text,
+    description text,
+    create_time wt_timestamp,
+    update_time wt_timestamp,
+    unique(scope_id, name)
+  );
+
+  create table static_host (
+    public_id wt_public_id primary key,
+    static_host_catalog_id wt_public_id not null
+      references static_host_catalog (public_id)
+      on delete cascade
+      on update cascade,
+    name text,
+    description text,
+    address text not null
+    check(
+      length(trim(address)) > 7
+      and
+      length(trim(address)) < 256
+    ),
+    create_time wt_timestamp,
+    update_time wt_timestamp,
+    unique(static_host_catalog_id, name)
+  );
+
+  create table static_host_set (
+    public_id wt_public_id primary key,
+    static_host_catalog_id wt_public_id not null
+      references static_host_catalog (public_id)
+      on delete cascade
+      on update cascade,
+    name text,
+    description text,
+    create_time wt_timestamp,
+    update_time wt_timestamp,
+    unique(static_host_catalog_id, name)
+  );
+
+  create table static_host_set_member (
+    static_host_set_id wt_public_id
+      references static_host_set (public_id)
+      on delete cascade
+      on update cascade,
+    static_host_id wt_public_id
+      references static_host (public_id)
+      on delete cascade
+      on update cascade,
+    primary key(static_host_set_id, static_host_id)
+  );
+
+insert into oplog_ticket (name, version)
+values
+  ('static_host_catalog', 1),
+  ('static_host', 1),
+  ('static_host_set', 1),
+  ('static_host_set_member', 1);
+
+commit;
+

internal/host/static/doc.go

@@ -0,0 +1,34 @@
+// 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

internal/host/static/example_test.go

@@ -0,0 +1,39 @@
+package static_test
+
+import (
+	"fmt"
+
+	"github.com/hashicorp/watchtower/internal/host/static"
+)
+
+func ExampleNewHostCatalog() {
+	projectPublicId := "p_1234"
+	catalog, _ := static.NewHostCatalog(projectPublicId, static.WithName("my catalog"))
+	fmt.Println(catalog.Name)
+	// Output:
+	// my catalog
+}
+
+func ExampleNewHost() {
+	catalogPublicId := "sthc_1234"
+	host, _ := static.NewHost(catalogPublicId, "127.0.0.1")
+	fmt.Println(host.Address)
+	// Output:
+	// 127.0.0.1
+}
+
+func ExampleNewHostSet() {
+	catalogPublicId := "sthc_1234"
+	set, _ := static.NewHostSet(catalogPublicId, static.WithName("my host set"))
+	fmt.Println(set.Name)
+	// Output:
+	// my host set
+}
+
+func ExampleNewHostSetMember() {
+	setPublicId := "sths_11111"
+	hostPublicId := "sth_22222"
+	member, _ := static.NewHostSetMember(setPublicId, hostPublicId)
+	fmt.Println(member.StaticHostSetId)
+	fmt.Println(member.StaticHostId)
+}