STAC-22985: Address review comments

aacevedoosorio · aacevedoosorio · commit d3388af2300d · 2025-10-03T15:43:55.000+02:00
diff --git a/cmd/cmd_rules_test.go b/cmd/cmd_rules_test.go
@@ -34,16 +34,27 @@ func TestNounsAndVerbsExistAsFilesInDirectories(t *testing.T) {
 }
 
 func TestVerbCommandCheckForJsonOuput(t *testing.T) {
+	var jsonCheckAllowList = map[string]struct{}{
+		"otelcomponentmapping/otelcomponentmapping_status.go": {},
+		"otelrelationmapping/otelrelationmapping_status.go":   {},
+	}
+
 	root := setupCmd(t)
 	for _, nounCmd := range root.Commands() {
 		for _, verbCmd := range nounCmd.Commands() {
 			nounName := strings.ReplaceAll(nounCmd.Name(), "-", "")
 			verbName := strings.ReplaceAll(verbCmd.Name(), "-", "_")
 			verCmdGoFile := fmt.Sprintf("%s/%s_%s.go", nounName, nounName, verbName)
+
+			if _, ok := jsonCheckAllowList[verCmdGoFile]; ok {
+				continue
+			}
+
 			verbCmdGoCode, err := os.ReadFile(verCmdGoFile)
 			if err != nil {
 				t.Fatal(err)
 			}
+
 			if !strings.Contains(string(verbCmdGoCode), "if cli.IsJson() {") {
 				t.Errorf("%s does not check whether to print to json!", verCmdGoFile)
 			}
diff --git a/cmd/otelcomponentmapping/otelcomponentmapping_list_test.go b/cmd/otelcomponentmapping/otelcomponentmapping_list_test.go
@@ -1,18 +1,19 @@
-package otelcomponentmapping
+package otelcomponentmapping_test
 
 import (
 	"testing"
 
-	"github.com/stackvista/stackstate-cli/cmd/otelmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelcomponentmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelmapping_test"
 	"github.com/stackvista/stackstate-cli/internal/di"
 	"github.com/stackvista/stackstate-cli/internal/printer"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestListOtelComponentMappingsJson(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelComponentMappingListCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingsResponse.Result = otelmapping.TestAllMappingItems
+	cmd := otelcomponentmapping.OtelComponentMappingListCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingsResponse.Result = otelmapping_test.TestAllMappingItems
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-o", "json")
 
@@ -21,7 +22,7 @@ func TestListOtelComponentMappingsJson(t *testing.T) {
 
 	expected := []map[string]interface{}{
 		{
-			"otel component mappings": otelmapping.TestAllMappingItems,
+			"otel component mappings": otelmapping_test.TestAllMappingItems,
 		},
 	}
 
@@ -30,8 +31,8 @@ func TestListOtelComponentMappingsJson(t *testing.T) {
 
 func TestOtelComponentMappingListTable(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelComponentMappingListCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingsResponse.Result = otelmapping.TestAllMappingItems
+	cmd := otelcomponentmapping.OtelComponentMappingListCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingsResponse.Result = otelmapping_test.TestAllMappingItems
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd)
 
@@ -42,8 +43,8 @@ func TestOtelComponentMappingListTable(t *testing.T) {
 		{
 			Header: []string{"Name", "Identifier"},
 			Data: [][]interface{}{
-				{otelmapping.TestSomeOtelMappingItem.Name, "identifier"},
-				{otelmapping.TestSomeOtelMappingItem2.Name, "identifier2"},
+				{otelmapping_test.TestSomeOtelMappingItem.Name, "identifier"},
+				{otelmapping_test.TestSomeOtelMappingItem2.Name, "identifier2"},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel mappings"},
 		},
diff --git a/cmd/otelcomponentmapping/otelcomponentmapping_status.go b/cmd/otelcomponentmapping/otelcomponentmapping_status.go
@@ -7,9 +7,6 @@ import (
 	"github.com/stackvista/stackstate-cli/internal/di"
 )
 
-// if cli.IsJson() {
-// cli.Printer.PrintJson(
-
 func OtelComponentMappingStatusCommand(deps *di.Deps) *cobra.Command {
 	args := &otelmapping.StatusArgs{}
 	cmd := &cobra.Command{
diff --git a/cmd/otelcomponentmapping/otelcomponentmapping_status_test.go b/cmd/otelcomponentmapping/otelcomponentmapping_status_test.go
@@ -1,18 +1,19 @@
-package otelcomponentmapping
+package otelcomponentmapping_test
 
 import (
 	"testing"
 
-	"github.com/stackvista/stackstate-cli/cmd/otelmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelcomponentmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelmapping_test"
 	"github.com/stackvista/stackstate-cli/internal/di"
 	"github.com/stackvista/stackstate-cli/internal/printer"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestOtelComponentMappingStatusJson(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelComponentMappingStatusCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingStatusResponse.Result = *otelmapping.TestSomeOtelMappingStatus
+	cmd := otelcomponentmapping.OtelComponentMappingStatusCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingStatusResponse.Result = *otelmapping_test.TestSomeOtelMappingStatus
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--identifier", "identifier", "-o", "json")
 
@@ -21,7 +22,7 @@ func TestOtelComponentMappingStatusJson(t *testing.T) {
 
 	expected := []map[string]interface{}{
 		{
-			"otel-component-mapping": otelmapping.TestSomeOtelMappingStatus,
+			"otel-component-mapping": otelmapping_test.TestSomeOtelMappingStatus,
 		},
 	}
 
@@ -30,8 +31,8 @@ func TestOtelComponentMappingStatusJson(t *testing.T) {
 
 func TestOtelComponentMappingStatusTable(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelComponentMappingStatusCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingStatusResponse.Result = *otelmapping.TestSomeOtelMappingStatus
+	cmd := otelcomponentmapping.OtelComponentMappingStatusCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelComponentMappingStatusResponse.Result = *otelmapping_test.TestSomeOtelMappingStatus
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--identifier", "identifier")
 
@@ -42,22 +43,22 @@ func TestOtelComponentMappingStatusTable(t *testing.T) {
 		{
 			Header: []string{"Name", "Identifier", "Components", "Relations"},
 			Data: [][]interface{}{
-				{otelmapping.TestSomeOtelMappingStatusItem.Name, "identifier", otelmapping.TestComponentCount, otelmapping.TestRelationCount},
+				{otelmapping_test.TestSomeOtelMappingStatusItem.Name, "identifier", otelmapping_test.TestComponentCount, otelmapping_test.TestRelationCount},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel mappings"},
 		},
 		{
 			Header: []string{"Metric", "10s ago", "10-20s ago", "20-30s ago"},
 			Data: [][]interface{}{
-				{"latency seconds", otelmapping.TestMetricValue, otelmapping.TestMetricValue, otelmapping.TestMetricValue},
+				{"latency seconds", otelmapping_test.TestMetricValue, otelmapping_test.TestMetricValue, otelmapping_test.TestMetricValue},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "metrics"},
 		},
 		{
 			Header: []string{"Issue Id", "Level", "Message"},
 			Data: [][]interface{}{
-				{"-", otelmapping.TestError1.Level, otelmapping.TestError1.Message},
-				{"-", otelmapping.TestError2.Level, otelmapping.TestError2.Message},
+				{"-", otelmapping_test.TestError1.Level, otelmapping_test.TestError1.Message},
+				{"-", otelmapping_test.TestError2.Level, otelmapping_test.TestError2.Message},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel component mapping errors"},
 		},
diff --git a/cmd/otelmapping_test/test_data.go b/cmd/otelmapping_test/test_data.go
@@ -1,4 +1,4 @@
-package otelmapping
+package otelmapping_test
 
 import (
 	"github.com/stackvista/stackstate-cli/generated/stackstate_api"
diff --git a/cmd/otelrelationmapping/otelrelationmapping_list_test.go b/cmd/otelrelationmapping/otelrelationmapping_list_test.go
@@ -1,18 +1,19 @@
-package otelrelationmapping
+package otelrelationmapping_test
 
 import (
 	"testing"
 
-	"github.com/stackvista/stackstate-cli/cmd/otelmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelmapping_test"
+	"github.com/stackvista/stackstate-cli/cmd/otelrelationmapping"
 	"github.com/stackvista/stackstate-cli/internal/di"
 	"github.com/stackvista/stackstate-cli/internal/printer"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestOtelRelationMappingListJson(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelRelationMappingListCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingsResponse.Result = otelmapping.TestAllMappingItems
+	cmd := otelrelationmapping.OtelRelationMappingListCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingsResponse.Result = otelmapping_test.TestAllMappingItems
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "-o", "json")
 
@@ -21,7 +22,7 @@ func TestOtelRelationMappingListJson(t *testing.T) {
 
 	expected := []map[string]interface{}{
 		{
-			"otel relation mappings": otelmapping.TestAllMappingItems,
+			"otel relation mappings": otelmapping_test.TestAllMappingItems,
 		},
 	}
 
@@ -30,8 +31,8 @@ func TestOtelRelationMappingListJson(t *testing.T) {
 
 func TestOtelRelationMappingListTable(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelRelationMappingListCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingsResponse.Result = otelmapping.TestAllMappingItems
+	cmd := otelrelationmapping.OtelRelationMappingListCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingsResponse.Result = otelmapping_test.TestAllMappingItems
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd)
 
@@ -42,8 +43,8 @@ func TestOtelRelationMappingListTable(t *testing.T) {
 		{
 			Header: []string{"Name", "Identifier"},
 			Data: [][]interface{}{
-				{otelmapping.TestSomeOtelMappingItem.Name, "identifier"},
-				{otelmapping.TestSomeOtelMappingItem2.Name, "identifier2"},
+				{otelmapping_test.TestSomeOtelMappingItem.Name, "identifier"},
+				{otelmapping_test.TestSomeOtelMappingItem2.Name, "identifier2"},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel mappings"},
 		},
diff --git a/cmd/otelrelationmapping/otelrelationmapping_status.go b/cmd/otelrelationmapping/otelrelationmapping_status.go
@@ -7,9 +7,6 @@ import (
 	"github.com/stackvista/stackstate-cli/internal/di"
 )
 
-// if cli.IsJson() {
-// cli.Printer.PrintJson(
-
 func OtelRelationMappingStatusCommand(deps *di.Deps) *cobra.Command {
 	args := &otelmapping.StatusArgs{}
 	cmd := &cobra.Command{
diff --git a/cmd/otelrelationmapping/otelrelationmapping_status_test.go b/cmd/otelrelationmapping/otelrelationmapping_status_test.go
@@ -1,18 +1,19 @@
-package otelrelationmapping
+package otelrelationmapping_test
 
 import (
 	"testing"
 
-	"github.com/stackvista/stackstate-cli/cmd/otelmapping"
+	"github.com/stackvista/stackstate-cli/cmd/otelmapping_test"
+	"github.com/stackvista/stackstate-cli/cmd/otelrelationmapping"
 	"github.com/stackvista/stackstate-cli/internal/di"
 	"github.com/stackvista/stackstate-cli/internal/printer"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestOtelRelationMappingStatusJson(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelRelationMappingStatusCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingStatusResponse.Result = *otelmapping.TestSomeOtelMappingStatus
+	cmd := otelrelationmapping.OtelRelationMappingStatusCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingStatusResponse.Result = *otelmapping_test.TestSomeOtelMappingStatus
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--identifier", "identifier", "-o", "json")
 
@@ -21,7 +22,7 @@ func TestOtelRelationMappingStatusJson(t *testing.T) {
 
 	expected := []map[string]interface{}{
 		{
-			"otel-relation-mapping": otelmapping.TestSomeOtelMappingStatus,
+			"otel-relation-mapping": otelmapping_test.TestSomeOtelMappingStatus,
 		},
 	}
 
@@ -30,8 +31,8 @@ func TestOtelRelationMappingStatusJson(t *testing.T) {
 
 func TestOtelRelationMappingStatusTable(t *testing.T) {
 	cli := di.NewMockDeps(t)
-	cmd := OtelRelationMappingStatusCommand(&cli.Deps)
-	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingStatusResponse.Result = *otelmapping.TestSomeOtelMappingStatus
+	cmd := otelrelationmapping.OtelRelationMappingStatusCommand(&cli.Deps)
+	cli.MockClient.ApiMocks.OtelMappingApi.GetOtelRelationMappingStatusResponse.Result = *otelmapping_test.TestSomeOtelMappingStatus
 
 	di.ExecuteCommandWithContextUnsafe(&cli.Deps, cmd, "--identifier", "identifier")
 
@@ -42,22 +43,22 @@ func TestOtelRelationMappingStatusTable(t *testing.T) {
 		{
 			Header: []string{"Name", "Identifier", "Components", "Relations"},
 			Data: [][]interface{}{
-				{otelmapping.TestSomeOtelMappingStatusItem.Name, "identifier", otelmapping.TestComponentCount, otelmapping.TestRelationCount},
+				{otelmapping_test.TestSomeOtelMappingStatusItem.Name, "identifier", otelmapping_test.TestComponentCount, otelmapping_test.TestRelationCount},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel mappings"},
 		},
 		{
 			Header: []string{"Metric", "10s ago", "10-20s ago", "20-30s ago"},
 			Data: [][]interface{}{
-				{"latency seconds", otelmapping.TestMetricValue, otelmapping.TestMetricValue, otelmapping.TestMetricValue},
+				{"latency seconds", otelmapping_test.TestMetricValue, otelmapping_test.TestMetricValue, otelmapping_test.TestMetricValue},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "metrics"},
 		},
 		{
 			Header: []string{"Issue Id", "Level", "Message"},
 			Data: [][]interface{}{
-				{"-", otelmapping.TestError1.Level, otelmapping.TestError1.Message},
-				{"-", otelmapping.TestError2.Level, otelmapping.TestError2.Message},
+				{"-", otelmapping_test.TestError1.Level, otelmapping_test.TestError1.Message},
+				{"-", otelmapping_test.TestError2.Level, otelmapping_test.TestError2.Message},
 			},
 			MissingTableDataMsg: printer.NotFoundMsg{Types: "otel relation mapping errors"},
 		},
diff --git a/stackstate-cli.iml b/stackstate-cli.iml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="Go" enabled="true" />
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,6 @@ import (`
`7`	`7`	`"github.com/stackvista/stackstate-cli/internal/di"`
`8`	`8`	`)`
`9`	`9`
`10`		`-// if cli.IsJson() {`
`11`		`-// cli.Printer.PrintJson(`
`12`		`-`
`13`	`10`	`func OtelComponentMappingStatusCommand(deps di.Deps) cobra.Command {`
`14`	`11`	`args := &otelmapping.StatusArgs{}`
`15`	`12`	`cmd := &cobra.Command{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package otelmapping`
	`1`	`+package otelmapping_test`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"github.com/stackvista/stackstate-cli/generated/stackstate_api"`