Skip to content

TESTING.md

Latest commit

 

History

History
90 lines (68 loc) · 3.58 KB

TESTING.md

File metadata and controls

90 lines (68 loc) · 3.58 KB
Raw

Running the Unity tests

Prerequisites

  • Install Unity 6000.3.10f1 through Unity Hub. This is the version recorded in ProjectSettings/ProjectVersion.txt.
  • Make sure the managed LibVLCSharp.dll is available. Binary plugin files are intentionally ignored by Git.

    • A packaged VLC for Unity build already contains it.

    • On Windows, place it at Assets/VLCUnity/Plugins/Windows/x86_64/LibVLCSharp.dll.

    • To build it from a sibling LibVLCSharp checkout:

      dotnet build ..\LibVLCSharp\src\LibVLCSharp\LibVLCSharp.csproj /p:UNITY=true -c Release
Copy-Item ..\LibVLCSharp\src\LibVLCSharp\bin\Release\netstandard2.0\LibVLCSharp.dll Assets\VLCUnity\Plugins\Windows\x86_64\

The Unity Test Framework dependency is declared in Packages/manifest.json and is restored automatically. Native LibVLC and VLC Unity plugin binaries are required for playback testing, but not for the logging Edit Mode tests. These tests do not exercise the native SetLogCallback entry point, so validate a freshly built native plugin before packaging.

Run in the Unity Editor

  1. Open the repository as a Unity project and wait for script compilation to finish.
  2. Open Window > General > Test Runner.
  3. Select EditMode.
  4. Run LibVLCSharp.Tests.VLCUnityLoggerTests, or use Run All.

Run from the command line

Close any Unity Editor instance that has the project open, then run:

& "C:\Program Files\Unity\Hub\Editor\6000.3.10f1\Editor\Unity.exe" `
  -batchmode `
  -projectPath (Get-Location) `
  -runTests `
  -testPlatform EditMode `
  -testFilter LibVLCSharp.Tests.VLCUnityLoggerTests `
  -testResults TestResults.xml `
  -logFile TestRun.log

Unity exits when the test run finishes. Do not add -quit, because it can make Unity exit before the tests start.

Run the native Linux policy tests

The native tests are headless. They validate Linux backend selection, stable DRM render-node enumeration, explicit device overrides, and compatibility-probe fallback without requiring Unity or a GPU:

meson setup build-linux-tests
meson compile -C build-linux-tests linux-graphics-interop-tests
meson test -C build-linux-tests linux-graphics-interop --print-errorlogs

The full Meson configuration still requires the normal LibVLC development dependency. CI should run this test on both x86_64 and arm64 Linux builders when arm64 packaging is added; the tested policy code has no architecture-specific assumptions.

Linux GPU integration matrix

Headless unit tests cannot validate driver-owned GLX/EGL sharing or external memory imports. Before publishing a Linux package, run VLCMinimalPlayback in both the Editor and a standalone player and confirm that the log reports either a successful shared-context probe or a compatible DMA-BUF device.

Cover these configurations when hardware is available:

Session GPU topology Expected path
Xorg Single Intel/AMD/NVIDIA GPU GLX shared context
XWayland Single GPU GLX shared context
Xorg or XWayland Integrated + NVIDIA PRIME GLX shared context on Unity's selected GPU
Forced DMA-BUF test Multiple render nodes Reject incompatible nodes and select the matching node
Native Wayland experimental Single GPU EGL plus DMA-BUF

For a forced-device run:

VLC_UNITY_GLX_FORCE_DMABUF=1 \
VLC_UNITY_DRM_DEVICE=/dev/dri/renderD129 \
./YourGame.x86_64 -force-glcore 2>&1 | tee vlc-unity-linux.log

For backend A/B testing:

VLC_UNITY_LINUX_OPENGL_BACKEND=glx ./YourGame.x86_64 -force-glcore
VLC_UNITY_LINUX_OPENGL_BACKEND=egl ./YourGame.x86_64 -force-glcore