Tough Day

Tough Day 2 について

「Tough Day 2」は、AEM インスタンスの限界についてストレステストを実行するためのアプリケーションです。Tough Day 2 は、デフォルトのテストスイートを使用してそのまま実行することも、テストのニーズに合わせて設定することも可能です。このアプリケーションのプレゼンテーションについては、こちらの録画を参照してください。

注意

Tough Day 2 には Java 8 が必要です。

Tough Day 2 の実行方法

アドビのリポジトリから最新バージョンの Tough Day 2 をダウンロードします。アプリケーションをダウンロードしたら、host パラメーターを指定することでアプリケーションをそのまま実行できます。次の例では、AEM インスタンスがローカルで実行されているので、値 localhost が使用されています。

java -jar toughday2.jar --host=localhost

パラメーターを追加した後に実行されるデフォルトスイートの名前は toughday です。このスイートには次のユースケースが含まれています。

  • ページとそのページのライブコピーを作成する(ロールアウトを含む)
  • ホームページを取得する
  • querybuilder でクエリを実行する
  • アセット階層を作成する
  • アセットの削除

このスイートには、15 %の書き込みアクションと 85 %の読み取りアクションが含まれています。

スイートのテストを実行するために、Tough Day 2 によってデフォルトのコンテンツパッケージがインストールされます。この動作はinstallsamplecontentパラメーターをfalseに設定することで回避できます。ただし、実行するテストのデフォルトパスを変更することも必要になります。パラメーターを指定せずに jar を実行した場合は、Tough Day 2 でヘルプ情報が表示されます。

原則として、アプリケーションを使用するには、次のパターンに従います。

java -jar toughday2.jar [--help | --help_full | --help_tests | --help_publish]  [<global arguments> | <actions> | --runmode | --publishmode]
メモ

Tough Day 2 にはクリーンアップステップが用意されていません。したがって、メインの実稼動インスタンスではなく、クローンされたステージングインスタンスで Tough Day 2 を実行することをお勧めします。ステージングインスタンスは、テスト後に削除する必要があります。

ヘルプの入手

Tough Day 2 には、コマンドラインからアクセスできる幅広いヘルプオプションが用意されています。次に例を示します。

java -jar toughday2.jar --help_full

以下の表に、関連するヘルプパラメーターを示します。

パラメーター 説明
--help グローバルな情報を出力します。例えば、利用可能なアクション、事前定義済みスイート、実行モード、グローバルパラメーターなどです。
--help_publish 利用可能なすべてのパブリッシャーを出力します。
--help_tests テストクラスとその説明を出力します。
--help_full 上記のすべてを出力し、さらに、テスト、パブリッシャー、スイートコンポーネントを出力します。
--help --runmode/publishmode type=<Mode> 指定した実行またはパブリッシュモードに関する情報を一覧表示します。

java -jar toughday2.jar --help --runmode type=constantload

java -jar toughday2.jar --help --publishmode type=intervals

--help --suite=<SuiteName> 特定のスイートのすべてのテストと、それぞれの設定可能なプロパティを一覧表示します。
java -jar toughday2.jar --help --suite=get_tests
--help --tag=<Tag>
指定したタグを持つすべての項目を一覧表示します。
java -jar toughday2.jar --help --tag=publish
--help <TestClass/PublisherClass>
特定のテストまたはパブリッシャーの設定可能なプロパティをすべて一覧表示します。

java -jar toughday2.jar --help UploadPDFTest

java -jar toughday2.jar --help CSVPublisher

グローバルパラメーター

Tough Day 2 には、テストの環境を設定または変更するグローバルパラメーターが用意されています。これには、ターゲットのホスト、ポート番号、使用されるプロトコル、インスタンスのユーザーとパスワードなどが含まれます。次に例を示します。

java -jar toughday2.jar --host=host --protocol=https --port=4502 --duration=30m --dryrun=true

以下のリストには、関連のあるパラメーターがあります。

パラメーター 説明 デフォルト値 可能な値
--installsamplecontent=<Val> デフォルトの Tough Day 2 コンテンツパッケージをインストールまたはスキップします。 true true または false
--protocol=<Val> ホストに使用するプロトコル。 http http または https
--host=<Val> ターゲットにするホスト名または IP。
--port=<Val> ホストのポート。 4502
--user=<Val> インスタンスのユーザー名。 admin
--password=<Val> 指定されたユーザーのパスワード。 admin
--duration=<Val> テストの期間。()単位、()単位、()単位、()単位で表現できます。 1d
--timeout=<Val> テストが中断され、失敗としてマークされるまでのテストの実行時間。秒単位で表現できます。 180
--suite=<Val> 値は、事前定義済みのテストスイートの 1 つまたはリスト(コンマ区切り)にすることができます。 toughday
--configfile=<Val> ターゲットの yaml 設定ファイル。
--contextpath=<Val> インスタンスのコンテキストパス。
--loglevel=<Val> Tough Day 2 エンジンのログレベル。 INFO ALL、DEBUG、INFO、WARN、ERROR、FATAL、OFF
--dryrun=<Val> true の場合は、結果の設定が出力され、テストは実行されません。 false true または false

