aallbrig
commented
3 months ago Going to add some current notes here.
The way Unity handles licenses changed since I set up aallbrig/getting-started-with-game-ci-docker. Before one would generate a .alf file, navigate to a Unity webpage, then receive a .ulf file in return. Now it appears the Unity license file is generated in the Unity Hub app (Unity License activation docs).
This .ulf Unity License file is generated for the detected OS; if one is on an M2 Macbook and generates the license, that license will only allow the Unity Editor to work on that particular OS. That's a problem because the GameCI container image is based on Ubuntu. Feeding in the .ulf file from host M2 will result in a gameCI failure.
E.g. command:
repo_root=$(git rev-parse --show-toplevel)
unity_version="2021.3.13f1"
base_version="3.1.0"
cat << 'HERE' > /tmp/create-script.sh
unity-editor \
-logFile /dev/stdout \
-quit \
-manualLicenseFile /UnityLicense.ulf
unity-editor \
-logFile /dev/stdout \
-quit \
-createProject $(pwd)
HERE
chmod +x /tmp/create-script.sh
docker run \
--interactive \
--platform linux/amd64 \
--tty \
--rm \
--env UNITY_EMAIL \
--env UNITY_PASSWORD \
--volume "/Library/Application Support/Unity/Unity_lic.ulf:/UnityLicense.ulf" \
--volume "$(mktemp -d):/unity" \
--workdir /unity \
--volume "/tmp/create-script.sh:/create-script.sh" \
"unityci/editor:ubuntu-${unity_version}-base-${base_version}" \
bash -c '/create-script.sh'Output:
Unity Editor version: 2021.3.13f1 (9e7d58001ecf)
Branch: 2021.3/staging
Build type: Release
Batch mode: YES
System name: Linux
Distro version: #1 SMP Thu May 23 08:36:57 UTC 2024
Kernel version: 6.6.31-linuxkit
Architecture: x86_64
Available memory: 7840 MB
[LicensingClient] Channel doesn't exist: "LicenseClient-root"
[Licensing::Module] Successfully launched the LicensingClient (PId: 35)
[Licensing::Module] Warning: LicensingClient has failed validation; ignoring
[LicensingClient] Handshaking with LicensingClient (version: 1.9.0+249add7)
[Licensing::Module] Successfully connected to LicensingClient on channel: "LicenseClient-root" (connect: 1.07s, validation: 0.20s, handshake: 0.00s)
[Licensing::Module] Connected to LicensingClient (PId: 35, launch time: 0.00, total connection time: 1.27s)
Entitlement-based licensing initiated
[Licensing::Module] Error: Access token is unavailable
[LicensingClient] Licenses updated successfully
Load manual activation license file.
LICENSE SYSTEM [2024730 12:44:0] Load license file from: /UnityLicense.ulf
LICENSE SYSTEM [2024730 12:44:0] Next license update check is after 2024-07-27T23:44:45
LICENSE SYSTEM [2024730 12:44:0] Machine binding 1 mismatch: (value of current machine) 576562626572264761624c65526f7578 != 527236A0-0965-578E-977F-D206EDEFB215 (value in license file). Reason might be there is a hardware change on this machine after the license was activated.
LICENSE SYSTEM [2024730 12:44:0] Machine binding 2 mismatch: (value of current machine) 576562626572264761624c65526f7578 != RQFG6M9KVY (value in license file). Reason might be there is a hardware change on this machine after the license was activated.
LICENSE SYSTEM [2024730 12:44:0] Machine identification is invalid for current license.
License file loaded.
Checking for leaked weakptr:
Found no leaked weakptrs.
Memory Statistics:
[ALLOC_TEMP_TLS] TLS Allocator
StackAllocators :
[ALLOC_TEMP_CurlRequest]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_CoreBusinessMetricsCache]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_Profiler.Dispatcher]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_AssetGarbageCollectorHelper] x 11
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_MEMORYPROFILER]
Requested Block Size 1.0 MB
Peak Block count 1
Peak Allocated memory 4.0 KB
Peak Large allocation bytes 0 B
##utp:{"type":"MemoryLeaks","version":2,"phase":"Immediate","time":1722343440852,"processId":21,"allocatedMemory":88575,"memoryLabels":[{"Default":122},{"Thread":64},{"Manager":7098},{"Serialization":40},{"BaseObject":12216},{"String":7824},{"DynamicArray":432},{"HashMap":3668},{"Utility":1024},{"Curl":1112},{"PoolAlloc":120},{"GI":3248},{"VR":80},{"RestService":1022},{"License":288},{"UnityConnect":29664},{"Collab":25},{"LocalIPC":99},{"ProfilerEditor":20021},{"Licensing":408}]}
(repeated text omitted)Reading more from gameCI source code, you realize that the is a new value UNITY_SERIAL that gets obtained in the JS parts of gameCI (see src/model/input.ts#L91, src/model/input.ts#L193, src/model/input.ts#L203, src/model/input.ts#L206 from the game-ci/unity-test-runner repo).
export UNITY_USERNAME=""
export UNITY_PASSWORD=""
# unity license file location found on page: https://game.ci/docs/github/activation
export UNITY_LICENSE=$(cat "/Library/Application Support/Unity/Unity_lic.ulf")
export UNITY_SERIAL=$(echo $UNITY_LICENSE | sed -n 's/.*<SerialMasked Value="\([^"]*\)".*/\1/p')
repo_root=$(git rev-parse --show-toplevel)
unity_version="2021.3.13f1"
base_version="3.1.0"
cat << 'HERE' > /tmp/create-script.sh
unity-editor \
-logFile /dev/stdout \
-quit \
-createProject $(pwd) \
-username "$UNITY_USERNAME" -password "$UNITY_PASSWORD" -serial "$UNITY_SERIAL"
HERE
chmod +x /tmp/create-script.sh
docker run \
--interactive \
--platform linux/amd64 \
--network host \
--tty \
--rm \
--env UNITY_USERNAME \
--env UNITY_PASSWORD \
--env UNITY_SERIAL \
--volume "$(mktemp -d):/unity" \
--workdir /unity \
--volume "/tmp/create-script.sh:/create-script.sh" \
"unityci/editor:ubuntu-${unity_version}-base-${base_version}" \
bash -c '/create-script.sh'Experimentation command I use:
export UNITY_LICENSE=$(cat "/Library/Application Support/Unity/Unity_lic.ulf")
export UNITY_SERIAL=$(echo $UNITY_LICENSE | sed -n 's/.*<SerialMasked Value="\([^"]*\)".*/\1/p')
unity_version="2021.3.13f1"
base_version="3.1.0"
docker run \
--interactive \
--platform linux/amd64 \
--network host \
--tty \
--rm \
--env UNITY_USERNAME \
--env UNITY_PASSWORD \
--env UNITY_SERIAL \
--volume "$(mktemp -d):/unity" \
--workdir /unity \
"unityci/editor:ubuntu-${unity_version}-base-${base_version}" \
bashThis way I can run any unity-editor commands I want. Note: unity-editor is a decorator script that calls out to the "real" Unity Editor (ubuntu) command line.
$ which unity-editor
/usr/bin/unity-editor
$ cat /usr/bin/unity-editor
#!/bin/bash
if [ -d /usr/bin/unity-editor.d ] ; then
for i in /usr/bin/unity-editor.d/*.sh; do
if [ -r $i ]; then
. $i
fi
done
fi
xvfb-run -ae /dev/stdout "$UNITY_PATH/Editor/Unity" -batchmode "$@"You can find the "real" Unity Editor command line docs here and the test commands in the Test Framework docs here.
Currently I have two issues. (1) username/password combination doesn't seem to be working? (2) license steps probably aren't complete. I think solving problem 2 will solve problem 1 because I guarantee my credentials are correct.
Sample output from inside an "experiment" container
$ unity-editor \
-logFile /dev/stdout \
-quit \
-createProject $(pwd) \
-username "$UNITY_USERNAME" -password "$UNITY_PASSWORD" -serial "$UNITY_SERIAL"
Unity Editor version: 2021.3.13f1 (9e7d58001ecf)
Branch: 2021.3/staging
Build type: Release
Batch mode: YES
System name: Linux
Distro version: #1 SMP Thu May 23 08:36:57 UTC 2024
Kernel version: 6.6.31-linuxkit
Architecture: x86_64
Available memory: 7840 MB
UnityConnectLoginRequest: Failed to login - please check your username or password
No sufficient permissions while processing request "https://core.cloud.unity3d.com/api/login", HTTP error code 401
.[LicensingClient] Channel doesn't exist: "LicenseClient-root"
[Licensing::Module] Successfully launched the LicensingClient (PId: 102)
[Licensing::Module] Warning: LicensingClient has failed validation; ignoring
[LicensingClient] Handshaking with LicensingClient (version: 1.9.0+249add7)
[Licensing::Module] Successfully connected to LicensingClient on channel: "LicenseClient-root" (connect: 1.03s, validation: 0.16s, handshake: 0.00s)
[Licensing::Module] Connected to LicensingClient (PId: 102, launch time: 0.00, total connection time: 1.19s)
Entitlement-based licensing initiated
[Licensing::Module] Error: Access token is unavailable
[Licensing::Module] Error: Failed to activate entitlement license
Cancelling DisplayDialog: Failed to activate/update license Timeout occured while trying to update license. Please try again later or contact support@unity3d.com
This should not be called in batch mode.
Checking for leaked weakptr:
Found no leaked weakptrs.
Memory Statistics:
[ALLOC_TEMP_TLS] TLS Allocator
StackAllocators :
[ALLOC_TEMP_CurlRequest]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_CoreBusinessMetricsCache]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_Profiler.Dispatcher]
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_TEMP_AssetGarbageCollectorHelper] x 11
Initial Block Size 64.0 KB
Current Block Size 64.0 KB
Peak Allocated Bytes 0 B
Overflow Count 0
[ALLOC_MEMORYPROFILER]
Requested Block Size 1.0 MB
Peak Block count 1
Peak Allocated memory 4.0 KB
Peak Large allocation bytes 0 B
##utp:{"type":"MemoryLeaks","version":2,"phase":"Immediate","time":1722294444852,"processId":86,"allocatedMemory":86136,"memoryLabels":[{"Default":226},{"Thread":64},{"Manager":7098},{"Serialization":40},{"BaseObject":12216},{"String":5361},{"DynamicArray":432},{"HashMap":3668},{"Utility":1024},{"Curl":1112},{"PoolAlloc":120},{"GI":3248},{"VR":80},{"RestService":1022},{"License":288},{"UnityConnect":29688},{"Collab":25},{"LocalIPC":99},{"ProfilerEditor":20021},{"Licensing":304}]}Next steps: continue reading through various GameCI bash scripts such as those found in https://github.com/game-ci/unity-test-runner/tree/main/dist/platforms/ubuntu
markmandel
Is your feature request related to a problem? Please describe. A discussion started in https://github.com/googleforgames/agones/pull/3887 over the idea of using GameCI's images (docs, docker hub) to run the Agones Unity SDK tests as a way of making things easier.
Describe the solution you'd like I'd like to see documentation additions that include how one may use
dockercommands to run the Agones Unity SDK tests.Describe alternatives you've considered 🤔 Perhaps a script with OS specific commands would also serve the purpose of making running tests for Agones Unity SDK easier as well.
Additional context Previous experience: https://github.com/aallbrig/getting-started-with-game-ci-docker