selfprivacy-rest-api/README.md

SelfPrivacy GraphQL API which allows app to control your server

build

$ nix build

In case of successful build, you should get the ./result symlink to a folder (in /nix/store) with build contents.

develop

$ nix develop
[SP devshell:/dir/selfprivacy-rest-api]$ python
Python 3.10.13 (main, Aug 24 2023, 12:59:26) [GCC 12.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
(ins)>>>

If you don't have experimental flakes enabled, you can use the following command:

nix --extra-experimental-features nix-command --extra-experimental-features flakes develop

testing

Run the test suite by running coverage with pytest inside an ephemeral NixOS VM with redis service enabled:

$ nix flake check -L

Run the same test suite, but additionally create ./result/coverage.xml in the current directory:

$ nix build .#checks.x86_64-linux.default -L

Alternatively, just print the path to /nix/store/...coverage.xml without creating any files in the current directory:

$ nix build .#checks.x86_64-linux.default -L --print-out-paths --no-link

Run the same test suite with arbitrary pytest options:

$ pytest-vm.sh # specify pytest options here, e.g. `--last-failed`

When running using the script, pytest cache is preserved between runs in .pytest_cache folder. NixOS VM state temporary resides in ${TMPDIR:=/tmp}/nixos-vm-tmp-dir/vm-state-machine during the test. Git workdir directory is shared read-write with VM via .nixos-vm-tmp-dir/shared-xchg symlink. VM accesses workdir contents via /tmp/shared mount point and /root/source symlink.

Launch VM and execute commands manually either in Linux console (user root) or using python NixOS tests driver API (refer to NixOS documentation):

$ nix run .#checks.x86_64-linux.default.driverInteractive

You can add --keep-vm-state in order to keep VM state between runs:

$ TMPDIR=".nixos-vm-tmp-dir" nix run .#checks.x86_64-linux.default.driverInteractive --keep-vm-state

Option -L/--print-build-logs is optional for all nix commands. It tells nix to print each log line one after another instead of overwriting a single one.

dependencies and dependant modules

This flake depends on a single Nix flake input - nixpkgs repository. nixpkgs repository is used for all software packages used to build, run API service, tests, etc.

In order to synchronize nixpkgs input with the same from selfprivacy-nixos-config repository, use this command:

$ nix flake lock --override-input nixpkgs nixpkgs --inputs-from git+https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-config.git?ref=BRANCH

Replace BRANCH with the branch name of selfprivacy-nixos-config repository you want to sync with. During development nixpkgs input update might be required in both selfprivacy-rest-api and selfprivacy-nixos-config repositories simultaneously. So, a new feature branch might be temporarily used until selfprivacy-nixos-config gets the feature branch merged.

Show current flake inputs (e.g. nixpkgs):

$ nix flake metadata

Show selfprivacy-nixos-config Nix flake inputs (including nixpkgs):

$ nix flake metadata git+https://git.selfprivacy.org/SelfPrivacy/selfprivacy-nixos-config.git?ref=BRANCH

Nix code for NixOS service module for API is located in NixOS configuration repository.

troubleshooting

Sometimes commands inside nix develop refuse to work properly if the calling shell lacks LANG environment variable. Try to set it before entering nix develop.