Add Package Builder for dlang projects

.github/workflows/update-dub-db.yml

@@ -0,0 +1,42 @@
+name: "Update Dub Package Database"
+
+on:
+  # Enable option to manually run the action:
+  workflow_dispatch:
+
+  # Run every Sunday at 00:00:
+  schedule:
+    - cron: 0 0 * * 0
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: cachix/install-nix-action@v25
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+          github_access_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Run `dump_dlang_pkgs.d`
+        id: update-lockfile
+        run: COMMIT_MSG=$(./scripts/commit_flake_update.bash | tee /dev/tty))
+
+      - uses: tibdex/[email protected]
+        id: generate-token
+        with:
+          app_id: ${{ secrets.APP_ID }}
+          private_key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ steps.generate-token.outputs.token }}
+          title: 'Update Dub Package Database'
+          commit-message: ${{ env.COMMIT_MSG }}
+          branch: 'create-pull-request/update-dub-package-database'
+          delete-branch: true
+          branch-suffix: timestamp
+          add-paths: flake.lock

.gitignore

@@ -14,3 +14,6 @@ bin/
 
 # Dotenv
 .env
+
+# Misc
+pkgs/build-dub-package/packages.json

README.md

@@ -186,6 +186,22 @@ one of the differences how things are usually done with and without flakes,
 even when it's possible to either pin or to not pin the nixpkgs version
 regardless of flake use.
 
+## buildDubPackage
+
+The buildDubPackage function can be used to build software which uses dub for dependency management.
+
+Flags can be supplied to dub using dubFlags, dubTestFlags and dubBuildFlags. dubFlags are added to both build and test.
+
+Unittests are run by default, but can be disabled by `dontDubTest = true;`.
+
+buildDubPackage resolves dependencies using dub.selections.json. If the package repository doesn't contain a dub.selections.json file, it must be supplied through `dubSelections`.
+
+Specific dub/ldc versions can be supplied by using override.
+
+If any files other then the main executable need to installed, they can be supplied through the array `extraFiles`.
+
+
+
 ## Source and binary variants
 
 DMD and LDC packages come in two variants: `binary` and `source`.

pkgs/build-dub-package/default.nix

