newt: Add possibility to run newt tests under Valgrind

m-gorecki · m-gorecki · commit 5384b36cdfc0 · 2025-06-26T16:34:20.000+02:00
This adds flag --valgrind to newt test command.
When used the tests are executed in Valgrind.
diff --git a/newt/builder/selftest.go b/newt/builder/selftest.go
@@ -77,7 +77,7 @@ func (t *TargetBuilder) SelfTestCreateExe() error {
 	return nil
 }
 
-func (t *TargetBuilder) SelfTestExecute() error {
+func (t *TargetBuilder) SelfTestExecute(valgrind bool) error {
 	if err := t.SelfTestCreateExe(); err != nil {
 		return err
 	}
@@ -87,7 +87,7 @@ func (t *TargetBuilder) SelfTestExecute() error {
 		return err
 	}
 
-	if err := t.AppBuilder.SelfTestExecute(testRpkg); err != nil {
+	if err := t.AppBuilder.SelfTestExecute(testRpkg, valgrind); err != nil {
 		return err
 	}
 
@@ -140,7 +140,7 @@ func (b *Builder) testOwner(bpkg *BuildPackage) *BuildPackage {
 	}
 }
 
-func (b *Builder) SelfTestExecute(testRpkg *resolve.ResolvePackage) error {
+func (b *Builder) SelfTestExecute(testRpkg *resolve.ResolvePackage, valgrind bool) error {
 	testPath := b.TestExePath()
 	if err := os.Chdir(filepath.Dir(testPath)); err != nil {
 		return err
@@ -149,6 +149,9 @@ func (b *Builder) SelfTestExecute(testRpkg *resolve.ResolvePackage) error {
 	util.StatusMessage(util.VERBOSITY_DEFAULT, "Executing test: %s\n",
 		testPath)
 	cmd := []string{testPath}
+	if valgrind {
+		cmd = append([]string{"valgrind", "--error-exitcode=1"}, cmd...)
+	}
 	if _, err := util.ShellCommand(cmd, nil); err != nil {
 		newtError := err.(*util.NewtError)
 		newtError.Text = fmt.Sprintf("Test failure (%s):\n%s",
diff --git a/newt/cli/build_cmds.go b/newt/cli/build_cmds.go
@@ -235,7 +235,7 @@ func pkgnames(pkgs []*pkg.LocalPackage) string {
 	return s
 }
 
-func testRunCmd(cmd *cobra.Command, args []string, exclude string, executeShell bool) {
+func testRunCmd(cmd *cobra.Command, args []string, exclude string, executeShell bool, valgrind bool) {
 	if len(args) < 1 {
 		NewtUsage(cmd, nil)
 	}
@@ -320,7 +320,7 @@ func testRunCmd(cmd *cobra.Command, args []string, exclude string, executeShell
 		util.StatusMessage(util.VERBOSITY_DEFAULT, "Testing package %s\n",
 			pack.FullName())
 
-		err = b.SelfTestExecute()
+		err = b.SelfTestExecute(valgrind)
 		if err == nil {
 			passedPkgs = append(passedPkgs, pack)
 		} else {
@@ -435,6 +435,7 @@ func sizeRunCmd(cmd *cobra.Command, args []string, ram bool, flash bool, section
 func AddBuildCommands(cmd *cobra.Command) {
 	var printShellCmds bool
 	var executeShell bool
+	var valgrind bool
 
 	buildCmd := &cobra.Command{
 		Use:   "build <target-name> [target-names...]",
@@ -474,12 +475,14 @@ func AddBuildCommands(cmd *cobra.Command) {
 		Use:   "test <package-name> [package-names...] | all",
 		Short: "Executes unit tests for one or more packages",
 		Run: func(cmd *cobra.Command, args []string) {
-			testRunCmd(cmd, args, exclude, executeShell)
+			testRunCmd(cmd, args, exclude, executeShell, valgrind)
 		},
 	}
 	testCmd.Flags().StringVarP(&exclude, "exclude", "e", "", "Comma separated list of packages to exclude")
 	testCmd.Flags().BoolVar(&executeShell, "executeShell", false,
 		"Execute build command using /bin/sh (Linux and MacOS only)")
+	testCmd.Flags().BoolVar(&valgrind, "valgrind", false,
+		"Run test executables under Valgrind")
 	cmd.AddCommand(testCmd)
 	AddTabCompleteFn(testCmd, func() []string {
 		return append(testablePkgList(), "all", "allexcept")

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ func (t *TargetBuilder) SelfTestCreateExe() error {`
`77`	`77`	`return nil`
`78`	`78`	`}`
`79`	`79`
`80`		`-func (t *TargetBuilder) SelfTestExecute() error {`
	`80`	`+func (t *TargetBuilder) SelfTestExecute(valgrind bool) error {`
`81`	`81`	`if err := t.SelfTestCreateExe(); err != nil {`
`82`	`82`	`return err`
`83`	`83`	`}`
`@@ -87,7 +87,7 @@ func (t *TargetBuilder) SelfTestExecute() error {`
`87`	`87`	`return err`
`88`	`88`	`}`
`89`	`89`
`90`		`- if err := t.AppBuilder.SelfTestExecute(testRpkg); err != nil {`
	`90`	`+ if err := t.AppBuilder.SelfTestExecute(testRpkg, valgrind); err != nil {`
`91`	`91`	`return err`
`92`	`92`	`}`
`93`	`93`
`@@ -140,7 +140,7 @@ func (b Builder) testOwner(bpkg BuildPackage) *BuildPackage {`
`140`	`140`	`}`
`141`	`141`	`}`
`142`	`142`
`143`		`-func (b Builder) SelfTestExecute(testRpkg resolve.ResolvePackage) error {`
	`143`	`+func (b Builder) SelfTestExecute(testRpkg resolve.ResolvePackage, valgrind bool) error {`
`144`	`144`	`testPath := b.TestExePath()`
`145`	`145`	`if err := os.Chdir(filepath.Dir(testPath)); err != nil {`
`146`	`146`	`return err`
`@@ -149,6 +149,9 @@ func (b Builder) SelfTestExecute(testRpkg resolve.ResolvePackage) error {`
`149`	`149`	`util.StatusMessage(util.VERBOSITY_DEFAULT, "Executing test: %s\n",`
`150`	`150`	`testPath)`
`151`	`151`	`cmd := []string{testPath}`
	`152`	`+ if valgrind {`
	`153`	`+ cmd = append([]string{"valgrind", "--error-exitcode=1"}, cmd...)`
	`154`	`+ }`
`152`	`155`	`if _, err := util.ShellCommand(cmd, nil); err != nil {`
`153`	`156`	`newtError := err.(*util.NewtError)`
`154`	`157`	`newtError.Text = fmt.Sprintf("Test failure (%s):\n%s",`