obd.shを使用してmysqltestを実行する

obd.shを使用してmysqltestテストを実行するには、obd.shでデプロイされたOceanBaseデータベースが必要です。本記事では、コンパイル済みソースコードから始めて、obd.shを使用してOceanBaseデータベースをデプロイし、mysqltestテストを実行する方法を例を交えて紹介します。

背景

開発者の操作手順を簡素化し、理解コストを低減するため、obdの一部のコマンドをobd.shスクリプトにカプセル化し、このスクリプトをOceanBaseソースコードのoceanbase/tools/deployディレクトリに配置しています。本記事で実行されるmysqltestテストは、obdのobd test mysqltestコマンドを呼び出しています。

概念

mysqltestは、OceanBaseデータベースのアクセステストにおける一つのテストです。簡単に言えば、作成されたcaseファイルを入力として使用し、データベースの出力と期待される出力を比較します。OceanBaseデータベースにおけるmysqltestテストのcaseはすべて、OceanBaseソースコードの oceanbase/tools/deploy/mysql_test ディレクトリに配置されています。

caseはmysqltestの最小実行単位であり、一つのcaseには少なくとも一つのテストファイルと一つの結果ファイルが含まれます。caseを分類することでsuiteが形成され、suiteは一連のcaseの集合です。

mysqltestテストの実行時には、選択したノードに応じて異なるモードに分かれます。一般的なmysqltestモードは以下のとおりです。

• cモード：Primary Zoneが存在するノードに接続してmysqltestを実行します。例えば、設定ファイルdistributed.yamlを使用してクラスタをデプロイした後、server1ノードからOceanBaseクラスタに接続してテストを実行します。

  ./obd.sh mysqltest -n <name> --suite acs --test-server=server1
  

• slaveモード：Primary Zoneが存在しないノードに接続してmysqltestを実行します。例えば、設定ファイルdistributed.yamlを使用してクラスタをデプロイした後、server2ノードからOceanBaseクラスタに接続してテストを実行します。

  ./obd.sh mysqltest -n <name> --suite acs --test-server=server2
  

• proxyモード：ODPを介してクラスタに接続し、mysqltestテストを実行します。例えば、設定ファイルdistributed-with-proxy.yamlを使用してクラスタをデプロイした後にテストを実行します。

  ./obd.sh mysqltest -n <name> --all
  

手順

本記事では、x86アーキテクチャのCentOS Linux 7.9を環境として操作方法を紹介しますが、参考用です。詳細なコンパイルおよびデプロイの手順については、OceanBaseのGitHubリポジトリを参照してください。

ステップ１：OceanBaseデータベースのソースコードをコンパイルする

1. OceanBaseのソースコードをダウンロードします。

   [admin@obtest ~]$ git clone https://github.com/oceanbase/oceanbase.git
   

2. オペレーティングシステムに応じて依存パッケージを準備します。

   [admin@obtest ~]$ sudo yum install git wget rpm* cpio make glibc-devel glibc-headers binutils m4
   

3. コンパイルします。

   [admin@obtest ~]$ cd oceanbase
   [admin@obtest oceanbase]$ bash build.sh release --init --make
   

ステップ2：コンパイル済みのOceanBaseファイルをデプロイする

1. 設定ファイルの準備

   [admin@obtest ~]$ sudo yum install -y yum-utils
   [admin@obtest ~]$ sudo yum-config-manager --add-repo https://mirrors.aliyun.com/oceanbase/OceanBase.repo
   [admin@obtest ~]$ sudo yum install -y libtool libaio obclient
   [admin@obtest ~]$ cd oceanbase/tools/deploy
   [admin@obtest deploy]$ ./obd.sh prepare
   

   obd.sh prepare コマンドは、コンパイルディレクトリ（例：build_release）からバイナリファイルをコピーしてイメージを作成し、現在の環境情報に基づいてデフォルト設定ファイルを生成します。複数のコンパイルディレクトリが存在する場合、このコマンドはデフォルトで最初のものを選択します。

   デプロイ時には、生成されたデフォルト設定ファイルを使用するか、GitHubリポジトリから他のサンプル設定ファイルをダウンロードして変更して使用することができます。mysqltestのテストモードに応じて対応する設定ファイルを選択する必要があります。詳細は以下の通りです。

   説明

   mysqltestのテストモードについては、上記の概念紹介を参照してください。

   • Cモードでmysqltestテストを実行する場合は、任意の設定ファイルを使用してデプロイできます。

   • スレーブモードでmysqltestテストを実行する場合は、distributed.yamlまたはdistributed-with-proxy.yaml設定ファイルを使用して2ノードクラスタをデプロイする必要があります。

   • プロキシモードでmysqltestテストを実行する場合は、distributed-with-proxy.yaml設定ファイルを使用してOceanBase + ODPクラスタをデプロイする必要があります。

