Test embedding of sites locations information
-----------------------------------

  $ mkdir -p a b c

  $ mkdir -p a

  $ cat >a/dune-project <<EOF
  > (lang dune 3.0)
  > (generate_opam_files true)
  > (using dune_site 0.1)
  > (name a)
  > (version 0.a)
  > (package (name a) (sites (share data)))
  > EOF

  $ for i in b d; do
  > mkdir -p $i
  > cat >$i/dune-project <<EOF
  > (lang dune 3.0)
  > (generate_opam_files true)
  > (using dune_site 0.1)
  > (name $i)
  > (version 0.$i)
  > (package (name $i) (sites (share data)) (depends c))
  > EOF
  > done

  $ for i in c; do
  >   mkdir -p $i
  >   cat >$i/dune-project <<EOF
  > (lang dune 3.0)
  > (generate_opam_files true)
  > (using dune_site 0.1)
  > (name $i)
  > (package (name $i) (sites (share data) (lib plugins)) (depends a))
  > EOF
  > done

  $ cat >a/dune <<EOF
  > (library
  >  (public_name a)
  >  (libraries dune-site))
  > (generate_sites_module (module sites) (sites a))
  > EOF

  $ cat >a/a.ml <<EOF
  > let v = "a"
  > let () = Printf.printf "run a\n%!"
  > let () = List.iter (Printf.printf "a: %s\n%!") Sites.Sites.data
  > EOF

  $ cat >b/dune <<EOF
  > (library
  >  (public_name b.b.b)
  >  (name b)
  >  (libraries c.register dune-site))
  > (generate_sites_module (module sites) (sites b))
  > (plugin (name c-plugins-b) (libraries b.b.b) (site (c plugins)))
  > (install (section (site (b data))) (files info.txt))
  > EOF

  $ cat >b/b.ml <<EOF
  > let v = "b"
  > let () = Printf.printf "run b\n%!"
  > let () = C_register.registered := "b"::!C_register.registered
  > let () = List.iter (Printf.printf "b: %s\n%!") Sites.Sites.data
  > let () =
  >     let test d = Sys.file_exists (Filename.concat d "info.txt") in
  >     let found = List.exists test Sites.Sites.data in
  >     Printf.printf "info.txt is found: %b\n%!" found
  > EOF

  $ cat >b/info.txt <<EOF
  > Lorem
  > EOF

  $ cat >d/dune <<EOF
  > (library
  >  (public_name d)
  >  (libraries c.register dune-site non-existent-library)
  >  (optional))
  > (generate_sites_module (module sites) (sites d))
  > (plugin (name c-plugins-d) (libraries d) (site (c plugins)) (optional))
  > (install (section (site (d data))) (files info.txt))
  > EOF

  $ cat >d/d.ml <<EOF
  > let v = "d"
  > let () = Printf.printf "run d\n%!"
  > let () = C_register.registered := "d"::!C_register.registered
  > let () = List.iter (Printf.printf "d: %s\n%!") Sites.Sites.data
  > let () =
  >     let test d = Sys.file_exists (Filename.concat d "info.txt") in
  >     let found = List.exists test Sites.Sites.data in
  >     Printf.printf "info.txt is found: %d\n%!" found
  > EOF

  $ cat >d/info.txt <<EOF
  > Lorem
  > EOF


  $ cat >c/dune <<EOF
  > (executable
  >  (public_name c)
  >  (promote (until-clean))
  >  (modules c sites)
  >  (libraries a c.register dune-site dune-site.plugins))
  > (library
  >  (public_name c.register)
  >  (name c_register)
  >  (modules c_register))
  > (generate_sites_module (module sites) (sourceroot) (plugins (c plugins)))
  > (rule
  >  (targets out.log)
  >  (deps (package c))
  >  (action (with-stdout-to out.log (run %{bin:c}))))
  > EOF

  $ cat >c/c_register.ml <<EOF
  > let registered : string list ref = ref []
  > EOF

  $ cat >c/c.ml <<EOF
  > let () = Printf.printf "run c: %s linked registered:%s.\n%!"
  >   A.v (String.concat "," !C_register.registered)
  > let () = match Sites.sourceroot with
  >       | Some d -> Printf.printf "sourceroot is %S\n%!" d
  >       | None -> Printf.printf "no sourceroot\n%!"
  > let () = List.iter (Printf.printf "c: %s\n%!") Sites.Sites.data
  > let () = Printf.printf "b is available: %b\n%!" (Dune_site_plugins.V1.available "b")
  > let () = Sites.Plugins.Plugins.load_all ()
  > let () = Printf.printf "run c: registered:%s.\n%!" (String.concat "," !C_register.registered)
  > EOF

  $ cat > dune-project << EOF
  > (lang dune 2.2)
  > EOF


Test with an opam like installation
--------------------------------

  $ dune build a/a.opam

