Merge pull request #289 from MelbourneHighSchoolRobotics/nix

Nix builds for Linux

Author: angustrau

.github/workflows/nix_lint.yml

@@ -0,0 +1,20 @@
+name: Nix linting
+
+on:
+  push:
+    branches-ignore: gh-pages
+
+jobs:
+  check-nix-lint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - uses: cachix/install-nix-action@v13
+      with:
+        nix_path: nixpkgs=channel:nixos-21.05
+
+    - run: ./nix/lint.sh
+    - run: ./nix/format.sh --check

.github/workflows/windows_package_create.yml

@@ -1,33 +1,33 @@
 name: Windows Executable Creation
 
-# Disabled as is broken
-on: []
+on:
+  push:
+    branches-ignore: gh-pages
 
 jobs:
   create-exe:
 
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v1
-    # Standard drop-in approach that should work for most people.
 
-    - name: Set up Python
-      uses: actions/setup-python@v2
+    - uses: cachix/install-nix-action@v13
       with:
-        python-version: 3.9
+        install_url: https://nixos-nix-install-tests.cachix.org/serve/i6laym9jw3wg9mw6ncyrk6gjx4l34vvx/install
+        install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+        extra_nix_config: |
+          experimental-features = nix-command flakes
+          access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}
+    - uses: cachix/cachix-action@v10
+      with:
+        name: melbournehighschoolrobotics
+        authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}'
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r requirements-dev.txt
+    - run: nix build --print-build-logs ".#windows"
+    - run: nix flake check
 
-    - name: Build with pyinstaller
-      run: |
-        python -m build_exe
-    # Create an artifact of the html output.
     - uses: actions/upload-artifact@v1
       with:
         name: windows_package
-        path: dist/ev3sim
+        path: result/

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+result
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

build_exe.py

@@ -20,7 +20,7 @@
 if os.path.exists("dist/ev3sim/user_config.yaml"):
     os.remove("dist/ev3sim/user_config.yaml")
 
-process = Popen("makensis config.nsi")
+process = Popen(["makensis", "config.nsi"])
 process.wait()
 shutil.move("installer.exe", "installer-32bit.exe")
 
@@ -35,6 +35,6 @@
 if os.path.exists("dist/ev3sim/user_config.yaml"):
     os.remove("dist/ev3sim/user_config.yaml")
 
-process = Popen("makensis config.nsi")
+process = Popen(["makensis", "config.nsi"])
 process.wait()
 shutil.move("installer.exe", "installer-64bit.exe")

config.nsi

@@ -83,8 +83,7 @@ File /nonfatal /a /r "dist\"
 WriteRegStr HKCU "Software\EV3Sim" "" $InstDir
 
 ;Run pip install process. pythonw seems to not finish correctly, and so ev3sim doesn't get installed.
-;To use test.pypi: '"$InstDir\python_embed\python.exe" -m pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple ev3sim==2.1.8.post1'
-ExecDos::exec '"$InstDir\python_embed\python.exe" -m pip install --trusted-host pypi.org --trusted-host files.pythonhosted.org ev3sim' "" "$InstDir\pip.log"
+ExecDos::exec '"$InstDir\python_embed\python.exe" -m pip install -f "$InstDir\python_embed\wheels" --no-index ev3sim' "" "$InstDir\pip.log"
 Pop $0
 StrCmp "0" $0 fine
 

docs/contributing.rst

@@ -31,3 +31,44 @@ Pull requests are linted with `black`_. To run black locally to fix any formatti
     black --config pyproject.toml .
 
 .. _black: https://github.com/psf/black
