clipboard_test.go

// Copyright 2021 The golang.design Initiative Authors.
// All rights reserved. Use of this source code is governed
// by a MIT license that can be found in the LICENSE file.
//
// Written by Changkun Ou <changkun.de>

package clipboard_test

import (
	"bytes"
	"context"
	"errors"
	"image/color"
	"image/png"
	"os"
	"reflect"
	"runtime"
	"testing"
	"time"

	"golang.design/x/clipboard"
)

func init() {
	clipboard.Debug = true
}

// degradesWithoutCgo reports whether the clipboard falls back to the no-op
// CGO_ENABLED=0 stubs on the current platform. Platforms with a cgo-free
// backend (Windows, macOS, Linux, and the BSDs) keep working without cgo; only
// the remaining cgo-only platforms (e.g. Android) degrade.
func degradesWithoutCgo() bool {
	switch runtime.GOOS {
	case "windows", "darwin", "linux", "freebsd", "openbsd", "netbsd":
		return false
	}
	return true
}

func TestClipboardInit(t *testing.T) {
	t.Run("no-cgo", func(t *testing.T) {
		if val, ok := os.LookupEnv("CGO_ENABLED"); !ok || val != "0" {
			t.Skip("CGO_ENABLED is set to 1")
		}
		if !degradesWithoutCgo() {
			t.Skip("this platform has a cgo-free backend; nothing to check")
		}

		if err := clipboard.Init(); !errors.Is(err, clipboard.ErrCgoDisabled) {
			t.Fatalf("expect ErrCgoDisabled, got: %v", err)
		}
	})
	t.Run("with-cgo", func(t *testing.T) {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
		if runtime.GOOS != "linux" {
			t.Skip("Only Linux may return error at the moment.")
		}

		if err := clipboard.Init(); err != nil && !errors.Is(err, clipboard.ErrUnavailable) {
			t.Fatalf("expect ErrUnavailable, but got: %v", err)
		}
	})
}

func TestClipboard(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	t.Run("image", func(t *testing.T) {
		data, err := os.ReadFile("tests/testdata/clipboard.png")
		if err != nil {
			t.Fatalf("failed to read gold file: %v", err)
		}
		clipboard.Write(clipboard.FmtImage, data)

		b := clipboard.Read(clipboard.FmtText)
		if b != nil {
			t.Fatalf("read clipboard that stores image data as text should fail, but got len: %d", len(b))
		}

		b = clipboard.Read(clipboard.FmtImage)
		if b == nil {
			t.Fatalf("read clipboard that stores image data as image should success, but got: nil")
		}

		img1, err := png.Decode(bytes.NewReader(data))
		if err != nil {
			t.Fatalf("write image is not png encoded: %v", err)
		}
		img2, err := png.Decode(bytes.NewReader(b))
		if err != nil {
			t.Fatalf("read image is not png encoded: %v", err)
		}

		w := img2.Bounds().Dx()
		h := img2.Bounds().Dy()

		incorrect := 0
		for i := 0; i < w; i++ {
			for j := 0; j < h; j++ {
				wr, wg, wb, wa := img1.At(i, j).RGBA()
				gr, gg, gb, ga := img2.At(i, j).RGBA()
				want := color.RGBA{
					R: uint8(wr),
					G: uint8(wg),
					B: uint8(wb),
					A: uint8(wa),
				}
				got := color.RGBA{
					R: uint8(gr),
					G: uint8(gg),
					B: uint8(gb),
					A: uint8(ga),
				}

				if !reflect.DeepEqual(want, got) {
					t.Logf("read data from clipbaord is inconsistent with previous written data, pix: (%d,%d), got: %+v, want: %+v", i, j, got, want)
					incorrect++
				}
			}
		}

		if incorrect > 0 {
			t.Fatalf("read data from clipboard contains too much inconsistent pixels to the previous written data, number of incorrect pixels: %v", incorrect)
		}
	})

	t.Run("text", func(t *testing.T) {
		data := []byte("golang.design/x/clipboard")
		clipboard.Write(clipboard.FmtText, data)

		b := clipboard.Read(clipboard.FmtImage)
		if b != nil {
			t.Fatalf("read clipboard that stores text data as image should fail, but got len: %d", len(b))
		}
		b = clipboard.Read(clipboard.FmtText)
		if b == nil {
			t.Fatal("read clipboard taht stores text data as text should success, but got: nil")
		}

		if !reflect.DeepEqual(data, b) {
			t.Fatalf("read data from clipbaord is inconsistent with previous written data, got: %d, want: %d", len(b), len(data))
		}
	})
}

