MM-46253: Comparison collect command (#653)

* Add comparison collect command

* Test comparison.GetDeploymentIds

cmd/ltctl/collect.go

@@ -16,6 +16,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/mattermost/mattermost-load-test-ng/deployment"
 	"github.com/mattermost/mattermost-load-test-ng/deployment/terraform"
 	"github.com/mattermost/mattermost-load-test-ng/deployment/terraform/ssh"
 
@@ -33,7 +34,7 @@ type file struct {
 	data []byte
 }
 
-func saveCollection(files []file) error {
+func saveCollection(namePrefix string, files []file) error {
 	u, err := user.Current()
 	if err != nil {
 		return err
@@ -49,7 +50,7 @@ func saveCollection(files []file) error {
 		return err
 	}
 
-	name := fmt.Sprintf("collection_%d", time.Now().Unix())
+	name := fmt.Sprintf("%scollection_%d", namePrefix, time.Now().Unix())
 	filename := fmt.Sprintf("./%s.tar", name)
 	f, err := os.Create(filename)
 	if err != nil {
@@ -144,7 +145,11 @@ func RunCollectCmdF(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	t, err := terraform.New("", config)
+	return collect(config, "", "")
+}
+
+func collect(config deployment.Config, deploymentId string, outputName string) error {
+	t, err := terraform.New(deploymentId, config)
 	if err != nil {
 		return fmt.Errorf("failed to create terraform engine: %w", err)
 	}
@@ -256,7 +261,7 @@ func RunCollectCmdF(cmd *cobra.Command, args []string) error {
 		files[i] = <-filesChan
 	}
 
-	if err := saveCollection(files); err != nil {
+	if err := saveCollection(outputName, files); err != nil {
 		return fmt.Errorf("failed to save collection: %w", err)
 	}
 

cmd/ltctl/comparison.go

@@ -14,6 +14,7 @@ import (
 	"time"
 
 	"github.com/mattermost/mattermost-load-test-ng/comparison"
+	"github.com/wiggin77/merror"
 
 	"github.com/spf13/cobra"
 )
@@ -172,6 +173,33 @@ func RunComparisonCmdF(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+func CollectComparisonCmdF(cmd *cobra.Command, args []string) error {
+	deployerConfig, err := getConfig(cmd)
+	if err != nil {
+		return err
+	}
+
+	configFilePath, _ := cmd.Flags().GetString("comparison-config")
+	cfg, err := comparison.ReadConfig(configFilePath)
+	if err != nil {
+		return fmt.Errorf("failed to read comparison config: %w", err)
+	}
+
+	cmp, err := comparison.New(cfg, &deployerConfig)
+	if err != nil {
+		return fmt.Errorf("failed to initialize comparison object: %w", err)
+	}
+
+	merr := merror.New()
+	for _, id := range cmp.GetDeploymentIds() {
+		if err := collect(deployerConfig, id, id+"_"); err != nil {
+			merr.Append(err)
+		}
+	}
+
+	return merr.ErrorOrNil()
+}
+
 func DestroyComparisonCmdF(cmd *cobra.Command, args []string) error {
 	deployerConfig, err := getConfig(cmd)
 	if err != nil {

cmd/ltctl/main.go

@@ -329,12 +329,19 @@ func main() {
 	runComparisonCmd.Flags().StringP("output-dir", "d", "", "path to output directory")
 	runComparisonCmd.Flags().StringP("format", "f", "plain", "output format [plain, json]")
 
+	collectComparisonCmd := &cobra.Command{
+		Use:   "collect",
+		Short: "Collect logs and configurations from all deployments",
+		RunE:  CollectComparisonCmdF,
+	}
+
 	destroyComparisonCmd := &cobra.Command{
 		Use:   "destroy",
 		Short: "Destroy the current load-test comparison environment",
 		RunE:  DestroyComparisonCmdF,
 	}
-	comparisonCmd.AddCommand(runComparisonCmd, destroyComparisonCmd)
+
+	comparisonCmd.AddCommand(runComparisonCmd, destroyComparisonCmd, collectComparisonCmd)
 	rootCmd.AddCommand(comparisonCmd)
 
 	if err := rootCmd.Execute(); err != nil {

comparison/comparison.go

@@ -5,6 +5,7 @@ package comparison
 
 import (
 	"fmt"
+	"sort"
 	"sync"
 
 	"github.com/mattermost/mattermost-load-test-ng/defaults"
@@ -153,3 +154,12 @@ func (c *Comparison) Destroy() error {
 		return t.Destroy()
 	})
 }
+
+func (c *Comparison) GetDeploymentIds() []string {
+	ids := []string{}
+	for k := range c.deployments {
+		ids = append(ids, k)
+	}
+	sort.Strings(ids)
+	return ids
+}

comparison/comparison_test.go

@@ -0,0 +1,50 @@
+package comparison
+
+import (
+	"sort"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestGetDeploymentIds(t *testing.T) {
+	testCases := []struct {
+		Name string
+		Ids  []string
+	}{
+		{
+			Name: "Empty comparison",
+			Ids:  []string{},
+		},
+		{
+			Name: "One element",
+			Ids:  []string{"a"},
+		},
+		{
+			Name: "Elements already ordered",
+			Ids:  []string{"a", "b"},
+		},
+		{
+			Name: "Unordered elements",
+			Ids:  []string{"b", "a"},
+		},
+	}
+
+	emptyCfg := deploymentConfig{}
+	for _, tc := range testCases {
+		t.Run(tc.Name, func(t *testing.T) {
+			cmp := Comparison{}
+			cmp.deployments = make(map[string]*deploymentConfig)
+			for _, id := range tc.Ids {
+				cmp.deployments[id] = &emptyCfg
+			}
+
+			expectedIds := make([]string, len(tc.Ids))
+			copy(expectedIds, tc.Ids)
+			sort.Strings(expectedIds)
+
+			actualIds := cmp.GetDeploymentIds()
+			require.EqualValues(t, expectedIds, actualIds)
+		})
+	}
+}