カスタマイズ

カスタマイズの方法には、コマンドラインパラメーターを使用する方法と yaml 設定ファイルを使用する方法の 2 つがあります。通常、設定ファイルは大規模なカスタムスイートに使用します。設定ファイルは、Tough Day 2 のデフォルトパラメーターよりも優先されます。コマンドラインパラメーターは、設定ファイルとデフォルトパラメーターの両方よりも優先されます。

テスト設定を保存するには、yaml 形式でコピーする方法しかありません。

新規テストの追加

デフォルトの toughday スイートを使用しない場合は、add パラメーターを使用して任意のテストを追加できます。コマンドラインパラメーターまたは yaml 設定ファイルを使用して CreateAssetTreeTest テストを追加する方法を以下の例に示します。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
tests:
  - add : CreateAssetTreeTest

同じテストの複数のインスタンスの追加

同じテストの複数のインスタンスを追加して実行することもできますが、そのためにはそれぞれのインスタンスに一意の名前を付ける必要があります。コマンドラインパラメーターまたは yaml 設定ファイルを使用して同じテストの 2 つのインスタンスを追加する方法を以下の例に示します。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest name=FirstAssetTree --add CreateAssetTreeTest name=SecondAssetTree

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
tests:
  - add : CreateAssetTreeTest
    properties:
      name : FirstAssetTree
  - add : CreateAssetTreeTest
    properties:
      name : SecondAssetTree

テストプロパティの変更

1 つ以上のテストプロパティを変更する必要がある場合は、そのプロパティをコマンドラインまたは yaml 設定ファイルに追加できます。使用可能なすべてのテストプロパティを表示するには、コマンドラインに --help <TestClass/PublisherClass> パラメーターを追加してください。次に例を示します。

java -jar toughday2.jar --help CreatePageTreeTest

yaml 設定ファイルによって Tough Day 2 のデフォルトのパラメーターが上書きされるので、コマンドラインパラメーターは設定ファイルとデフォルトの両方よりも優先されることに注意してください。

コマンドラインパラメーターまたは yaml 設定ファイルを使用して CreatePageTreeTest テストの template プロパティを変更する方法を以下の例に示します。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --add CreatePageTreeTest template=/conf/toughday-templates/settings/wcm/templates/toughday-template

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
tests:
  - add : CreatePageTreeTest
    properties:
      template : /conf/toughday-templates/settings/wcm/templates/toughday-template

事前定義済みのテストスイートの使用

事前定義済みのスイートにテストを追加する方法、事前定義済みのスイートの既存のテストを再設定および除外する方法を以下の例に示します。

事前定義済みのスイートに新しいテストを追加するには、add パラメーターを使用して、ターゲットとなる事前定義済みのスイートを指定します。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --suite=toughday --add CreatePageTreeTest

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
  suite : toughday
tests:
  - add : CreatePageTreeTest

また、特定のスイート内の既存のテストは、config* *パラメーターを使用して再設定することもできます。スイート名とテストの実際の名前(テストクラス名ではありません)も指定する必要があることに注意してください。テスト名は、テストクラスの name プロパティで確認できます。テストプロパティの確認方法について詳しくは、テストプロパティの変更を参照してください。

以下の例では0、CreatePageTreeTest のデフォルトのアセットタイトル(名前は UploadAsset)を「NewAsset」に変更しています。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --suite=toughday --config UploadAsset title=NewAsset

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
  suite : toughday
tests:
  - config : UploadAsset
    properties :
      title : NewAsset

さらに、exclude パラメーターを使用して、事前定義済みのスイートからテストを削除したり、デフォルトの設定から公開者を削除したりできます。スイート名とテストの実際の名前(テスト C lass 名ではありません)も指定する必要があることに注意してください。テスト名は、テストクラスの name プロパティで確認できます。以下の例では、(UploadAsset という名前の)CreatePageTreeTest テストを toughday スイートから削除しています。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --suite=toughday --exclude UploadAsset

yaml 設定ファイルを使用する場合:

globals:
  host : localhost
  suite : toughday
tests:
  - exclude : UploadAsset

実行モード

Tough Day 2 は、標準​モードと​定負荷​モードのいずれかで実行できます。

標準​実行モードには、次の 2 つのパラメーターがあります。

  • concurrency - テストの実行のために Tough Day 2 によって作成されるスレッドの数を表します。これらのスレッドでは、実行時間が終了するか、実行するテストがなくなるまでテストが実行されます。

  • waittime - 同じスレッド上の連続した 2 つのテスト実行の間の待機時間。この値はミリ秒単位で指定する必要があります。

