io/ioutil: WriteFile example errors when run on the Go Playground

[mntlty]

What version of Go are you using (go version)?

latest

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

Go Playground https://play.golang.org/

What did you do?

run example at https://golang.org/pkg/io/ioutil/#WriteFile which links to https://play.golang.org/p/bIP2HMSXz1u

What did you expect to see?

no error

What did you see instead?

error: `open testdata/hello: no such file or directory

Suggested Fixes

WriteFile does not create a directory, and the code example tries to write to the non-existent directory testdata. Possible solution are either to create this directory in the example code or change the argument to WriteFile to just include the file name

[tpaschalis]

You're right! In the background, ioutil.WriteFile uses os.OpenFile, and has been doing so since 2011, which doesn't create any intermediate directories.

I think that we could indeed change the example.
My 2¢ would be to add a couple of lines that create a directory in the example. We could also avoid the testdata name since it holds a special meaning in Go.

I'm not sure about documenting this behavior though since we don't explicitly mention anything about directories there.

[toothrot]

/cc @dmitshur

[dmitshur]

The testdata directory exists on disk. However, the example doesn’t have an // Output comment, so it’s only meant to be compiled and displayed in documentation, but not executed:

$ go test -v -run ExampleWriteFile io/ioutil
testing: warning: no tests to run

It doesn’t work on the Go Playground because the testdata directory isn’t available in that environment. But given there isn’t an // Output comment, maybe there shouldn’t be a button to run it on the website.

[mntlty]

@dmitshur the issue isn't really about the playground but that the example as written doesn't work without other steps that are not included here, like "must have this directory before running this code"

[AlexanderYastrebov]

Seems like duplicate of #32916 fixed by https://golang.org/cl/284452