all: initial import from gio main repository

Signed-off-by: Elias Naur <mail@eliasnaur.com>

gogio/wayland_test.go

@@ -0,0 +1,196 @@
+// SPDX-License-Identifier: Unlicense OR MIT
+
+package main_test
+
+import (
+	"bufio"
+	"bytes"
+	"context"
+	"fmt"
+	"image"
+	"image/png"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"regexp"
+	"strings"
+	"sync"
+	"text/template"
+	"time"
+)
+
+type WaylandTestDriver struct {
+	driverBase
+
+	runtimeDir string
+	socket     string
+	display    string
+}
+
+// No bars or anything fancy. Just a white background with our dimensions.
+var tmplSwayConfig = template.Must(template.New("").Parse(`
+output * bg #FFFFFF solid_color
+output * mode {{.Width}}x{{.Height}}
+default_border none
+`))
+
+var rxSwayReady = regexp.MustCompile(`Running compositor on wayland display '(.*)'`)
+
+func (d *WaylandTestDriver) Start(path string) {
+	// We want os.Environ, so that it can e.g. find $DISPLAY to run within
+	// X11. wlroots env vars are documented at:
+	// https://github.com/swaywm/wlroots/blob/master/docs/env_vars.md
+	env := os.Environ()
+	if *headless {
+		env = append(env, "WLR_BACKENDS=headless")
+	}
+
+	d.needPrograms(
+		"sway",    // to run a wayland compositor
+		"grim",    // to take screenshots
+		"swaymsg", // to send input
+	)
+
+	// First, build the app.
+	dir := d.tempDir("gio-endtoend-wayland")
+	bin := filepath.Join(dir, "red")
+	flags := []string{"build", "-tags", "nox11", "-o=" + bin}
+	if raceEnabled {
+		flags = append(flags, "-race")
+	}
+	flags = append(flags, path)
+	cmd := exec.Command("go", flags...)
+	if out, err := cmd.CombinedOutput(); err != nil {
+		d.Fatalf("could not build app: %s:\n%s", err, out)
+	}
+
+	conf := filepath.Join(dir, "config")
+	f, err := os.Create(conf)
+	if err != nil {
+		d.Fatal(err)
+	}
+	defer f.Close()
+	if err := tmplSwayConfig.Execute(f, struct{ Width, Height int }{
+		d.width, d.height,
+	}); err != nil {
+		d.Fatal(err)
+	}
+
+	d.socket = filepath.Join(dir, "socket")
+	env = append(env, "SWAYSOCK="+d.socket)
+	d.runtimeDir = dir
+	env = append(env, "XDG_RUNTIME_DIR="+d.runtimeDir)
+
+	var wg sync.WaitGroup
+	d.Cleanup(wg.Wait)
+
+	// First, start sway.
+	{
+		ctx, cancel := context.WithCancel(context.Background())
+		cmd := exec.CommandContext(ctx, "sway", "--config", conf, "--verbose")
+		cmd.Env = env
+		stderr, err := cmd.StderrPipe()
+		if err != nil {
+			d.Fatal(err)
+		}
+		if err := cmd.Start(); err != nil {
+			d.Fatal(err)
+		}
+		d.Cleanup(cancel)
+		d.Cleanup(func() {
+			// Give it a chance to exit gracefully, cleaning up
+			// after itself. After 10ms, the deferred cancel above
+			// will signal an os.Kill.
+			cmd.Process.Signal(os.Interrupt)
+			time.Sleep(10 * time.Millisecond)
+		})
+
+		// Wait for sway to be ready. We probably don't need a deadline
+		// here.
+		br := bufio.NewReader(stderr)
+		for {
+			line, err := br.ReadString('\n')
+			if err != nil {
+				d.Fatal(err)
+			}
+			if m := rxSwayReady.FindStringSubmatch(line); m != nil {
+				d.display = m[1]
+				break
+			}
+		}
+
+		wg.Add(1)
+		go func() {
+			if err := cmd.Wait(); err != nil && ctx.Err() == nil && !strings.Contains(err.Error(), "interrupt") {
+				// Don't print all stderr, since we use --verbose.
+				// TODO(mvdan): if it's useful, probably filter
+				// errors and show them.
+				d.Error(err)
+			}
+			wg.Done()
+		}()
+	}
+
+	// Then, start our program on the sway compositor above.
+	{
+		ctx, cancel := context.WithCancel(context.Background())
+		cmd := exec.CommandContext(ctx, bin)
+		cmd.Env = []string{"XDG_RUNTIME_DIR=" + d.runtimeDir, "WAYLAND_DISPLAY=" + d.display}
+		output, err := cmd.StdoutPipe()
+		if err != nil {
+			d.Fatal(err)
+		}
+		cmd.Stderr = cmd.Stdout
+		d.output = output
+		if err := cmd.Start(); err != nil {
+			d.Fatal(err)
+		}
+		d.Cleanup(cancel)
+		wg.Add(1)
+		go func() {
+			if err := cmd.Wait(); err != nil && ctx.Err() == nil {
+				d.Error(err)
+			}
+			wg.Done()
+		}()
+	}
+
+	// Wait for the gio app to render.
+	d.waitForFrame()
+}
+
+func (d *WaylandTestDriver) Screenshot() image.Image {
+	cmd := exec.Command("grim", "/dev/stdout")
+	cmd.Env = []string{"XDG_RUNTIME_DIR=" + d.runtimeDir, "WAYLAND_DISPLAY=" + d.display}
+	out, err := cmd.CombinedOutput()
+	if err != nil {
+		d.Errorf("%s", out)
+		d.Fatal(err)
+	}
+	img, err := png.Decode(bytes.NewReader(out))
+	if err != nil {
+		d.Fatal(err)
+	}
+	return img
+}
+
+func (d *WaylandTestDriver) swaymsg(args ...interface{}) {
+	strs := []string{"--socket", d.socket}
+	for _, arg := range args {
+		strs = append(strs, fmt.Sprint(arg))
+	}
+	cmd := exec.Command("swaymsg", strs...)
+	if out, err := cmd.CombinedOutput(); err != nil {
+		d.Errorf("%s", out)
+		d.Fatal(err)
+	}
+}
+
+func (d *WaylandTestDriver) Click(x, y int) {
+	d.swaymsg("seat", "-", "cursor", "set", x, y)
+	d.swaymsg("seat", "-", "cursor", "press", "button1")
+	d.swaymsg("seat", "-", "cursor", "release", "button1")
+
+	// Wait for the gio app to render after this click.
+	d.waitForFrame()
+}