Merge lp:~freeman-wes/gocheck/gocheck into lp:gocheck

[Wes Freeman]

Adding -benchmem functionality with -gocheck.bmem.

[lp:~freeman-wes/gocheck/gocheck]

87. By Wes Freeman on 2013-12-22

adding another tab before memstats

Unmerged revisions

87. By Wes Freeman on 2013-12-22

adding another tab before memstats

86. By Wes Freeman on 2013-12-22

added benchmem functionality

=== modified file 'benchmark.go'
--- benchmark.go	2013-03-02 02:47:45 +0000
+++ benchmark.go	2013-12-22 09:38:42 +0000
@@ -6,9 +6,12 @@
 
 import (
 	"fmt"
+	"runtime"
 	"time"
 )
 
+var memStats runtime.MemStats
+
 // testingB is a type passed to Benchmark functions to manage benchmark
 // timing and to specify the number of iterations to run.
 type timer struct {
@@ -18,6 +21,12 @@
 	bytes     int64
 	timerOn   bool
 	benchTime time.Duration
+	// The initial states of memStats.Mallocs and memStats.TotalAlloc.
+	startAllocs uint64
+	startBytes  uint64
+	// The net total of this test after being run.
+	netAllocs uint64
+	netBytes  uint64
 }
 
 // StartTimer starts timing a test. This function is called automatically
@@ -27,6 +36,10 @@
 	if !c.timerOn {
 		c.start = time.Now()
 		c.timerOn = true
+
+		runtime.ReadMemStats(&memStats)
+		c.startAllocs = memStats.Mallocs
+		c.startBytes = memStats.TotalAlloc
 	}
 }
 
@@ -37,6 +50,9 @@
 	if c.timerOn {
 		c.duration += time.Now().Sub(c.start)
 		c.timerOn = false
+		runtime.ReadMemStats(&memStats)
+		c.netAllocs += memStats.Mallocs - c.startAllocs
+		c.netBytes += memStats.TotalAlloc - c.startBytes
 	}
 }
 
@@ -45,8 +61,13 @@
 func (c *C) ResetTimer() {
 	if c.timerOn {
 		c.start = time.Now()
+		runtime.ReadMemStats(&memStats)
+		c.startAllocs = memStats.Mallocs
+		c.startBytes = memStats.TotalAlloc
 	}
 	c.duration = 0
+	c.netAllocs = 0
+	c.netBytes = 0
 }
 
 // SetBytes informs the number of bytes that the benchmark processes
@@ -90,7 +111,13 @@
 			ns = fmt.Sprintf("%12.1f ns/op", float64(c.duration.Nanoseconds())/float64(c.N))
 		}
 	}
-	return fmt.Sprintf("%8d\t%s%s", c.N, ns, mb)
+	memStats := ""
+	if c.benchMem {
+		allocedBytes := fmt.Sprintf("%8d B/op", int64(c.netBytes)/int64(c.N))
+		allocs := fmt.Sprintf("%8d allocs/op", int64(c.netAllocs)/int64(c.N))
+		memStats = fmt.Sprintf("\t%s\t%s", allocedBytes, allocs)
+	}
+	return fmt.Sprintf("%8d\t%s%s%s", c.N, ns, mb, memStats)
 }
 
 func min(x, y int) int {

=== modified file 'gocheck.go'
--- gocheck.go	2013-03-02 02:47:45 +0000
+++ gocheck.go	2013-12-22 09:38:42 +0000
@@ -62,7 +62,7 @@
 }
 
 func (method *methodType) String() string {
-	return method.suiteName()+"."+method.Info.Name
+	return method.suiteName() + "." + method.Info.Name
 }
 
 func (method *methodType) matches(re *regexp.Regexp) bool {
@@ -72,15 +72,16 @@
 }
 
 type C struct {
-	method    *methodType
-	kind      funcKind
-	status    funcStatus
-	logb      *logger
-	logw      io.Writer
-	done      chan *C
-	reason    string
-	mustFail  bool
-	tempDir   *tempDir
+	method   *methodType
+	kind     funcKind
+	status   funcStatus
+	logb     *logger
+	logw     io.Writer
+	done     chan *C
+	reason   string
+	mustFail bool
+	tempDir  *tempDir
+	benchMem bool
 	timer
 }
 
@@ -495,6 +496,7 @@
 	output                    *outputWriter
 	reportedProblemLast       bool
 	benchTime                 time.Duration
+	benchMem                  bool
 }
 
 type RunConf struct {
@@ -504,6 +506,7 @@
 	Filter        string
 	Benchmark     bool
 	BenchmarkTime time.Duration // Defaults to 1 second
+	BenchmarkMem  bool
 }
 
 // Create a new suiteRunner able to run all methods in the given suite.
@@ -528,6 +531,7 @@
 		output:    newOutputWriter(conf.Output, conf.Stream, conf.Verbose),
 		tracker:   newResultTracker(),
 		benchTime: conf.BenchmarkTime,
+		benchMem:  conf.BenchmarkMem,
 	}
 	runner.tests = make([]*methodType, 0, suiteNumMethods)
 	runner.tempDir = new(tempDir)
@@ -613,13 +617,14 @@
 		logb = new(logger)
 	}
 	c := &C{
-		method:  method,
-		kind:    kind,
-		logb:    logb,
-		logw:    logw,
-		tempDir: runner.tempDir,
-		done:    make(chan *C, 1),
-		timer:   timer{benchTime: runner.benchTime},
+		method:   method,
+		kind:     kind,
+		logb:     logb,
+		logw:     logw,
+		tempDir:  runner.tempDir,
+		done:     make(chan *C, 1),
+		timer:    timer{benchTime: runner.benchTime},
+		benchMem: runner.benchMem,
 	}
 	runner.tracker.expectCall(c)
 	go (func() {
@@ -913,4 +918,3 @@
 	return fmt.Sprintf("%s%s: %s: %s%s", prefix, label, niceFuncPath(pc),
 		niceFuncName(pc), suffix)
 }
-

=== modified file 'run.go'
--- run.go	2013-03-01 22:15:07 +0000
+++ run.go	2013-12-22 09:38:42 +0000
@@ -30,7 +30,8 @@
 	verboseFlag = flag.Bool("gocheck.v", false, "Verbose mode")
 	streamFlag  = flag.Bool("gocheck.vv", false, "Super verbose mode (disables output caching)")
 	benchFlag   = flag.Bool("gocheck.b", false, "Run benchmarks")
-	benchTime   = flag.Duration("gocheck.btime", 1 * time.Second, "approximate run time for each benchmark")
+	benchTime   = flag.Duration("gocheck.btime", 1*time.Second, "approximate run time for each benchmark")
+	benchMem    = flag.Bool("gocheck.bmem", false, "Report memory benchmarks")
 	listFlag    = flag.Bool("gocheck.list", false, "List the names of all tests that will be run")
 )
 
@@ -39,11 +40,12 @@
 // module.
 func TestingT(testingT *testing.T) {
 	conf := &RunConf{
-		Filter:    *filterFlag,
-		Verbose:   *verboseFlag,
-		Stream:    *streamFlag,
-		Benchmark: *benchFlag,
+		Filter:        *filterFlag,
+		Verbose:       *verboseFlag,
+		Stream:        *streamFlag,
+		Benchmark:     *benchFlag,
 		BenchmarkTime: *benchTime,
+		BenchmarkMem:  *benchMem,
 	}
 	if *listFlag {
 		w := bufio.NewWriter(os.Stdout)