BZR リポジトリを使用するテストを自動化する： CTEST_BZR_COMMAND とその他の方法の比較

CMake の Variables に関連する CTEST_BZR_COMMAND のプログラミング解説

概要

• CTEST_BZR_COMMAND は、BZR リポジトリのテストを自動化する際に役立ちます。
• テストケースの実行前後に、BZR コマンドを実行することができます。
• コマンドラインは、BZR のバージョンや環境設定によって異なります。

設定方法

CTEST_BZR_COMMAND は、CMakeLists.txt ファイル内で設定できます。

set(CTEST_BZR_COMMAND "bzr")

上記のように設定すると、bzr コマンドがそのまま実行されます。

コマンドラインオプション

CTEST_BZR_COMMAND は、BZR コマンドのオプションを指定することができます。

set(CTEST_BZR_COMMAND "bzr update --verbose")

上記のように設定すると、bzr update コマンドが --verbose オプション付きで実行されます。

使用例

CTEST_BZR_COMMAND は、様々なテストケースで使用できます。

例 1: テストケースの実行前に BZR リポジトリを更新する

set(CTEST_BZR_COMMAND "bzr update")

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

上記のように設定すると、MyTest テストケースが実行される前に、bzr update コマンドが実行され、BZR リポジトリが最新の状態に更新されます。

例 2: テストケースの実行後に BZR リポジトリをコミットする

set(CTEST_BZR_COMMAND "bzr commit -m \"Test results\"")

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

上記のように設定すると、MyTest テストケースが実行された後、bzr commit コマンドが実行され、テスト結果が BZR リポジトリにコミットされます。

補足

• CTEST_BZR_COMMAND は、BZR リポジトリを使用するプロジェクトでのみ使用できます。
• CTEST_BZR_COMMAND は、CMake 3.10 以降で利用可能です。

CTEST_BZR_COMMAND のサンプルコード

サンプル 1: テストケースの実行前に BZR リポジトリを更新する

set(CTEST_BZR_COMMAND "bzr update")

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

このサンプルコードでは、MyTest テストケースが実行される前に、bzr update コマンドが実行され、BZR リポジトリが最新の状態に更新されます。

サンプル 2: テストケースの実行後に BZR リポジトリをコミットする

set(CTEST_BZR_COMMAND "bzr commit -m \"Test results\"")

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

このサンプルコードでは、MyTest テストケースが実行された後、bzr commit コマンドが実行され、テスト結果が BZR リポジトリにコミットされます。

サンプル 3: テストケースごとに異なる BZR コマンドを実行する

set(CTEST_TEST_BZR_COMMANDS
  "MyTest1: bzr update"
  "MyTest2: bzr commit -m \"Test results\"")

add_test(NAME "MyTest1"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

add_test(NAME "MyTest2"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

このサンプルコードでは、MyTest1 テストケースの前には bzr update コマンドが実行され、MyTest2 テストケースの後には bzr commit コマンドが実行されます。

サンプル 4: BZR コマンドの出力を取り込む

set(CTEST_BZR_COMMAND "bzr log --short")

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")
  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})

set(CTEST_TEST_BZR_OUTPUT_ON_FAILURE "TRUE")

このサンプルコードでは、MyTest テストケースが実行された後、bzr log --short コマンドの出力が出力されます。テストケースが失敗した場合、出力はテスト結果に含まれます。

サンプル 5: BZR コマンドの実行を条件付きで実行する

if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.bzr)
  set(CTEST_BZR_COMMAND "bzr update")
endif()

add_test(NAME "MyTest"
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

このサンプルコードでは、MyTest テストケースが実行される前に、`

CTEST_BZR_COMMAND の代替方法

BZR コマンドを直接実行する

CTEST_BZR_COMMAND を使用せずに、テストケース内で直接 BZR コマンドを実行することができます。

add_test(NAME "MyTest"
  COMMAND bzr update
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

CMake の Custom Command を使用して、BZR コマンドを実行するカスタムテストを作成することができます。

add_custom_command(TARGET MyTest
  COMMAND bzr update
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

add_test(NAME MyTest
  COMMAND ${CMAKE_COMMAND} -E echo "Hello, world!")

Python スクリプトを使用して、BZR コマンドを実行し、テスト結果を処理することができます。

import bzr

def test_my_test():
  bzr.update()
  print("Hello, world!")

if __name__ == "__main__":
  test_my_test()

BZR テストツールを使用する

BZR には、bzr test コマンドなどのテストツールが付属しています。これらのツールを使用して、テストケースを実行することができます。

bzr test

どの方法を選択するべきかは、プロジェクトのニーズと要件によって異なります。

• CTEST_BZR_COMMAND は、BZR リポジトリを使用するテストを自動化する最も簡単な方法です。
• BZR コマンドを直接実行する方法は、最も柔軟な方法ですが、最も複雑な方法でもあります。
• CMake の Custom Command は、BZR コマンドと CMake のテストフレームワークを統合する便利な方法です。
• Python スクリプトは、複雑なテストロジックを実装する必要がある場合に役立ちます。
• BZR テストツールは、BZR リポジトリに付属のツールを使用してテストを実行したい場合に役立ちます。