aboutsummaryrefslogtreecommitdiff
path: root/posts/laminar-is-best.md
blob: 8ef1f4a6b28f28892528b9bae0f3ed925584e162 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
title: Laminar CI の紹介と Guix System への導入
id: laminar-is-best
date: 2021-08-03 10:30
updated: 2021-08-02 11:50
description: Laminar を導入して CI サーバーを構築した話
---

Laminar という軽量 CI を使って [ci.tojo.tokyo](https://ci.tojo.tokyo) という CI サーバーを構築したので、Laminar と Guix System への導入方法について紹介する。

## 動機

自前の git サーバーを構築したが、しばらく運用をしていると CI (Continuous Integration) 環境が欲しくなった。趣味では基本的に一人で開発をしているので他の開発者の変更と統合したテストをしたいなどという気持ちは全くないが、git リポジトリに push したら勝手にテストをしてくれたり、デプロイをしてくれるような良い感じの環境が欲しくなったのだ。

それとは別に、現在 ACL2 で定理証明をするのにもはまっていて、証明した結果を共有するときにコードだけではなくて ACL2 の出力結果を気軽に共有できる環境が欲しいと思っていたのも大きな理由の一つである。


## きっかけ

CI が欲しいなーと思いながら、[Guix](https://guix.gnu.org/) のマニュアルの [Continuous Integration (GNU Guix Reference Manual)](https://guix.gnu.org/manual/en/html_node/Continuous-Integration.html) という節を読んでいたところ、Cuirass と Laminar というソフトウェアが載っていたのに気づいた。Cuirass は GNU Guix に対して継続的インテグレーションをするやつなので私が求めているものとは違うものだが、laminar はちょうど欲しいと思っていた軽量の CI を実現するものだった。

## Laminar とは

[Laminar](https://laminar.ohwg.net/) はジョブの自動化やトラッキング機能を提供し、良い感じの Web インターフェースでジョブの実行結果等を表示してくれるツールだ。

これだけであれば一般的な CI ツールと同じだが、Laminar の使用方法は他の一般的な CI ツールとは全く異なる。

Laminar には:

* Web UI の管理画面による設定が**ない**
* YAML 等による CI の設定用ファイルが**ない**
* 無駄な車輪の再発明が**ない**

Web UI による設定画面が存在するとそれだけで設定のバージョン管理が難しくなるのでない方がよい。また管理画面が存在すると、公開時のセキュリティ上のリスクについて悩まないといけなくなってしまう。

CI を設定するために YAML 等で表現された謎の CI 設定用言語を学べとかいわれるとなんでそのツールをを使うためだけに表現力の貧弱な設定用言語を使わなくてはならんのだと感じる(GNU Guix を見倣って欲しいものである)ので YAML の設定ファイルはない方がよい。

そして、一般的に CI について勉強していると一番よく思うのが「なんでそんな簡単なことをそんな複雑にしてるんだ……」という問題で、既存のツールを使えば簡単にできることを中途半端に再発明することで無駄な学習を強要し、さらに無駄に表現力が狭められていることで融通の効かない不便な仕組みの中に閉じ込められてしまう。

Laminar には**そういった無駄な車輪の再発明が一切なく**、既存のツールをフルに生かすことができる Hackable な CI ツールなのだ。

では、Laminar ではどうやって他の CI に必要な機能を実現しているのだろうか。この章では Laminar のアプローチについて紹介する。

### Laminar でのジョブの設定方法

では Laminar ではどうやって CI にジョブを設定するかというと、基本的には LAMINAR_HOME ディレクトリ(デフォルトは /var/lib/laminar) の cfg ディレクトリに、 `<ジョブの名前>.run` というファイル名の実行可能なスクリプトを置くだけである。
そしてコマンド `laminarc queue <ジョブの名前>` を実行するとジョブがキューに入り `laminar` ユーザーで実行され、Web UI に結果が良い感じに表示される。

### git への push を hooks するにはどうする?

git サーバーと同居する場合は [Git Hooks を使う](https://git-scm.com/book/ja/v2/Git-%E3%81%AE%E3%82%AB%E3%82%B9%E3%82%BF%E3%83%9E%E3%82%A4%E3%82%BA-Git-%E3%83%95%E3%83%83%E3%82%AF)。
私は git サーバーと同居させる選択をしたのでこれで終わりだが、そうでない場合についても対応可能なようなのでその場合は公式ドキュメントを参照すると良いだろう。

### ジョブの定期実行はどうする?

cron を使う。GNU Guix System を利用している場合は GNU mcron を使うのがいいだろう(参照: [Scheduled Job Execution (GNU Guix Reference Manual)](https://guix.gnu.org/manual/en/html_node/Scheduled-Job-Execution.html))。

### Docker でジョブを実行するにはどうする?

Laminar は別に Docker をサポートしていない。でも、ジョブのスクリプト中に `docker run` をすればよいとある。
たしかに、これで駄目な理由は特に考えられないので、CI 側で Docker をサポートするのは無駄である。

また、Guix ユーザーであれば Docker よりも [guix environment](https://guix.gnu.org/manual/en/html_node/Invoking-guix-environment.html) を使いたいと思うだろう(例: [deploy-www-tojo-tokyo ジョブ](https://git.tojo.tokyo/ci.git/tree/jobs/deploy-www-tojo-tokyo.run?id=580db52c3004cfdbd56aa2c8861c8fbc9fb5cdd8#n5))。にもかかわらず公式で Docker をサポートされたり、Docker を使用することを過剰に推奨されるとうっとうしいだけなので、Laminar が無駄に Docker サポートをしないという方針は良いものである。

### 他のジョブから同期的に別のジョブを呼ぶにはどうするの?

ジョブのスクリプト中に `laminarc run <別のジョブ>` と書けばよい。それだけで別のジョブを呼んでくれるし、Web UI からは元のジョブの実行結果から別のジョブの実行結果にジャンプできるし、逆に別のジョブの実行結果から呼び出し元のジョブの実行結果にジャンプすることもできる。

### パラメータ付きのジョブを作るにはどうしたらいい?

環境変数を使う。`lamiarc queue <ジョブの名前> key=value` とすればパラメータを付けてジョブを呼びだせる。

## ci.tojo.tokyo の構築

ci.tojo.tokyo での構築の方法について紹介する。

### Laminar サーバーの構築

Laminar は Guix System の Service として登録されているので、単に Service の設定をシステムの設定に追加するだけである([guix-config のコミット](https://git.tojo.tokyo/guix-config.git/commit/?id=6caebdd7a6d8703e4db6461e6ce390bf40c314f3), cgit サーバー側の設定の変更も混じっているがこれは気にしないでいただきたい……)。

### ジョブの設定

Ci の設定は [ci.git](https://git.tojo.tokyo/ci.git/about/) リポジトリに記載している通りである。ただ、Guix System で利用する際に一点注意が必要な点があったのでそこだけ説明する。

#### Guix System の環境変数の設定

ジョブの設定だが Guix Environment を使うユーザーは注意が必要な点がある。
ジョブは laminar ユーザーで実行されるのだが、PATH 環境変数がリセットされた環境でジョブが実行される。
guix では shebang に `/usr/bin/sh` と `/usr/bin/env` しか使えないが、`/usr/bin/env` を使っても PATH 環境変数がリセットされているためなんのジョブも呼び出すこともできない。
Laminar には必要な環境変数を静的に設定する方法(`$LAMINAR_HOME/cfg/env` に記載)が提供されているが、Guix System のユーザーは下記のようにして環境変数を設定したいと思うだろう。

```
GUIX_PROFILE="/var/lib/laminar/.config/guix/current"
. "$GUIX_PROFILE/etc/profile"
```

Laminar では、`$LAMINAR_HOME/cfg/before` に全てのジョブの前に実行される前処理を記述することができるので私は下記のようにスクリプトを配置することで解決した。

[$LAMINAR_HOME/cfg/before](https://git.tojo.tokyo/ci.git/tree/before)
```
#!/bin/sh
set -eu

export PATH="${PATH}:/run/current-system/profile/bin:/run/current-system/profile/sbin"

GUIX_PROFILE="/var/lib/laminar/.config/guix/current"
. "$GUIX_PROFILE/etc/profile"

env | while read kv; do
  laminarc set "$kv"
done
```

## おわりに

Laminar の概要と、Guix System に Laminar の構築をしてジョブの設定する方法について紹介した。必要な機能が十分揃っている上に、既存のツールを利用できるように設計されているため CI ツールそのものの学習コストは最小である。Guix System の設定に laminar を追加するだけでを導入できるし、CI の実行時に guix environment を使うこともできるから Guix System との相性も抜群である。

他の CI システムと比較してシンプルでかつ利用が簡単なため、既存の CI ツールを使うのが難しいと感じていた方は一度試してみてはいかがだろうか。