This document describes how to setup a development environment for conformance testsuite development based on NixOS and devenv.
The devenv will create a containerized environment based on the devenv.nix configuration file.
It will setup the following services:
- MongoDB
- Nginx
- Setup 127.0.0.1 host aliases for localhost.emobix.co.uk
- Generate and install TLS certificates into the local Keychain
See: https://nixos.org/download/#download-nix
sh <(curl -L https://nixos.org/nix/install)
See: https://devenv.sh/getting-started/#2-install-devenv
nix-env -iA devenv -f https://github.com/NixOS/nixpkgs/tarball/nixpkgs-unstable
Once the installation of nix and devenv has been completed, one can start the devenv.
See: https://devenv.sh/getting-started/#commands
devenv up
Once up, one can launch the Conformance Testsuite in the IDE.
To stop the environment press ctrl+c and confirm the message via with enter.
To update the local devenv, you can run the following command:
devenv update
Note that you might need to add a github PAT (personal access token) to be able to download NIX artifacts.
To generate a personal access token, go to https://github.com/settings/personal-access-tokens/new and create a new token.
You need only read permissions for repositories (to download release artifacts).
mkdir -p ~/.config/nix/
echo "access-tokens = github.com=$INSERT_YOUR_GH_PATH_HERE" > ~/.config/nix/nix.conf