coreapi: make sure to cancel context in tests

License: MIT Signed-off-by: Łukasz Magiera <[email protected]>
ipfs · Dec 20, 2018 · f456a98 · f456a98
1 parent 71d4aca
commit f456a98
Show file tree

Hide file tree

Showing 10 changed files with 165 additions and 66 deletions.
diff --git a/core/coreapi/interface/tests/api.go b/core/coreapi/interface/tests/api.go
@@ -3,6 +3,7 @@ package tests
 import (
 	"context"
 	"testing"
+	"time"
 
 	coreiface "github.com/ipfs/go-ipfs/core/coreapi/interface"
 )
@@ -21,12 +22,37 @@ type Provider interface {
 	MakeAPISwarm(ctx context.Context, fullIdentity bool, n int) ([]coreiface.CoreAPI, error)
 }
 
+func (tp *provider) MakeAPISwarm(ctx context.Context, fullIdentity bool, n int) ([]coreiface.CoreAPI, error) {
+	tp.apis <- 1
+	go func() {
+		<-ctx.Done()
+		tp.apis <- -1
+	}()
+
+	return tp.Provider.MakeAPISwarm(ctx, fullIdentity, n)
+}
+
 type provider struct {
 	Provider
+
+	apis chan int
 }
 
 func TestApi(p Provider) func(t *testing.T) {
-	tp := &provider{p}
+	running := 1
+	apis := make(chan int)
+	zeroRunning := make(chan struct{})
+	go func() {
+		for i := range apis {
+			running += i
+			if running < 1 {
+				close(zeroRunning)
+				return
+			}
+		}
+	}()
+
+	tp := &provider{Provider: p, apis:apis}
 
 	return func(t *testing.T) {
 		t.Run("Block", tp.TestBlock)
@@ -39,5 +65,14 @@ func TestApi(p Provider) func(t *testing.T) {
 		t.Run("Pin", tp.TestPin)
 		t.Run("PubSub", tp.TestPubSub)
 		t.Run("Unixfs", tp.TestUnixfs)
+
+		apis <- -1
+		t.Run("TestsCancelCtx", func(t *testing.T) {
+			select {
+			case <-zeroRunning:
+			case <-time.After(time.Second):
+				t.Errorf("%d node(s) not closed", running)
+			}
+		})
 	}
 }
diff --git a/core/coreapi/interface/tests/block.go b/core/coreapi/interface/tests/block.go
@@ -22,7 +22,8 @@ func (tp *provider) TestBlock(t *testing.T) {
 }
 
 func (tp *provider) TestBlockPut(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -39,7 +40,8 @@ func (tp *provider) TestBlockPut(t *testing.T) {
 }
 
 func (tp *provider) TestBlockPutFormat(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -56,7 +58,8 @@ func (tp *provider) TestBlockPutFormat(t *testing.T) {
 }
 
 func (tp *provider) TestBlockPutHash(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -73,7 +76,8 @@ func (tp *provider) TestBlockPutHash(t *testing.T) {
 }
 
 func (tp *provider) TestBlockGet(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -113,7 +117,8 @@ func (tp *provider) TestBlockGet(t *testing.T) {
 }
 
 func (tp *provider) TestBlockRm(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -166,7 +171,8 @@ func (tp *provider) TestBlockRm(t *testing.T) {
 }
 
 func (tp *provider) TestBlockStat(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)

diff --git a/core/coreapi/interface/tests/dag.go b/core/coreapi/interface/tests/dag.go
@@ -31,7 +31,8 @@ var (
 )
 
 func (tp *provider) TestPut(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -48,7 +49,8 @@ func (tp *provider) TestPut(t *testing.T) {
 }
 
 func (tp *provider) TestPutWithHash(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -65,7 +67,8 @@ func (tp *provider) TestPutWithHash(t *testing.T) {
 }
 
 func (tp *provider) TestDagPath(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -97,7 +100,8 @@ func (tp *provider) TestDagPath(t *testing.T) {
 }
 
 func (tp *provider) TestTree(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -126,7 +130,8 @@ func (tp *provider) TestTree(t *testing.T) {
 }
 
 func (tp *provider) TestBatch(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)

diff --git a/core/coreapi/interface/tests/dht.go b/core/coreapi/interface/tests/dht.go
@@ -15,7 +15,8 @@ func (tp *provider) TestDht(t *testing.T) {
 }
 
 func (tp *provider) TestDhtFindPeer(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	apis, err := tp.MakeAPISwarm(ctx, true, 5)
 	if err != nil {
 		t.Fatal(err)
@@ -51,7 +52,8 @@ func (tp *provider) TestDhtFindPeer(t *testing.T) {
 }
 
 func (tp *provider) TestDhtFindProviders(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	apis, err := tp.MakeAPISwarm(ctx, true, 5)
 	if err != nil {
 		t.Fatal(err)
@@ -80,7 +82,8 @@ func (tp *provider) TestDhtFindProviders(t *testing.T) {
 }
 
 func (tp *provider) TestDhtProvide(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	apis, err := tp.MakeAPISwarm(ctx, true, 5)
 	if err != nil {
 		t.Fatal(err)

diff --git a/core/coreapi/interface/tests/key.go b/core/coreapi/interface/tests/key.go
@@ -28,7 +28,8 @@ func (tp *provider) TestKey(t *testing.T) {
 }
 
 func (tp *provider) TestListSelf(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Fatal(err)
@@ -61,7 +62,8 @@ func (tp *provider) TestListSelf(t *testing.T) {
 }
 
 func (tp *provider) TestRenameSelf(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Fatal(err)
@@ -88,7 +90,8 @@ func (tp *provider) TestRenameSelf(t *testing.T) {
 }
 
 func (tp *provider) TestRemoveSelf(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Fatal(err)
@@ -106,7 +109,8 @@ func (tp *provider) TestRemoveSelf(t *testing.T) {
 }
 
 func (tp *provider) TestGenerate(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -128,7 +132,8 @@ func (tp *provider) TestGenerate(t *testing.T) {
 }
 
 func (tp *provider) TestGenerateSize(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -150,7 +155,8 @@ func (tp *provider) TestGenerateSize(t *testing.T) {
 }
 
 func (tp *provider) TestGenerateType(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	t.Skip("disabled until libp2p/specs#111 is fixed")
 
 	api, err := tp.makeAPI(ctx)
@@ -175,7 +181,8 @@ func (tp *provider) TestGenerateType(t *testing.T) {
 }
 
 func (tp *provider) TestGenerateExisting(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -207,7 +214,8 @@ func (tp *provider) TestGenerateExisting(t *testing.T) {
 }
 
 func (tp *provider) TestList(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -252,7 +260,8 @@ func (tp *provider) TestList(t *testing.T) {
 }
 
 func (tp *provider) TestRename(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -280,7 +289,8 @@ func (tp *provider) TestRename(t *testing.T) {
 }
 
 func (tp *provider) TestRenameToSelf(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -303,7 +313,8 @@ func (tp *provider) TestRenameToSelf(t *testing.T) {
 }
 
 func (tp *provider) TestRenameToSelfForce(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -326,7 +337,8 @@ func (tp *provider) TestRenameToSelfForce(t *testing.T) {
 }
 
 func (tp *provider) TestRenameOverwriteNoForce(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -355,7 +367,8 @@ func (tp *provider) TestRenameOverwriteNoForce(t *testing.T) {
 }
 
 func (tp *provider) TestRenameOverwrite(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -393,7 +406,8 @@ func (tp *provider) TestRenameOverwrite(t *testing.T) {
 }
 
 func (tp *provider) TestRenameSameNameNoForce(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -421,7 +435,8 @@ func (tp *provider) TestRenameSameNameNoForce(t *testing.T) {
 }
 
 func (tp *provider) TestRenameSameName(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)
@@ -449,7 +464,8 @@ func (tp *provider) TestRenameSameName(t *testing.T) {
 }
 
 func (tp *provider) TestRemove(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	api, err := tp.makeAPI(ctx)
 	if err != nil {
 		t.Error(err)

diff --git a/core/coreapi/interface/tests/name.go b/core/coreapi/interface/tests/name.go
@@ -36,7 +36,8 @@ func appendPath(p coreiface.Path, sub string) coreiface.Path {
 }
 
 func (tp *provider) TestPublishResolve(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	init := func() (coreiface.CoreAPI, coreiface.Path) {
 		apis, err := tp.MakeAPISwarm(ctx, true, 5)
 		if err != nil {
@@ -185,7 +186,8 @@ func (tp *provider) TestPublishResolve(t *testing.T) {
 }
 
 func (tp *provider) TestBasicPublishResolveKey(t *testing.T) {
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	apis, err := tp.MakeAPISwarm(ctx, true, 5)
 	if err != nil {
 		t.Fatal(err)
@@ -228,7 +230,8 @@ func (tp *provider) TestBasicPublishResolveKey(t *testing.T) {
 func (tp *provider) TestBasicPublishResolveTimeout(t *testing.T) {
 	t.Skip("ValidTime doesn't appear to work at this time resolution")
 
-	ctx := context.Background()
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	apis, err := tp.MakeAPISwarm(ctx, true, 5)
 	if err != nil {
 		t.Fatal(err)