fix(all): introduce and use iox.CopyContext (#380)

* fix(all): introduce and use iox.CopyContext

This PR is part of https://github.com/ooni/probe/issues/1417.

In https://github.com/ooni/probe-cli/pull/379 we introduced a context
aware wrapper for io.ReadAll (formerly ioutil.ReadAll).

Here we introduce a context aware wrapper for io.Copy.

* fix(humanize): more significant digits

* fix: rename humanize files to follow the common pattern

* fix aligment

* fix test

internal/iox/iox.go

@@ -6,7 +6,7 @@ import (
 	"io"
 )
 
-// ReadAllContext reads the whole reader r in a
+// ReadAllContext is like io.ReadAll but reads r in a
 // background goroutine. This function will return
 // earlier if the context is cancelled. In which case
 // we will continue reading from r in the background
@@ -45,3 +45,27 @@ var _ io.Reader = &MockableReader{}
 func (r *MockableReader) Read(b []byte) (int, error) {
 	return r.MockRead(b)
 }
+
+// CopyContext is like io.Copy but may terminate earlier
+// when the context expires. This function has the same
+// caveats of ReadAllContext regarding the temporary leaking
+// of the background goroutine used to do I/O.
+func CopyContext(ctx context.Context, dst io.Writer, src io.Reader) (int64, error) {
+	countch, errch := make(chan int64, 1), make(chan error, 1) // buffers
+	go func() {
+		count, err := io.Copy(dst, src)
+		if err != nil {
+			errch <- err
+			return
+		}
+		countch <- count
+	}()
+	select {
+	case count := <-countch:
+		return count, nil
+	case <-ctx.Done():
+		return 0, ctx.Err()
+	case err := <-errch:
+		return 0, err
+	}
+}

internal/iox/iox_test.go

@@ -3,6 +3,7 @@ package iox
 import (
 	"context"
 	"errors"
+	"io"
 	"strings"
 	"testing"
 	"time"
@@ -68,3 +69,64 @@ func TestReadAllContextWithErrorAndCancelledContext(t *testing.T) {
 		t.Fatal("not the expected number of bytes")
 	}
 }
+
+func TestCopyContextCommonCase(t *testing.T) {
+	r := strings.NewReader("deadbeef")
+	ctx := context.Background()
+	out, err := CopyContext(ctx, io.Discard, r)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if out != 8 {
+		t.Fatal("not the expected number of bytes")
+	}
+}
+
+func TestCopyContextWithError(t *testing.T) {
+	expected := errors.New("mocked error")
+	r := &MockableReader{
+		MockRead: func(b []byte) (int, error) {
+			return 0, expected
+		},
+	}
+	ctx := context.Background()
+	out, err := CopyContext(ctx, io.Discard, r)
+	if !errors.Is(err, expected) {
+		t.Fatal("not the error we expected", err)
+	}
+	if out != 0 {
+		t.Fatal("not the expected number of bytes")
+	}
+}
+
+func TestCopyContextWithCancelledContext(t *testing.T) {
+	r := strings.NewReader("deadbeef")
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel() // fail immediately
+	out, err := CopyContext(ctx, io.Discard, r)
+	if !errors.Is(err, context.Canceled) {
+		t.Fatal("not the error we expected", err)
+	}
+	if out != 0 {
+		t.Fatal("not the expected number of bytes")
+	}
+}
+
+func TestCopyContextWithErrorAndCancelledContext(t *testing.T) {
+	expected := errors.New("mocked error")
+	r := &MockableReader{
+		MockRead: func(b []byte) (int, error) {
+			time.Sleep(time.Millisecond)
+			return 0, expected
+		},
+	}
+	ctx, cancel := context.WithCancel(context.Background())
+	cancel() // fail immediately
+	out, err := CopyContext(ctx, io.Discard, r)
+	if !errors.Is(err, context.Canceled) {
+		t.Fatal("not the error we expected", err)
+	}
+	if out != 0 {
+		t.Fatal("not the expected number of bytes")
+	}
+}