Headless automated testing on linux fails due to use of init() functions

[arran4]

Basically if the package your testing includes:

import (
	"github.com/hajimehoshi/ebiten/v2"
)

It will fail with:

2021/10/30 12:41:14 PlatformError: X11: The DISPLAY environment variable is missing
panic: NotInitialized: The GLFW library is not initialized

goroutine 1 [running]:
github.com/go-gl/glfw/v3.3/glfw.acceptError({0x0, 0x0, 0x10004})
	/home/runner/go/pkg/mod/github.com/go-gl/glfw/v3.3/[email protected]/error.go:174 +0x186
github.com/go-gl/glfw/v3.3/glfw.panicError(...)
	/home/runner/go/pkg/mod/github.com/go-gl/glfw/v3.3/[email protected]/error.go:185
github.com/go-gl/glfw/v3.3/glfw.WindowHint(0x7f7a84c59428, 0x30)
	/home/runner/go/pkg/mod/github.com/go-gl/glfw/v3.3/[email protected]/window.go:275 +0x3f
github.com/hajimehoshi/ebiten/v2/internal/glfw.WindowHint(...)
	/home/runner/go/pkg/mod/github.com/hajimehoshi/ebiten/[email protected]/internal/glfw/glfw_notwindows.go:363
github.com/hajimehoshi/ebiten/v2/internal/uidriver/glfw.initialize()
	/home/runner/go/pkg/mod/github.com/hajimehoshi/ebiten/[email protected]/internal/uidriver/glfw/ui.go:175 +0x5e
github.com/hajimehoshi/ebiten/v2/internal/uidriver/glfw.init.2()
	/home/runner/go/pkg/mod/github.com/hajimehoshi/ebiten/[email protected]/internal/uidriver/glfw/ui.go:159 +0x19

Minimal example can be found here:
https://github.com/arran4/ebiten-init-failure/

https://github.com/arran4/ebiten-init-failure/runs/4055296526?check_suite_focus=true#step:5:24

[hajimehoshi]

Probably you are talking about GitHub workflows. See https://github.com/hajimehoshi/ebiten/blob/main/.github/workflows/test.yml for example. Thanks,

[arran4]

Thanks it seems you're using xvfb to bring up a virtualX. That is over kill in my solutions:

      - name: Xvfb
        if: ${{ startsWith(matrix.os, 'ubuntu-') }}
        run: |
          Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &

I think with either tags or by changing the way the func init() functions work we can allow headless testing to work. I am not testing ebiten in my code base but I am importing definitions.

I was thinking of something like this:

Index: uidriver_noui.go
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/uidriver_noui.go b/uidriver_noui.go
new file mode 100644
--- /dev/null	(date 1635640237792)
+++ b/uidriver_noui.go	(date 1635640237792)
@@ -0,0 +1,141 @@
+// Copyright 2019 The Ebiten Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build noui
+// +build noui
+
+package ebiten
+
+import (
+	"github.com/hajimehoshi/ebiten/v2/internal/driver"
+	"time"
+)
+
+type nullUI struct {
+	cursorMode          driver.CursorMode
+	cursorShape         CursorShapeType
+	fullscreen          bool
+	runnableOnUnfocused bool
+	fpsMode             driver.FPSMode
+	screenTransparent   bool
+}
+
+func (n *nullUI) Run(context driver.UIContext) error {
+	return nil
+}
+
+func (n *nullUI) RunWithoutMainLoop(context driver.UIContext) {
+}
+
+func (n *nullUI) DeviceScaleFactor() float64 {
+	return 1
+}
+
+func (n *nullUI) IsFocused() bool {
+	return true
+}
+
+func (n *nullUI) ScreenSizeInFullscreen() (int, int) {
+	return 1, 1
+}
+
+func (n *nullUI) ResetForFrame() {
+}
+
+func (n *nullUI) CursorMode() driver.CursorMode {
+	return n.cursorMode
+}
+
+func (n *nullUI) SetCursorMode(mode driver.CursorMode) {
+	n.cursorMode = mode
+}
+
+func (n *nullUI) CursorShape() driver.CursorShape {
+	return n.cursorShape
+}
+
+func (n *nullUI) SetCursorShape(shape driver.CursorShape) {
+	n.cursorShape = CursorShapeDefault
+}
+
+func (n *nullUI) IsFullscreen() bool {
+	return n.fullscreen
+}
+
+func (n *nullUI) SetFullscreen(fullscreen bool) {
+	n.fullscreen = fullscreen
+}
+
+func (n *nullUI) IsRunnableOnUnfocused() bool {
+	return n.runnableOnUnfocused
+}
+
+func (n *nullUI) SetRunnableOnUnfocused(runnableOnUnfocused bool) {
+	n.runnableOnUnfocused = runnableOnUnfocused
+}
+
+func (n *nullUI) FPSMode() driver.FPSMode {
+	return n.fpsMode
+}
+
+func (n *nullUI) SetFPSMode(mode driver.FPSMode) {
+	n.fpsMode = mode
+}
+
+func (n *nullUI) ScheduleFrame() {
+}
+
+func (n *nullUI) IsScreenTransparent() bool {
+	return n.screenTransparent
+}
+
+func (n *nullUI) SetScreenTransparent(transparent bool) {
+	n.screenTransparent = transparent
+}
+
+func (n *nullUI) SetInitFocused(focused bool) {
+}
+
+func (n *nullUI) Vibrate(duration time.Duration) {
+}
+
+func (n *nullUI) Input() driver.Input {
+	return nil
+}
+
+func (n *nullUI) Window() driver.Window {
+	return nil
+}
+
+func (n *nullUI) Graphics() driver.Graphics {
+	return nil
+}
+
+func setMockUIDriver(driver driver.UI) {
+	mockUIDriver = driver
+}
+
+var (
+	mockUIDriver driver.UI = nil
+)
+
+func uiDriver() driver.UI {
+	if mockUIDriver == nil {
+		mockUIDriver = &nullUI{
+			cursorMode:  CursorModeVisible,
+			cursorShape: CursorShapeDefault,
+		}
+	}
+	return mockUIDriver
+}
Index: uidriver_glfw.go
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/uidriver_glfw.go b/uidriver_glfw.go
--- a/uidriver_glfw.go	(revision 15f62bfeb5a031bd7fd7e486f5a3f586974426c4)
+++ b/uidriver_glfw.go	(date 1635639858337)
@@ -12,8 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-//go:build !android && !js && !ios
-// +build !android,!js,!ios
+//go:build !android && !js && !ios && !noui
+// +build !android,!js,!ios,!noui
 
 package ebiten
 

[arran4]

arran4/ebiten-init-failure#1 <-- In context

[hajimehoshi]

#353 For headless Ebiten, there is a task but I don't have bandwidth to work on it so far.

[arran4]

ok