STAC-24049: add crud commands for otel component|relation mappings

Author: deontaljaard

cmd/otelcomponentmapping.go

@@ -15,6 +15,10 @@ func OtelComponentMappingCommand(deps *di.Deps) *cobra.Command {
 
 	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingListCommand(deps))
 	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingStatusCommand(deps))
+	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingDescribeCommand(deps))
+	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingDeleteCommand(deps))
+	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingEditCommand(deps))
+	cmd.AddCommand(otelcomponentmapping.OtelComponentMappingApplyCommand(deps))
 
 	return cmd
 }

cmd/otelcomponentmapping/otelcomponentmapping_apply.go

@@ -0,0 +1,75 @@
+package otelcomponentmapping
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/spf13/cobra"
+	"github.com/stackvista/stackstate-cli/generated/stackstate_api"
+	"github.com/stackvista/stackstate-cli/internal/common"
+	"github.com/stackvista/stackstate-cli/internal/di"
+	"sigs.k8s.io/kustomize/kyaml/yaml"
+)
+
+type ApplyArgs struct {
+	File string
+}
+
+func OtelComponentMappingApplyCommand(deps *di.Deps) *cobra.Command {
+	args := &ApplyArgs{}
+	cmd := &cobra.Command{
+		Use:   "apply",
+		Short: "Create or edit an OTel Component Mapping from YAML",
+		Long:  "Create or edit a OTel Component Mapping from YAML file.",
+		RunE:  deps.CmdRunEWithApi(RunApplyComponentMappingCommand(args)),
+	}
+
+	common.AddRequiredFileFlagVar(cmd, &args.File, "Path to a .yaml file with the mapping definition")
+
+	return cmd
+}
+
+func RunApplyComponentMappingCommand(args *ApplyArgs) di.CmdWithApiFn {
+	return func(cmd *cobra.Command, cli *di.Deps, api *stackstate_api.APIClient, serverInfo *stackstate_api.ServerInfo) common.CLIError {
+		fileBytes, err := os.ReadFile(args.File)
+		if err != nil {
+			return common.NewReadFileError(err, args.File)
+		}
+
+		ext := strings.ToLower(filepath.Ext(args.File))
+		if ext != ".yaml" {
+			return common.NewCLIArgParseError(fmt.Errorf("unsupported file type: %s. Only .yaml files are supported", ext))
+		}
+
+		return applyYAMLOtelComponentMapping(cli, api, fileBytes)
+	}
+}
+
+func applyYAMLOtelComponentMapping(cli *di.Deps, api *stackstate_api.APIClient, fileBytes []byte) common.CLIError {
+	var mapping stackstate_api.OtelComponentMapping
+	if err := yaml.Unmarshal(fileBytes, &mapping); err != nil {
+		return common.NewCLIArgParseError(fmt.Errorf("failed to parse YAML: %v", err))
+	}
+
+	reqObj := stackstate_api.UpsertOtelComponentMappingsRequest{
+		Identifier:  mapping.Identifier,
+		Name:        mapping.Name,
+		Description: mapping.Description,
+		Input:       mapping.Input,
+		Output:      mapping.Output,
+		Vars:        mapping.Vars,
+		ExpireAfter: mapping.ExpireAfter,
+	}
+	upserted, resp, err := api.OtelMappingApi.UpsertOtelComponentMappings(cli.Context).UpsertOtelComponentMappingsRequest(reqObj).Execute()
+	if err != nil {
+		return common.NewResponseError(err, resp)
+	}
+	if cli.IsJson() {
+		cli.Printer.PrintJson(map[string]interface{}{"otel_component_mapping": upserted})
+	} else {
+		cli.Printer.Success(fmt.Sprintf("OTel component mapping upserted successfully! Identifier: %s, Name: %s", mapping.GetIdentifier(), mapping.GetName()))
+	}
+	return nil
+}

cmd/otelcomponentmapping/otelcomponentmapping_apply_test.go

