{ description = "SelfPrivacy API flake"; inputs.nixpkgs.url = "github:nixos/nixpkgs"; outputs = { self, nixpkgs, ... }: let system = "x86_64-linux"; pkgs = nixpkgs.legacyPackages.${system}; selfprivacy-graphql-api = pkgs.callPackage ./default.nix { pythonPackages = pkgs.python310Packages; rev = self.shortRev or self.dirtyShortRev or "dirty"; }; python = self.packages.${system}.default.pythonModule; python-env = python.withPackages (ps: self.packages.${system}.default.propagatedBuildInputs ++ (with ps; [ coverage pytest pytest-datadir pytest-mock pytest-subprocess black mypy pylsp-mypy python-lsp-black python-lsp-server pyflakes typer # for strawberry ] ++ strawberry-graphql.optional-dependencies.cli)); vmtest-src-dir = "/root/source"; shellMOTD = '' Welcome to SP API development shell! [formatters] black nixpkgs-fmt [testing in NixOS VM] nixos-test-driver - run an interactive NixOS VM with all dependencies included and 2 disk volumes pytest-vm - run pytest in an ephemeral NixOS VM with Redis, accepting pytest arguments ''; in { # see https://github.com/NixOS/nixpkgs/blob/66a9817cec77098cfdcbb9ad82dbb92651987a84/nixos/lib/test-driver/test_driver/machine.py#L359 packages.${system} = { default = selfprivacy-graphql-api; pytest-vm = pkgs.writeShellScriptBin "pytest-vm" '' set -o errexit set -o nounset set -o xtrace # see https://github.com/NixOS/nixpkgs/blob/66a9817cec77098cfdcbb9ad82dbb92651987a84/nixos/lib/test-driver/test_driver/machine.py#L359 export TMPDIR=''${TMPDIR:=/tmp}/nixos-vm-tmp-dir readonly NIXOS_VM_SHARED_DIR_HOST="$TMPDIR/shared-xchg" readonly NIXOS_VM_SHARED_DIR_GUEST="/tmp/shared" mkdir -p "$TMPDIR" ln -sfv "$PWD" -T "$NIXOS_VM_SHARED_DIR_HOST" SCRIPT=$(cat <&2") machine.succeed("cd ${vmtest-src-dir} && coverage run -m pytest -v $@ >&2") machine.succeed("cd ${vmtest-src-dir} && coverage report >&2") EOF ) if [ -f "/etc/arch-release" ]; then ${self.checks.${system}.default.driverInteractive}/bin/nixos-test-driver --no-interactive <(printf "%s" "$SCRIPT") else ${self.checks.${system}.default.driver}/bin/nixos-test-driver -- <(printf "%s" "$SCRIPT") fi ''; }; nixosModules.default = import ./nixos/module.nix self.packages.${system}.default; devShells.${system}.default = pkgs.mkShellNoCC { name = "SP API dev shell"; packages = with pkgs; [ nixpkgs-fmt rclone redis restic sonar-scanner-cli self.packages.${system}.pytest-vm # FIXME consider loading this explicitly only after ArchLinux issue is solved self.checks.x86_64-linux.default.driverInteractive # the target API application python environment python-env ]; shellHook = '' # envs set with export and as attributes are treated differently. # for example. printenv will not fetch the value of an attribute. export TEST_MODE="true" # more tips for bash-completion to work on non-NixOS: # https://discourse.nixos.org/t/whats-the-nix-way-of-bash-completion-for-packages/20209/16?u=alexoundos # Load installed profiles for file in "/etc/profile.d/"*.sh; do # If that folder doesn't exist, bash loves to return the whole glob [[ -f "$file" ]] && source "$file" done printf "%s" "${shellMOTD}" ''; }; checks.${system} = { fmt-check = pkgs.runCommandLocal "sp-api-fmt-check" { nativeBuildInputs = [ pkgs.black ]; } "black --check ${self.outPath} > $out"; default = pkgs.testers.runNixOSTest { name = "default"; nodes.machine = { lib, pkgs, ... }: { # 2 additional disks (1024 MiB and 200 MiB) with empty ext4 FS virtualisation.emptyDiskImages = [ 1024 200 ]; virtualisation.fileSystems."/volumes/vdb" = { autoFormat = true; device = "/dev/vdb"; # this name is chosen by QEMU, not here fsType = "ext4"; noCheck = true; }; virtualisation.fileSystems."/volumes/vdc" = { autoFormat = true; device = "/dev/vdc"; # this name is chosen by QEMU, not here fsType = "ext4"; noCheck = true; }; boot.consoleLogLevel = lib.mkForce 3; documentation.enable = false; services.journald.extraConfig = lib.mkForce ""; services.redis.servers.sp-api = { enable = true; save = [ ]; settings.notify-keyspace-events = "KEA"; }; environment.systemPackages = with pkgs; [ python-env # TODO: these can be passed via wrapper script around app rclone restic ]; environment.variables.TEST_MODE = "true"; systemd.tmpfiles.settings.src.${vmtest-src-dir}.L.argument = self.outPath; }; testScript = '' start_all() machine.succeed("cd ${vmtest-src-dir} && coverage run --data-file=/tmp/.coverage -m pytest -p no:cacheprovider -v >&2") machine.succeed("coverage xml --rcfile=${vmtest-src-dir}/.coveragerc --data-file=/tmp/.coverage >&2") machine.copy_from_vm("coverage.xml", ".") machine.succeed("coverage report >&2") ''; }; }; }; nixConfig.bash-prompt = ''\n\[\e[1;32m\][\[\e[0m\]\[\e[1;34m\]SP devshell\[\e[0m\]\[\e[1;32m\]:\w]\$\[\[\e[0m\] ''; }