🦭

Nix で Bats の拡張ライブラリを使う方法と内部挙動の理解 (symlinkJoin / withLibraries / 無名関数)

に公開

はじめに

Nix を利用していると往々にして「公式ドキュメントには載っていないけど、便利な機能が用意されていた」といった体験をします。

ソースコードを読むとよい事があるという一例として、Bash シェルスクリプトのテストツールである Bats を Nix で利用した際の体験を紹介します。

具体的には、検索に出てこない拡張ライブラリ(bats-assert)を利用するために nixpkgs のソースコードから withLibraries という関数を発見した経緯と使い方を紹介します。

また、後半では「なぜその関数で動くのか?」という内部挙動(symlinkJoin や wrapProgram の仕組み)について深掘りしていきます。

直面した課題

NixOS Search - Packages で Bats を検索したところ、Bats 本体はありましたが、ヘルパーライブラリである bats-assert はヒットしませんでした。

検索結果

https://github.com/bats-core/bats-core

https://github.com/bats-core/bats-assert

試した事 - nix pkgs における bats のソースコードを確認

bats-assert を使いたかったので、bats-assert をビルドする式を書く参考とするためにソースコードを確認しました。

ソースの場所

https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ba/bats/package.nix#1

すると、passthru.tests にて bats-assert という文字列が見つかりました。

package.nix
  passthru.tests = {
    # 中略
        ''
          ${
            bats.withLibraries (p: [
              p.bats-support
              p.bats-assert
              p.bats-file
              p.bats-detik
            ])
          }/bin/bats "$testScriptPath"
          touch "$out"
        '';

これを参考に flake.nix を作ってみます。

bats.withLibraries を利用

bats.withLibraries を使った結果、assert が使えるようになりました。

flake.nix
{
  description = "Bats environment";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixpkgs-unstable";
    flake-utils.url = "github:numtide/flake-utils";
  };

  outputs =
    { nixpkgs, flake-utils, ... }:
    let
      supportSystems = with flake-utils.lib.system; [
        x86_64-linux
      ];
    in
    flake-utils.lib.eachSystem supportSystems (
      system:
      let
        pkgs = nixpkgs.legacyPackages.${system};
      in
      {
        devShells.default = pkgs.mkShell {
            packages = with pkgs; [
                (bats.withLibraries (p: [
                    p.bats-assert
                    p.bats-support
                ]))
            ];
        };
      }
    );
}
test.bats
#!/usr/bin/env bats

setup() {
    bats_load_library 'bats-assert'
    bats_load_library 'bats-support'
}

@test "hoge" {
    run true
    assert_success
}
Bash
$ bats test.bats
test.bats
 ✓ hoge

1 test, 0 failures

bats.withLibraries とは何だったのか?

1. passthru による関数の定義

https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ba/bats/package.nix#1

ソースコードである package.nix から withLibraries を探すと、以下の記述が見つかりました。

package.nix
  passthru.withLibraries =
    selector:
    symlinkJoin {
      name = "bats-with-libraries-${bats.version}";

      paths = [
        bats
      ]
      ++ selector bats.libraries;

      nativeBuildInputs = [
        makeWrapper
      ];

      postBuild = ''
        wrapProgram "$out/bin/bats" \
          --suffix BATS_LIB_PATH : "$out/share/bats"
      '';
    };

passthru とは何でしょう?
リファレンスを見ると、便利な関数を追加する機能と解説されています。

Many passthru attributes are situational, so this section only lists recurring patterns. They fall in one of these categories:
Global conventions, which are applied almost universally in Nixpkgs.
Conventions for adding extra functionality to a derivation.

また、テストの記述にも利用されるようです。

passthru.tests
An attribute set with tests as values. A test is a derivation that builds when the test passes and fails to build otherwise.
Run these tests with:
cd path/to/nixpkgs
nix-build -A your-package.tests

https://nixos.org/manual/nixpkgs/stable/#chap-passthru

今回だと、pkgs.bats.withLibraries として呼び出せる関数を passthru.withLibraries で定義していると解釈すればよさそうです。

2. 関数 withLibraries

Nix における関数は <引数>: <式> と記述します。