#We print the generated file in order to update the following tests
  $ cat a/a.opam
  # This file is generated by dune, edit dune-project instead
  opam-version: "2.0"
  version: "0.a"
  depends: [
    "dune" {>= "3.0"}
    "odoc" {with-doc}
  ]
  build: [
    ["dune" "subst"] {dev}
    [
      "dune"
      "build"
      "-p"
      name
      "-j"
      jobs
      "--promote-install-files=false"
      "@install"
      "@runtest" {with-test}
      "@doc" {with-doc}
    ]
    ["dune" "install" "-p" name "--create-install-files" name]
  ]

  $ dune build -p a --promote-install-files=false @install

  $ test -e a/a.install
  [1]

  $ dune install -p a --create-install-files a --prefix "_destdir"

  $ cat a/a.install
  lib: [
    "_destdir/_destdir/lib/a/META"
    "_destdir/_destdir/lib/a/Sites.ml"
    "_destdir/_destdir/lib/a/a.a"
    "_destdir/_destdir/lib/a/a.cma"
    "_build/install/default/lib/a/a.cmi"
    "_build/install/default/lib/a/a.cmt"
    "_build/install/default/lib/a/a.cmx"
    "_build/install/default/lib/a/a.cmxa"
    "_build/install/default/lib/a/a.ml"
    "_build/install/default/lib/a/a__.cmi"
    "_build/install/default/lib/a/a__.cmt"
    "_build/install/default/lib/a/a__.cmx"
    "_build/install/default/lib/a/a__.ml"
    "_build/install/default/lib/a/a__Sites.cmi"
    "_build/install/default/lib/a/a__Sites.cmt"
    "_build/install/default/lib/a/a__Sites.cmx"
    "_destdir/_destdir/lib/a/dune-package"
    "_build/install/default/lib/a/opam"
  ]
  libexec: [
    "_destdir/_destdir/lib/a/a.cmxs"
  ]

Build everything
----------------

  $ dune build

Test with a normal installation
--------------------------------

  $ dune install --prefix _install

Once installed, we have the sites information:

  $ grep share/a _install/lib/a/dune-package
    $TESTCASE_ROOT/_install/share/a))

  $ OCAMLPATH=_install/lib:$OCAMLPATH _install/bin/c
  run a
  a: $TESTCASE_ROOT/_install/share/a/data
  run c: a linked registered:.
  no sourceroot
  c: $TESTCASE_ROOT/_install/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_install/share/b/data
  info.txt is found: true
  run c: registered:b.

Test with a relocatable installation
--------------------------------

  $ dune install --prefix _install_relocatable --relocatable

Once installed, we have the sites information:

  $ _install_relocatable/bin/c
  run a
  a: $TESTCASE_ROOT/_install_relocatable/share/a/data
  run c: a linked registered:.
  no sourceroot
  c: $TESTCASE_ROOT/_install_relocatable/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_install_relocatable/share/b/data
  info.txt is found: true
  run c: registered:b.

Test after moving a relocatable installation
--------------------------------

  $ mv _install_relocatable  _install_relocatable2

Once installed, we have the sites information:

  $ _install_relocatable2/bin/c
  run a
  a: $TESTCASE_ROOT/_install_relocatable2/share/a/data
  run c: a linked registered:.
  no sourceroot
  c: $TESTCASE_ROOT/_install_relocatable2/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_install_relocatable2/share/b/data
  info.txt is found: true
  run c: registered:b.

Test substitution when promoting
--------------------------------

It is wrong that info.txt is not found, but to make it work it is an important
development because b is not promoted

  $ c/c.exe
  run a
  a: $TESTCASE_ROOT/_build/install/default/share/a/data
  run c: a linked registered:.
  sourceroot is "$TESTCASE_ROOT"
  c: $TESTCASE_ROOT/_build/install/default/share/c/data
  b is available: true
  run b
  info.txt is found: false
  run c: registered:b.

Test within dune rules
--------------------------------
  $ dune build c/out.log

  $ cat _build/default/c/out.log
  run a
  a: $TESTCASE_ROOT/_build/install/default/share/a/data
  run c: a linked registered:.
  sourceroot is "$TESTCASE_ROOT"
  c: $TESTCASE_ROOT/_build/install/default/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_build/install/default/share/b/data
  info.txt is found: true
  run c: registered:b.


Test with dune exec
--------------------------------
  $ dune exec -- c/c.exe
  run a
  a: $TESTCASE_ROOT/_build/install/default/share/a/data
  run c: a linked registered:.
  sourceroot is "$TESTCASE_ROOT"
  c: $TESTCASE_ROOT/_build/install/default/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_build/install/default/share/b/data
  info.txt is found: true
  run c: registered:b.


