reftest: add a test for git packages with submodules

Author: kit-ty-kate

master_changes.md

@@ -157,6 +157,7 @@ users)
   * Add a test showing the behaviour of `opam list --latests-only` [#5375 @kit-ty-kate]
   * Add a test filtering mechanism [#6105 @Keryan-dev]
   * Add a package fetching test [#6146 @rjbou]
+  * Add a test for git packages with submodules [#6132 @kit-ty-kate]
 
 ### Engine
   * Add a test filtering mechanism [#6105 @Keryan-dev]

tests/reftests/dune.inc

@@ -818,6 +818,24 @@
    %{targets}
    (run ./run.exe %{exe:../../src/client/opamMain.exe.exe} %{dep:filter-operators.test} %{read-lines:testing-env}))))
 
+(rule
+ (alias reftest-git)
+ (action
+  (diff git.test git.out)))
+
+(alias
+ (name reftest)
+ (deps (alias reftest-git)))
+
+(rule
+ (targets git.out)
+ (deps root-N0REP0)
+ (package opam)
+ (action
+  (with-stdout-to
+   %{targets}
+   (run ./run.exe %{exe:../../src/client/opamMain.exe.exe} %{dep:git.test} %{read-lines:testing-env}))))
+
 (rule
  (alias reftest-init-ocaml-eval-variables.unix)
  (enabled_if (and (= %{os_type} "Unix") (or (<> %{env:TESTALL=1} 0) (= %{env:TESTN0REP0=0} 1))))

tests/reftests/git.test

@@ -0,0 +1,80 @@
+N0REP0
+### : Check the bevahiour when presented with a broken submodule
+### mkdir submodule
+### git -C ./submodule init -q
+### git -C ./submodule config core.autocrlf false
+### touch ./submodule/some-file
+### git -C ./submodule add ./some-file
+### git -C ./submodule commit -qm "first commit"
+### mkdir use-submodule
+### git -C ./use-submodule init -q
+### git -C ./use-submodule config core.autocrlf false
+### git -C ./use-submodule submodule add ../submodule ./vendor
+Cloning into '${BASEDIR}/use-submodule/vendor'...
+done.
+### git -C ./use-submodule commit -qm "first commit"
+### <create-submodule-pkg.sh>
+mkdir -p REPO/packages/submodule/submodule.1
+cat > REPO/packages/submodule/submodule.1/opam << EOF
+opam-version: "2.0"
+build: ["ls" "vendor/some-file"]
+url {
+  src: "git+file://${BASEDIR}/use-submodule"
+}
+EOF
+### sh ./create-submodule-pkg.sh
+### opam update
+
+<><> Updating package repositories ><><><><><><><><><><><><><><><><><><><><><><>
+[default] synchronised from file://${BASEDIR}/REPO
+Now run 'opam upgrade' to apply any package updates.
+### opam switch create submodule --empty
+### opam install --verbose submodule
+The following actions will be performed:
+=== install 1 package
+  - install submodule 1
+
+<><> Processing actions <><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+Processing  1/3: [submodule.1: git]
+-> retrieved submodule.1  (git+file://${BASEDIR}/use-submodule)
+Processing  2/3: [submodule: ls]
++ ${BASEDIR}/OPAM/opam-init/hooks/sandbox.sh "build" "ls" "vendor/some-file" (CWD=${BASEDIR}/OPAM/submodule/.opam-switch/build/submodule.1)
+- vendor/some-file
+-> compiled  submodule.1
+-> installed submodule.1
+Done.
+### rm -r ./submodule
+### opam remove submodule
+The following actions will be performed:
+=== remove 1 package
+  - remove submodule 1
+
+<><> Processing actions <><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+-> removed   submodule.1
+Done.
+### opam install --verbose submodule
+The following actions will be performed:
+=== install 1 package
+  - install submodule 1
+
+<><> Processing actions <><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+Processing  1/3: [submodule.1: git]
+[WARNING] Git submodule update failed in ${BASEDIR}/OPAM/submodule/.opam-switch/sources/submodule.1
+-> retrieved submodule.1  (git+file://${BASEDIR}/use-submodule)
+Processing  2/3: [submodule: ls]
++ ${BASEDIR}/OPAM/opam-init/hooks/sandbox.sh "build" "ls" "vendor/some-file" (CWD=${BASEDIR}/OPAM/submodule/.opam-switch/build/submodule.1)
+- ls: cannot access 'vendor/some-file': No such file or directory
+[ERROR] The compilation of submodule.1 failed at "ls vendor/some-file".
+
+##% output ###
+# ls: cannot access 'vendor/some-file': No such file or directory
+
+
+
+<><> Error report <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
++- The following actions failed
+| - build submodule 1
++- 
+- No changes have been performed
+'${OPAM} install --verbose submodule' failed.
+# Return code 31 #