package.nix
passthru.withLibraries =
    selector:
    symlinkJoin {
        # ...

selector が引数で、symlinkJoin 以下が式となります。

https://zenn.dev/asa1984/books/nix-hands-on/viewer/ch01-01-nix-lang-basics#関数

式を見ていくと、引数である selector は bats.libraries を引数として受け取っています。

package.nix
symlinkJoin {
    name = "bats-with-libraries-${bats.version}";

    paths = [
        bats
    ]
    ++ selector bats.libraries;

    nativeBuildInputs = [
        makeWrapper
    ];

    postBuild = ''
        wrapProgram "$out/bin/bats" \
            --suffix BATS_LIB_PATH : "$out/share/bats"
    '';

引数を取るので、selector は関数として扱われているようです。

では、selector という関数は何者でしょうか?

3. 関数 selector

selector が利用されている箇所を抜き出します。

package.nix
paths = [
    bats
]
++ selector bats.libraries;

引数と返り値をそれぞれ見てみましょう。

3.1 関数 selector の引数

引数として渡されている bats.libraries は何者でしょうか?

ソースコードを探すと、以下の様に定義されていました。

package.nix
passthru.libraries = callPackages ./libraries.nix { };

callPackages されている bats/libraries.nix を確認してみます。

https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/by-name/ba/bats/libraries.nix#1

libraries.nix
{
  lib,
  stdenv,
  fetchFromGitHub,
}:
{
  bats-assert = stdenv.mkDerivation (finalAttrs: {
    pname = "bats-assert";
    version = "2.1.0";
    src = fetchFromGitHub {
      owner = "bats-core";
      repo = "bats-assert";
      rev = "v${finalAttrs.version}";
      hash = "sha256-opgyrkqTwtnn/lUjMebbLfS/3sbI2axSusWd5i/5wm4=";
    };
    dontBuild = true;
    installPhase = ''
      runHook preInstall
      mkdir -p "$out/share/bats/bats-assert"
      cp load.bash "$out/share/bats/bats-assert"
      cp -r src "$out/share/bats/bats-assert"
      runHook postInstall
    '';
    meta = {
      description = "Common assertions for Bats";
      platforms = lib.platforms.all;
      homepage = "https://github.com/bats-core/bats-assert";
      license = lib.licenses.cc0;
      maintainers = with lib.maintainers; [ brokenpip3 ];
    };
  });

  bats-support = stdenv.mkDerivation (finalAttrs: {
  # 略...

bats-assert 等のビルドレシピが書かれています。

関数として解釈するなら、以下が引数となります。

{
  lib,
  stdenv,
  fetchFromGitHub,
}:

そして、以下が返り値です。

{
  bats-assert = stdenv.mkDerivation (finalAttrs: {
    pname = "bats-assert";
    version = "2.1.0";
    src = fetchFromGitHub {
      owner = "bats-core";
      repo = "bats-assert";
      # ...

  bats-support = stdenv.mkDerivation (finalAttrs: {
    pname = "bats-support";
    version = "0.3.0";
    src = fetchFromGitHub {
      owner = "bats-core";
      # ...

つまり、selector はツールのビルドレシピの集合体(bats-assert、bats-support、...)を引数として受け取っていると解釈できそうです。

3.2 関数 selector の返り値

selector が利用されている箇所を再掲します。

package.nix
paths = [
    bats
]
++ selector bats.libraries;

[] ++ [] はリストの連結です。

https://zenn.dev/asa1984/books/nix-hands-on/viewer/ch01-01-nix-lang-basics#list

つまり、selector の返り値は paths に代入されるリストです。

後述しますが、paths は「ツールのビルドレシピ」のリストを必要とします。
(symlinkJoin の定義より)

ややこしい言い方になりましたが、概念的には devShells package = [pkgs.vim] と使う時のリストと同じだと思います。

3.3 関数 selector の処理内容

以上を整理すると、selector は「ツールのビルドレシピの集合体」を引数とし、「ツールのビルドレシピのリスト」を返り値とします。

引数の「ツールのビルドレシピの集合体」とは bats.libraries であり、bats.libraries.bats-assert の様な形で単独のビルドレシピを取り出せます。

取り出したビルドレシピをリストにすれば、selector に期待されている返り値になりそうです。

4. 関数 withLibraries の呼び出し方

以上より、関数 selector の引数と返り値が明確になりました。

次は、selector を引数とする withLibraries を flake.nix でどのように呼び出すかを考えます。

pkgs.bats.withLibraries で withLibraries にアクセスできます。
関数を引数として渡す必要があります。

ここで、無名関数を利用します。

4.1 無名関数

# 無名関数
nix-repl> (a: a + 1) 1
2

これは、引数 a を受け取り、a + 1 の結果を返す関数を定義し、引数として 1 を渡しています。

https://zenn.dev/asa1984/books/nix-hands-on/viewer/ch01-01-nix-lang-basics#関数

引数 a を受け取り、a + 1 の結果を返す関数を考えると、以下の通りです。

(a: a + 1)

4.2 selector 相当の無名関数

selector は bats.libraries を引数とします。
bats.libraries.bats-assert で bats-assert のビルドレシピを取り出せます。

「ビルドレシピのリスト」を返り値にしたいので、[ bats.libraries.bats-assert ] と表現できそうです。

ここでは、引数 bats.libraries を受け取り、[ bats.libraries.bats-assert ] を返す関数を考えてみます。

(bats.libraries: [ bats.libraries.bats-assert ])

それっぽくなりましたが、bats.libraries の様な変数名は . が含まれており、バグりそうです。
p という変数名に置き換えます。

(p: [ p.bats-assert ])

4.3 関数 withLibraries に無名関数を渡す

最後に、作成した無名関数を pkgs.bats.withLibraries に引数として渡します。

pkgs.bats.withLibraries (p: [ p.bats-assert ])

ソースコードの passthru.tests で利用していた形を再現できました。

package.nix
  passthru.tests = {
  # ...
            bats.withLibraries (p: [
              p.bats-support
              p.bats-assert
              p.bats-file
              p.bats-detik
            ])

5. symlinkJoin

関数 withLibraries の引数はこれで解明できました。
最後に、式の方を見てみましょう。

package.nix
  passthru.withLibraries =
    selector:
    symlinkJoin {
      name = "bats-with-libraries-${bats.version}";

      paths = [
        bats
      ]
      ++ selector bats.libraries;

      nativeBuildInputs = [
        makeWrapper
      ];

      postBuild = ''
        wrapProgram "$out/bin/bats" \
          --suffix BATS_LIB_PATH : "$out/share/bats"
      '';
    };

symlinkJoin は何者でしょうか?

リファレンスには、複数のパッケージの中身を 1 つのフォルダに入っているかのように合体させる機能だと書かれています。

This can be used to put many derivations into the same directory structure.

https://nixos.org/manual/nixpkgs/stable/#trivial-builder-symlinkJoin

1 つのフォルダにまとまる事でどんな利点があるのでしょうか?

イマイチしっくりこないので、nix develop の実行結果を観察していきます。

5.1 nix develop の結果を観察

flake.nix
devShells.default = pkgs.mkShell {
    packages = with pkgs; [
        (bats.withLibraries (p: [
            p.bats-assert
            p.bats-support
        ]))
    ];
};
Bash
$ nix develop

$ which bats
/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/bats

$ ls /nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/
bats

$ ls /nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/share/bats
bats-assert  bats-support

Bats、bats-assert、bats-support が同じディレクトリに格納されています。

5.2 symlinkJoin が無かったら?

以下の様に、Bats と bats-assert を別々に定義しました。

flake.nix
devShells.default = pkgs.mkShell {
    packages = with pkgs; [
        bats
        bats.libraries.bats-assert
    ];
    shellHook = ''
        echo ${pkgs.bats.out}
        echo ${pkgs.bats.libraries.bats-assert.out}
    '';
};
Bash
$ nix develop
/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0
/nix/store/c25dr9pr55qz2pm3b2h56fchf7nd2588-bats-assert-2.1.0

Bats と bats-assert が別々のディレクトリに格納されました。

5.3 Bats と bats-assert の関係性

Bats は環境変数 BATS_LIB_PATH を使ってヘルパーライブラリを探します。

先ほどの flake.nix の場合、そのままでは BATS_LIB_PATH が未定義なので、Bats は bats-assert を参照できません。

$ bats test.bats
Could not find library 'bats-assert' relative to test file or in BATS_LIB_PATH

BATS_LIB_PATH に正しいパスを通せばエラーは解消します。

Bash
export BATS_LIB_PATH=/nix/store/c25dr9pr55qz2pm3b2h56fchf7nd2588-bats-assert-2.1.0/share

flake.nix の shellHook を使えば、この環境変数の設定を自動化できそうです。
しかし、毎回作るのは大変そうです。

5.4 symlinkJoin があると?

withLibraries 関数を再掲します。

package.nix
  passthru.withLibraries =
    selector:
    symlinkJoin {
      name = "bats-with-libraries-${bats.version}";

      paths = [
        bats
      ]
      ++ selector bats.libraries;

      nativeBuildInputs = [
        makeWrapper
      ];

      postBuild = ''
        wrapProgram "$out/bin/bats" \
          --suffix BATS_LIB_PATH : "$out/share/bats"
      '';
    };

実行される処理を順に追っていきます。

処理 1. symlinkJoin - paths

symlinkJoin の paths で指定された Bats、bats-assert が個別にビルドレシピに従いビルドされます。

処理 2. Bats - installPhase

この際、Bats、bats-assert のビルドレシピに従い、installPhase の処理が行われます。

# Bats 本体
installPhase = ''
    ./install.sh $out
'';

# bats-assert
installPhase = ''
    runHook preInstall
    mkdir -p "$out/share/bats/bats-assert"
    cp load.bash "$out/share/bats/bats-assert"
    cp -r src "$out/share/bats/bats-assert"
    runHook postInstall
'';

これらにより、Bats、bats-assert のビルド結果(バイナリへのパス等)は $out/share/bats/bats-assert 等に配置されます。

各ツールのビルド後、symlinkJoin が Bats、bats-assert のビルド結果を受け取り、1 つのディレクトリにまとめます。

処理 3. symlinkJoin - nativeBuildInputs

次に、symlinkJoin の nativeBuildInputs が始まります。

nativeBuildInputs = [
    makeWrapper
];

これは、以降の工程 postBuild にて wrapProgram を使うための準備のようです。
(詳細は次項)

処理 4. symlinkJoin - postBuild

最後に、nativeBuildInputs が行われます。

postBuild = ''
    wrapProgram "$out/bin/bats" \
        --suffix BATS_LIB_PATH : "$out/share/bats"
'';

先ほど makeWrapper を準備した結果、wrapProgram を呼び出せています。

wrapProgram により、bats を呼び出した際、BATS_LIB_PATH が設定された状態になります。

結果、Bats が bats-assert を見つけられるようになります。

6. wrapProgram

wrapProgram とは具体的にどんな事をしてくれるのでしょうか?

https://nixos.org/manual/nixpkgs/stable/#fun-wrapProgram

リファレンスの説明を読んでもよく分からないので、実際の挙動を観察します。

6.1 挙動を観察 - symlinkJoin を使わない場合

pkgs.bats だけを devShells で利用した場合、bats コマンドは以下のビルド結果へリンクされていました。

/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/bin/bats

長いので折り畳み。

#!/nix/store/hkbylipx1iiawqdcjv858p501wv81bpm-bash-interactive-5.3p3/bin/bash

set -euo pipefail

# Note: We first need to use POSIX's `[ ... ]' instead of Bash's `[[ ... ]]'
# because this is the check for Bash, where the shell may not be Bash.  Once we
# confirm that we are in Bash, we can use [[ ... ]] and (( ... )).  Note that
# these [[ ... ]] and (( ... )) do not cause syntax errors in POSIX shells,
# though they can be parsed differently.
if [ -z "${BASH_VERSION-}" ] ||
    [[ -z "${BASH_VERSINFO-}" ]] ||
    ((BASH_VERSINFO[0] < 3 || (BASH_VERSINFO[0] == 3 && BASH_VERSINFO[1] < 2)))
then
  printf 'bats: this program needs to be run by Bash >= 3.2\n' >&2
  exit 1
fi

if command -v greadlink >/dev/null; then
  bats_readlinkf() {
    greadlink -f "$1"
  }
else
  bats_readlinkf() {
    /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/readlink -f "$1"
  }
fi

fallback_to_readlinkf_posix() {
  bats_readlinkf() {
    [ "${1:-}" ] || return 1
    max_symlinks=40
    CDPATH='' # to avoid changing to an unexpected directory

    target=$1
    [ -e "${target%/}" ] || target=${1%"${1##*[!/]}"} # trim trailing slashes
    [ -d "${target:-/}" ] && target="$target/"

    cd -P . 2>/dev/null || return 1
    while [ "$max_symlinks" -ge 0 ] && max_symlinks=$((max_symlinks - 1)); do
      if [ ! "$target" = "${target%/*}" ]; then
        case $target in
        /*) cd -P "${target%/*}/" 2>/dev/null || break ;;
        *) cd -P "./${target%/*}" 2>/dev/null || break ;;
        esac
        target=${target##*/}
      fi

      if [ ! -L "$target" ]; then
        target="${PWD%/}${target:+/}${target}"
        printf '%s\n' "${target:-/}"
        return 0
      fi

      # `ls -dl` format: "%s %u %s %s %u %s %s -> %s\n",
      #   <file mode>, <number of links>, <owner name>, <group name>,
      #   <size>, <date and time>, <pathname of link>, <contents of link>
      # https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ls.html
      link=$(/nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/ls -dl -- "$target" 2>/dev/null) || break
      target=${link#*" $target -> "}
    done
    return 1
  }
}

if ! BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}" 2>/dev/null); then
  fallback_to_readlinkf_posix
  BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}")
fi

export BATS_SAVED_PATH=$PATH
BATS_BASE_LIBDIR=lib # this will be patched with the true value in install.sh

export BATS_ROOT=${BATS_PATH%/*/*}
export -f bats_readlinkf
exec /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/env BATS_ROOT="/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0" BATS_LIBDIR="${BATS_BASE_LIBDIR:-lib}" "/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats" "$@"
### resholve directives (auto-generated) ## format_version: 3
# resholve: fake external:greadlink
# resholve: fake external:shlock
# resholve: fix $BATS_LIBDIR:lib
# resholve: fix $BATS_LIBEXEC:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core
# resholve: fix $BATS_ROOT:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0
# resholve: keep $BATS_LINE_REFERENCE_FORMAT
# resholve: keep $BATS_LOCKING_IMPLEMENTATION
# resholve: keep $BATS_TEST_NAME
# resholve: keep $interpolated_formatter
# resholve: keep $interpolated_report_formatter
# resholve: keep $parallel_binary_name
# resholve: keep $pre_command
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/env
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/ls
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/readlink
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats-exec-test
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats-preprocess
# resholve: keep source:$BATS_TEST_SOURCE
# resholve: keep source:$library_load_path
# resholve: keep source:$setup_suite_file
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/common.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/formatter.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/preprocessing.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/semaphore.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/test_functions.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/tracing.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/validator.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/warnings.bash

6.2 挙動を観察 - symlinkJoin を使う場合

pkgs.bats.withLibraries として devShells で利用した場合、bats コマンドは以下のビルド結果へリンクされていました。

先ほど比べ、文量が少ないです。
また、先ほどにはなかった BATS_LIB_PATH を設定する記述があります。
そして、最後に /nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/.bats-wrapped を呼んでいます。
先ほどは bats のバイナリを呼んでいたので、挙動が異なります。

/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/bats
#! /nix/store/lw117lsr8d585xs63kx5k233impyrq7q-bash-5.3p3/bin/bash -e
BATS_LIB_PATH=${BATS_LIB_PATH:+':'$BATS_LIB_PATH':'}
if [[ $BATS_LIB_PATH != *':''/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/share/bats'':'* ]]; then
    BATS_LIB_PATH=$BATS_LIB_PATH'/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/share/bats'
fi
BATS_LIB_PATH=${BATS_LIB_PATH#':'}
BATS_LIB_PATH=${BATS_LIB_PATH%':'}
export BATS_LIB_PATH
exec -a "$0" "/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/.bats-wrapped"  "$@" 

bats-wrapped の中身を確認します。
すると、symlinkJoin を使わない場合の bats のリンク先と同じ内容でした。

/nix/store/yghky3in844mf0apjvnr3mq8mna6k4qx-bats-with-libraries-1.12.0/bin/.bats-wrapped

長いので折り畳み。

#!/nix/store/hkbylipx1iiawqdcjv858p501wv81bpm-bash-interactive-5.3p3/bin/bash

set -euo pipefail

# Note: We first need to use POSIX's `[ ... ]' instead of Bash's `[[ ... ]]'
# because this is the check for Bash, where the shell may not be Bash.  Once we
# confirm that we are in Bash, we can use [[ ... ]] and (( ... )).  Note that
# these [[ ... ]] and (( ... )) do not cause syntax errors in POSIX shells,
# though they can be parsed differently.
if [ -z "${BASH_VERSION-}" ] ||
    [[ -z "${BASH_VERSINFO-}" ]] ||
    ((BASH_VERSINFO[0] < 3 || (BASH_VERSINFO[0] == 3 && BASH_VERSINFO[1] < 2)))
then
  printf 'bats: this program needs to be run by Bash >= 3.2\n' >&2
  exit 1
fi

if command -v greadlink >/dev/null; then
  bats_readlinkf() {
    greadlink -f "$1"
  }
else
  bats_readlinkf() {
    /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/readlink -f "$1"
  }
fi

fallback_to_readlinkf_posix() {
  bats_readlinkf() {
    [ "${1:-}" ] || return 1
    max_symlinks=40
    CDPATH='' # to avoid changing to an unexpected directory

    target=$1
    [ -e "${target%/}" ] || target=${1%"${1##*[!/]}"} # trim trailing slashes
    [ -d "${target:-/}" ] && target="$target/"

    cd -P . 2>/dev/null || return 1
    while [ "$max_symlinks" -ge 0 ] && max_symlinks=$((max_symlinks - 1)); do
      if [ ! "$target" = "${target%/*}" ]; then
        case $target in
        /*) cd -P "${target%/*}/" 2>/dev/null || break ;;
        *) cd -P "./${target%/*}" 2>/dev/null || break ;;
        esac
        target=${target##*/}
      fi

      if [ ! -L "$target" ]; then
        target="${PWD%/}${target:+/}${target}"
        printf '%s\n' "${target:-/}"
        return 0
      fi

      # `ls -dl` format: "%s %u %s %s %u %s %s -> %s\n",
      #   <file mode>, <number of links>, <owner name>, <group name>,
      #   <size>, <date and time>, <pathname of link>, <contents of link>
      # https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ls.html
      link=$(/nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/ls -dl -- "$target" 2>/dev/null) || break
      target=${link#*" $target -> "}
    done
    return 1
  }
}

if ! BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}" 2>/dev/null); then
  fallback_to_readlinkf_posix
  BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}")
fi

export BATS_SAVED_PATH=$PATH
BATS_BASE_LIBDIR=lib # this will be patched with the true value in install.sh

export BATS_ROOT=${BATS_PATH%/*/*}
export -f bats_readlinkf
exec /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/env BATS_ROOT="/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0" BATS_LIBDIR="${BATS_BASE_LIBDIR:-lib}" "/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats" "$@"
### resholve directives (auto-generated) ## format_version: 3
# resholve: fake external:greadlink
# resholve: fake external:shlock
# resholve: fix $BATS_LIBDIR:lib
# resholve: fix $BATS_LIBEXEC:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core
# resholve: fix $BATS_ROOT:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0
# resholve: keep $BATS_LINE_REFERENCE_FORMAT
# resholve: keep $BATS_LOCKING_IMPLEMENTATION
# resholve: keep $BATS_TEST_NAME
# resholve: keep $interpolated_formatter
# resholve: keep $interpolated_report_formatter
# resholve: keep $parallel_binary_name
# resholve: keep $pre_command
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/env
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/ls
# resholve: keep /nix/store/d75200gb22v7p0703h5jrkgg8bqydk5q-coreutils-9.8/bin/readlink
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats-exec-test
# resholve: keep /nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/libexec/bats-core/bats-preprocess
# resholve: keep source:$BATS_TEST_SOURCE
# resholve: keep source:$library_load_path
# resholve: keep source:$setup_suite_file
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/common.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/formatter.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/preprocessing.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/semaphore.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/test_functions.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/tracing.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/validator.bash
# resholve: keep source:/nix/store/fnj6f2gr439m0xyf931mrfsas9a30vpk-bats-1.12.0/lib/bats-core/warnings.bash

つまり、symlinkJoin にて wrapProgram が実行され export BATS_LIB_PATH を実行してから bats が呼ばれるような挙動になっているようです。

これにより、flake.nix で export BATS_LIB_PATH しなくても、bats コマンドを呼ぶだけで、自動的に export BATS_LIB_PATH された状態で bats のバイナリが呼ばれます。

便利!

Discussion