func TestClipboardMultipleWrites(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	data, err := os.ReadFile("tests/testdata/clipboard.png")
	if err != nil {
		t.Fatalf("failed to read gold file: %v", err)
	}
	chg := clipboard.Write(clipboard.FmtImage, data)

	data = []byte("golang.design/x/clipboard")
	clipboard.Write(clipboard.FmtText, data)

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*2)
	defer cancel()

	select {
	case <-ctx.Done():
		t.Fatalf("failed to receive clipboard change notification")
	case _, ok := <-chg:
		if !ok {
			t.Fatalf("change channel is closed before receiving the changed clipboard data")
		}
	}
	_, ok := <-chg
	if ok {
		t.Fatalf("changed channel should be closed after receiving the notification")
	}

	b := clipboard.Read(clipboard.FmtImage)
	if b != nil {
		t.Fatalf("read clipboard that should store text data as image should fail, but got: %d", len(b))
	}

	b = clipboard.Read(clipboard.FmtText)
	if b == nil {
		t.Fatalf("read clipboard that should store text data as text should success, got: nil")
	}

	if !reflect.DeepEqual(data, b) {
		t.Fatalf("read data from clipbaord is inconsistent with previous write, want %s, got: %s", string(data), string(b))
	}
}

func TestClipboardConcurrentRead(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	// This test check that concurrent read/write to the clipboard does
	// not cause crashes on some specific platform, such as macOS.
	done := make(chan bool, 2)
	go func() {
		defer func() {
			done <- true
		}()
		clipboard.Read(clipboard.FmtText)
	}()
	go func() {
		defer func() {
			done <- true
		}()
		clipboard.Read(clipboard.FmtImage)
	}()
	<-done
	<-done
}

func TestClipboardWriteEmpty(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	chg1 := clipboard.Write(clipboard.FmtText, nil)
	if got := clipboard.Read(clipboard.FmtText); got != nil {
		t.Fatalf("write nil to clipboard should read nil, got: %v", string(got))
	}
	clipboard.Write(clipboard.FmtText, []byte(""))
	<-chg1

	if got := clipboard.Read(clipboard.FmtText); string(got) != "" {
		t.Fatalf("write empty string to clipboard should read empty string, got: `%v`", string(got))
	}
}

func TestClipboardWatch(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*2)
	defer cancel()

	// clear clipboard
	clipboard.Write(clipboard.FmtText, []byte(""))
	lastRead := clipboard.Read(clipboard.FmtText)

	changed := clipboard.Watch(ctx, clipboard.FmtText)

	want := []byte("golang.design/x/clipboard")
	go func(ctx context.Context) {
		t := time.NewTicker(time.Millisecond * 500)
		for {
			select {
			case <-ctx.Done():
				return
			case <-t.C:
				clipboard.Write(clipboard.FmtText, want)
			}
		}
	}(ctx)
loop:
	for {
		select {
		case <-ctx.Done():
			if string(lastRead) == "" {
				t.Fatalf("clipboard watch never receives a notification")
			}
			t.Log(string(lastRead))
			break loop
		case data, ok := <-changed:
			if !ok {
				if string(lastRead) == "" {
					t.Fatalf("clipboard watch never receives a notification")
				}
				break loop
			}
			if !bytes.Equal(data.Bytes, want) {
				t.Fatalf("received data from watch mismatch, want: %v, got %v", string(want), string(data.Bytes))
			}
			if data.Format != clipboard.FmtText {
				t.Fatalf("received data from watch has wrong format, want: %v, got %v", clipboard.FmtText, data.Format)
			}
			lastRead = data.Bytes
		}
	}
	// After the context is cancelled, watch must close the channel (per the
	// Watch doc). A buffered value may still be pending, so drain until the
	// channel is observed closed rather than asserting on a single receive.
	deadline := time.After(2 * time.Second)
	for {
		select {
		case _, ok := <-changed:
			if !ok {
				return // channel closed as documented
			}
			// A value was buffered before the close; keep draining.
		case <-deadline:
			t.Fatalf("changed channel was not closed after ctx cancellation")
		}
	}
}

