You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Tools/CI/service.cmb/README.md
+10-3Lines changed: 10 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Testing against the CMB Service
2
2
3
-
The CMB Service is a tool that is external to our repository. The tool is inside the `runtime` folder in the [mps-common-multiplayer-backend](https://github.com/Unity-Technologies/mps-common-multiplayer-backend)repository.
3
+
The CMB Service is a tool that is external to our repository. The tool is inside the `runtime` folder of the [CMB service](https://github.com/Unity-Technologies/unity-player-services/tree/main/services/common-multiplayer-backend)in the Unity Player Services monorepo.
4
4
5
5
Due to this, there is some more setup needed when running tests against the CMB Service.
6
6
@@ -16,9 +16,12 @@ First, ensure the `USE_CMB_SERVICE` scripting define or environment variable is
16
16
17
17
### Download the service
18
18
19
-
Go to the `CMB Runtime CI` action inside the cmb repo ([link here](https://github.com/Unity-Technologies/mps-common-multiplayer-backend/actions/workflows/runtime.yaml)). Open the most recent job and scroll down to the bottom of the page (You may have to scroll in the sidebar on the left, the centre of the page is not scrollable).
19
+
1. Go to the [CMB Runtime Build workflow](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/actions/workflows/cmb-runtime-build.yaml) on this repo's Actions page.
20
+
2. Trigger a new run with **Run workflow**
21
+
a. optionally pass a unity-player-services branch, tag, or SHA (default will build `main`).
22
+
3. Wait for the action to finish running.
20
23
21
-
Inside the **Artifacts** section at the bottom of the page, download the `comb-server-<platform>-latest` that matches your computer architecture. This will download a pre-built binary of the most recent CMB Service.
24
+
Inside the **Artifacts** section at the bottom of the page of the finished run you will see three pre-built `comb-server` binaries. Download the `comb-server-<platform>-latest`binary that matches your computer architecture.
22
25
23
26
### Run the service locally
24
27
@@ -56,3 +59,7 @@ The following environment variables allow for further configuration of the setup
56
59
`CMB_SERVICE_PORT` defines the port where the tests will try to connect to the service (defaults to `7789`).
57
60
58
61
`NGO_HOST` defines the http address where the tests will try to connect to the service (defaults to `127.0.0.1`).
62
+
63
+
## Running on CI (Yamato)
64
+
65
+
The CMB tests can also be run from Yamato. The jobs are defined in [`.yamato/cmb-service-standalone-tests.yml`](../../../.yamato/cmb-service-standalone-tests.yml) and appear in Yamato as `CMB Service Test - NGO <project> - [<platform>, <editor>, <backend>]`. The job can be triggered manually from any branch meaning it can be easier to run the CMB tests from Yamato rather than set them up locally. The test uses [`run_cmb_service.sh`](./run_cmb_service.sh) to setup and run the CMB service.
0 commit comments