Allow plugins to apply yaml

changelogs/unreleased/2775-xtreme-vikram-yadav

@@ -0,0 +1 @@
+allowed Go plugins to apply yaml

internal/octant/actions.go

@@ -22,7 +22,6 @@ const (
 	ActionOverviewServiceEditor   = "action.octant.dev/serviceEditor"
 	ActionDeploymentConfiguration = "action.octant.dev/deploymentConfiguration"
 	ActionUpdateObject            = "action.octant.dev/update"
-	ActionApplyYaml               = "action.octant.dev/apply"
 )
 
 func sendAlert(alerter action.Alerter, alertType action.AlertType, message string, expiration *time.Time) {

internal/octant/apply_yaml.go

@@ -34,7 +34,7 @@ func NewApplyYaml(logger log.Logger, objectStore store.Store) *ApplyYaml {
 
 // ActionName returns the name of this action
 func (p *ApplyYaml) ActionName() string {
-	return ActionApplyYaml
+	return action.ActionApplyYaml
 }
 
 // Handle applies the requested yaml to the cluster

internal/octant/apply_yaml_test.go

@@ -98,7 +98,7 @@ data:
 
 	ctx := context.Background()
 
-	payload := action.CreatePayload(ActionApplyYaml, map[string]interface{}{
+	payload := action.CreatePayload(action.ActionApplyYaml, map[string]interface{}{
 		"update":    update,
 		"namespace": "default",
 	})
@@ -164,7 +164,7 @@ data:
 
 	ctx := context.Background()
 
-	payload := action.CreatePayload(ActionApplyYaml, map[string]interface{}{
+	payload := action.CreatePayload(action.ActionApplyYaml, map[string]interface{}{
 		"update":    update,
 		"namespace": "default",
 	})
@@ -228,7 +228,7 @@ metadata:
 
 	ctx := context.Background()
 
-	payload := action.CreatePayload(ActionApplyYaml, map[string]interface{}{
+	payload := action.CreatePayload(action.ActionApplyYaml, map[string]interface{}{
 		"update":    update,
 		"namespace": "default",
 	})
@@ -286,7 +286,7 @@ metadata:
 
 	ctx := context.Background()
 
-	payload := action.CreatePayload(ActionApplyYaml, map[string]interface{}{
+	payload := action.CreatePayload(action.ActionApplyYaml, map[string]interface{}{
 		"update":    update,
 		"namespace": "default",
 	})
@@ -326,7 +326,7 @@ data: {
 
 	ctx := context.Background()
 
-	payload := action.CreatePayload(ActionApplyYaml, map[string]interface{}{
+	payload := action.CreatePayload(action.ActionApplyYaml, map[string]interface{}{
 		"update":    update,
 		"namespace": "default",
 	})

pkg/action/actions.go

@@ -20,4 +20,9 @@ const (
 	// The ActionRequest.Payload for this action contains a single string entry `contextName` with a value
 	// of the new context.
 	RequestSetContext = "action.octant.dev/setContext"
+
+	// ActionApplyYaml is the action to apply a yaml resource configuration.
+	// The ActionRequest.Payload for this action contains string entry `namespace` and a string entry
+	// `update` containing the yaml configuration for a resource.
+	ActionApplyYaml = "action.octant.dev/apply"
 )

pkg/plugin/api/api_test.go

@@ -143,6 +143,25 @@ func TestAPI(t *testing.T) {
 				require.NoError(t, err)
 			},
 		},
+		{
+			name: "applyYAML",
+			initFunc: func(t *testing.T, mocks *apiMocks) {
+				mocks.objectStore.EXPECT().
+					CreateOrUpdateFromYAML(contextType, "default", "---\nyaml").
+					Return([]string{}, nil).
+					Do(func(ctx context.Context, namespace, yaml string) {
+						require.Equal(t, "bar", ctx.Value(api.DashboardMetadataKey("foo")))
+					})
+			},
+			doFunc: func(t *testing.T, client *api.Client) {
+				clientCtx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
+				defer cancel()
+
+				clientCtx = metadata.AppendToOutgoingContext(clientCtx, "x-octant-foo", "bar")
+				_, err := client.ApplyYAML(clientCtx, "default", "---\nyaml")
+				require.NoError(t, err)
+			},
+		},
 		{
 			name: "get",
 			initFunc: func(t *testing.T, mocks *apiMocks) {

pkg/plugin/api/client.go

@@ -149,6 +149,20 @@ func (c *Client) Update(ctx context.Context, object *unstructured.Unstructured)
 	return err
 }
 
+// ApplyYAML creates or updates resource(s) based on input yaml string.
+func (c *Client) ApplyYAML(ctx context.Context, namespace, yaml string) ([]string, error) {
+	client := c.DashboardConnection.Client()
+
+	req := &proto.ApplyYAMLRequest{
+		Namespace: namespace,
+		Yaml:      yaml,
+	}
+
+	res, err := client.ApplyYAML(ctx, req)
+
+	return res.Resources, err
+}
+
 func (c *Client) Create(ctx context.Context, object *unstructured.Unstructured) error {
 	client := c.DashboardConnection.Client()
 

pkg/plugin/api/client_test.go

@@ -42,6 +42,32 @@ func TestClient_Update(t *testing.T) {
 	require.NoError(t, err)
 }
 
+func TestClient_ApplyYAML(t *testing.T) {
+	controller := gomock.NewController(t)
+	defer controller.Finish()
+
+	ctx := context.Background()
+	namespace := "foo-namespace"
+	yamlString := "---\napiVersion:apps/v1"
+
+	dashboardClient := fake.NewMockDashboardClient(controller)
+	req := &proto.ApplyYAMLRequest{
+		Namespace: namespace,
+		Yaml:      yamlString,
+	}
+	dashboardClient.EXPECT().ApplyYAML(gomock.Any(), req).Return(&proto.ApplyYAMLResponse{}, nil)
+
+	conn := fake.NewMockDashboardConnection(controller)
+	conn.EXPECT().Client().Return(dashboardClient)
+
+	connOpt := MockDashboardConnection(conn)
+
+	client, err := api.NewClient("address", connOpt)
+	require.NoError(t, err)
+
+	_, err = client.ApplyYAML(ctx, namespace, yamlString)
+	require.NoError(t, err)
+}
 func TestClient_ForceFrontendUpdate(t *testing.T) {
 	controller := gomock.NewController(t)
 	defer controller.Finish()