@@ -0,0 +1,141 @@
+package otelcomponentmapping_test
+
+import (
+	"errors"
+	"os"
+	"testing"
+
+	"github.com/stackvista/stackstate-cli/cmd/otelcomponentmapping"
+	"github.com/stackvista/stackstate-cli/generated/stackstate_api"
+	"github.com/stackvista/stackstate-cli/internal/di"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v2"
+)
+
+func createTempYamlFile(t *testing.T, content string) string {
+	t.Helper()
+	tmpfile, err := os.CreateTemp(os.TempDir(), "test_componentmapping_*.yaml")
+	if err != nil {
+		panic(err)
+	}
+
+	_, err = tmpfile.Write([]byte(content))
+	assert.NoError(t, err)
+	tmpfile.Close()
+	return tmpfile.Name()
+}
+
+func toOtelMappingItem(m stackstate_api.OtelComponentMapping) stackstate_api.OtelMappingItem {
+	return stackstate_api.OtelMappingItem{
+		Name:       m.Name,
+		Identifier: &m.Identifier,
+	}
+}
+
+func TestOtelComponentMappingApply_SuccessYaml(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	mapping := stackstate_api.OtelComponentMapping{
+		Name:       "my-mapping",
+		Identifier: "urn:otel:component:foo",
+	}
+	yamlContent, err := yaml.Marshal(mapping)
+	assert.NoError(t, err)
+	tmpFile := createTempYamlFile(t, string(yamlContent))
+	defer os.Remove(tmpFile)
+
+	want := toOtelMappingItem(mapping)
+	cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsResponse.Result = want
+
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", tmpFile)
+
+	assert.Len(t, *cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsCalls, 1)
+	upsertCall := (*cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsCalls)[0]
+	assert.Equal(t, mapping.Identifier, upsertCall.PupsertOtelComponentMappingsRequest.Identifier)
+	assert.Equal(t, mapping.Name, upsertCall.PupsertOtelComponentMappingsRequest.Name)
+}
+
+func TestOtelComponentMappingApply_SuccessJson(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	mapping := stackstate_api.OtelComponentMapping{
+		Name:       "my-mapping",
+		Identifier: "urn:otel:component:foo",
+	}
+	yamlContent, err := yaml.Marshal(mapping)
+	assert.NoError(t, err)
+	tmpFile := createTempYamlFile(t, string(yamlContent))
+	defer os.Remove(tmpFile)
+
+	want := toOtelMappingItem(mapping)
+	cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsResponse.Result = want
+
+	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", tmpFile, "-o", "json")
+
+	assert.Len(t, *cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsCalls, 1)
+
+	output := *cli.MockPrinter.PrintJsonCalls
+	assert.Len(t, output, 1)
+	val, ok := output[0]["otel_component_mapping"]
+	assert.True(t, ok)
+	actualPtr, ok := val.(*stackstate_api.OtelMappingItem)
+	if ok {
+		assert.Equal(t, &want, actualPtr)
+	} else {
+		actualVal, ok := val.(stackstate_api.OtelMappingItem)
+		require.True(t, ok, "PrintJsonCalls type is not OtelMappingItem or *OtelMappingItem")
+		assert.Equal(t, want, actualVal)
+	}
+}
+
+func TestOtelComponentMappingApply_FileNotFound(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	badPath := "/not/a/real/path.yaml"
+	require.Panics(t, func() {
+		di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", badPath)
+	}, "expected panic for missing file during apply command execution")
+}
+
+func TestOtelComponentMappingApply_WrongExtension(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	tmpFile := createTempYamlFile(t, "irrelevant-content")
+	newPath := tmpFile + ".txt"
+	err := os.Rename(tmpFile, newPath)
+	assert.NoError(t, err)
+	defer os.Remove(newPath)
+	require.Panics(t, func() {
+		di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", newPath)
+	}, "expected panic for wrong extension during apply command execution")
+}
+
+func TestOtelComponentMappingApply_InvalidYaml(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	tmpFile := createTempYamlFile(t, "not: [valid, yaml,,,")
+	defer os.Remove(tmpFile)
+	require.Panics(t, func() {
+		di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", tmpFile)
+	}, "expected panic for invalid YAML during apply command execution")
+}
+
+func TestOtelComponentMappingApply_ApiError(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingApplyCommand(&cli.Deps)
+	mapping := stackstate_api.OtelComponentMapping{
+		Name:       "my-mapping",
+		Identifier: "urn:otel:component:foo",
+	}
+	yamlContent, err := yaml.Marshal(mapping)
+	assert.NoError(t, err)
+	tmpFile := createTempYamlFile(t, string(yamlContent))
+	defer os.Remove(tmpFile)
+
+	cli.MockClient.ApiMocks.OtelMappingApi.UpsertOtelComponentMappingsResponse.Error = errors.New("api failure")
+
+	require.Panics(t, func() {
+		di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-f", tmpFile)
+	}, "expected panic for API error during apply command execution")
+}

