Split test runs among deployments

If more than one account is passed for a deployment with `force import` divide test runs between deployments.

Author: easafe

.gitignore

@@ -1,10 +1,12 @@
 .DS_Store
 metadata/
+src/
+.sfdx/
 
 # Force CLI specific things
 force
 metadata
-test 
+test
 
 *.json
 

command/deploy.go

@@ -55,15 +55,15 @@ func (c *deployStatus) isAborted() bool {
 	return c.aborted
 }
 
-func deploy(force *Force, files ForceMetadataFiles, deployOptions *ForceDeployOptions, outputOptions *deployOutputOptions) error {
+func deploy(force *Force, files ForceMetadataFiles, deployOptions ForceDeployOptions, outputOptions *deployOutputOptions) error {
 	status := deployStatus{aborted: false}
 
 	return deployWith(force, &status, files, deployOptions, outputOptions)
 }
 
-func deployWith(force *Force, status *deployStatus, files ForceMetadataFiles, deployOptions *ForceDeployOptions, outputOptions *deployOutputOptions) error {
+func deployWith(force *Force, status *deployStatus, files ForceMetadataFiles, deployOptions ForceDeployOptions, outputOptions *deployOutputOptions) error {
 	startTime := time.Now()
-	deployId, err := force.Metadata.StartDeploy(files, *deployOptions)
+	deployId, err := force.Metadata.StartDeploy(files, deployOptions)
 	if err != nil {
 		return err
 	}

command/field.go

@@ -173,7 +173,7 @@ func updateFLSOnProfile(force *Force, objectName string, fieldName string) (err
 	}
 	displayOptions := defaultDeployOutputOptions()
 	displayOptions.quiet = true
-	return deploy(force, pb.ForceMetadataFiles(), new(ForceDeployOptions), displayOptions)
+	return deploy(force, pb.ForceMetadataFiles(), ForceDeployOptions{}, displayOptions)
 }
 
 func getFLSUpdateXML(objectName string, fieldName string) string {

command/import.go

@@ -7,14 +7,38 @@ import (
 	"os"
 	"os/user"
 	"path/filepath"
+	"slices"
+	"sort"
 	"strings"
 	"sync"
 
 	. "github.com/ForceCLI/force/error"
 	. "github.com/ForceCLI/force/lib"
+
+	"github.com/antlr4-go/antlr/v4"
+	"github.com/octoberswimmer/apexfmt/parser"
 	"github.com/spf13/cobra"
 )
 
+var importCmd = &cobra.Command{
+	Use:   "import",
+	Short: "Import metadata from a local directory",
+	Example: `
+  force import
+  force import -directory=my_metadata -c -r -v
+  force import -checkonly -runalltests
+`,
+	Run: func(cmd *cobra.Command, args []string) {
+		options := getDeploymentOptions(cmd)
+		srcDir := sourceDir(cmd)
+
+		displayOptions := getDeploymentOutputOptions(cmd)
+
+		runImport(srcDir, options, displayOptions)
+	},
+	Args: cobra.MaximumNArgs(0),
+}
+
 func init() {
 	// Deploy options
 	importCmd.Flags().BoolP("rollbackonerror", "r", false, "roll back deployment on error")
@@ -25,7 +49,8 @@ func init() {
 	importCmd.Flags().BoolP("allowmissingfiles", "m", false, "set allow missing files")
 	importCmd.Flags().BoolP("autoupdatepackage", "u", false, "set auto update package")
 	importCmd.Flags().BoolP("ignorewarnings", "i", false, "ignore warnings")
-	importCmd.Flags().StringSliceP("test", "", []string{}, "Test(s) to run")
+	importCmd.Flags().BoolP("splittests", "s", false, "split tests between deployments")
+	importCmd.Flags().StringSliceP("test", "", []string{}, "test(s) to run")
 
 	// Output options
 	importCmd.Flags().BoolP("ignorecoverage", "w", false, "suppress code coverage warnings")
@@ -42,25 +67,6 @@ func init() {
 	RootCmd.AddCommand(importCmd)
 }
 
-var importCmd = &cobra.Command{
-	Use:   "import",
-	Short: "Import metadata from a local directory",
-	Example: `
-  force import
-  force import -directory=my_metadata -c -r -v
-  force import -checkonly -runalltests
-`,
-	Run: func(cmd *cobra.Command, args []string) {
-		options := getDeploymentOptions(cmd)
-		srcDir := sourceDir(cmd)
-
-		displayOptions := getDeploymentOutputOptions(cmd)
-
-		runImport(srcDir, options, displayOptions)
-	},
-	Args: cobra.MaximumNArgs(0),
-}
-
 func sourceDir(cmd *cobra.Command) string {
 	directory, _ := cmd.Flags().GetString("directory")
 
@@ -92,7 +98,7 @@ func sourceDir(cmd *cobra.Command) string {
 	return root
 }
 
-func runImport(root string, options ForceDeployOptions, displayOptions *deployOutputOptions) {
+func runImport(root string, baseOptions ForceDeployOptions, displayOptions *deployOutputOptions) {
 	if displayOptions.quiet {
 		previousLogger := Log
 		var l quietLogger
@@ -124,16 +130,27 @@ func runImport(root string, options ForceDeployOptions, displayOptions *deployOu
 
 	var deployments sync.WaitGroup
 	status := deployStatus{aborted: false}
+	forces := manager.getAllForce()
+	var options []ForceDeployOptions
+	if baseOptions.TestLevel == "NoTestRun" || len(forces) == 1 {
+		options = make([]ForceDeployOptions, len(forces))
+		for i := range options {
+			options[i] = baseOptions
+		}
+	} else {
+		options = splitTests(baseOptions, files, len(forces))
+	}
 
-	for _, f := range manager.getAllForce() {
+	for i, f := range forces {
 		if status.isAborted() {
 			break
 		}
 		current := f
+		index := i
 		deployments.Add(1)
 		go func() {
 			defer deployments.Done()
-			err := deployWith(current, &status, files, &options, displayOptions)
+			err := deployWith(current, &status, files, options[index], displayOptions)
 			if err == nil && displayOptions.reportFormat == "text" && !displayOptions.quiet {
 				fmt.Printf("Imported from %s\n", root)
 			}
@@ -146,3 +163,111 @@ func runImport(root string, options ForceDeployOptions, displayOptions *deployOu
 
 	deployments.Wait()
 }
+
+// Evenly distribute tests to be run among deployments by counting how many test methods each (test) class has
+func splitTests(ops ForceDeployOptions, files ForceMetadataFiles, deployments int) []ForceDeployOptions {
+	//what about RunAllTestsInOrg?
+	options := make([]ForceDeployOptions, deployments)
+	testClasses := makeTestClasses(ops, files)
+	split := splitByDeployments(testClasses, deployments)
+
+	for i, s := range split {
+		options[i] = ops
+		options[i].RunTests = make([]string, len(s))
+
+		for j, className := range s {
+			options[i].RunTests[j] = className.name
+		}
+	}
+
+	return options
+}
+
+type testClass struct {
+	name    string
+	methods int
+}
+
+func makeTestClasses(ops ForceDeployOptions, files ForceMetadataFiles) []testClass {
+	allTests := len(ops.RunTests) == 0
+	testClasses := make([]testClass, 0)
+	folderPreffix := "classes" + string(os.PathSeparator)
+
+	for fileName, contents := range files {
+		name, isClass := strings.CutSuffix(fileName, ".cls")
+
+		if isClass && (allTests || slices.Contains(ops.RunTests, name)) {
+			count := testMethods(contents)
+
+			if count > 0 {
+				testClasses = append(testClasses, testClass{name: strings.TrimPrefix(name, folderPreffix), methods: count})
+			}
+		}
+	}
+
+	return testClasses
+}
+
+type testClassListener struct {
+	*parser.BaseApexParserListener
+	methods int
+}
+
+func (t *testClassListener) EnterModifier(ctx *parser.ModifierContext) {
+	if ctx.TESTMETHOD() != nil {
+		t.methods += 1
+	}
+}
+
+func (t *testClassListener) EnterAnnotation(ctx *parser.AnnotationContext) {
+	annotation := ctx.QualifiedName()
+
+	if annotation != nil && strings.ToUpper(annotation.GetText()) == "ISTEST" {
+		t.methods += 1
+	}
+}
+
+func testMethods(src []byte) int {
+	input := antlr.NewInputStream(string(src))
+	lexer := parser.NewApexLexer(input)
+	stream := antlr.NewCommonTokenStream(lexer, antlr.TokenDefaultChannel)
+	p := parser.NewApexParser(stream)
+	listener := new(testClassListener)
+
+	p.RemoveErrorListeners()
+	antlr.ParseTreeWalkerDefault.Walk(listener, p.CompilationUnit())
+
+	return listener.methods
+}
+
+type byMethods []testClass
+
+func (a byMethods) Len() int           { return len(a) }
+func (a byMethods) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
+func (a byMethods) Less(i, j int) bool { return a[i].methods > a[j].methods }
+
+func splitByDeployments(classes []testClass, n int) [][]testClass {
+	sort.Sort(byMethods(classes))
+	groups := make([][]testClass, n)
+
+	for i := range groups {
+		groups[i] = []testClass{}
+	}
+
+	methodCounts := make([]int, n)
+
+	for _, class := range classes {
+		// Find the group with the least number of methods
+		minIdx := 0
+		for i := 1; i < n; i++ {
+			if methodCounts[i] < methodCounts[minIdx] {
+				minIdx = i
+			}
+		}
+
+		groups[minIdx] = append(groups[minIdx], class)
+		methodCounts[minIdx] += class.methods
+	}
+
+	return groups
+}

command/push.go

@@ -173,7 +173,7 @@ func pushByPaths(resourcePaths []string, deployOptions *ForceDeployOptions, disp
 			ErrorAndExit("Could not add %s: %s", p, err.Error())
 		}
 	}
-	err = deploy(force, pb.ForceMetadataFiles(), deployOptions, displayOptions)
+	err = deploy(force, pb.ForceMetadataFiles(), *deployOptions, displayOptions)
 	if err != nil {
 		ErrorAndExit(err.Error())
 	}
@@ -198,7 +198,7 @@ func pushByMetadataType(metadataType string, metadataNames []string, deployOptio
 		}
 	}
 
-	err = deploy(force, pb.ForceMetadataFiles(), deployOptions, displayOptions)
+	err = deploy(force, pb.ForceMetadataFiles(), *deployOptions, displayOptions)
 	if err != nil {
 		ErrorAndExit(err.Error())
 	}
@@ -217,7 +217,7 @@ func pushMetadataTypes(metadataTypes []string, deployOptions *ForceDeployOptions
 		}
 	}
 
-	err = deploy(force, pb.ForceMetadataFiles(), deployOptions, displayOptions)
+	err = deploy(force, pb.ForceMetadataFiles(), *deployOptions, displayOptions)
 	if err != nil {
 		ErrorAndExit(err.Error())
 	}

go.mod

@@ -1,12 +1,15 @@
 module github.com/ForceCLI/force
 
-go 1.20
+go 1.22
+
+toolchain go1.22.4
 
 require (
 	github.com/ForceCLI/config v0.0.0-20230217143549-9149d42a3c99
 	github.com/ForceCLI/force-md v0.0.0-20240126214027-5b906037b66a
 	github.com/ForceCLI/inflect v0.0.0-20130829110746-cc00b5ad7a6a
 	github.com/ViViDboarder/gotifier v0.0.0-20140619195515-0f19f3d7c54c
+	github.com/antlr4-go/antlr/v4 v4.13.1
 	github.com/antonmedv/expr v1.15.3
 	github.com/bgentry/speakeasy v0.1.0
 	github.com/bmizerany/assert v0.0.0-20160611221934-b7ed37b82869
@@ -19,12 +22,13 @@ require (
 	github.com/hamba/avro/v2 v2.16.0
 	github.com/linkedin/goavro/v2 v2.12.0
 	github.com/obeattie/ohmyglob v0.0.0-20150811221449-290764208a0d
+	github.com/octoberswimmer/apexfmt v0.0.0-20240326123316-6d1990ec1d8b
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/onsi/ginkgo v1.12.0
 	github.com/onsi/gomega v1.10.0
 	github.com/pkg/errors v0.9.1
 	github.com/rgalanakis/golangal v0.0.0-20210923203926-e36008487518
-	github.com/spf13/cobra v1.7.0
+	github.com/spf13/cobra v1.8.0
 	golang.org/x/crypto v0.14.0
 	google.golang.org/grpc v1.39.0-dev
 	google.golang.org/protobuf v1.28.1
@@ -36,7 +40,7 @@ require (
 	github.com/charmbracelet/harmonica v0.2.0 // indirect
 	github.com/cihub/seelog v0.0.0-20170130134532-f561c5e57575 // indirect
 	github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81 // indirect
-	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect
 	github.com/fsnotify/fsnotify v1.4.9 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
@@ -62,8 +66,9 @@ require (
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/exp v0.0.0-20240506185415-9bf2ced13842 // indirect
 	golang.org/x/net v0.17.0 // indirect
-	golang.org/x/sync v0.1.0 // indirect
+	golang.org/x/sync v0.7.0 // indirect
 	golang.org/x/sys v0.13.0 // indirect
 	golang.org/x/term v0.13.0 // indirect
 	golang.org/x/text v0.13.0 // indirect