Skip to content

build: enable UI tests on macOS via Tycho profile + JRE docs #1283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joaodinissf merged 1 commit into from
May 18, 2026
+29 −0
Merged

build: enable UI tests on macOS via Tycho profile + JRE docs #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,21 @@ export WORKSPACE=$(pwd)
- **Aggregator module**: `com.avaloq.tools.ddk.xtext.test`
- **UI tests**: Require virtual display (xvfb on Linux) or `-XstartOnFirstThread` (macOS)

### macOS developer setup

SWT on Cocoa requires the Display to be created on the main thread. UI tests
therefore need `-XstartOnFirstThread`. There are two contexts:

- **`mvn verify` / CI**: the `macosx` profile in `ddk-parent/pom.xml` (activated
on `family=mac`) adds the flag automatically. No setup required.
- **Running launches from Eclipse**: add `-XstartOnFirstThread` to your JRE's
default VM arguments — `Window > Preferences > Java > Installed JREs > [your
JDK] > Edit > Default VM arguments`. PDE launches with `append.args=true`
inherit this on macOS only. The flag is not hardcoded in the `.launch` files
because the JVM on Windows and Linux rejects it as an "Unrecognized VM
option". This matches Eclipse Platform's own UI test launches (which omit
the flag and rely on the same JRE-default-args mechanism).

### Aggregator pattern — important

The project runs **all tests through one aggregator module**, not per-`.test`-module. `ddk-parent/pom.xml` sets `<skip>true</skip>` on `tycho-surefire-plugin` globally; only `com.avaloq.tools.ddk.xtext.test` overrides it with its own full tycho-surefire configuration. Inside that module, `src/com/avaloq/tools/ddk/xtext/AllTests.java` is a JUnit 5 `@Suite` that `@SelectClasses` from ~14 per-module `*TestSuite` classes (`ExportTestSuite`, `CheckCoreTestSuite`, `TypeSystemTestSuite`, `CheckUiTestSuite`, etc.). Those other `.test` bundles are on `xtext.test`'s OSGi classpath via `Require-Bundle`, so their test classes get discovered and executed inside the single Eclipse runtime spun up for `xtext.test`.
Expand Down
14 changes: 14 additions & 0 deletions ddk-parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,5 +425,19 @@
<osgi.arch>x86_64</osgi.arch>
</properties>
</profile>
<profile>
<id>macosx</id>
<activation>
<os>
<family>mac</family>
</os>
</activation>
<properties>
<osgi.os>macosx</osgi.os>
<osgi.ws>cocoa</osgi.ws>
<osgi.arch>aarch64</osgi.arch>
<test.javaOptions>${runtime.javaOptions} -XstartOnFirstThread</test.javaOptions>
</properties>
</profile>
</profiles>
</project>