+
+Building with Nix
+-----------------
+
+The `Nix <https://nixos.org/>`_ package manager can be used to create reproducible builds on Linux and Mac.
+
+Setup
+^^^^^
+
+First `install Nix <https://nixos.org/download.html>`_ with experimental `Flakes <https://nixos.wiki/wiki/Flakes#Non-NixOS>`_ support.
+
+.. code-block:: bash
+
+    curl -L https://nixos.org/nix/install | sh
+    . /home/$USER/.nix-profile/etc/profile.d/nix.sh
+
+    nix-env -iA nixpkgs.nixUnstable
+    mkdir -p ~/.config/nix
+    echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
+
+Then set up the binary cache for faster builds.
+
+.. code-block:: bash
+
+    nix-env -iA cachix -f https://cachix.org/api/v1/install
+    cachix use melbournehighschoolrobotics
+
+Release
+^^^^^^^
+
+To build installers for Windows:
+
+.. code-block:: bash
+
+    nix build ".#windows"
+
+To build for Linux:
+
+.. code-block:: bash
+
+    nix build ".#linux"

ev3sim/search_locations.py

@@ -1,10 +1,25 @@
 preset_locations = lambda: ["workspace/presets/", "workspace", "package/presets/"]
-config_locations = lambda: ["workspace", "package"]
 device_locations = lambda: ["workspace/devices/", "package/devices/"]
 theme_locations = lambda: ["workspace/assets/", "workspace", "package/assets"]
 asset_locations = lambda: ["workspace/assets/", "workspace", "package/assets/"]
 
 
+def config_locations():
+    import os
+    import platform
+    from pathlib import Path
+
+    if platform.system() == "Linux":
+        home_dir = os.path.expanduser("~")
+        xdg_config_dir = os.environ.get("XDG_CONFIG_HOME") or os.path.join(home_dir, ".config")
+        config_dir = os.path.join(xdg_config_dir, "ev3sim")
+        # Ensure config dir exists
+        Path(config_dir).mkdir(parents=True, exist_ok=True)
+        return ["workspace", "local|" + config_dir]
+
+    return ["workspace", "package"]
+
+
 def code_locations(bot_path):
     from ev3sim.file_helper import find_abs_directory
 

flake.lock

@@ -0,0 +1,28 @@
+{
+  description = "A simulator for soccer robots programmed with ev3dev.";
+
+  inputs.nixpkgs.url = "github:nixos/nixpkgs/21.05";
+  # On unstable to use some new python packages. Eventually will be merged into Nix 21.11
+  inputs.unstable.url = "github:nixos/nixpkgs/nixpkgs-unstable";
+  inputs.flake-utils.url = "github:numtide/flake-utils";
+  inputs.mindpile.url = "github:MelbourneHighSchoolRobotics/mindpile";
+  inputs.mindpile.inputs.nixpkgs.follows = "nixpkgs";
+  inputs.mindpile.inputs.flake-utils.follows = "flake-utils";
+
+  outputs = { nixpkgs, unstable, flake-utils, mindpile, ... }:
+    flake-utils.lib.eachSystem [ "x86_64-linux" ] (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+        unstablePkgs = unstable.legacyPackages.${system};
+      in rec {
+        packages = {
+          linux = pkgs.callPackage ./nix/linux.nix {
+            inherit (unstablePkgs.python39Packages) ev3dev2 opensimplex pymunk pygame pygame-gui;
+            mindpile = mindpile.legacyPackages.${system}.mindpile;
+          };
+
+          windows = pkgs.callPackage ./nix/windows-installer.nix { };
+        };
+        defaultPackage = packages.linux;
+      });
+}

flake.nix

@@ -0,0 +1,13 @@
+# HACK! Build an ev3dev2 wheel natively as it doesn't build under Wine for some reason, and isn't on PyPi
+{ pkgs, fetchurl, ... }:
+let
+  ev3dev2 = fetchurl {
+    url =
+      "https://files.pythonhosted.org/packages/8a/8c/2ddffc70572989acb5d2f60e5e1d7e93f6daf9b05200ac0e80d030e98950/python-ev3dev2-2.1.0.post1.tar.gz";
+    sha256 = "0j89fgcmr8vx9maifr2jrihxjci0c3mgmmq0yg42mbmnx2q6kz8c";
+  };
+  python = pkgs.python39.withPackages (p: with p; [ pip setuptools wheel ]);
+in pkgs.runCommandNoCC "ev3dev2-wheel" { } ''
+  mkdir $out
+  ${python}/bin/python -m pip wheel -w $out --no-deps --no-index ${ev3dev2}
+''