Elog and Ebuild Phase Hook

Introduction ELOG Ebuild Phase Hook
emerge のログと通知
ELOG と Ebuild Phase Hook について調べた
Yasuhiro Asaka @grauwoelfchen
Gentoo 勉強会 #2
2014-05-11
Yasuhiro Asaka @grauwoelfchen Gentoo 勉強会 #2

1 Introduction
2 ELOG
3 Ebuild Phase Hook

自己紹介
Yasuhiro Asaka
プログラマ (フリーランス)
Gentoo, Funtoo
StumpWM, Xterm
Dvorak, Vim

目的、調べたこと
emerge のログを取りたい、完了を知りたい
ELOG でモジュールを使う
ELOG でカスタムコマンドでを使う
emerge のフェーズの経過を知りたい
Ebuild Phase Hook を使う

内容
ELOG のロギング機能
ELOG ってどんなのか
モジュールを使う
カスタムコマンドを使う
Ebuild Phase Hook
Ebuild Phase Hook ってど
んなのか
パッケージ毎に用意して
使う
/etc/portage/bashrc におい
て使う

Portage-2.0.* では enotice という ebuild があった
ELOG になって Portage に組み込まれた (enotice と非互換)
保存されたログは eread で確認できる
設定に使う変数 (make.conf)
PORTAGE_ELOG_CLASSES ELOG 対象を指定する (info, warn, error など)
PORTAGE_ELOG_SYSTEM モジュールを指定する (空だと ELOG は disabled)
PORTAGE_ELOG_COMMAND $PACKAGE ($PF, $PN-$PVR) と $LOGFILE (パス) の
2 つの値を渡せる (正規表現)

設定例 e.g. GentWoo
PORTAGE_ELOG_CLASSES="log warn error qa"
PORTAGE_ELOG_SYSTEM="custom:* echo save"
PORTAGE_ELOG_COMMAND="/usr/bin/gentwoo ’${PACKAGE}’ ’${LOGFILE}’"

一度に複数のモジュールを使うことができる
コロンで区切って、PORTAGE_ELOG_CLASSES を上書きできる
"echo save:log mail:*"
コードは /usr/lib/portage/pym/portage/elog/ にある (Python)
標準で用意されている echo, save, custom, syslog, mail,
mail_summary, save, save_summary
PORTAGE_ELOG_COMMAND を使うには custom を指定する

Email モジュール
PORTAGE_ELOG_SYSTEM に
mail または mail_summary モジュールを追加して使う
mail_summary は emerge が終了すると
すべてのメッセージを 1 通にまとめて送る
${ACTION} (merge, unmerge) は mail でのみ使える
PORTAGE_ELOG_MAILURI /usr/share/portage/conﬁg/make.conf.example 参照
PORTAGE_ELOG_MAILFROM "portageexample.org"
PORTAGE_ELOG_MAILSUBJECT "[portage] euild log for ${ACTION} ${PACKAGE} on ${HOST}"

email モジュールの注意、まとめ
SystemExit などで中止しても送られる (成否によらない)
認証などで失敗すると例外のメッセージを出してくれる
!!! An error occured while trying to send logmail: ...
Sure you conﬁgured PORTAGE_LOG_MAILURI correctly?
Python (socket.getfqdn()) で、/etc/hosts をちゃんと読めるか
確認しておく (${HOST})
portage 2.1.1 からアドレスの user 部分にもが使える
(gmail だと, user@gmail.com@gmail.com:100587)
port は SMTP 認証を使う場合は 465 や 587 じゃなくて、
100465 とか 100587 にする

ログ (通知) 例: Email モジュール
INFO: setup
Package: app-editors/vim-7.4.273
Repository: gentoo
Maintainer: vim@gentoo.org
USE: X acl amd64 cscope elibc_glibc kernel_linux lua ...
racket userland_GNU
FEATURES: preserve-libs sandbox
INFO: prepare
Applying vim-patches-7.4.273.patch ...
INFO: postinst
Updating documentation tags in /usr/share/vim/vim74
Calling eselect vi update...

jabber モジュール
http://projects.usrportage.de/index.fcgi/
portage-mod-jabber/wiki
% epkginfo portage-mod_jabber
* app-portage/portage-mod_jabber [gentoo]
Maintainer: hanno@gentoo.org
Upstream: None specified
Homepage: http://usrportage.de/
Location: /usr/portage/app-portage/portage-mod_jabber
Keywords: 0.0.3:0:
Keywords: 0.0.5.1:0: ~amd64 ~arm ~x86
License: GPL-2
# configuration (make.conf)
PORTAGE_ELOG_SYSTEM="jabber"
PORTAGE_ELOG_JABBERFROM="sender:password@host.com[/resource]"
PORTAGE_ELOG_JABBERTO="jid1@host.com jid2@host.com admin@foo.com"

