Handler project (#44)

* Renamed fakeRepo to mockRepo

* Changing around TODOs to capture current plans with the code.

* Remove the repo interface and use a real DB for tests.

* Fixed a few tests.

* Adding checks for properly formatted identifiers.

* Updating code to account for recent merges.  Relaxing some restrictions on what an id can look like.

* Added small comment explaining why RegisterGrpcGatewayer interface exists.

* Move project service up a call level.

Long term I think it would make sense to define these services even higher up the call stack, potentially at the initialization of the controller server, near where the DB is initialized.

* Making these fields align with those in the resources under hosts/...

* Hard code the service initialization in the handler registration code.

* Regenerate project related code proto code.

* Removing type field for project.

* Adds basic project handling in CLI/SDK (#47)

*    Adds SDK for creating and reading projects
*    Reorganizes a bit
*    Adds CLI for creating and reading projects
*    Fixes some some generation bugs
*    Adds redirect support for default org ID

* Fix protobuf import references being moved.

* Update client test to look for "orgs" and "projects" instead of "org" and "project"

* Update expected segments test

* Fix setAddr handling when default organization is in use

* Set client in target after create or read

Co-authored-by: Jim Lambert <jimlambrt@Jims-MBP-3.home>
Co-authored-by: Jim <jlambert@hashicorp.com>
Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com>
Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
This commit is contained in:
authored and GitHub committed 2020-05-12 17:35:48 -07:00
1 parent 8d7f24268c
commit c0c6a9b0b8
36 files changed
+4104 -112

No files matched your search

+45 -24
View File
@@ -5,6 +5,7 @@ import (
"context"
"crypto/tls"
"encoding/json"
"errors"
"fmt"
"io"
"net"
@@ -240,17 +241,21 @@ func (c *Config) setAddr(addr string) error {
switch len(split) {
case 0:
case 2:
if split[0] != "org" {
return fmt.Errorf("expected org segment in address, found %q", split[0])
switch split[0] {
case "orgs":
c.Org = split[1]
case "projects":
c.Project = split[1]
default:
return fmt.Errorf("expected orgs or projects segment first in address, found %q", split[0])
}
c.Org = split[1]
case 4:
if split[0] != "org" {
return fmt.Errorf("expected org segment in address, found %q", split[0])
if split[0] != "orgs" {
return fmt.Errorf("expected orgs segment in address, found %q", split[0])
}
c.Org = split[1]
if split[2] != "project" {
return fmt.Errorf("expected project segment in address, found %q", split[2])
if split[2] != "projects" {
return fmt.Errorf("expected projects segment in address, found %q", split[2])
}
c.Project = split[3]
default:
@@ -543,7 +548,7 @@ func (c *Client) SetBackoff(backoff retryablehttp.Backoff) {
// underlying http.Client is used; modifying the client from more than one
// goroutine at once may not be safe, so modify the client as needed and then
// clone.
func (c *Client) Clone() (*Client, error) {
func (c *Client) Clone() *Client {
c.modifyLock.RLock()
defer c.modifyLock.RUnlock()
@@ -560,6 +565,8 @@ func (c *Client) Clone() (*Client, error) {
CheckRetry: config.CheckRetry,
Limiter: config.Limiter,
SRVLookup: config.SRVLookup,
Org: config.Org,
Project: config.Project,
}
if config.TLSConfig != nil {
newConfig.TLSConfig = new(TLSConfig)
@@ -573,7 +580,7 @@ func (c *Client) Clone() (*Client, error) {
newConfig.Headers[k] = vSlice
}
return NewClient(newConfig)
return &Client{config: newConfig}
}
func copyHeaders(in http.Header) http.Header {
@@ -647,10 +654,6 @@ func (c *Client) NewRequest(ctx context.Context, method, requestPath string, bod
}
}
if org == "" {
return nil, fmt.Errorf("could not create request, no organization set")
}
u, err := url.Parse(addr)
if err != nil {
return nil, err
@@ -689,9 +692,12 @@ func (c *Client) NewRequest(ctx context.Context, method, requestPath string, bod
}
}
orgProjPath := path.Join("org", org)
var orgProjPath string
if org != "" {
orgProjPath = path.Join(orgProjPath, "orgs", org)
}
if project != "" {
orgProjPath = path.Join(orgProjPath, "project", project)
orgProjPath = path.Join(orgProjPath, "projects", project)
}
req := &http.Request{
@@ -700,12 +706,13 @@ func (c *Client) NewRequest(ctx context.Context, method, requestPath string, bod
User: u.User,
Scheme: u.Scheme,
Host: host,
Path: path.Join(u.Path, "v1", orgProjPath, requestPath),
Path: path.Join(u.Path, "/v1", orgProjPath, requestPath),
},
Host: u.Host,
}
req.Header = headers
req.Header.Add("authorization", "bearer: "+token)
req.Header.Set("content-type", "application/json")
if ctx != nil {
req = req.WithContext(ctx)
}
@@ -752,14 +759,11 @@ func (c *Client) Do(r *retryablehttp.Request) (*Response, error) {
}
if timeout != 0 {
// NOTE: this leaks a timer. But when we defer a cancel call here for
// the returned function we see errors in tests with contxt canceled.
// Although the request is done by the time we exit this function it is
// still causing something else to go wrong. Maybe it ends up being
// tied to the response somehow and reading the response body ends up
// checking it, or something. I don't know, but until we can chase this
// down, keep it not-canceled even though vet complains.
ctx, _ = context.WithTimeout(ctx, timeout)
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, timeout)
// This dance is just to ignore vet warnings; we don't want to cancel
// this as it will make reading the response body impossible
_ = cancel
}
r.Request = r.Request.WithContext(ctx)
@@ -782,6 +786,23 @@ func (c *Client) Do(r *retryablehttp.Request) (*Response, error) {
}
result, err := client.Do(r)
if result != nil && err == nil && result.StatusCode == 307 {
loc, err := result.Location()
if err != nil {
return nil, fmt.Errorf("error getting new location during redirect: %w", err)
}
// Ensure a protocol downgrade doesn't happen
if r.URL.Scheme == "https" && loc.Scheme != "https" {
return nil, errors.New("redirect would cause protocol downgrade")
}
// Update the request
r.URL = loc
result, err = client.Do(r)
}
if err != nil {
if strings.Contains(err.Error(), "tls: oversized") {
err = fmt.Errorf(
+3 -3
View File
@@ -51,7 +51,7 @@ func TestConfigSetAddress(t *testing.T) {
},
{
"valid org",
"http://127.0.0.1:9200/v1/org/orgid",
"http://127.0.0.1:9200/v1/orgs/orgid",
"http://127.0.0.1:9200",
"",
"orgid",
@@ -59,7 +59,7 @@ func TestConfigSetAddress(t *testing.T) {
},
{
"invalid project",
"http://127.0.0.1:9200/v1/org/orgid/project",
"http://127.0.0.1:9200/v1/orgs/orgid/projects",
"http://127.0.0.1:9200",
"unexpected number of segments in address",
"",
@@ -67,7 +67,7 @@ func TestConfigSetAddress(t *testing.T) {
},
{
"valid project",
"http://127.0.0.1:9200/v1/org/orgid/project/projid",
"http://127.0.0.1:9200/v1/orgs/orgid/projects/projid",
"http://127.0.0.1:9200",
"",
"orgid",
+20 -4
View File
@@ -13,10 +13,16 @@ func (s HostCatalog) CreateHost(ctx context.Context, host *Host) (*Host, *api.Er
return nil, nil, fmt.Errorf("nil client in CreateHost request")
}
if s.Id == "" {
return nil, nil, fmt.Errorf("missing catalog ID in CreateHost request")
return nil, nil, fmt.Errorf("missing HostCatalog ID in CreateHost request")
} else {
// If it's explicitly set here, override anything that might be in the
// client
}
req, err := s.Client.NewRequest(ctx, "PUT", fmt.Sprintf("host-catalogs/%s/hosts", s.Id), host)
req, err := s.Client.NewRequest(ctx, "POST", fmt.Sprintf("host-catalogs/%s/hosts", s.Id), host)
if err != nil {
return nil, nil, fmt.Errorf("error creating CreateHost request: %w", err)
}
@@ -32,6 +38,8 @@ func (s HostCatalog) CreateHost(ctx context.Context, host *Host) (*Host, *api.Er
return nil, nil, fmt.Errorf("error decoding CreateHost repsonse: %w", err)
}
target.Client = s.Client
return target, apiErr, nil
}
@@ -40,10 +48,16 @@ func (s HostCatalog) CreateHostSet(ctx context.Context, hostset *HostSet) (*Host
return nil, nil, fmt.Errorf("nil client in CreateHostSet request")
}
if s.Id == "" {
return nil, nil, fmt.Errorf("missing catalog ID in CreateHostSet request")
return nil, nil, fmt.Errorf("missing HostCatalog ID in CreateHostSet request")
} else {
// If it's explicitly set here, override anything that might be in the
// client
}
req, err := s.Client.NewRequest(ctx, "PUT", fmt.Sprintf("host-catalogs/%s/host-sets", s.Id), hostset)
req, err := s.Client.NewRequest(ctx, "POST", fmt.Sprintf("host-catalogs/%s/host-sets", s.Id), hostset)
if err != nil {
return nil, nil, fmt.Errorf("error creating CreateHostSet request: %w", err)
}
@@ -59,5 +73,7 @@ func (s HostCatalog) CreateHostSet(ctx context.Context, hostset *HostSet) (*Host
return nil, nil, fmt.Errorf("error decoding CreateHostSet repsonse: %w", err)
}
target.Client = s.Client
return target, apiErr, nil
}
+1 -1
View File
@@ -3,7 +3,7 @@
THIS_FILE := $(lastword $(MAKEFILE_LIST))
api:
go run -tags genapi .
go run .
goimports -w ${GEN_BASEPATH}/api
.PHONY: api
+37 -11
View File
@@ -1,5 +1,3 @@
// +build genapi
package main
import (
@@ -14,7 +12,6 @@ import (
type createInfo struct {
baseType string
targetType string
verb string
path string
}
@@ -23,14 +20,19 @@ var createFuncs = map[string][]*createInfo{
{
"HostCatalog",
"Host",
"PUT",
"host-catalogs/%s/hosts",
`fmt.Sprintf("host-catalogs/%s/hosts", s.Id)`,
},
{
"HostCatalog",
"HostSet",
"PUT",
"host-catalogs/%s/host-sets",
`fmt.Sprintf("host-catalogs/%s/host-sets", s.Id)`,
},
},
"scopes": {
{
"Organization",
"Project",
`"projects"`,
},
},
}
@@ -47,13 +49,11 @@ package %s
BaseType string
TargetType string
LowerTargetType string
Verb string
Path string
}{
BaseType: createInfo.baseType,
TargetType: createInfo.targetType,
LowerTargetType: strings.ToLower(createInfo.targetType),
Verb: createInfo.verb,
Path: createInfo.path,
})
}
@@ -71,10 +71,26 @@ func (s {{ .BaseType }}) Create{{ .TargetType }}(ctx context.Context, {{ .LowerT
return nil, nil, fmt.Errorf("nil client in Create{{ .TargetType }} request")
}
if s.Id == "" {
return nil, nil, fmt.Errorf("missing catalog ID in Create{{ .TargetType }} request")
{{ if (eq .BaseType "Organization") }}
// Assume the client has been configured with organization already and
// move on
{{ else if (eq .BaseType "Project") }}
// Assume the client has been configured with project already and move
// on
{{ else }}
return nil, nil, fmt.Errorf("missing {{ .BaseType}} ID in Create{{ .TargetType }} request")
{{ end }}
} else {
// If it's explicitly set here, override anything that might be in the
// client
{{ if (eq .BaseType "Organization") }}
ctx = context.WithValue(ctx, "org", s.Id)
{{ else if (eq .BaseType "Project") }}
ctx = context.WithValue(ctx, "project", s.Id)
{{ end }}
}
req, err := s.Client.NewRequest(ctx, "{{ .Verb }}", fmt.Sprintf("{{ .Path }}", s.Id), {{ .LowerTargetType }})
req, err := s.Client.NewRequest(ctx, "POST", {{ .Path }}, {{ .LowerTargetType }})
if err != nil {
return nil, nil, fmt.Errorf("error creating Create{{ .TargetType }} request: %w", err)
}
@@ -90,6 +106,16 @@ func (s {{ .BaseType }}) Create{{ .TargetType }}(ctx context.Context, {{ .LowerT
return nil, nil, fmt.Errorf("error decoding Create{{ .TargetType }} repsonse: %w", err)
}
{{ if (eq .TargetType "Organization") }}
target.Client = s.Client.Clone()
target.Client.SetOrgnization(target.Id)
{{ else if (eq .TargetType "Project") }}
target.Client = s.Client.Clone()
target.Client.SetProject(target.Id)
{{ else }}
target.Client = s.Client
{{ end }}
return target, apiErr, nil
}
`))
+22 -2
View File
@@ -1,5 +1,3 @@
// +build genapi
package main
import "os"
@@ -72,6 +70,28 @@ var inputStructs = []*structInfo{
"",
templateTypeResource,
},
{
os.Getenv("GEN_BASEPATH") + "/internal/gen/controller/api/resources/scopes/organization.pb.go",
"Organization",
os.Getenv("GEN_BASEPATH") + "/api/scopes/organization.gen.go",
"Organization",
"scopes",
"",
"",
"",
templateTypeResource,
},
{
os.Getenv("GEN_BASEPATH") + "/internal/gen/controller/api/resources/scopes/project.pb.go",
"Project",
os.Getenv("GEN_BASEPATH") + "/api/scopes/project.gen.go",
"Project",
"scopes",
"",
"",
"",
templateTypeResource,
},
{
os.Getenv("GEN_BASEPATH") + "/internal/gen/controller/api/resources/hosts/host_catalog.pb.go",
"StaticHostCatalogDetails",
+1 -2
View File
@@ -1,9 +1,8 @@
// +build genapi
package main
func main() {
parsePBs()
writeStructTemplates()
writeCreateFuncs()
writeReadFuncs()
}
-2
View File
@@ -1,5 +1,3 @@
// +build genapi
package main
import (
+116
View File
@@ -0,0 +1,116 @@
package main
import (
"bytes"
"fmt"
"io/ioutil"
"os"
"strings"
"text/template"
)
type readInfo struct {
baseType string
targetType string
verb string
path string
}
var readFuncs = map[string][]*readInfo{
"scopes": {
{
"Organization",
"Project",
"GET",
"projects/%s",
},
},
}
func writeReadFuncs() {
for outPkg, funcs := range readFuncs {
outFile := os.Getenv("GEN_BASEPATH") + fmt.Sprintf("/api/%s/read.gen.go", outPkg)
outBuf := bytes.NewBuffer([]byte(fmt.Sprintf(
`// Code generated by "make api"; DO NOT EDIT.
package %s
`, outPkg)))
for _, readInfo := range funcs {
readFuncTemplate.Execute(outBuf, struct {
BaseType string
TargetType string
LowerTargetType string
Verb string
Path string
}{
BaseType: readInfo.baseType,
TargetType: readInfo.targetType,
LowerTargetType: strings.ToLower(readInfo.targetType),
Verb: readInfo.verb,
Path: readInfo.path,
})
}
if err := ioutil.WriteFile(outFile, outBuf.Bytes(), 0644); err != nil {
fmt.Printf("error writing file %q: %v\n", outFile, err)
os.Exit(1)
}
}
}
var readFuncTemplate = template.Must(template.New("").Parse(
`
func (s {{ .BaseType }}) Read{{ .TargetType }}(ctx context.Context, {{ .LowerTargetType }} *{{ .TargetType }}) (*{{ .TargetType }}, *api.Error, error) {
if s.Client == nil {
return nil, nil, fmt.Errorf("nil client in Read{{ .TargetType }} request")
}
if s.Id == "" {
{{ if (eq .BaseType "Organization") }}
// Assume the client has been configured with organization already and
// move on
{{ else if (eq .BaseType "Project") }}
// Assume the client has been configured with project already and move
// on
{{ else }}
return nil, nil, fmt.Errorf("missing {{ .BaseType }} ID in Read{{ .TargetType }} request")
{{ end }}
} else {
// If it's explicitly set here, override anything that might be in the
// client
{{ if (eq .BaseType "Organization") }}
ctx = context.WithValue(ctx, "org", s.Id)
{{ else if (eq .BaseType "Project") }}
ctx = context.WithValue(ctx, "project", s.Id)
{{ end }}
}
if {{ .LowerTargetType }}.Id == "" {
return nil, nil, fmt.Errorf("empty {{ .LowerTargetType }} ID field in Read{{ .TargetType }} request")
}
req, err := s.Client.NewRequest(ctx, "{{ .Verb }}", fmt.Sprintf("{{ .Path }}", {{ .LowerTargetType }}.Id), {{ .LowerTargetType }})
if err != nil {
return nil, nil, fmt.Errorf("error creating Read{{ .TargetType }} request: %w", err)
}
resp, err := s.Client.Do(req)
if err != nil {
return nil, nil, fmt.Errorf("error performing client request during Read{{ .TargetType }} call: %w", err)
}
target := new({{ .TargetType }})
apiErr, err := resp.Decode(target)
if err != nil {
return nil, nil, fmt.Errorf("error decoding Read{{ .TargetType }} repsonse: %w", err)
}
{{ if (eq .TargetType "Organization") }}
target.Client = s.Client.Clone()
target.Client.SetOrgnization(target.Id)
{{ else if (eq .TargetType "Project") }}
target.Client = s.Client.Clone()
target.Client.SetProject(target.Id)
{{ else }}
target.Client = s.Client
{{ end }}
return target, apiErr, nil
}
`))
-2
View File
@@ -1,5 +1,3 @@
// +build genapi
package main
import (
+1 -1
View File
@@ -47,7 +47,7 @@ func (r *Response) Decode(inStruct interface{}) (*Error, error) {
inStruct = &apiErr
}
if err := dec.Decode(inStruct); err != nil {
return nil, fmt.Errorf("error decoding response: %w", err)
return nil, fmt.Errorf("error decoding response: %w; response was %s", err, r.Body.String())
}
if r.resp.StatusCode >= 400 {
return &apiErr, nil
+48
View File
@@ -0,0 +1,48 @@
// Code generated by "make api"; DO NOT EDIT.
package scopes
import (
"context"
"fmt"
"github.com/hashicorp/watchtower/api"
)
func (s Organization) CreateProject(ctx context.Context, project *Project) (*Project, *api.Error, error) {
if s.Client == nil {
return nil, nil, fmt.Errorf("nil client in CreateProject request")
}
if s.Id == "" {
// Assume the client has been configured with organization already and
// move on
} else {
// If it's explicitly set here, override anything that might be in the
// client
ctx = context.WithValue(ctx, "org", s.Id)
}
req, err := s.Client.NewRequest(ctx, "POST", "projects", project)
if err != nil {
return nil, nil, fmt.Errorf("error creating CreateProject request: %w", err)
}
resp, err := s.Client.Do(req)
if err != nil {
return nil, nil, fmt.Errorf("error performing client request during CreateProject call: %w", err)
}
target := new(Project)
apiErr, err := resp.Decode(target)
if err != nil {
return nil, nil, fmt.Errorf("error decoding CreateProject repsonse: %w", err)
}
target.Client = s.Client.Clone()
target.Client.SetProject(target.Id)
return target, apiErr, nil
}
+51
View File
@@ -0,0 +1,51 @@
// Code generated by "make api"; DO NOT EDIT.
package scopes
import (
"encoding/json"
"time"
"github.com/fatih/structs"
"github.com/hashicorp/watchtower/api"
"github.com/hashicorp/watchtower/api/internal/strutil"
)
type Organization struct {
Client *api.Client `json:"-"`
defaultFields []string
// The ID of the Organization
// Output only.
Id string `json:"id,omitempty"`
// Optional name for identification purposes
Name *string `json:"name,omitempty"`
// Optional user-set descripton for identification purposes
Description *string `json:"description,omitempty"`
// The time this resource was created
// Output only.
CreatedTime time.Time `json:"created_time,omitempty"`
// The time this resource was last updated.
// Output only.
UpdatedTime time.Time `json:"updated_time,omitempty"`
}
func (s *Organization) SetDefault(key string) {
s.defaultFields = strutil.AppendIfMissing(s.defaultFields, key)
}
func (s *Organization) UnsetDefault(key string) {
s.defaultFields = strutil.StrListDelete(s.defaultFields, key)
}
func (s Organization) MarshalJSON() ([]byte, error) {
m := structs.Map(s)
if m == nil {
m = make(map[string]interface{})
}
for _, k := range s.defaultFields {
m[k] = nil
}
return json.Marshal(m)
}
+53
View File
@@ -0,0 +1,53 @@
// Code generated by "make api"; DO NOT EDIT.
package scopes
import (
"encoding/json"
"time"
"github.com/fatih/structs"
"github.com/hashicorp/watchtower/api"
"github.com/hashicorp/watchtower/api/internal/strutil"
)
type Project struct {
Client *api.Client `json:"-"`
defaultFields []string
// The ID of the Project
// Output only.
Id string `json:"id,omitempty"`
// Optional name for identification purposes
Name *string `json:"name,omitempty"`
// Optional user-set descripton for identification purposes
Description *string `json:"description,omitempty"`
// The time this resource was created
// Output only.
CreatedTime time.Time `json:"created_time,omitempty"`
// The time this resource was last updated.
// Output only.
UpdatedTime time.Time `json:"updated_time,omitempty"`
// Whether the resource is disabled
Disabled *bool `json:"disabled,omitempty"`
}
func (s *Project) SetDefault(key string) {
s.defaultFields = strutil.AppendIfMissing(s.defaultFields, key)
}
func (s *Project) UnsetDefault(key string) {
s.defaultFields = strutil.StrListDelete(s.defaultFields, key)
}
func (s Project) MarshalJSON() ([]byte, error) {
m := structs.Map(s)
if m == nil {
m = make(map[string]interface{})
}
for _, k := range s.defaultFields {
m[k] = nil
}
return json.Marshal(m)
}
+51
View File
@@ -0,0 +1,51 @@
// Code generated by "make api"; DO NOT EDIT.
package scopes
import (
"context"
"fmt"
"github.com/hashicorp/watchtower/api"
)
func (s Organization) ReadProject(ctx context.Context, project *Project) (*Project, *api.Error, error) {
if s.Client == nil {
return nil, nil, fmt.Errorf("nil client in ReadProject request")
}
if s.Id == "" {
// Assume the client has been configured with organization already and
// move on
} else {
// If it's explicitly set here, override anything that might be in the
// client
ctx = context.WithValue(ctx, "org", s.Id)
}
if project.Id == "" {
return nil, nil, fmt.Errorf("empty project ID field in ReadProject request")
}
req, err := s.Client.NewRequest(ctx, "GET", fmt.Sprintf("projects/%s", project.Id), project)
if err != nil {
return nil, nil, fmt.Errorf("error creating ReadProject request: %w", err)
}
resp, err := s.Client.Do(req)
if err != nil {
return nil, nil, fmt.Errorf("error performing client request during ReadProject call: %w", err)
}
target := new(Project)
apiErr, err := resp.Decode(target)
if err != nil {
return nil, nil, fmt.Errorf("error decoding ReadProject repsonse: %w", err)
}
target.Client = s.Client.Clone()
target.Client.SetProject(target.Id)
return target, apiErr, nil
}