HN 日本語サマリー

← 一覧へ戻る
プログラミング

25年前のミニマルC++単体テストフレームワークの近代化(パート2)

Modernizing a 25-year-old minimal C++ unit testing framework (Part 2) (freshsources.com)

18 pointsby chuckallison2 コメント

要約

この記事は、25年前のシンプルなC++単体テストフレームワークを、C++17のインライン変数とC++20のモジュール、std::source_locationといった最新機能を用いて近代化するパート2です。前回の記事で残された、テストフレームワークのカウンタがファイルごとに分離してしまう問題と、ヘッダーファイルへの依存による管理の煩雑さを解決するため、インライン変数とモジュールが導入されます。

全文翻訳

自動化された安価な単体テスト:パート2

C++ Code Capsules


この2部構成シリーズのパート1で、例外処理の検証を含む、驚くほどシンプルな方法で自動単体テストを処理する、実績のある(つまり古い :-)テクニックを紹介しました。しかし、前回の投稿では2つの問題が残されており、それらを修正する旅は、モダンC++の2つの主要機能、インライン変数とモジュールの優れたツアーとなることが判明しました。

パート1で議論されたテストフレームワークのシンプルさは、すべてが小さなヘッダーファイルtest.h(インクルードガードは省略)に含まれていることに起因します。

namespace {
    std::size_t nPass = 0;
    std::size_t nFail = 0;
    inline void do_fail(const char* text, const char* fileName, long lineNumber) {
        std::cout << "FAILURE: " << text << " in file " << fileName
                  << " on line " << lineNumber << std::endl;
        ++nFail;
    }
    inline void do_test(const char* condText, bool cond, const char* fileName, long lineNumber) {
        if (!cond) 
            do_fail(condText, fileName, lineNumber);
        else
            ++nPass;
    }
    inline void succeed_() noexcept {
        ++nPass;
    }
    inline void report_() {
        std::cout << "\nTest Report:\n\n";
        std::cout << "\tNumber of Passes = " << nPass << std::endl;
        std::cout << "\tNumber of Failures = " << nFail << std::endl;
    }
}

