Merge pull request #181 from bayashi/guard-failnow

Guard FailNow

Author: bayashi

README.md

@@ -89,7 +89,7 @@ func TestProtoMessages(t *testing.T) {
 
 ## Helper Methods
 
-* **FailNow**, **FailNowOn**: Halt the test case immediately when the test fails
+* **FailNow**: Halt the test case immediately when the test fails
 * **Diff**: Get diff of 2 objects on anywhere
 * **Dump**: Get dumped string of objects on anywhere
 * **Debug**: Show debug info only on failure

actually_ctx.go

@@ -0,0 +1,48 @@
+package actually
+
+import (
+	"runtime"
+	"strconv"
+	"strings"
+	"sync"
+)
+
+// global context of actually
+var aCtx = &aContext{
+	failNowStates: make(map[int64]bool),
+}
+
+type aContext struct {
+	mu            sync.RWMutex
+	failNowStates map[int64]bool // [goroutineID]bool
+}
+
+func (ac *aContext) failNowOn() {
+	ac.mu.Lock()
+	defer ac.mu.Unlock()
+	ac.failNowStates[goroutineID()] = true
+}
+
+func (ac *aContext) failNotNow() {
+	ac.mu.Lock()
+	defer ac.mu.Unlock()
+	delete(ac.failNowStates, goroutineID())
+}
+
+func (ac *aContext) failNowState() bool {
+	ac.mu.RLock()
+	defer ac.mu.RUnlock()
+	return ac.failNowStates[goroutineID()]
+}
+
+func goroutineID() int64 {
+	var buf [64]byte
+	n := runtime.Stack(buf[:], false)
+	idField := strings.Fields(strings.TrimPrefix(string(buf[:n]), "goroutine "))[0]
+	id, err := strconv.ParseInt(idField, 10, 64)
+	if err != nil {
+		panic(err)
+	}
+
+	return id
+}

actually_test.go

@@ -40,7 +40,7 @@ func TestExpect(t *testing.T) {
 		t.Errorf("`Expect()` was broken. Expected:%#v, but Actual:%#v", i, a.expect)
 	}
 	if a.failNow != nil && *a.failNow != false {
-		t.Errorf("`FailNotNow()` was broken. Expected:%#v, but Actual:%#v", false, a.failNow)
+		t.Errorf("Initial failNow value is wrong. Expected:%#v, but Actual:%#v", false, a.failNow)
 	}
 }
 

actually_util.go

@@ -35,7 +35,7 @@ var funcFail = func(a *testingA, w *w.Witness, reason string) {
 	a.t.Helper()
 	if a.failNow != nil && !*a.failNow {
 		w.Fail(a.t, reason, skipMine)
-	} else if (a.failNow != nil && *a.failNow) || len(os.Getenv(envKey_FailNow)) > 0 {
+	} else if (a.failNow != nil && *a.failNow) || aCtx.failNowState() || len(os.Getenv(envKey_FailNow)) > 0 {
 		w.FailNow(a.t, reason, skipMine)
 	} else {
 		w.Fail(a.t, reason, skipMine)

actually_util_test.go

@@ -7,18 +7,6 @@ import (
 )
 
 func TestFail(t *testing.T) {
-	{
-		a := FailNow()
-		if *a.failNow != true {
-			t.Errorf("`FailNow()` was broken. Expected:%#v, but Actual:%#v", true, a.failNow)
-		}
-
-		a = FailNotNow()
-		if *a.failNow != false {
-			t.Errorf("`FailNotNow()` was broken. Expected:%#v, but Actual:%#v", false, a.failNow)
-		}
-	}
-
 	a := Got(nil)
 	if a.failNow != nil && *a.failNow != false {
 		t.Errorf("Default failNow is false, but Actual:%#v", a.failNow)
@@ -29,11 +17,6 @@ func TestFail(t *testing.T) {
 		t.Errorf("`FailNow()` was broken. Expected:%#v, but Actual:%#v", true, a.failNow)
 	}
 
-	a.FailNotNow()
-	if *a.failNow != false {
-		t.Errorf("`FailNotNow()` was broken. Expected:%#v, but Actual:%#v", false, a.failNow)
-	}
-
 	a.t = t
 
 	stub()

helpers.go

@@ -16,76 +16,29 @@ func failNowPtr(v bool) *bool {
 	return &v
 }
 
-// `FailNow` turns a flag on to stop further test execution immediately if one test fails.
+// The method `FailNow` turns a flag on to stop further test execution immediately if one test fails.
 /*
 	actually.Got(something).FailNow().Nil(t) // Fail now for only this test
 */
-func FailNow() *testingA {
-	return &testingA{
-		failNow: failNowPtr(true),
-	}
-}
 func (a *testingA) FailNow() *testingA {
 	a.failNow = failNowPtr(true)
 
 	return a
 }
 
-// FailNowOn function turns an ENV flag on to stop further test execution immediately if one test fails.
-// This switch is enabled within the test. Not only during function.
-/*
-	func Test(t *testing.T) {
-		actually.FailNowOn(t)
-		actually.Got(something).Nil(t)                    // Fail Now
-		actually.Got(something).Expect(something).Same(t) // Fail Now
-	}
-*/
-// Warning: Do not use FailNowOn along with t.Parallel.
-func FailNowOn(t *testing.T) {
-	t.Setenv(envKey_FailNow, envKey_FailNow)
-}
-
-// FailNotNowOn function turns an ENV flag off to stop further test execution immediately if one test fails.
-// If you want to turn the ENV flag on, then you should call `FailNowOn`.
-/*
-	func Test(t *testing.T) {
-		// turn on to fail right now
-		actually.FailNowOn(t)
-		actually.Got(something).Nil(t)                    // Fail Now
-		actually.Got(something).Expect(something).Same(t) // Fail Now
-
-		// turn off
-		actually.FailNotNowOn(t)
-		actually.Got(something).Nil(t)                    // NOT Fail Now
-		actually.Got(something).Expect(something).Same(t) // NOT Fail Now
-
-		// Fail Now by FailNow() in the chain
-		actually.Got(something).FailNow().Nil(t)          // Fail Now
-
-		// Again, turn on to fail right now
-		actually.FailNowOn(t)
-		actually.Got(something).Nil(t)                    // Fail Now
-	}
-*/
-// This switch is enabled within the test. Not only during function.
-func FailNotNowOn(t *testing.T) {
-	t.Setenv(envKey_FailNow, "")
-}
-
-// FailNotNow turns a flag off, so that even if the test fails, execution does not stop immediately.
+// The function `FailNow` receives a func that is including tests of `actually`.
+// The included tests inside `FailNow` will stop execution immediately upon failure,
+// even without explicitly calling `FailNow` individually.
 /*
-   It behaves this way by default. If you want the opposite behavior, call `FailNow` method.
+	actually.FailNow(func() {
+		actually.Got(false).True(t) // stop this failuer
+		actually.Got(true).True(t)  // not executed
+	})
 */
-// Deprecated: Anyone uses? This method will be removed in the near future.
-func FailNotNow() *testingA {
-	return &testingA{
-		failNow: failNowPtr(false),
-	}
-}
-func (a *testingA) FailNotNow() *testingA {
-	a.failNow = failNowPtr(false)
-
-	return a
+func FailNow(fn func()) {
+	aCtx.failNowOn()
+	defer aCtx.failNotNow()
+	fn()
 }
 
 // X turns on a flag to show test values as raw in a fail report.