2. （オプション）設定ファイルの変更

   ポートやディレクトリなどの情報を変更する必要がある場合は、以下のコマンドで設定ファイルを開いて変更できます。

   [admin@obtest deploy]$ vim distributed-with-proxy.yaml
   

   注目すべきパラメータは以下の表のとおりです。

   パラメータ	必須	説明
   servers	必須	各マシンは - name: マシン識別子 (改行)ip: マシンIP の形式で指定する必要があります。複数のマシンがある場合は、同様に複数回指定します。マシン識別子は重複してはなりません。 マシンIPが重複しない場合は、- <ip> （改行）- <ip> の形式でも指定できます。この場合、- <ip> の形式は - name: マシンIP（改行）ip: マシンIP と同等です。
   mysql_port	必須	SQLサービスプロトコルのポート番号を設定します。
   rpc_port	必須	リモートアクセスプロトコルのポート番号を設定します。これは、observerプロセスと他ノードのプロセス間のRPC通信ポートです。
   home_path	必須	コンポーネントのインストールパス。
   production_mode	必須	本番モードパラメータです。有効にすると、サーバーリソースが本番環境での使用を満たしているかどうかチェックされます。テストシナリオでは無効の方が推奨されます。無効の場合、デプロイが失敗する可能性があります。
   devname	オプション	servers で指定したIPに対応するNICです。IPとNICの対応関係は ip addr コマンドで確認できます。
   listen_port	必須	ODPリスニングポート。
   prometheus_listen_port	必須	ODP prometheusリスニングポート。

3. OceanBaseデータベースのデプロイ

   [admin@obtest deploy]$ ./obd.sh deploy -c distributed-with-proxy.yaml -n test
   

   ここでは、-cはデプロイに必要な設定ファイルのパスを指定するために使用されます。ここではdistributed-with-proxy.yamlを例に示します。-nはデプロイするクラスタ名を指定するために使用されます。ここではtestを例に示します。

ステップ3：mysqltestテストの実行

フルテストを実行するか、特定のcaseまたはsuiteを指定してテストを実行できます。

• フルテストとは、mysql_test/test_suiteディレクトリ内のすべてのsuiteを実行することです。以下のコマンドを参照してください。

  [admin@obtest ~]$ cd oceanbase/tools/deploy
  [admin@obtest deploy]$ ./obd.sh mysqltest -n test --all
  

• 特定のcaseを指定してテストを実行します。例えば、mysql_test/test_suite/alter/t/alter_log_archive_option.test を指定する場合、以下のコマンドを参照してください。

  [admin@obtest ~]$ cd oceanbase/tools/deploy
  [admin@obtest deploy]$ ./obd.sh mysqltest -n test --test-dir ./mysql_test/test_suite/alter/t --result-dir ./mysql_test/test_suite/alter/r --test-set alter_log_archive_option
  

• suiteを指定してテストを実行します。例えば、mysql_test/test_suiteディレクトリ内の特定のsuiteに対してテストを実行する場合、以下のコマンドを参照してください。

  [admin@obtest ~]$ cd oceanbase/tools/deploy
  [admin@obtest deploy]$ ./obd.sh mysqltest -n test --suite acs
  

付録

mysqltestテストを実行する際には、実際の状況に応じていくつかのパラメータを設定できます。各パラメータの説明は以下の表のとおりです。