カスタムコマンドで通知する
root ユーザのプロセスになる
X-Session に接続する工夫が必要
DISPLAY ":0.0"
XAUTHORITY "/home/user/.Xauthority" (X-session のクッキー)
#!/bin/sh
if [ $# -lt 1 ]; then
echo "Usage: ‘basename $0‘ command" >&2
exit 2
fi
su -c "exec env DISPLAY=’$DISPLAY’ XAUTHORITY=’$XAUTHORITY’ ’$SHELL’ -c ’$*’"

デモ
Stumpish の例
https://gist.github.com/grauwoelfchen/4f64480526d8aa1b15b4
https://gist.github.com/grauwoelfchen/3d64c13cf473667123d6
# xroot-stumpish ’package name’ ’log file name’
+--------------------+
| package name |
| log file name |
+--------------------+

Ebuild Phase Hook とは
Ebuild の各段階の前後 (pre, post) で評価されれる Bash スクリプト
Ebuild を直接書き換えたりせずに各 Phase で環境変数などを
上書きしたりできる
カテゴリや SLOT を絞って評価されるようにもできる
Ebuild で使われる変数のほかヘルパー関数 (einfo など) も使える

bashrc の場所と順序
評価される順序 (上から)
$PN Package name
$P Package name and version
$PF Full-Package name (${PN}-${PVR})
1 /etc/portage/bashrc
2 /etc/portage/env/${CATEGORY}/${PN}
3 /etc/portage/env/${CATEGORY}/${PN}:${SLOT}
4 /etc/portage/env/${CATEGORY}/${P}
5 /etc/portage/env/${CATEGORY}/${PF}

Ebuild Phase Hook の例
ML (gentoo-portage-dev) にあった例
$ cat /etc/portage/env/sys-libs/glibc
pre_pkg_setup() {
local x
for x in installsources splitdebug ; do
if ! has $x $FEATURES ; then
elog "bashrc is adding $x to FEATURES for $PN"
FEATURES="$FEATURES $x"
fi
done
...
}

Ebuild Phase Hook の例
グローバルでフックする例
$ cat /etc/portage/bashrc
if [ "${EBUILD_PHASE}" == "postinst" ]; then
einfo "postinst"
...
elif [ "${EBUILD_PHASE}" == "postrm" ]; then
einfo "postrm"
...
fi
...

Ebuild Phase の一覧
1 pretend
2 clean
3 setup
4 unpack
5 prepare
6 conﬁgure
7 compile
8 test
9 install
10 ?
11 preinst
12 ?
13 prerm
14 postrm
15 cleanrm
16 postinst
17 ?
18 clean

Ebuild Phase Hook の注意、まとめ
同期的に呼ばれる (sleep すると emerge とまっちゃう)
対象の Phase が定義されていない場合もある (ebuild による)
${EBUILD_PHASE} が空文字列で呼ばれる時がある ?
本来は Ebuild を直接ハックせずに、環境変数や設定などを
行うもの

参考リンク
Portage Documentation http://dev.gentoo.org/~zmedico/portage/doc/
Ebuild Phase Hook http://dev.gentoo.org/~zmedico/portage/doc/ch01s02.html
Ebuild Phases http://dev.gentoo.org/~zmedico/portage/doc/ch06.html#package-ebuild-phases
Helper Functions http://dev.gentoo.org/~zmedico/portage/doc/ch06s02.html
Ebuild Writing http://devmanual.gentoo.org/ebuild-writing/index.html
EAPI http://devmanual.gentoo.org/ebuild-writing/eapi/
Variables http://devmanual.gentoo.org/ebuild-writing/variables/
Working with Portage > Files and Directories
http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=3&chap=1
Gentoo Wiki - Project:Portage http://wiki.gentoo.org/wiki/Project:Portage
Portage log http://wiki.gentoo.org/wiki/Portage_log
mod_jabber for Portage http://projects.usrportage.de/index.fcgi/portage-mod-jabber/wiki
Remote X Apps mini-HOWTO http://zweije.home.xs4all.nl/xauth.html#toc7
7. X Applications from Another User-id http://zweije.home.xs4all.nl/xauth-7.html

おわり
ありがとうございました
Gentoo Security Team の方作成の LaTeX テーマを
使わせてもらいました
http://a3li.li/2014/04/gentoo-latex-beamer-theme/

Elog and Ebuild Phase Hook

More Related Content

What's hot

Elog and Ebuild Phase Hook