feat: implement tenant provisioning handler #9
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| package api_test | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "net/url" | ||
| "testing" | ||
|
|
||
| "github.com/fil-forge/hilt/internal/testutil" | ||
| "github.com/fil-forge/hilt/pkg/api" | ||
| "github.com/fil-forge/hilt/pkg/store/provider" | ||
| providermemory "github.com/fil-forge/hilt/pkg/store/provider/memory" | ||
| "github.com/fil-forge/hilt/pkg/store/tenant" | ||
| tenantmemory "github.com/fil-forge/hilt/pkg/store/tenant/memory" | ||
| "github.com/fil-forge/hilt/pkg/vault" | ||
| vaultmemory "github.com/fil-forge/hilt/pkg/vault/memory" | ||
| "github.com/fil-forge/ucantone/did/plc" | ||
| "github.com/labstack/echo/v4" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| type provisionDeps struct { | ||
| tenants tenant.Store | ||
| providers provider.Store | ||
| vault vault.Vault | ||
| plcPosts int | ||
| } | ||
|
|
||
| // setupProvision builds an echo server with the provision handler wired to | ||
| // memory stores/vault and a PLC directory client pointed at an httptest server | ||
| // that accepts genesis operations (no real PLC network). | ||
| func setupProvision(t *testing.T) (*echo.Echo, *provisionDeps) { | ||
| t.Helper() | ||
| deps := &provisionDeps{ | ||
| tenants: tenantmemory.New(), | ||
| providers: providermemory.New(), | ||
| vault: vaultmemory.New(), | ||
| } | ||
|
|
||
| plcServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| if r.Method == http.MethodPost { | ||
| deps.plcPosts++ | ||
| } | ||
| w.WriteHeader(http.StatusOK) | ||
|
alanshaw marked this conversation as resolved.
|
||
| })) | ||
| t.Cleanup(plcServer.Close) | ||
|
|
||
| endpoint, err := url.Parse(plcServer.URL) | ||
| require.NoError(t, err) | ||
| plcClient, err := plc.NewDirectoryClient(*endpoint) | ||
| require.NoError(t, err) | ||
|
|
||
| route := api.NewProvisionTenantHandler(zap.NewNop(), deps.tenants, deps.providers, deps.vault, plcClient) | ||
| e := echo.New() | ||
| e.Add(route.Method, route.Path, route.Handler) | ||
| return e, deps | ||
| } | ||
|
|
||
| func provisionRequest(t *testing.T, e *echo.Echo, tenantID string, body api.ProvisionTenantRequest) *httptest.ResponseRecorder { | ||
| t.Helper() | ||
| encoded, err := json.Marshal(body) | ||
| require.NoError(t, err) | ||
| req := httptest.NewRequest(http.MethodPut, "/tenants/"+tenantID, bytes.NewReader(encoded)) | ||
| req.Header.Set(echo.HeaderContentType, echo.MIMEApplicationJSON) | ||
| rec := httptest.NewRecorder() | ||
| e.ServeHTTP(rec, req) | ||
| return rec | ||
| } | ||
|
|
||
| func TestProvisionTenantHandler(t *testing.T) { | ||
| ctx := t.Context() | ||
|
|
||
| t.Run("provisions a new tenant", func(t *testing.T) { | ||
| e, deps := setupProvision(t) | ||
| require.NoError(t, deps.providers.Add(ctx, testutil.RandomDID(t), "us-east-1")) | ||
|
|
||
| rec := provisionRequest(t, e, "tenant-1", api.ProvisionTenantRequest{DisplayName: "Acme", Region: "us-east-1"}) | ||
| require.Equal(t, http.StatusCreated, rec.Code) | ||
| require.Contains(t, rec.Body.String(), `"tenantId":"tenant-1"`) | ||
| require.Contains(t, rec.Body.String(), `"displayName":"Acme"`) | ||
|
|
||
| // A tenant record exists, keyed by a did:plc, mapped to the external id. | ||
| stored, err := deps.tenants.GetByExternalID(ctx, "tenant-1") | ||
| require.NoError(t, err) | ||
| require.Equal(t, "plc", stored.ID.Method()) | ||
| require.Equal(t, "tenant-1", stored.ExternalID) | ||
| require.Equal(t, tenant.Active, stored.Status) | ||
|
|
||
| // The private key was stored in the vault and the genesis op published. | ||
| key, err := deps.vault.Read(ctx, "/tenant/"+stored.ID.String()) | ||
| require.NoError(t, err) | ||
| require.NotEmpty(t, key) | ||
| require.Equal(t, 1, deps.plcPosts) | ||
| }) | ||
|
|
||
| t.Run("is idempotent on the external id", func(t *testing.T) { | ||
| e, deps := setupProvision(t) | ||
| require.NoError(t, deps.providers.Add(ctx, testutil.RandomDID(t), "us-east-1")) | ||
|
|
||
| first := provisionRequest(t, e, "tenant-2", api.ProvisionTenantRequest{DisplayName: "Acme", Region: "us-east-1"}) | ||
| require.Equal(t, http.StatusCreated, first.Code) | ||
| stored, err := deps.tenants.GetByExternalID(ctx, "tenant-2") | ||
| require.NoError(t, err) | ||
|
|
||
| second := provisionRequest(t, e, "tenant-2", api.ProvisionTenantRequest{DisplayName: "Acme", Region: "us-east-1"}) | ||
| require.Equal(t, http.StatusOK, second.Code) | ||
|
|
||
| // No new key minted/published on the idempotent call. | ||
| require.Equal(t, 1, deps.plcPosts) | ||
| again, err := deps.tenants.GetByExternalID(ctx, "tenant-2") | ||
| require.NoError(t, err) | ||
| require.Equal(t, stored.ID, again.ID) | ||
| }) | ||
|
|
||
| t.Run("unknown region is rejected", func(t *testing.T) { | ||
| e, _ := setupProvision(t) | ||
| rec := provisionRequest(t, e, "tenant-3", api.ProvisionTenantRequest{DisplayName: "Acme", Region: "nowhere"}) | ||
| require.Equal(t, http.StatusBadRequest, rec.Code) | ||
| }) | ||
|
|
||
| t.Run("missing displayName is rejected", func(t *testing.T) { | ||
| e, deps := setupProvision(t) | ||
| require.NoError(t, deps.providers.Add(ctx, testutil.RandomDID(t), "us-east-1")) | ||
| rec := provisionRequest(t, e, "tenant-4", api.ProvisionTenantRequest{Region: "us-east-1"}) | ||
| require.Equal(t, http.StatusBadRequest, rec.Code) | ||
| }) | ||
|
|
||
| t.Run("missing region is rejected", func(t *testing.T) { | ||
| e, _ := setupProvision(t) | ||
| rec := provisionRequest(t, e, "tenant-5", api.ProvisionTenantRequest{DisplayName: "Acme"}) | ||
| require.Equal(t, http.StatusBadRequest, rec.Code) | ||
| }) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add retry with exponential backoff to gracefully handle temporary service degradation or unavailability of PLC?
Also, is there any timeout/deadline enforced for this call to a 3rd-party API?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally I'd like to push retries all the way back to the client so we don't end up adding retry logic for every database/API call we make in these handlers.
I will configure the HTTP client with a timeout though - good call.