日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
TESTS(7) FreeBSD 多方面の情報マニュアル TESTS(7)
名称
tests -- FreeBSD テストスイート (Test Suite) 入門
解説
FreeBSD テストスイートは、2 つの主な目的のために自動的なテストの収集を提
供しています。一方では、テストスイートは、それらがソースツリーを修正する
とき、バグと回帰を検出するために開発者を援助します。他方では、それは、
FreeBSD オペレーティングシステムの新しいインストールがそれらのハードウェ
アのプラットフォームで正確に振る舞うことを確認するためにエンドユーザ
(と、特に、システム管理者) に許可し、また、システムが通常の操作と保守の間
に回帰に悩まされることを保証することを許可します。
FreeBSD テストスイートは、/usr/tests 階層構造にあります。
このマニュアルページは、テストスイートを実行する方法、とそのオプションの
機能のいくつかを設定する方法について説明しています。テストを書くことに関
する情報については、atf(7) を参照してください。
テストスイートのインストール
テストスイートは、FreeBSD 11.0-RELEASE 現在、デフォルトでインストールされ
ます。
/usr/tests ディレクトリが見当たらないなら、利用者は、テストスイートの構築
を有効にし、システムを再構築し、結果をインストールしなければりません。利
用者は、build(7) に記述されているようにシステムを再構築して、
/etc/src.conf ファイル (詳細については、src.conf(5) を参照) で
`WITH_TESTS=yes' を設定することによって、それを行うことができます。
いつテストを実行するか?
テストスイートを実行する方法の詳細に飛び込む前に、ここに、それを実行する
べきいくつかのシナリオを示します:
• システムがハードウェアのプラットフォームで正確に動作することを
保証するために FreeBSD の新しいインストールの後。
• 新しいコードがハードウェアのプラットフォームで正常に動作して、
アップグレードが利用者の設定で回帰を導入しなかったことを保証す
るために異なるバージョンに FreeBSD のアップグレードの後。
• 何らかの新しいバグおよび回帰を検出するためにソースを修正した
後。
• (サードパーティのパッケージのインストール、または設定ファイルへ
の手動の修正ような) システムへのあらゆる変更を保証するための定
期的な cron(8) ジョブは、予期しない失敗を導入しません。
テストの実行
最初に、ports(7) から `devel/kyua' パッケージをインストールする必要があり
ます。次に、すべてのテストスイートを実行するために次のコマンドを使用しま
す:
$ kyua test -k /usr/tests/Kyuafile
上記は、再帰的に /usr/tests のすべてのテストプログラムを繰り返し、それら
を実行し、それらの結果を格納し、(デフォルトで ~/.kyua/store.db) Kyua の
データベースのデータをデバッグして、結果の要約を印刷 (表示) します。この
要約は、実行されたすべての全体的なテストの簡潔な計算とそれらのいくつかが
失敗したかを含んでいます。
コマンド行でそれらの名前を提供することによって、どのテストを実行するかを
制限することは可能です。例えば、次は、cp(1) と cut(1) ユーティリティに対
するテストを実行します:
$ kyua test -k /usr/tests/Kyuafile bin/cp usr.bin/cut
テスト実行の報告書の取得
テスト結果に関する追加の情報は、Kyua の様々な報告するコマンドを使用するこ
とによって検索して取り出すことができます。例えば、次は、実行されたテスト
の普通のテキスト報告書を印刷 (表示) し、どれが失敗したかを表示します:
$ kyua report
この例は、ウェブサーバで公表される準備ができている HTML 報告書を生成しま
す:
$ kyua report-html --output ~/public_html/tests
Kyua のコマンド行インタフェースに関する詳細については、そのマニュアルペー
ジ kyua(1) を参照してください。
テストの設定
それらを実行することができる前に、FreeBSD テストスイートのいくつかのテス
トケースは、管理者によって手動で設定することを必要とします。特定のプロパ
ティが定義されないなら、それらを要求するテストは、スキップされます。
テストスイートは、/usr/local/etc/kyua/kyua.conf の、それらの設定変数を定
義することによって設定されます。このファイルの形式は、kyua.conf(5) に詳し
く述べられています。
次の設定変数は、FreeBSD テストスイートで利用可能です:
allow_devfs_side_effects 定義されるなら、ディスクデバイスのような、半永
久的なデバイスノードを破壊して、再作成するテス
トを有効にします。この変数なしで、テストは、
/dev/tap* と /dev/pts* のように、それらが後で
それらをクリーンアップする限り、通常一時的なデ
バイスノードを作成して破壊するかもしれません。
しかしながら、この変数を要求するテストには、緩
んだクリーンアップ要求があります。それらは、破
壊したあらゆるデバイスを再作成しなければなりま
せんが、同じ devname である必要はありません。
allow_sysctl_side_effects 全体的に重大な sysctl(8) 変数を変更するテスト
を有効にします。テストは、それらのクリーンアッ
プの過程のあらゆる変更を取り消します。
disks ディスクデバイスノードの空白で区切られたリスト
に設定されなければなりません。ディスクへの破壊
的なアクセスを必要とするテストは、これらのデバ
イスを使用しなければなりません。テストは、これ
らのディスクに存在するあらゆるデータを保存する
ようには要求されません。
fibs FIB (経路表) の空白で区切られたリストに設定さ
れなければなりません。経路表を修正するために必
要のあるテストは、これらのうちのいずれかを使用
します。テストは、それらが作成するあらゆる新し
い経路をクリーンアップします。
何かが失敗する場合に行うこと?
テストスイートの実行の間に何かの失敗があるなら、失敗を解析し、修正するこ
とができるように、FreeBSD の開発者に、それを報告することを考慮してくださ
い。そうするために、適切なメーリングリストにメッセージを送信するか、また
は問題報告書を提出してくださし。より詳しい情報については、次を参照してく
ださい。
• FreeBSD Mailing Lists:
https://lists.freebsd.org/
• Problem Reporting:
https://www.freebsd.org/support/
関連ファイル
/usr/local/etc/kyua/kyua.conf kyua(1) のためのシステム全体の設定ファイ
ル。
~/.kyua/kyua.conf kyua(1) のためのユーザ特有の設定ファイ
ル。システムファイルに優先します。
~/.kyua/store.db Kyua によって使用されるデフォルトの結果の
データベース。
/usr/tests/ FreeBSD テストスイートの位置。
/usr/tests/Kyuafile トップレベルのテストスイート定義ファイ
ル。
関連項目
kyua(1), atf(7), build(7), development(7)
歴史
FreeBSD テストスイートは、FreeBSD 10.1 ではじめて登場しました。
tests マニュアルページは、NetBSD 6.0 ではじめて登場し、後に、FreeBSD 10.1
に移植されました。
作者
Julio Merino <jmmv@FreeBSD.org>
FreeBSD 13.2 August 19, 2020 FreeBSD 13.2