クラス BrokerRunningSupport
java.lang.ObjectSE
org.springframework.amqp.rabbit.junit.BrokerRunningSupport
Rabbit ブローカーアプリケーションが実行されていないかアクセスできない場合に統合テストが失敗するのを防ぐために使用できるクラス。Rabbit ブローカーがバックグラウンドで実行されていない場合、ここでのすべてのテストは、前提条件に違反しているため (デフォルトで) 単純にスキップされます (成功として表示されます)。
CI サーバーなどでブローカーを強制的に使用可能にしたい場合は、環境変数 "RABBITMQ_SERVER_REQUIRED" を true
に設定すると、テストはすぐに失敗します。
- 導入:
- 2.2
- 作成者:
- Dave Syer, Gary Russell
ネストされたクラスのサマリー
フィールドサマリー
メソッドのサマリー
修飾子と型メソッド説明static void
setEnvironmentVariableOverrides(Map)
で設定された環境変数オーバーライドをすべてクリアします。void
deleteExchanges
(StringSE... exchanges) ブローカーから任意の取引所を削除します。void
deleteQueues
(StringSE... queuesToDelete) ブローカーから任意のキューを削除します。static boolean
fatal()
ルールの接続ファクトリで使用される接続の接続 ID を生成します。管理者パスワードを返します。管理 uri を返します。管理者ユーザーを返します。com.rabbitmq.client.ConnectionFactory
このルールで使用される接続ファクトリを取得します。ポートを返します。パスワードを返します。int
getPort()
ポートを返します。getUser()
ユーザーを返します。static BrokerRunningSupport
static BrokerRunningSupport
static BrokerRunningSupport
boolean
static BrokerRunningSupport
static BrokerRunningSupport
isRunningWithEmptyQueues
(StringSE... names) ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。void
構成されたすべてのキューを削除して再宣言します。void
removeExchanges
(StringSE... exchanges) ブローカーから取引所を削除します。void
removeTestQueues
(StringSE... additionalQueues) isRunningWithEmptyQueues(String...)
メソッドによって作成されたテストキューをすべて削除します。void
setAdminPassword
(StringSE password) 管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。void
setAdminUri
(StringSE adminUri) REST API の uri を設定します。void
setAdminUser
(StringSE user) 管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。static void
setEnvironmentVariableOverrides
(MapSE<StringSE, StringSE> environmentVariables) ホスト、ポートなどの環境変数のオーバーライドを設定します。void
setHostName
(StringSE hostName) void
setPassword
(StringSE password) amqp 接続のデフォルト "guest" のパスワードを設定します。void
setPort
(int port) void
setPurgeAfterEach
(boolean purgeAfterEach) 各テストの後にテストキューをパージします (JUnit 5)。void
amqp 接続のデフォルト「ゲスト」のユーザーを設定します。void
test()
ブローカーへの接続を確認し、キューを作成します。
フィールドの詳細
メソッドの詳細
setEnvironmentVariableOverrides
ホスト、ポートなどの環境変数のオーバーライドを設定します。存在する場合、実際の環境変数をオーバーライドします。変数は、このメソッドが呼び出された後に作成されたルールインスタンスにのみ適用されます。オーバーライド
- パラメーター:
environmentVariables
- 変数。
clearEnvironmentVariableOverrides
public static void clearEnvironmentVariableOverrides()setEnvironmentVariableOverrides(Map)
で設定された環境変数オーバーライドをすべてクリアします。isRunningWithEmptyQueues
ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。- パラメーター:
names
- テストのために宣言するキュー。- 戻り値:
- 既存の実行中のブローカーを想定する新しいルール
isRunning
- 戻り値:
- 既存の実行中のブローカーを想定する新しいルール
isNotRunning
- 戻り値:
- 既存のブローカーが存在しないことを前提とする新しいルール
isBrokerAndManagementRunning
- 戻り値:
- 管理プラグインを備えた既存のブローカーを想定する新しいルール
isBrokerAndManagementRunningWithEmptyQueues
- パラメーター:
queues
- キュー。- 戻り値:
- 提供されたキューが宣言された (必要に応じて空にされた) 管理プラグインを備えた既存のブローカーを想定する新しいルール。
setPort
public void setPort(int port) - パラメーター:
port
- 設定するポート
setHostName
- パラメーター:
hostName
- 設定するホスト名
setUser
amqp 接続のデフォルト「ゲスト」のユーザーを設定します。- パラメーター:
user
- ユーザー。
setPassword
amqp 接続のデフォルト "guest" のパスワードを設定します。- パラメーター:
password
- パスワード。
setAdminUri
REST API の uri を設定します。- パラメーター:
adminUri
- uri。
setAdminUser
管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。- パラメーター:
user
- ユーザー。
setAdminPassword
管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。- パラメーター:
password
- パスワード。
getPort
public int getPort()ポートを返します。- 戻り値:
- ポート。
getHostName
ポートを返します。- 戻り値:
- ポート。
getUser
ユーザーを返します。- 戻り値:
- ユーザー。
getPassword
パスワードを返します。- 戻り値:
- パスワード。
getAdminUser
管理者ユーザーを返します。- 戻り値:
- ユーザー。
getAdminPassword
管理者パスワードを返します。- 戻り値:
- パスワード。
isPurgeAfterEach
public boolean isPurgeAfterEach()setPurgeAfterEach
public void setPurgeAfterEach(boolean purgeAfterEach) 各テストの後にテストキューをパージします (JUnit 5)。- パラメーター:
purgeAfterEach
- パージする場合は true。
test
ブローカーへの接続を確認し、キューを作成します。- 例外:
BrokerRunningSupport.BrokerNotAliveException
- ブローカーが利用できない場合。
fatal
public static boolean fatal()generateId
ルールの接続ファクトリで使用される接続の接続 ID を生成します。- 戻り値:
- ID。
removeTestQueues
isRunningWithEmptyQueues(String...)
メソッドによって作成されたテストキューをすべて削除します。- パラメーター:
additionalQueues
- テストによって作成された可能性のある削除する追加のキュー。
removeExchanges
ブローカーから取引所を削除します。- パラメーター:
exchanges
- 取引所。- 導入:
- 2.3
purgeTestQueues
public void purgeTestQueues()構成されたすべてのキューを削除して再宣言します。テストが古いデータを残す可能性があり、複数のテストが同じキューを使用する場合に、テスト間で使用できます。deleteQueues
ブローカーから任意のキューを削除します。- パラメーター:
queuesToDelete
- 削除するキュー。
deleteExchanges
ブローカーから任意の取引所を削除します。- パラメーター:
exchanges
- 削除する取引所。
getConnectionFactory
public com.rabbitmq.client.ConnectionFactory getConnectionFactory()このルールで使用される接続ファクトリを取得します。- 戻り値:
- 接続ファクトリ。
getAdminUri
管理 uri を返します。- 戻り値:
- uri。