Skip to content

README.md

Latest commit

 

History

History
58 lines (33 loc) · 2.91 KB

README.md

File metadata and controls

58 lines (33 loc) · 2.91 KB

Testing against the CMB Service

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 repository.

Due to this, there is some more setup needed when running tests against the CMB Service.

Configuration

The tests are automatically configured to run any HostOrServer.DAHost or NetworkTopologyTypes.DistributedAuthority test against the CMB server when either the USE_CMB_SERVICE scripting define is set, or when an environment variable is passed in with USE_CMB_SERVICE=true. When set, all non-distributed authority compatible tests will be ignored.

By default, the tests are configured to look for the service on the local machine (localhost/http://127.0.0.1) at port 7789.

Running against the service

First, ensure the USE_CMB_SERVICE scripting define or environment variable is set.

Download the service

Go to the CMB Runtime CI action inside the cmb repo (link here). 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).

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.

Run the service locally

Next we'll run the binary on the command line.

Note

If you're running on macOS, you'll have to add execution privileges to the binary before running it.

xattr -c /path/to/comb-server

To run the service, run the following command:

/path/to/download/comb-server -l info --metrics-port 5000 standalone --port 7789 -t 60m

Note that we have set the port to 7789 to match where the tests will be looking.

After each test, all connected clients will disconnect from the service. The service will automatically shut down when that happens. When running multiple tests in a row, it can be more convenient to run the service in a loop:

while :; do /path/to/download/file -l info --metrics-port 5000 standalone --port 7789 -t 60m; done

Run the tests

With USE_CMB_SERVICE set, everything should be configured so that running any distributed authority test in the editor should run against the service we have running on the command line. Try running a test to validate that information is logged in the command line.

Further configuration

The following environment variables allow for further configuration of the setup.

CMB_SERVICE_PORT defines the port where the tests will try to connect to the service (defaults to 7789).

NGO_HOST defines the http address where the tests will try to connect to the service (defaults to 127.0.0.1).