Test compiling an external plugin
---------------------------------
  $ mkdir e
  $ cat >e/dune-project <<EOF
  > (lang dune 2.8)
  > (using dune_site 0.1)
  > (name e)
  > (package (name e) (sites (share data)))
  > EOF

  $ cat >e/dune <<EOF
  > (library
  >  (public_name e)
  >  (libraries c.register dune-site))
  > (generate_sites_module (module sites) (sites e))
  > (plugin (name c-plugins-e) (libraries e) (site (c plugins)))
  > (install (section (site (e data))) (files info.txt))
  > (rule (alias runtest) (deps (package a) (package b) (package c) (package d) (package e))
  >   (action (run %{bin:c})))
  > EOF

  $ cat >e/e.ml <<EOF
  > let v = "e"
  > let () = Printf.printf "run e\n%!"
  > let () = C_register.registered := "e"::!C_register.registered
  > let () = List.iter (Printf.printf "e: %s\n%!") Sites.Sites.data
  > let () =
  >     let test d = Sys.file_exists (Filename.concat d "info.txt") in
  >     let found = List.exists test Sites.Sites.data in
  >     Printf.printf "info.txt is found: %b\n%!" found
  > EOF

  $ cat >e/info.txt <<EOF
  > Lorem
  > EOF

  $ OCAMLPATH=$(pwd)/_install/lib:$OCAMLPATH dune build --root=e
  Entering directory 'e'
  Leaving directory 'e'

  $ OCAMLPATH=$(pwd)/_install/lib:$OCAMLPATH PATH=$(pwd)/_install/bin:$PATH dune exec  --root=e -- c
  Entering directory 'e'
  Leaving directory 'e'
  run a
  a: $TESTCASE_ROOT/_install/share/a/data
  run c: a linked registered:.
  no sourceroot
  c: $TESTCASE_ROOT/_install/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_install/share/b/data
  info.txt is found: true
  run e
  e: $TESTCASE_ROOT/e/_build/install/default/share/e/data
  info.txt is found: true
  run c: registered:e,b.

  $ OCAMLPATH=$(pwd)/_install/lib:$OCAMLPATH dune install --root=e --prefix $(pwd)/_install

  $ OCAMLPATH=_install/lib:$OCAMLPATH _install/bin/c
  run a
  a: $TESTCASE_ROOT/_install/share/a/data
  run c: a linked registered:.
  no sourceroot
  c: $TESTCASE_ROOT/_install/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_install/share/b/data
  info.txt is found: true
  run e
  e: $TESTCASE_ROOT/_install/share/e/data
  info.txt is found: true
  run c: registered:e,b.

  $ OCAMLPATH=_install/lib:$OCAMLPATH dune build @runtest
  run a
  a: $TESTCASE_ROOT/_build/install/default/share/a/data
  run c: a linked registered:.
  sourceroot is "$TESTCASE_ROOT"
  c: $TESTCASE_ROOT/_build/install/default/share/c/data
  b is available: true
  run b
  b: $TESTCASE_ROOT/_build/install/default/share/b/data
  info.txt is found: true
  run e
  e: $TESTCASE_ROOT/_build/install/default/share/e/data
  info.txt is found: true
  run c: registered:e,b.

Test %{version:installed-pkg}
-----------------------------

  $ for i in f; do
  >   mkdir -p $i
  >   cat >$i/dune-project <<EOF
  > (lang dune 3.0)
  > (using dune_site 0.1)
  > (name $i)
  > (version 0.$i)
  > (package (name $i) (sites (share data) (lib plugins)) (allow_empty))
  > EOF
  > done

  $ cat >f/dune <<EOF
  > (rule
  >  (target test.target)
  >  (action
  >   (with-stdout-to %{target}
  >    (progn
  >     (echo "a = %{version:a}\n")
  >     (echo "e = %{version:e}\n")))))
  > EOF

  $ OCAMLPATH=_install/lib:$OCAMLPATH dune build --root=f
  Entering directory 'f'
  Leaving directory 'f'
  $ cat $(pwd)/f/_build/default/test.target
  a = 0.a
  e = 

  $ cat f/dune | sed 's/version:a/version:a.test/' > f/dune.tmp && mv f/dune.tmp f/dune
  $ OCAMLPATH=_install/lib:$OCAMLPATH dune build --root=f
  Entering directory 'f'
  File "dune", line 6, characters 15-32:
  6 |     (echo "a = %{version:a.test}\n")
                     ^^^^^^^^^^^^^^^^^
  Error: Library names are not allowed in this position. Only package names are
  allowed
  Leaving directory 'f'
  [1]

  $ rm f/dune

Test error location
---------------------------------

  $ cat >>a/dune <<EOF
  > (install
  >  (section (site (non-existent foo)))
  >  (files a.ml)
  > )
  > EOF

  $ dune build @install
  File "a/dune", line 6, characters 16-34:
  6 |  (section (site (non-existent foo)))
                      ^^^^^^^^^^^^^^^^^^
  Error: The package non-existent is not found
  [1]

  $ cat >a/dune <<EOF
  > (library
  >  (public_name a)
  >  (libraries dune-site))
  > (generate_sites_module (module sites) (sites non-existent))
  > EOF

  $ dune build
  File "a/dune", line 4, characters 45-57:
  4 | (generate_sites_module (module sites) (sites non-existent))
                                                   ^^^^^^^^^^^^
  Error: Unknown package
  [1]