// TestClipboardWatchMultiFormat exercises the variadic Watch: a single call
// observes more than one format at once and each received value is tagged with
// the format it was detected in. Watching with no format argument observes all
// supported formats. This test cannot compile against the old single-format
// Watch(ctx, Format) <-chan []byte signature.
func TestClipboardWatchMultiFormat(t *testing.T) {
	if degradesWithoutCgo() {
		if val, ok := os.LookupEnv("CGO_ENABLED"); ok && val == "0" {
			t.Skip("CGO_ENABLED is set to 0")
		}
	}

	img, err := os.ReadFile("tests/testdata/clipboard.png")
	if err != nil {
		t.Fatalf("failed to read test image: %v", err)
	}
	// Use a payload distinct from other tests and clear the clipboard first:
	// the Linux watcher emits only when the bytes differ from what it read at
	// startup, so a leftover identical string would suppress the text event.
	wantText := []byte("golang.design/x/clipboard#89-watch-multiformat")
	clipboard.Write(clipboard.FmtText, []byte(""))

	ctx, cancel := context.WithTimeout(context.Background(), time.Second*20)
	defer cancel()

	// Watch all supported formats through a single call.
	changed := clipboard.Watch(ctx)

	// The clipboard holds only the most recently written format and the
	// platform watchers poll once per second, so alternate the two formats
	// on a tick slower than that poll interval. Writing both back-to-back
	// would let the second clobber the first before any watcher observes it.
	go func(ctx context.Context) {
		tk := time.NewTicker(time.Millisecond * 1300)
		defer tk.Stop()
		writeImage := false
		for {
			select {
			case <-ctx.Done():
				return
			case <-tk.C:
				if writeImage {
					clipboard.Write(clipboard.FmtImage, img)
				} else {
					clipboard.Write(clipboard.FmtText, wantText)
				}
				writeImage = !writeImage
			}
		}
	}(ctx)

	var sawText, sawImage bool
	for !(sawText && sawImage) {
		select {
		case <-ctx.Done():
			t.Fatalf("did not observe both formats from a single Watch: text=%v image=%v", sawText, sawImage)
		case data, ok := <-changed:
			if !ok {
				t.Fatalf("watch channel closed before observing both formats: text=%v image=%v", sawText, sawImage)
			}
			switch data.Format {
			case clipboard.FmtText:
				if !bytes.Equal(data.Bytes, wantText) {
					t.Fatalf("text event payload mismatch, want %q got %q", wantText, data.Bytes)
				}
				sawText = true
			case clipboard.FmtImage:
				// Image bytes round-trip through platform conversions
				// (DIB/TIFF), so assert the payload is a decodable PNG
				// rather than byte-identical to the source.
				if _, err := png.Decode(bytes.NewReader(data.Bytes)); err != nil {
					t.Fatalf("image event payload is not a valid PNG: %v", err)
				}
				sawImage = true
			default:
				t.Fatalf("watch reported an unexpected format: %v", data.Format)
			}
		}
	}
}

func BenchmarkClipboard(b *testing.B) {
	b.Run("text", func(b *testing.B) {
		data := []byte("golang.design/x/clipboard")

		b.ReportAllocs()
		b.ResetTimer()
		for i := 0; i < b.N; i++ {
			clipboard.Write(clipboard.FmtText, data)
			_ = clipboard.Read(clipboard.FmtText)
		}
	})
}

func TestClipboardNoCgo(t *testing.T) {
	if val, ok := os.LookupEnv("CGO_ENABLED"); !ok || val != "0" {
		t.Skip("CGO_ENABLED is set to 1")
	}
	if !degradesWithoutCgo() {
		t.Skip("this platform has a cgo-free backend and is always tested")
	}

	// When CGO is disabled, the clipboard cannot function but the public
	// API must degrade gracefully instead of panicking: Read/Write return
	// nil and Watch returns a closed channel. See issue #93.
	t.Run("Read", func(t *testing.T) {
		if got := clipboard.Read(clipboard.FmtText); got != nil {
			t.Fatalf("expect nil when CGO_ENABLED=0, got: %v", got)
		}
	})

	t.Run("Write", func(t *testing.T) {
		if got := clipboard.Write(clipboard.FmtText, []byte("dummy")); got != nil {
			t.Fatalf("expect nil when CGO_ENABLED=0, got non-nil channel")
		}
	})

	t.Run("Watch", func(t *testing.T) {
		changed := clipboard.Watch(context.TODO(), clipboard.FmtText)
		if changed == nil {
			t.Fatalf("expect a non-nil channel when CGO_ENABLED=0")
		}
		select {
		case _, ok := <-changed:
			if ok {
				t.Fatalf("expect a closed channel when CGO_ENABLED=0")
			}
		case <-time.After(time.Second):
			t.Fatalf("expect a closed channel when CGO_ENABLED=0, but it blocked")
		}
	})
}