add comment about purpose of context use in example/tests

eikenb · eikenb · commit 05f7f0a92cdc · 2019-02-04T13:22:46.000-08:00
diff --git a/request-example.go b/request-example.go
@@ -27,10 +27,10 @@ func InMemHandler() Handlers {
 
 // Example Handlers
 func (fs *root) Fileread(r *Request) (io.ReaderAt, error) {
-	_ = r.WithContext(r.Context())
 	if fs.mockErr != nil {
 		return nil, fs.mockErr
 	}
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	fs.filesLock.Lock()
 	defer fs.filesLock.Unlock()
 	file, err := fs.fetch(r.Filepath)
@@ -47,10 +47,10 @@ func (fs *root) Fileread(r *Request) (io.ReaderAt, error) {
 }
 
 func (fs *root) Filewrite(r *Request) (io.WriterAt, error) {
-	_ = r.WithContext(r.Context())
 	if fs.mockErr != nil {
 		return nil, fs.mockErr
 	}
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	fs.filesLock.Lock()
 	defer fs.filesLock.Unlock()
 	file, err := fs.fetch(r.Filepath)
@@ -69,10 +69,10 @@ func (fs *root) Filewrite(r *Request) (io.WriterAt, error) {
 }
 
 func (fs *root) Filecmd(r *Request) error {
-	_ = r.WithContext(r.Context())
 	if fs.mockErr != nil {
 		return fs.mockErr
 	}
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	fs.filesLock.Lock()
 	defer fs.filesLock.Unlock()
 	switch r.Method {
@@ -130,10 +130,10 @@ func (f listerat) ListAt(ls []os.FileInfo, offset int64) (int, error) {
 }
 
 func (fs *root) Filelist(r *Request) (ListerAt, error) {
-	_ = r.WithContext(r.Context())
 	if fs.mockErr != nil {
 		return nil, fs.mockErr
 	}
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	fs.filesLock.Lock()
 	defer fs.filesLock.Unlock()
 
diff --git a/request_test.go b/request_test.go
@@ -22,28 +22,28 @@ func (t *testHandler) Fileread(r *Request) (io.ReaderAt, error) {
 	if t.err != nil {
 		return nil, t.err
 	}
-	_ = r.WithContext(r.Context())
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	return bytes.NewReader(t.filecontents), nil
 }
 
 func (t *testHandler) Filewrite(r *Request) (io.WriterAt, error) {
 	if t.err != nil {
 		return nil, t.err
 	}
-	_ = r.WithContext(r.Context())
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	return io.WriterAt(t.output), nil
 }
 
 func (t *testHandler) Filecmd(r *Request) error {
-	_ = r.WithContext(r.Context())
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	return t.err
 }
 
 func (t *testHandler) Filelist(r *Request) (ListerAt, error) {
 	if t.err != nil {
 		return nil, t.err
 	}
-	_ = r.WithContext(r.Context())
+	_ = r.WithContext(r.Context()) // initialize context for deadlock testing
 	f, err := os.Open(r.Filepath)
 	if err != nil {
 		return nil, err

Original file line number	Diff line number	Diff line change
`@@ -22,28 +22,28 @@ func (t testHandler) Fileread(r Request) (io.ReaderAt, error) {`
`22`	`22`	`if t.err != nil {`
`23`	`23`	`return nil, t.err`
`24`	`24`	`}`
`25`		`- _ = r.WithContext(r.Context())`
	`25`	`+ _ = r.WithContext(r.Context()) // initialize context for deadlock testing`
`26`	`26`	`return bytes.NewReader(t.filecontents), nil`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`func (t testHandler) Filewrite(r Request) (io.WriterAt, error) {`
`30`	`30`	`if t.err != nil {`
`31`	`31`	`return nil, t.err`
`32`	`32`	`}`
`33`		`- _ = r.WithContext(r.Context())`
	`33`	`+ _ = r.WithContext(r.Context()) // initialize context for deadlock testing`
`34`	`34`	`return io.WriterAt(t.output), nil`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func (t testHandler) Filecmd(r Request) error {`
`38`		`- _ = r.WithContext(r.Context())`
	`38`	`+ _ = r.WithContext(r.Context()) // initialize context for deadlock testing`
`39`	`39`	`return t.err`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`func (t testHandler) Filelist(r Request) (ListerAt, error) {`
`43`	`43`	`if t.err != nil {`
`44`	`44`	`return nil, t.err`
`45`	`45`	`}`
`46`		`- _ = r.WithContext(r.Context())`
	`46`	`+ _ = r.WithContext(r.Context()) // initialize context for deadlock testing`
`47`	`47`	`f, err := os.Open(r.Filepath)`
`48`	`48`	`if err != nil {`
`49`	`49`	`return nil, err`