diff options
| author | nsfisis <nsfisis@gmail.com> | 2024-04-20 23:44:15 +0900 |
|---|---|---|
| committer | nsfisis <nsfisis@gmail.com> | 2024-04-20 23:44:30 +0900 |
| commit | 88f8bcc0862621c96d23a552eaa2a8fed010440f (patch) | |
| tree | e9822c6dcbf4ac58df5638fa6c4d4f3d4fb3c615 /vhosts/blog/public/posts/2024-04-21 | |
| parent | b372b90ae4f65855d6f7132c7722f0228f43daa8 (diff) | |
| download | nsfisis.dev-88f8bcc0862621c96d23a552eaa2a8fed010440f.tar.gz nsfisis.dev-88f8bcc0862621c96d23a552eaa2a8fed010440f.tar.zst nsfisis.dev-88f8bcc0862621c96d23a552eaa2a8fed010440f.zip | |
feat(blog/content): new post /posts/2024-04-21/pipefail-option-in-gitlab-ci-cd/
Diffstat (limited to 'vhosts/blog/public/posts/2024-04-21')
| -rw-r--r-- | vhosts/blog/public/posts/2024-04-21/pipefail-option-in-gitlab-ci-cd/index.html | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/vhosts/blog/public/posts/2024-04-21/pipefail-option-in-gitlab-ci-cd/index.html b/vhosts/blog/public/posts/2024-04-21/pipefail-option-in-gitlab-ci-cd/index.html new file mode 100644 index 00000000..fb77cdc0 --- /dev/null +++ b/vhosts/blog/public/posts/2024-04-21/pipefail-option-in-gitlab-ci-cd/index.html @@ -0,0 +1,229 @@ +<!DOCTYPE html> +<html lang="ja-JP"> + <head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <meta name="author" content="nsfisis"> + <meta name="copyright" content="© 2024 nsfisis"> + <meta name="description" content="GitLab CI/CD で bash/sh スクリプトを動かすと、pipefail オプションが有効になった状態で実行される。"> + <meta name="keywords" content="CI/CD,GitLab"> + <meta property="og:type" content="article"> + <meta property="og:title" content="【GitLab】 GitLab CI/CD 上での bash/sh は pipefail が有効になっている｜REPL: Rest-Eat-Program Loop"> + <meta property="og:description" content="GitLab CI/CD で bash/sh スクリプトを動かすと、pipefail オプションが有効になった状態で実行される。"> + <meta property="og:site_name" content="REPL: Rest-Eat-Program Loop"> + <meta property="og:locale" content="ja_JP"> + <link rel="icon" type="image/svg+xml" href="/favicon.svg"> + <title>【GitLab】 GitLab CI/CD 上での bash/sh は pipefail が有効になっている｜REPL: Rest-Eat-Program Loop</title> + <link rel="stylesheet" href="/style.css?h=0656606dcfb3f6fa094a976e05df9007"> + <link rel="stylesheet" href="/hl.css?h=340e65ffd5c17713efc9107c06304f7b"> + </head> + <body class="single"> + <header class="header"> + <div class="site-logo"> + <a href="/">REPL: Rest-Eat-Program Loop</a> + </div> + <nav class="nav"> + <ul> + <li> + <a href="/about/">About</a> + </li> + <li> + <a href="/posts/">Posts</a> + </li> + <li> + <a href="/slides/">Slides</a> + </li> + <li> + <a href="/tags/">Tags</a> + </li> + </ul> + </nav> + </header> + <main class="main"> + <article class="post-single"> + <header class="post-header"> + <h1 class="post-title">【GitLab】 GitLab CI/CD 上での bash/sh は pipefail が有効になっている</h1> + <ul class="post-tags"> + <li class="tag"> + <a href="/tags/ci-cd/">CI/CD</a> + </li> + <li class="tag"> + <a href="/tags/gitlab/">GitLab</a> + </li> + </ul> + </header> + <div class="post-content"> + <section> + <h2 id="changelog">更新履歴</h2> + <ol> + <li class="revision"> + <time datetime="2022-11-17">2022-11-17</time>: デジタルサーカス株式会社の社内記事として公開 + </li> + <li class="revision"> + <time datetime="2024-04-21">2024-04-21</time>: ブログ記事として一般公開 + </li> + </ol> + </section> + <div class="admonition"> + <div class="admonition-label"> + NOTE + </div> + <div class="admonition-content"> + この記事は、2022-11-17 に<a href="https://www.dgcircus.com/">デジタルサーカス株式会社</a> の社内 Qiita Team に公開された記事をベースに、加筆修正して一般公開したものです。 + </div> + </div> + + <p> + ハマったのでメモ。 + </p> + + <section id="section--background"> + <h2><a href="#section--background">前提</a></h2> + <section id="section--background--gitlab-ci-cd"> + <h3><a href="#section--background--gitlab-ci-cd">GitLab CI/CD について</a></h3> + <p> + GitLab CI/CD では、Docker executor を用いて任意の Docker image 上でスクリプトを走らせることができる。 + </p> + + <p> + 例: + </p> + + <pre class="highlight" filename=".gitlab-ci.yml" language="yaml"><code class="highlight"><span class="hljs-attr">hello-world:</span> + <span class="hljs-attr">stage:</span> <span class="hljs-string">test</span> + <span class="hljs-attr">image:</span> <span class="hljs-string">alpine:latest</span> + <span class="hljs-attr">script:</span> + <span class="hljs-bullet">-</span> <span class="hljs-string">'echo "Hello, World!"'</span> + <span class="hljs-attr">rules:</span> + <span class="hljs-bullet">-</span> <span class="hljs-attr">if:</span> <span class="hljs-string">'$CI_MERGE_REQUEST_IID'</span> + <span class="hljs-attr">when:</span> <span class="hljs-string">always</span></code></pre> + + <p> + ここで、<code>script</code> に指定したコマンドが失敗する (exit status が 0 以外になる) と、即座に実行が停止され、ジョブは失敗する。 + </p> + + <p> + では、次のようなケースだとどうなるか。 + </p> + + <pre class="highlight" filename=".gitlab-ci.yml" language="yaml"><code class="highlight"><span class="hljs-attr">hello-world:</span> + <span class="hljs-attr">stage:</span> <span class="hljs-string">test</span> + <span class="hljs-attr">image:</span> <span class="hljs-string">alpine:latest</span> + <span class="hljs-attr">script:</span> + <span class="hljs-bullet">-</span> <span class="hljs-string">'exit 1 | exit 0'</span> + <span class="hljs-attr">rules:</span> + <span class="hljs-bullet">-</span> <span class="hljs-attr">if:</span> <span class="hljs-string">'$CI_MERGE_REQUEST_IID'</span> + <span class="hljs-attr">when:</span> <span class="hljs-string">always</span></code></pre> + + <p> + 失敗するコマンドをパイプに接続した。通常 Bash では、パイプの最後のコマンドの exit code が全体の exit code になる。 + </p> + </section> + + <section id="section--background--pipefail-option"> + <h3><a href="#section--background--pipefail-option"><code>pipefail</code> オプションについて</a></h3> + <p> + 前述したようなケースにおいて、途中で失敗したときに全体を失敗させるには、<code>pipefail</code> オプションを有効にする。 + </p> + + <pre class="highlight" language="bash"><code class="highlight"><span class="hljs-comment"># On にする</span> +<span class="hljs-built_in">set</span> -o pipefail +<span class="hljs-comment"># Off にする</span> +<span class="hljs-built_in">set</span> +o pipefail</code></pre> + + <p> + こうすると、パイプ全体が失敗するようになる。 この設定は、デフォルトだと off になっている。 + </p> + </section> + </section> + + <section id="section--problem"> + <h2><a href="#section--problem">発生した問題</a></h2> + <p> + 次のような GitLab CI/CD ジョブが失敗してしまった。 + </p> + + <pre class="highlight" filename=".gitlab-ci.yml" language="yaml"><code class="highlight"><span class="hljs-attr">hoge:</span> + <span class="hljs-attr">stage:</span> <span class="hljs-string">test</span> + <span class="hljs-attr">image:</span> <span class="hljs-string">alpine:latest</span> + <span class="hljs-attr">script:</span> + <span class="hljs-bullet">-</span> <span class="hljs-string">'cat hoge.txt | grep piyo | sed -e "s/foo/bar/g"'</span> + <span class="hljs-attr">rules:</span> + <span class="hljs-bullet">-</span> <span class="hljs-attr">if:</span> <span class="hljs-string">'$CI_MERGE_REQUEST_IID'</span> + <span class="hljs-attr">when:</span> <span class="hljs-string">always</span></code></pre> + + <p> + <code>grep</code> コマンドは、パターンにマッチする行が一行もなかったとき、exit code 1 を返す。よって、<code>pipefail</code> が on になっていると、このジョブは失敗する。 現在の <code>pipefail</code> がどうなっているか確かめるため <code>set +o</code> で全オプションを出力させたところ、<code>pipefail</code> が on になっていた。 + </p> + + <p> + しかし、先述したように Bash における <code>pipefail</code> のデフォルト値は off のはずだ。 実際に、ローカルで <code>alpine:latest</code> を動かしてみたところ、 + </p> + + <pre class="highlight"><code>$ docker run --rm alpine:latest sh -c "set +o" +set +o errexit +set +o noglob +set +o ignoreeof +set +o monitor +set +o noexec +set +o xtrace +set +o verbose +set +o noclobber +set +o allexport +set +o notify +set +o nounset +set +o vi +set +o pipefail</code></pre> + + <p> + 確かに <code>pipefail</code> は無効になっている。 + </p> + + <p> + なぜスクリプト内で <code>set -o pipefail</code> しているわけでもないのに <code>pipefail</code> が on になっているのか。 + </p> + </section> + + <section id="section--where-pipefail-is-enabled"> + <h2><a href="#section--where-pipefail-is-enabled">どこで <code>pipefail</code> が on になるか</a></h2> + <p> + <code>.gitlab-ci.yml</code> で明示的には書いていないので、GitLab Runner (GitLab CI/CD のスクリプトを実行するプログラム) が勝手に追加しているに違いない。 そう仮説を立てて <a href="https://gitlab.com/gitlab-org/gitlab-runner">GitLab Runner のリポジトリ</a> を調査したところ、<a href="https://gitlab.com/gitlab-org/gitlab-runner/-/blob/c75da0796a0e3048991dccfdf2784e3d931beda4/shells/bash.go#L276">ソースコード中の以下の箇所</a> で <code>set -o pipefail</code> していることが判明した (コメントは筆者による)。 + </p> + + <pre class="highlight" language="go"><code class="highlight"><span class="hljs-comment">// pipefail オプションが存在しない環境にも対応するため、</span> +<span class="hljs-comment">// 先に set -o でオプション一覧を表示させたあと、set -o pipefail している</span> +buf.WriteString(<span class="hljs-string">"if set -o | grep pipefail > /dev/null; then set -o pipefail; fi; set -o errexit\n"</span>)</code></pre> + </section> + + <section id="section--how-to-solve"> + <h2><a href="#section--how-to-solve">どのように解決するか</a></h2> + <p> + 通常の Bash スクリプトを書く場合と同様に、<code>pipefail</code> が on になっていては困る場所だけ off にしてやればよい。 + </p> + + <pre class="highlight" diff="true" filename=".gitlab-ci.yml" language="yaml"><code class="highlight"> <span class="hljs-attr">hoge:</span> + <span class="hljs-attr">stage:</span> <span class="hljs-string">test</span> + <span class="hljs-attr">image:</span> <span class="hljs-string">alpine:latest</span> + <span class="hljs-attr">script:</span> +<span class="hljs-string">+</span> <span class="hljs-bullet">-</span> <span class="hljs-string">'set +o pipefail'</span> + <span class="hljs-bullet">-</span> <span class="hljs-string">'cat hoge.txt | grep piyo | sed -e "s/foo/bar/g"'</span> +<span class="hljs-string">+</span> <span class="hljs-bullet">-</span> <span class="hljs-string">'set -o pipefail'</span> <span class="hljs-comment"># この例の場合、ここで終わりなので戻さなくてもよい</span> + <span class="hljs-attr">rules:</span> + <span class="hljs-bullet">-</span> <span class="hljs-attr">if:</span> <span class="hljs-string">'$CI_MERGE_REQUEST_IID'</span> + <span class="hljs-attr">when:</span> <span class="hljs-string">always</span></code></pre> + </section> + + <section id="section--remarks"> + <h2><a href="#section--remarks">備考</a></h2> + <p> + なお、上述した実装ファイルは <code>shells/bash.go</code> だが、<code>alpine:latest</code> の例でもそうであったように、シェルが <code>sh</code> である場合にも適用される。 + </p> + </section> + </div> + </article> + </main> + <footer class="footer"> + © 2021 nsfisis + </footer> + </body> +</html> |