README.md

Opam Repository for the xapi components of xenserver

This Opam repository contains the OCaml components of the XenServer toolstack and their upstream dependencies. This is just package metadata (not the actual source code) that tells Opam how to download source code, compile, and install packages.

Using this OPAM Repository for Dev Work

You can add this Git repository as a remote Opam repository to your local Opam setup in order to install XenServer packages. See below for an alternative using Docker when you don't want to use Opam natively. Please be aware that this is not giving you a working XenServer installation because this depends on other components. It is most useful for development outside a build system for the complete XenServer distribution.

opam repo add xs-opam https://github.com/xapi-project/xs-opam.git

Installing packages

To install all dependencies of xapi, use the xs-toolstack metapackage:

opam install -t xs-toolstack

Additionally, there are developer tools, like utop, merlin or the lsp server:

opam install dev-tools

Continuous Integration

Github Actions builds the entire universe represented by this Opam repository.

Using xs-opam on github actions builds

To use the repository in github actions 3 steps are needed to set up the opam environment:

• One to download the .env file
• One to load it into the environment
• One to initialize the opam environment

Here's an example template for the standard .github/workflows/main.yml, package should be change to include the opam packages available in the repository and the build and test steps adapted to the repository.

name: Build and test

on:
  push:
  pull_request:

jobs:
  ocaml-test:
    name: Ocaml tests
    runs-on: ubuntu-20.04
    env:
      package: "EXAMPLE-BINARY EXAMPLE-LIBRARY"

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Pull configuration from xs-opam
        run: |
          curl --fail --silent https://raw.githubusercontent.com/xapi-project/xs-opam/master/tools/xs-opam-ci.env | cut -f2 -d " " > .env

      - name: Load environment file
        id: dotenv
        uses: falti/dotenv-action@v0.2.4

      - name: Use ocaml
        uses: avsm/setup-ocaml@v1
        with:
          ocaml-version: ${{ steps.dotenv.outputs.ocaml_version_full }}
          opam-repository: ${{ steps.dotenv.outputs.repository }}

      - name: Install dependencies
        run: |
          opam pin add . --no-action
          opam depext -u ${{ env.package }}
          opam install ${{ env.package }} --deps-only --with-test -v

      - name: Build
        run: |
          opam exec -- ./configure
          opam exec -- make

      - name: Run tests
        run: opam exec -- make test