Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Return nil when openFifo returns nil #47

Merged
merged 1 commit into from Dec 22, 2022
Merged

Return nil when openFifo returns nil #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion fifo.go
View file
Open in desktop
Expand Up @@ -71,7 +71,13 @@ func OpenFifoDup2(ctx context.Context, fn string, flag int, perm os.FileMode, fd
// fifo isn't open. read/write will be connected after the actual fifo is
// open or after fifo is closed.
func OpenFifo(ctx context.Context, fn string, flag int, perm os.FileMode) (io.ReadWriteCloser, error) {
return openFifo(ctx, fn, flag, perm)
fifo, err := openFifo(ctx, fn, flag, perm)
if fifo == nil {
// Do not return a non-nil ReadWriteCloser((*fifo)(nil)) value
// as that can confuse callers.
return nil, err
}
return fifo, err
}

func openFifo(ctx context.Context, fn string, flag int, perm os.FileMode) (*fifo, error) {
Expand Down
8 changes: 5 additions & 3 deletions fifo_test.go
View file
Open in desktop
Expand Up @@ -42,15 +42,16 @@ func TestFifoCancel(t *testing.T) {
leakCheckWg = nil
}()

_, err = OpenFifo(context.Background(), filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_NONBLOCK, 0600)
f, err := OpenFifo(context.Background(), filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_NONBLOCK, 0600)
assert.Exactly(t, nil, f)
Copy link
Contributor Author

@corhere corhere Nov 8, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Annoyingly, assert.Nil considers non-nil interface values which contain nil concrete values to be nil values despite those values being != nil.

assert.NotNil(t, err)

assert.NoError(t, checkWgDone(leakCheckWg))

ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
defer cancel()

f, err := OpenFifo(ctx, filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_CREAT|syscall.O_NONBLOCK, 0600)
f, err = OpenFifo(ctx, filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_CREAT|syscall.O_NONBLOCK, 0600)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh! Not a blocker (at all), but if you want to reduce code-churn, perhaps reformat the octal values to the new format (0o600) while updating these lines

assert.NoError(t, err)

b := make([]byte, 32)
Expand Down Expand Up @@ -200,7 +201,8 @@ func TestFifoBlocking(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
defer cancel()

_, err = OpenFifo(ctx, filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_CREAT, 0600)
f, err := OpenFifo(ctx, filepath.Join(tmpdir, "f0"), syscall.O_RDONLY|syscall.O_CREAT, 0600)
assert.Exactly(t, nil, f)
assert.EqualError(t, err, "context deadline exceeded")

select {
Expand Down