enso/tools/ci

CI Tools

This folder contains miscellaneous utilities for CI.

Docker

Building

A custom docker image requires a certain number of directories to be present from a desired edition. The root directory of the docker build context can be provided in the docker build command:

docker build \
  -t runtime:latest \
  -f tools/ci/docker/engine/Dockerfile \
  --build-context docker-tools=tools/ci/docker/engine \
  built-distribution/enso-engine-0.0.0-dev-linux-amd64/enso-0.0.0-dev

Running

To start Language Server with a default configuration, run the built image and mount the project directory:

docker run -it --rm \
  --network=host \
  --mount type=bind,src=~/Documents/enso-projects/NewProject,dst=/volumes/workspace/project_root \
  runtime:latest

Ydoc Docker

Build Node.js container

To build a Node.js-based Ydoc, you need to first ensure that you have the distributable sources:

pnpm -r compile

the resulting artifacts are located in app/ydoc-server-nodejs/dist directory. Having the right Node.js sources in place, one can now build the docker image:

docker build -t ydoc-server-nodejs:latest -f tools/ci/docker/ydoc-server-nodejs/Dockerfile --build-context docker-tools=tools/ci/docker/ydoc-server-nodejs app/ydoc-server-nodejs

Build Native Image container

Build the Native Image:

sbt ydoc-server/buildNativeImage

Build the Docker image:

docker build -t ydoc-server-polyglot:latest --build-context native-image=lib/java/ydoc-server/target/native-image tools/ci/docker/ydoc-server-polyglot

Running

Both images ydoc-server-nodejs and ydoc-server-polyglot are started the same way:

• PORT - the port number under which Ydoc will be available
• HOSTNAME - the hostname under which Ydoc will be available
• LANGUAGE_SERVER_URL - the full url (with port number) of the language server to connect to

docker run -it -e PORT=1234 -e HOSTNAME='0.0.0.0' -e LANGUAGE_SERVER_URL=ws://localhost:59876 ydoc-server-nodejs:latest

When correctly setup the network layer one can also hit Ydoc's healthcheck endpoint:

> curl http://${HOSTNAME}:${PORT}/_health
OK