Tough Day

Tough Day 2 について

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

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=<タグ>
指定したタグを持つすべての項目をリストします。
java -jar toughday2.jar —help —tag=publish
—help <TestClass/PublisherClass>
特定のテストまたはパブリッシャーの設定可能なプロパティをすべてリストします。

java -jar toughday2.jar —help PDFTestのアップロード

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> テストの期間。 (s)秒、(m)分、(h)時間、(d)日で表現できます。 1d
--timeout=<Val> テストが中断され、失敗とマークされるまでの期間。 秒単位で表現できます。 180
--suite=<Val> 値は、事前定義済みのテストスイートの1つまたは(コンマ区切りの)リストにすることができます。 厳しい
--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.yamlの設定と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 プロパティで確認できます。テストプロパティの確認方法について詳しくは、テストプロパティの変更を参照してください。

以下の例では、CreatePageTreeTestUploadAssetという名前)のデフォルトのアセットタイトルが「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プロパティにあります。 次の例では、 CreatePageTreeTestUploadAssetという名前)テストが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 - 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 種類のテスト指標が報告されます。*​記号を含む指標は、正常に実行された後にのみレポートされます。

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

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

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

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

さらに、指標がレポートされるモードは2つあります。

  • シンプルな​公開モード — 実行の開始から公開時点までの結果をレポートします。
  • 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/sites-developing/tough-day.md#global-parameters)を参照してください。

使用例

既知の問題

ファイルを入手

このページ