iosemantic

A testing library containing helper function to verify that io.Readers and io.Writers implement their respective specifications.

An example usage is DRFS, where I implemented a file abstraction and use this library to ensure my implementation has the correct io semantics.

Example

func TestMyCustomFileBackendSemantics(t *testing.T) {
    var file = NewCustomFileBackend()
    iosemantic.ImplementsReader(t, file)
    iosemantic.ImplementsWriter(t, file)
    iosemantic.ImplementsWriterAt(t, file)
}

Caveats

iosemantic only verifies that the interfaces match their specifications, not that the input and output buffers remain consistent. You will still need to write tests to verify your business logic.

Stability

The current API will remain consistent. Functions accepting respective option structs may be expanded on by adding options to these structs, where unset fields are set to sane defaults.