Merge pull request #550 from n8henrie/issue_549

Add support for submodules in flakes

.github/workflows/test.yml

@@ -64,3 +64,53 @@ jobs:
     - run: |
         . /etc/static/bashrc
         darwin-rebuild build --flake ./modules/examples#simple --override-input darwin .
+    - name: Test git submodules
+      run: |
+        . /etc/static/bashrc
+
+        mkdir -p /tmp/{test-nix-darwin-submodules,example-submodule}
+
+        pushd /tmp/example-submodule
+          echo '"hello"' > hello.nix
+          git init
+          git add .
+          git commit -m "add a submodule we will import"
+        popd
+
+        cp -a ./modules/examples/. /tmp/test-nix-darwin-submodules
+
+        pushd /tmp/test-nix-darwin-submodules
+          /usr/bin/sed -i.bak \
+            '\#modules = \[#s#darwin.darwinModules.simple#./simple.nix#' \
+            ./flake.nix
+          /usr/bin/sed -i.bak \
+            's#pkgs.vim#pkgs."${import ./submodule-test/hello.nix}"#' \
+            ./simple.nix
+          git init
+          git add flake.nix simple.nix
+          git \
+            -c protocol.file.allow=always \
+            submodule add /tmp/example-submodule submodule-test
+        popd
+
+        # Should fail
+        darwin-rebuild build \
+          --flake /tmp/test-nix-darwin-submodules#simple \
+          --override-input darwin . \
+          && {
+            printf 'succeeded while expecting failure due to submodule\n' >/dev/stderr
+            exit 1
+          }
+        # Should also fail
+        darwin-rebuild build \
+          --flake /tmp/test-nix-darwin-submodules?submodules=0#simple \
+          --override-input darwin . \
+          && {
+            printf 'succeeded while expecting failure due to submodule\n' >/dev/stderr
+            exit 1
+          }
+
+        # Should succeed
+        darwin-rebuild build \
+          --flake /tmp/test-nix-darwin-submodules?submodules=1#simple \
+          --override-input darwin .

pkgs/nix-tools/darwin-rebuild.sh

@@ -121,9 +121,16 @@ if [ -z "$action" ]; then showSyntax; fi
 flakeFlags=(--extra-experimental-features 'nix-command flakes')
 
 if [ -n "$flake" ]; then
-    if [[ $flake =~ ^(.*)\#([^\#\"]*)$ ]]; then
-       flake="${BASH_REMATCH[1]}"
-       flakeAttr="${BASH_REMATCH[2]}"
+    # Offical regex from https://www.rfc-editor.org/rfc/rfc3986#appendix-B
+    if [[ "${flake}" =~ ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))? ]]; then
+       scheme=${BASH_REMATCH[2]}
+       authority=${BASH_REMATCH[4]}
+       path=${BASH_REMATCH[5]}
+       queryWithQuestion=${BASH_REMATCH[6]}
+       fragment=${BASH_REMATCH[9]}
+
+       flake=${scheme}${authority}${path}${queryWithQuestion}
+       flakeAttr=${fragment}
     fi
     if [ -z "$flakeAttr" ]; then
       flakeAttr=$(hostname -s)
@@ -138,7 +145,16 @@ if [ -n "$flake" ]; then
         cmd=info
     fi
 
-    flake=$(nix "${flakeFlags[@]}" flake "$cmd" --json "${extraMetadataFlags[@]}" "${extraLockFlags[@]}" -- "$flake" | jq -r .url)
+    metadata=$(nix "${flakeFlags[@]}" flake "$cmd" --json "${extraMetadataFlags[@]}" "${extraLockFlags[@]}" -- "$flake")
+    flake=$(jq -r .url <<<"${metadata}")
+
+    if [ "$(jq -r .resolved.submodules <<<"${metadata}")" = "true" ]; then
+      if [[ "$flake" == *'?'* ]]; then
+        flake="${flake}&submodules=1"
+      else
+        flake="${flake}?submodules=1"
+      fi
+    fi
 fi
 
 if [ "$action" != build ]; then