cmd/otelcomponentmapping/otelcomponentmapping_delete.go

@@ -0,0 +1,55 @@
+package otelcomponentmapping
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/stackvista/stackstate-cli/generated/stackstate_api"
+	"github.com/stackvista/stackstate-cli/internal/common"
+	"github.com/stackvista/stackstate-cli/internal/di"
+)
+
+type DeleteArgs struct {
+	Identifier string
+}
+
+func OtelComponentMappingDeleteCommand(deps *di.Deps) *cobra.Command {
+	args := &DeleteArgs{}
+	cmd := &cobra.Command{
+		Use:   "delete",
+		Short: "Delete an OTel Component Mapping by identifier (URN)",
+		Long:  "Delete an OTel Component Mapping by identifier (URN)",
+		RunE:  deps.CmdRunEWithApi(RunDeleteComponentMappingCommand(args)),
+	}
+
+	common.AddRequiredIdentifierFlagVar(cmd, &args.Identifier, "Identifier (URN) of the Component Mapping to delete")
+
+	return cmd
+}
+
+func RunDeleteComponentMappingCommand(args *DeleteArgs) di.CmdWithApiFn {
+	return func(
+		cmd *cobra.Command,
+		cli *di.Deps,
+		api *stackstate_api.APIClient,
+		serverInfo *stackstate_api.ServerInfo,
+	) common.CLIError {
+		if args.Identifier == "" {
+			return common.NewCLIArgParseError(fmt.Errorf("--identifier is required"))
+		}
+
+		resp, err := api.OtelMappingApi.DeleteOtelComponentMapping(cli.Context, args.Identifier).Execute()
+		if err != nil {
+			return common.NewResponseError(err, resp)
+		}
+
+		result := map[string]interface{}{"deleted_identifier": args.Identifier}
+		if cli.IsJson() {
+			cli.Printer.PrintJson(result)
+		} else {
+			cli.Printer.Success(fmt.Sprintf("OTel Component Mapping deleted: %s", args.Identifier))
+		}
+
+		return nil
+	}
+}

cmd/otelcomponentmapping/otelcomponentmapping_delete_test.go

@@ -0,0 +1,57 @@
+package otelcomponentmapping_test
+
+import (
+	"testing"
+
+	"github.com/stackvista/stackstate-cli/cmd/otelcomponentmapping"
+	"github.com/stackvista/stackstate-cli/internal/di"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestOtelComponentMappingDelete_Success(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingDeleteCommand(&cli.Deps)
+	mockUrn := "urn:otel:component:delete-test"
+
+	_, err := di.ExecuteCommandWithContext(&cli.Deps, cmd, "--identifier", mockUrn)
+
+	assert.Nil(t, err)
+	assert.Len(t, *cli.MockPrinter.SuccessCalls, 1)
+	assert.Contains(t, (*cli.MockPrinter.SuccessCalls)[0], mockUrn)
+}
+
+func TestOtelComponentMappingDelete_MissingIdentifier(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingDeleteCommand(&cli.Deps)
+
+	_, err := di.ExecuteCommandWithContext(&cli.Deps, cmd)
+
+	assert.NotNil(t, err)
+	assert.Contains(t, err.Error(), "required flag(s) \"identifier\" not set")
+}
+
+func TestOtelComponentMappingDelete_ApiError(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingDeleteCommand(&cli.Deps)
+	mockUrn := "urn:otel:component:delete-error"
+
+	cli.MockClient.ApiMocks.OtelMappingApi.DeleteOtelComponentMappingResponse.Error = assert.AnError
+
+	_, err := di.ExecuteCommandWithContext(&cli.Deps, cmd, "--identifier", mockUrn)
+	assert.NotNil(t, err)
+}
+
+func TestOtelComponentMappingDelete_SuccessJsonOutput(t *testing.T) {
+	cli := di.NewMockDeps(t)
+	cmd := otelcomponentmapping.OtelComponentMappingDeleteCommand(&cli.Deps)
+	mockUrn := "urn:otel:component:delete-test-json"
+
+	_, err := di.ExecuteCommandWithContext(&cli.Deps, cmd, "--identifier", mockUrn, "--output", "json")
+
+	assert.Nil(t, err)
+	expected := []map[string]interface{}{
+		{"deleted_identifier": mockUrn},
+	}
+	assert.Equal(t, expected, *cli.MockPrinter.PrintJsonCalls)
+	assert.False(t, cli.MockPrinter.HasNonJsonCalls)
+}