hakurei/system/dbus/dbus_test.go

package dbus_test

import (
	"context"
	"errors"
	"fmt"
	"io"
	"os"
	"strings"
	"syscall"
	"testing"
	"time"

	"hakurei.app/helper"
	"hakurei.app/message"
	"hakurei.app/system/dbus"
)

func TestFinalise(t *testing.T) {
	if _, err := dbus.Finalise(dbus.ProxyPair{}, dbus.ProxyPair{}, nil, nil); !errors.Is(err, syscall.EBADE) {
		t.Errorf("Finalise: error = %v, want %v",
			err, syscall.EBADE)
	}

	for id, tc := range testCasePairs {
		t.Run("create final for "+id, func(t *testing.T) {
			var wt io.WriterTo
			if v, err := dbus.Finalise(tc[0].bus, tc[1].bus, tc[0].c, tc[1].c); (errors.Is(err, syscall.EINVAL)) != tc[0].wantErr {
				t.Errorf("Finalise: error = %v, wantErr %v",
					err, tc[0].wantErr)
				return
			} else {
				wt = v
			}

			// rest of the tests happen for sealed instances
			if tc[0].wantErr {
				return
			}

			// build null-terminated string from wanted args
			want := new(strings.Builder)
			args := append(tc[0].want, tc[1].want...)
			for _, arg := range args {
				want.WriteString(arg)
				want.WriteByte(0)
			}

			got := new(strings.Builder)
			if _, err := wt.WriteTo(got); err != nil {
				t.Errorf("WriteTo: error = %v", err)
			}

			if want.String() != got.String() {
				t.Errorf("Seal: %q, want %q",
					got.String(), want.String())
			}
		})
	}
}

func TestProxyStartWaitCloseString(t *testing.T) {
	t.Run("sandbox", func(t *testing.T) { testProxyFinaliseStartWaitCloseString(t, true) })
	t.Run("direct", func(t *testing.T) { testProxyFinaliseStartWaitCloseString(t, false) })
}

const (
	stubProxyTimeout = 5 * time.Second
)

func testProxyFinaliseStartWaitCloseString(t *testing.T, useSandbox bool) {
	{
		oldWaitDelay := helper.WaitDelay
		helper.WaitDelay = 16 * time.Second
		t.Cleanup(func() { helper.WaitDelay = oldWaitDelay })
	}

	{
		proxyName := dbus.ProxyName
		dbus.ProxyName = os.Args[0]
		t.Cleanup(func() { dbus.ProxyName = proxyName })
	}

	var p *dbus.Proxy

	t.Run("string for nil proxy", func(t *testing.T) {
		want := "(invalid dbus proxy)"
		if got := p.String(); got != want {
			t.Errorf("String: %q, want %q",
				got, want)
		}
	})

	t.Run("invalid start", func(t *testing.T) {
		if !useSandbox {
			p = dbus.NewDirect(t.Context(), message.New(nil), nil, nil)
		} else {
			p = dbus.New(t.Context(), message.New(nil), nil, nil)
		}

		if err := p.Start(); !errors.Is(err, syscall.ENOTRECOVERABLE) {
			t.Errorf("Start: error = %q, wantErr %q", err, syscall.ENOTRECOVERABLE)
			return
		}
	})

	for id, tc := range testCasePairs {
		// this test does not test errors
		if tc[0].wantErr {
			continue
		}

		t.Run("proxy for "+id, func(t *testing.T) {
			var final *dbus.Final
			t.Run("finalise", func(t *testing.T) {
				if v, err := dbus.Finalise(tc[0].bus, tc[1].bus, tc[0].c, tc[1].c); err != nil {
					t.Errorf("Finalise: error = %v, wantErr %v", err, tc[0].wantErr)
					return
				} else {
					final = v
				}
			})

			ctx, cancel := context.WithTimeout(t.Context(), stubProxyTimeout)
			defer cancel()
			output := new(strings.Builder)
			if !useSandbox {
				p = dbus.NewDirect(ctx, message.New(nil), final, output)
			} else {
				p = dbus.New(ctx, message.New(nil), final, output)
			}

			{ // check invalid wait behaviour
				wantErr := "dbus: not started"
				if err := p.Wait(); err == nil || err.Error() != wantErr {
					t.Errorf("Wait: error = %v, wantErr %v", err, wantErr)
				}
			}

			{ // check string behaviour
				want := "(unused dbus proxy)"
				if got := p.String(); got != want {
					t.Errorf("String: %q, want %q", got, want)
					return
				}
			}

			if err := p.Start(); err != nil {
				t.Fatalf("Start: error = %v", err)
			}

			{ // check running string behaviour
				wantSubstr := fmt.Sprintf("%s --args=3 --fd=4", os.Args[0])
				if useSandbox {
					wantSubstr = `argv: ["xdg-dbus-proxy" "--args=3" "--fd=4"], filter: true, rules: 0, flags: 0x1, presets: 0xf`
				}
				if got := p.String(); !strings.Contains(got, wantSubstr) {
					t.Errorf("String: %q, want %q",
						got, wantSubstr)
					return
				}
			}

			p.Close()
			if err := p.Wait(); err != nil {
				t.Errorf("Wait: error = %v\noutput: %s", err, output.String())
			}
		})
	}
}