@@ -0,0 +1,150 @@
+{
+  lib,
+  stdenv,
+  dub,
+  dmd,
+  makeSetupHook,
+  jq,
+  bash,
+  gnugrep,
+  fetchgit,
+  writeScript,
+}: {
+  name ? "${args.pname}-${args.version}",
+  src ? null,
+  sourceRoot ? null,
+  prePatch ? "",
+  patches ? [],
+  postPatch ? "",
+  nativeBuildInputs ? [],
+  buildInputs ? [],
+  # Flags to pass to all dub commands.
+  dubFlags ? [],
+  # Flags to pass to `dub test`.
+  dubTestFlags ? [],
+  # Flags to pass to `dub build`.
+  dubBuildFlags ? [],
+  # Extra files to copy to $out`.
+  extraFiles ? [],
+  # Dub selection file.
+  dubSelections ? "/notexist/dub.selections.json",
+  ...
+} @ args: let
+  dubConfigHook =
+    makeSetupHook
+    {
+      name = "dub-config-hook";
+      substitutions = {
+        "jq" = "${jq}/bin/jq";
+        "shell" = "${bash}/bin/bash";
+        "dub" = "${dub}/bin/dub";
+      };
+    }
+    (writeScript "dub-config-hook.sh" ''
+      #!@shell@
+      echo "Executing dubConfigHook"
+
+      echo "Configuring dub"
+
+      export HOME="/build"
+      mkdir -p $HOME/.dub
+      if ${gnugrep}/bin/grep "dependenc" ${src}/dub.* &> /dev/null; then
+        if [ -f ${src}/dub.selections.json ]; then
+            echo "dub.selections.json exists"
+        else
+            if [ -f "${dubSelections}" ]; then
+                echo "Using ${dubSelections}"
+            else
+                echo "dub.selections.json does not exist. Please supply it manually"
+                exit 1
+            fi
+        fi
+        ${
+        let
+          selectionsJson =
+            if builtins.pathExists "${src}/dub.selections.json"
+            then "${src}/dub.selections.json"
+            else if dubSelections != "/notexist/dub.selections.json"
+            then dubSelections
+            else null;
+          selections =
+            if selectionsJson != null
+            then (builtins.fromJSON (builtins.readFile selectionsJson)).versions
+            else null;
+          deps =
+            if selections != null
+            then
+              lib.mapAttrsToList (dep: ver: let
+                data = import ../dub/pkgs/${dep}/default.nix;
+                pkg = rec {
+                  name = dep;
+                  version = ver;
+                  path = fetchgit {
+                    url = data.url;
+                    rev = data.versions.${ver}.rev;
+                    sha256 = data.versions.${ver}.sha256;
+                    fetchSubmodules = false;
+                  };
+                };
+              in
+                pkg)
+              selections
+            else null;
+
+          str =
+            if deps != null
+            then
+              (lib.concatMapStringsSep "\n" (dep: ''
+                  dep_path="$HOME/.dub/packages/${dep.name}-${dep.version}"
+                  mkdir -p "$dep_path"
+                  cp -r "${dep.path}"/* "$dep_path"
+                  @dub@ add-local "$dep_path" "${dep.version}"
+                '')
+                deps)
+            else "";
+        in
+          str
+      }
+      fi
+
+      echo "Finished dubConfigHook"
+    '');
+
+  dubBuildHook =
+    makeSetupHook
+    {
+      name = "dub-build-hook";
+      substitutions = {
+        "dub" = "${dub}/bin/dub";
+        "dmd" = "${dmd}/bin/dmd";
+      };
+    }
+    ./dub-build-hook.sh;
+
+  dubTestHook =
+    makeSetupHook
+    {
+      name = "dub-test-hook";
+      substitutions = {
+        "dub" = "${dub}/bin/dub";
+        "dmd" = "${dmd}/bin/dmd";
+      };
+    }
+    ./dub-test-hook.sh;
+
+  dubInstallHook =
+    makeSetupHook
+    {
+      name = "dub-install-hook";
+    }
+    ./dub-install-hook.sh;
+in
+  stdenv.mkDerivation (args
+    // {
+      nativeBuildInputs = nativeBuildInputs ++ [dub dmd dubConfigHook dubBuildHook dubInstallHook dubTestHook];
+      buildInputs = buildInputs ++ [dub dmd];
+
+      strictDeps = true;
+
+      meta = (args.meta or {}) // {platforms = args.meta.platforms or dub.meta.platforms;};
+    })

pkgs/build-dub-package/dub-build-hook.sh

@@ -0,0 +1,26 @@
+# shellcheck shell=bash
+
+dubBuildHook() {
+    echo "Executing dubBuildHook"
+
+    runHook preBuild
+
+    export HOME="/build"
+    chmod -R +rw $HOME
+    chown -R $(whoami) $HOME
+    if ! @dub@ build  $dubBuildFlags "${dubBuildFlagsArray[@]}" $dubFlags "${dubFlagsArray[@]}"; then
+        echo
+        echo 'ERROR: `dub build` failed'
+        echo
+
+        exit 1
+    fi
+
+    runHook postBuild
+
+    echo "Finished dubBuildHook"
+}
+
+if [ -z "${dontdubBuild-}" ] && [ -z "${buildPhase-}" ]; then
+    buildPhase=dubBuildHook
+fi

pkgs/build-dub-package/dub-install-hook.sh

@@ -0,0 +1,51 @@
+# shellcheck shell=bash
+
+dubInstallHook() {
+    echo "Executing dubInstallHook"
+
+    runHook preInstall
+
+    mkdir -p "$out/bin"
+    if [ -e "$pname" ]; then
+        bin=$pname
+    elif [ -e "bin/$pname" ]; then
+        bin="bin/$pname"
+    elif [ -e "$pname/$pname" ]; then
+        bin="$pname/$pname"
+    elif [ -e "bin/$pname/$pname" ]; then
+        bin="bin/$pname/$pname"
+    elif [ -e "$pname/bin/$pname" ]; then
+        bin="$pname/bin/$pname"
+    else
+        if ls *.a *.so *.so.* *.dylib 1>/dev/null 2>&1; then
+            echo "INFO: Could not find the binary to install, but found some libraries"
+        elif [ -z "${extraFiles-}"  ]; then
+            echo "ERROR: Could not find the binary to install, or any libraries, and no additional files were specified"
+            exit 1
+        else
+            echo "WARNING: Could not find the binary to install, but additional files were specified"
+        fi
+    fi
+
+
+    if [ -n "${bin-}" ]; then
+        cp "$bin" "$out/bin"
+    fi
+
+    mkdir -p "$out/lib"
+    cp -r *.a *.so *.so.* *.dylib "$out/lib" 2>/dev/null || true
+
+    for f in $extraFiles; do
+        fDir=$(dirname "$f")
+        mkdir -p "$out/$fDir"
+        cp "$f" "$fDir/$f"
+    done
+
+    runHook postInstall
+
+    echo "Finished dubInstallHook"
+}
+
+if [ -z "${dontdubInstall-}" ] && [ -z "${installPhase-}" ]; then
+    installPhase=dubInstallHook
+fi

pkgs/build-dub-package/dub-test-hook.sh

@@ -0,0 +1,27 @@
+# shellcheck shell=bash
+
+dubTestHook() {
+    echo "Executing dubTestHook"
+
+    runHook preTest
+
+    export HOME="/build"
+    chmod -R +rw $HOME
+    chown -R $(whoami) $HOME
+    if ! @dub@ test  $dubTestFlags "${dubTestFlagsArray[@]}" $dubFlags "${dubFlagsArray[@]}"; then
+        echo
+        echo 'ERROR: `dub test` failed'
+        echo
+
+        exit 1
+    fi
+
+    runHook postTest
+
+    echo "Finished dubTestHook"
+}
+
+if [ -z "${dontDubTest-}" ] && [ -z "${checkPhase-}" ]; then
+    checkPhase=dubTestHook
+    doCheck=true
+fi