-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add async operation support to dynamic-rp
This change adds the async operationStatus and operationResult handlers to the dynamic-rp API. This change is significant, because like all functionality in dynamic-rp, it's dynamic and needs to work for any UDT resource provider rather than a fixed namespace. Signed-off-by: Ryan Nowak <[email protected]>
- Loading branch information
Showing
6 changed files
with
230 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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 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,88 @@ | ||
| /* | ||
| Copyright 2023 The Radius Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package frontend | ||
|
|
||
| import ( | ||
| "net/http" | ||
| "strings" | ||
|
|
||
| v1 "github.com/radius-project/radius/pkg/armrpc/api/v1" | ||
| "github.com/radius-project/radius/pkg/armrpc/frontend/controller" | ||
| "github.com/radius-project/radius/pkg/armrpc/frontend/server" | ||
| "github.com/radius-project/radius/pkg/armrpc/rest" | ||
| "github.com/radius-project/radius/pkg/ucp/resources" | ||
| ) | ||
|
|
||
| // dynamicOperationHandler returns an http.Handler that can instantiate and run a controller.Controller for a dynamic resource. | ||
| // | ||
| // Usually when we register a route, we know up-front the resource type that will be handled by the controller. | ||
| // In the dynamic-rp use-case we don't know. We need to dynamically determine the resource type based on the URL. | ||
| // | ||
| // For example: | ||
| // | ||
| // Route: /planes/radius/{planeName}/providers/{providerNamespace}/locations/{locationName}/operationResults/{operationID} | ||
| // URL: /planes/radius/myplane/providers/Applications.Example/locations/global/operationResults/1234 | ||
| // Resource Type: Applications.Example/operationResults | ||
| // | ||
| // # OR | ||
| // | ||
| // Route: /planes/radius/{planeName}/resourceGroups/my-rg/providers/{providerNamespace}/{resourceType}/{resourceName} | ||
| // URL: /planes/radius/myplane/resourceGroups/my-rg/providers/Applications.Example/customService/my-service | ||
| // Resource Type: Applications.Example/customService | ||
| // | ||
| // This code ensures that the controller will be provided with the correct resource type. | ||
| func dynamicOperationHandler(method v1.OperationMethod, baseOptions controller.Options, factory func(opts controller.Options) (controller.Controller, error)) http.HandlerFunc { | ||
| return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| id, err := resources.Parse(r.URL.Path) | ||
| if err != nil { | ||
| result := rest.NewBadRequestResponse(err.Error()) | ||
| err = result.Apply(r.Context(), w, r) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| operationType := v1.OperationType{Type: strings.ToUpper(id.Type()), Method: method} | ||
|
|
||
| // Copy the options and initalize them dynamically for this type. | ||
| opts := baseOptions | ||
| opts.ResourceType = id.Type() | ||
|
|
||
| // Special case the operation status and operation result types. | ||
| // | ||
| // This is special-casing that all of our resource providers do to store a single data row for both operation statuses and operation results. | ||
| if strings.HasSuffix(strings.ToLower(opts.ResourceType), "locations/operationstatuses") || strings.HasSuffix(strings.ToLower(opts.ResourceType), "locations/operationresults") { | ||
| opts.ResourceType = id.ProviderNamespace() + "/operationstatuses" | ||
| } | ||
|
|
||
| ctrl, err := factory(opts) | ||
| if err != nil { | ||
| result := rest.NewBadRequestResponse(err.Error()) | ||
| err = result.Apply(r.Context(), w, r) | ||
| if err != nil { | ||
| http.Error(w, err.Error(), http.StatusInternalServerError) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| handler := server.HandlerForController(ctrl, operationType) | ||
| handler.ServeHTTP(w, r) | ||
| }) | ||
| } |
This file contains 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 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 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,79 @@ | ||
| /* | ||
| Copyright 2023 The Radius Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package dynamic | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "testing" | ||
|
|
||
| "github.com/google/uuid" | ||
| v1 "github.com/radius-project/radius/pkg/armrpc/api/v1" | ||
| "github.com/radius-project/radius/pkg/armrpc/asyncoperation/statusmanager" | ||
| "github.com/radius-project/radius/pkg/components/database" | ||
| "github.com/radius-project/radius/pkg/dynamicrp/testhost" | ||
| "github.com/radius-project/radius/test/testcontext" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // This test covers the basic functionality of the operation status/result controllers. | ||
| // | ||
| // This test is synthetic because we don't have a real operation to test against. | ||
| func Test_Dynamic_OperationResultAndStatus(t *testing.T) { | ||
| ctx := testcontext.New(t) | ||
| dynamic, ucp := testhost.Start(t) | ||
|
|
||
| // Setup a plane & resource provider & location | ||
| plane := createRadiusPlane(ucp) | ||
| createResourceProvider(ucp) | ||
| createLocation(ucp) | ||
|
|
||
| // Now we can make a request to the operation result/status endpoints. | ||
| operationName := uuid.New().String() | ||
|
|
||
| operationResultID := fmt.Sprintf("/planes/radius/%s/providers/%s/locations/global/operationResults/%s", *plane.Name, resourceProviderNamespace, operationName) | ||
| operationStatusID := fmt.Sprintf("/planes/radius/%s/providers/%s/locations/global/operationStatuses/%s", *plane.Name, resourceProviderNamespace, operationName) | ||
|
|
||
| // This operation doesn't exist yet, so we should get a 404. | ||
| response := ucp.MakeRequest("GET", fmt.Sprintf("%s?api-version=%s", operationResultID, apiVersion), nil) | ||
| response.EqualsErrorCode(http.StatusNotFound, "NotFound") | ||
|
|
||
| response = ucp.MakeRequest("GET", fmt.Sprintf("%s?api-version=%s", operationStatusID, apiVersion), nil) | ||
| response.EqualsErrorCode(http.StatusNotFound, "NotFound") | ||
|
|
||
| // Now let's simulate the creation of an operation, by putting one in the database. | ||
| databaseClient, err := dynamic.Options().DatabaseProvider.GetClient(ctx) | ||
| require.NoError(t, err) | ||
|
|
||
| operation := &statusmanager.Status{ | ||
| AsyncOperationStatus: v1.AsyncOperationStatus{ | ||
| ID: operationStatusID, | ||
| Name: operationName, | ||
| Status: v1.ProvisioningStateUpdating, | ||
| }, | ||
| } | ||
|
|
||
| err = databaseClient.Save(ctx, &database.Object{Data: operation, Metadata: database.Metadata{ID: operationStatusID}}) | ||
| require.NoError(t, err) | ||
|
|
||
| // Now let's query it again, we should find it. | ||
| response = ucp.MakeRequest("GET", fmt.Sprintf("%s?api-version=%s", operationResultID, apiVersion), nil) | ||
| response.EqualsStatusCode(http.StatusAccepted) | ||
|
|
||
| response = ucp.MakeRequest("GET", fmt.Sprintf("%s?api-version=%s", operationStatusID, apiVersion), nil) | ||
| response.EqualsStatusCode(http.StatusOK) | ||
| } |
This file contains 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