次の例は、コマンドラインを使用してパラメーターを追加する方法を示しています。

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest --runmode=normal concurrency=20

または、yaml 設定ファイルを使用してパラメーターを追加する方法もあります。

runmode:
  type : normal
  waittime : 300
  concurrency : 200

定負荷​実行モードは、通常実行モードとは異なり、一定数のスレッドではなく一定数の開始されたテスト実行を生成します。同じ名前の実行モードパラメーターを使用して負荷を設定できます。

テストの選択

テストの選択プロセスはどちらの実行モードでも同じで、次のように進みます。すべてのテストには weight プロパティがあり、これによって、スレッドでの実行の可能性が決定します。例えば、テストが 2 つあり、一方の重みを 5、もう一方の重みを 10 とした場合、後者が実行される可能性は前者の 2 倍になります。

さらに、テストには count プロパティを指定できます。これにより、実行回数が指定の数に制限されます。この回数に達すると、それ以上テストは実行されません。既に実行中のテストインスタンスはすべて、設定されたとおりに実行を終了します。次の例は、コマンドラインまたは yaml 設定ファイルを使用してこれらのパラメーターを追加する方法を示しています。

java -jar toughday2.jar --host=localhost --add CreateAssetTreeTest weight=5 --add CreatePageTreeTest weight=10 count=100 --runmode=normal concurrency=20

または

- add : CreateAssetTreeTest
    properties :
      name : UploadAsset
      weight : 5
      base : 3
      foldertitle : IAmAFolder
      assettitle : IAmAnAsset
      count : 100
メモ

並列実行が原因で、実際のテスト実行回数は count パラメーターで設定された数と正確に一致しません。偏差が(concurrency parameter パラメーターによって制御される)実行スレッドの数に比例することを想定してください。

ドライラン

ドライランでは、指定されたすべての入力(コマンドラインパラメーターまたは設定ファイル)が解析され、デフォルト値と統合された結果が出力されます。テストは実行されません。

java -jar toughday2.jar --host=localhost --suite=toughday --add CreatePageTreeTest --dryrun=true

出力

Tough Day 2 では、テストの指標とログの両方が出力されます。詳しくは、これ以降の項を参照してください。

テスト指標

現在、Tough Day 2 では、ユーザーが評価できる 9 種類のテスト指標が報告されます。* 記号が付いた指標は、実行に成功した後にのみ報告されます。

名前 説明
Timestamp 最後に完了したテスト実行のタイムスタンプ。
渡された 成功した実行の数。
失敗 失敗した実行の数。
Min* テスト実行の最短期間。
Max* テスト実行の最長期間。
Median* すべてのテスト実行の算出された中央値時間。
平均* すべてのテスト実行の算出された平均時間。
StdDev* 標準偏差。
90p* 90 パーセンタイル。
99p* 99 パーセンタイル。
99.9p* 99.9 パーセンタイル。
実際のスループット* 実行数を経過した実行時間で割った値。

これらの指標は、(テストの追加と同様に)add パラメーターを使用して追加できる公開者を利用して記述されています。現在、次の 2 つのオプションがあります。

  • CSVPublisher - CSV ファイルを出力します。
  • ConsolePublisher - 出力はコンソールに表示されます。

デフォルトでは、両方の公開者が有効になっています。

さらに、指標の報告には次の 2 つのモードがあります。

  • simple パブリッシュモード - 実行の開始から公開時点までの結果が報告されます。
  • intervals パブリッシュモード - 特定の期間内の結果が報告されます。期間は、interval パブリッシュモード/パラメーターを使用して設定することができます。

次の例は、コマンドラインまたは yaml 設定ファイルを使用して intervals パラメーターを設定する方法を示しています。

コマンドラインパラメーターを使用する場合:

java -jar toughday2.jar --host=localhost --add CreatePageTreeTest --publishmode type=intervals interval=10s

yaml 設定ファイルを使用する場合:

publishmode:
     type : intervals
     interval : 10s
     tests:
        -add : CreatePageTreeTest

ログ

Tough Day 2 では、Tough Day 2 を実行したディレクトリにログフォルダーが作成されます。このフォルダーには次の 2 種類のログが格納されます。

  • toughday.log:アプリケーションの状態に関連したメッセージ、デバッグ情報およびグローバルメッセージが格納されます。
  • toughday_<testname>.log:指定したテストに関連するメッセージ。

ログは上書きされません。その後の実行では、既存のログにメッセージが追加されます。ログには複数のレベルがあります。詳しくは、 [loglevel parameter](/docs/experience-manager-65/developing/testing/tough-day.md#global-parameters)を参照してください。

このページ