#define test_(cond) do_test(#cond, cond, __FILE__, __LINE__)
#define fail_(expr) do_fail(expr, __FILE__, __LINE__)
#define throw_(expr,T)                      \
    try {                                   \
        expr;                               \
        std::cout << "THROW ";              \
        do_fail(#expr,__FILE__,__LINE__);   \
    } catch (const T&) {                    \
        ++nPass;                            \
    } catch (...) {                         \
        std::cout << "THROW ";              \
        do_fail(#expr,__FILE__,__LINE__);   \
    }

#define nothrow_(expr)                      \
    try {                                   \
        expr;                               \
        ++nPass;                            \
    } catch (...) {                         \
        std::cout << "NOTHROW ";            \
        do_fail(#expr,__FILE__,__LINE__);   \
    }        

一般的に、ユーザーはtest_マクロを呼び出すだけでよく、これはテストされる式をテキストとして、関連するファイル名と行番号と共にキャプチャします。例えば、ソースコードの行が次のようになっている場合:

test_(stk.top() == 1);

プリプロセッサは、コンパイルストリームで次のテキストに置き換えます:

do_test("stk.top() == 1", stk.top() == 1, "tstack.cpp", 17);

これは、ファイル名がtstack.cppであり、そのファイルの17行目で呼び出しが発生したことを示します。テストが失敗した場合、コンソールに次のように表示されます:

FAILURE: stk.top() == 1 in file tstack.cpp on line 17

report_関数は、成功と失敗の数を表示します。例えば:

Test Report:

    Number of Passes = 13
    Number of Failures = 0

他の関数は完全性のために存在しますが、ユーザーが使用することはめったにありません。

この記事では、パート1の最後に特定された2つの問題を修正します。

  1. 匿名名前空間内のカウンターは、個々のファイルごとに固有です。これは、グローバル変数を回避するために意図されたものであり、このフレームワークは単一ファイル学生プロジェクトで使用されることを意図していましたが、不要な制約です。大規模なプロジェクトでは、One Definition Rule(ODR)に違反することなく、すべてのプロジェクトファイル間で成功と失敗の合計カウントを共有する必要があります。
  2. ヘッダーファイルへの依存関係は、C++において長年頭痛の種として認識されてきました。上記の макро は匿名名前空間に含まれるインライン関数を呼び出すため、テスト対象の各ファイルはコードのコピーを独自に持ちます。モジュールは、このような問題を軽減するためにC++20で導入されました。

ここでは макро が依然として必要になるため、可能な限り多くの機能をモジュールに移動するハイブリッドアプローチを採用します。


インライン変数

C++17はinline 変数の概念を導入しました。関数と同様に、inline変数は複数の翻訳単位で定義でき、リンカーはそれらの定義すべてを1つに折りたたむことが要求されます。ルールはインライン関数と同様です。

  • すべての定義は同一でなければなりません(同じトークン、同じ型、同じ初期化子)。
  • 変数はデフォルトで名前空間スコープで外部リンケージを持ちます。
  • すべての翻訳単位で同じオブジェクトであることが保証されます(どこでも同じアドレス)。

ここでの修正は、名前付き名前空間を選択し、nPassとnFailをinlineとして宣言することです。

namespace TestFramework {
    inline std::size_t nPass = 0;
    inline std::size_t nFail = 0;

    // 他の関数も同じ名前空間に配置されます...
    inline void fail...
    inline void test...
    inline void succeed...
    inline void report...

関数はすべてTestFramework名前空間にあるため、do_failをfailに、do_testをtestに名前変更しました。最後の2つの関数から末尾のアンダースコアも削除しました。末尾のアンダースコアは макро のみに保持されます。マクロも関連関数への完全修飾呼び出しを行う必要があります。例:

#define test_(cond) TestFramework::test(#cond, cond, __FILE__, __LINE__)

変数はODRを満たし、グローバル名前空間を汚染しません。これは、ヘッダーオンリーを維持したい場合には良い解決策です。それは簡単でした。


モジュールの移行

モジュールは、機能のパッケージングのための、よりクリーンでモダンなアプローチです。実際、C++20にモジュールがある今、inline変数の必要性はほとんどありません。変数と関数は、独自のモジュールに移動できます。それを行う前に、マクロがまだ必要かどうか、そしてそれらがモジュールとどのように相互作用するかを決定する必要があります。

マクロを使用する主な動機は、テストされる式を文字列としてキャプチャすることでした。これに代わるものはないと知っているので、test_、fail_、throw_、nothrow_のマクロはそのまま残ります。

ファイル名と行番号をキャプチャするために、C++20で導入されたstd::source_locationを使用します。

void test(
    bool cond,
    std::string_view expr,
    const std::source_location& loc = std::source_location::current())
{
    if (cond)
        ++nPass;
    else
        fail(expr, loc);
}

std::source_location::current()がデフォルト引数として現れるため、呼び出しサイトで正しい情報をキャプチャします。(式テキストを受け取るためにstd::string_viewも使用しました。)

マクロはプリプロセッサの遺物であり、モジュールからエクスポートできません。ここでの解決策は、マクロを別のヘッダーファイルに保持し、それらが以前に述べたようにTestFramework名前空間に呼び出すようにすることです。

// test_macros.h: testモジュールのマクロコンパニオン。
// test_ を使用するテストドライバーでこれをインクルードしてください。
// マクロはモジュールからエクスポートできません — このヘッダーはそのギャップを埋めます。
// 作者: Chuck Allison (Creative Commons License, 2001 - 2026)
// このヘッダーはクライアントコードで `import test;` の後に現れる必要があります。

#ifndef TEST_MACROS_H
#define TEST_MACROS_H

#define test_(cond) TestFramework::test(cond, #cond)
#define fail_(msg)  TestFramework::fail(msg)

#define throw_(expr, T)                                         \
    try {                                                       \
        expr;                                                   \
        TestFramework::fail("THROW expected in: " #expr);       \
    } catch (const T&) {                                        \
        ++TestFramework::nPass;                                 \
    } catch (...) {                                             \
        TestFramework::fail("THROW wrong exception: " #expr);   \
    }

#define nothrow_(expr)                                          \
    try {                                                       \
        expr;                                                   \
        ++TestFramework::nPass;                                 \
    } catch (...) {                                             \
        TestFramework::fail("NOTHROW expected: " #expr);        \
    }

#define report_() TestFramework::report()      // 一貫性のために

#endif

現在の慣習に従い、変数と関数をtest.cppmという名前のtestという名前のモジュールに移動します。

// test.cppm: シンプルで効果的な自動テストのスキャフォールディング
// C++20モジュールバージョン。stdとstd::source_locationを使用。
// マクロはコンパニオンヘッダー test_macros.h にあります(モジュールはマクロをエクスポートできません)。
// 作者: Chuck Allison (Creative Commons License, 2001 - 2026)

export module test;

import std;

export namespace TestFramework {
    std::size_t nPass = 0;
    std::size_t nFail = 0;

    void fail(
        std::string_view msg,
        const std::source_location& loc = std::source_location::current())
    {
        std::cout << "FAILURE: " << msg
                  << " in file " << loc.file_name()
                  << " on line " << loc.line()
                  << " in function " << loc.function_name() << '\n';
        ++nFail;
    }

    void test(
        bool cond,
        std::string_view expr,
        const std::source_location& loc = std::source_location::current())
    {
        if (cond)
            ++nPass;
        else
            fail(expr, loc);
    }

    void succeed() {
        ++nPass;
    }

    void report() {
        std::cout << "\nTest Report:\n\n"
                  << "\tNumber of Passes = " << nPass << '\n'
                  << "\tNumber of Failures = " << nFail << '\n';
    }
}

TestFramework名前空間も明示的にエクスポートする必要があることに注意してください。

モジュールが独自のモジュールにすべて配置されたので、inlineキーワードはもはや必要ありません。しかし、このモジュールを使用するには、test_macros.hヘッダーをインクルードする前に testモジュールをインポートする必要があります。これにより、TestFramework名前空間がマクロから見えるようになります。以下は、testモジュールを使用するように書き直されたパート1のStackテスト例です。(Stackクラスもモジュール化しました。)

// tstack.cpp: Stack<T> のテストドライバー
// C++20モジュールバージョン。

import stack;
import std;
import test;
#include "test_macros.h"

int main() {
    Stack<int> stk;

    test_(stk.size() == 0);

    // 例外のテスト(空のスタックでは top と pop は無効)
    throw_(stk.top(), std::underflow_error);
    throw_(stk.pop(), std::underflow_error);
    nothrow_(stk.size());

    // push と top のテスト
    stk.push(1);
    test_(stk.top() == 1);
    test_(stk.size() == 1);
    stk.push(2);
    test_(stk.top() == 2);
    test_(stk.size() == 2);

    // pop のテスト
    stk.pop();
    test_(stk.top() == 1);
    test_(stk.size() == 1);
    stk.pop();
    test_(stk.size() == 0);
    throw_(stk.top(), std::underflow_error);
    throw_(stk.pop(), std::underflow_error);

    report_();
}

クライアントコードでの唯一の違いは、importの使用と、インポートの後にヘッダーファイルをインクルードすることです。


実際にどちらを使うべきか?

スコアをつけているなら:どちらのバージョンも、このシリーズを開始したODRバグを修正します。インライン変数修正は、キーワードを1つ追加するだけで、std=c++17が動作するすべての場所で動作します — モジュールの依存関係スキャナーなし、BMIの心配なし、学生に課題の締め切り前に夜11時に説明する必要のあるコンパイル順序の落とし穴なし。C++20が利用可能であれば、__FILE__と__LINE__をstd::source_locationに置き換えて、ヘッダーオンリーのままでいることもできます。

モジュールバージョンは、真のカプセル化(単なる丁寧な名前空間ではなく)を提供し、すべての翻訳単位でヘッダーを再解析するのをスキップしますが、2つのファイルを管理し、インポート・アット・ハッシュ・インクルードの順序を正しく行うことを要求します。これは、Visual C++以外ではまだ開発途上のツールチェーンの話です。

私の推奨:コースワークや、今日どこでも、どんなものでもビルドする必要があるものには、ヘッダーオンリーバージョンをデフォルトにしてください。ビルド環境が本当に堅牢なモジュールのサポートを得て、実際に強力な境界を望むようになったら、モジュールバージョンに手を伸ばすことを検討してください — エコシステムが言語に追いつくまで、それを毎日のドライバーではなく、目的地として扱ってください。モジュール・ハッシュ・インクルードのハイブリッドアプローチは、今後長い間現実となるでしょう。


(注:このコードは、Visual Studio 2026 Community EditionのVisual C++で開発されました。コードはこちらからダウンロードできます。この投稿の以前のドラフトに関するBjarne Stroustrup氏の有益なコメントに感謝いたします。)