クラス BrokerRunning

java.lang.ObjectSE
org.junit.rules.TestWatcher
org.springframework.amqp.rabbit.junit.BrokerRunning
実装されているすべてのインターフェース:
org.junit.rules.TestRule
@DeprecatedSE(since="4.0", forRemoval=true) public final class BrokerRunning extends org.junit.rules.TestWatcher
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
4.0 以降、JUnit 5 RabbitAvailable が優先されます。
Rabbit ブローカーアプリケーションが実行されていないかアクセスできない場合に、統合テストが失敗しないようにするルール。Rabbit ブローカーがバックグラウンドで実行されていない場合、ここでのすべてのテストは、前提条件に違反しているため (デフォルトで) 単純にスキップされます (成功として表示されます)。使用箇所:
 @Rule
 public static BrokerRunning brokerIsRunning = BrokerRunning.isRunning();

 @Test
 public void testSendAndReceive() throws Exception {
        // ... test using RabbitTemplate etc.
 }
ルールを静的として宣言すると、囲んでいるテストケース内のすべてのテストを 1 回だけチェックするだけで済みますが、非静的にすることによるオーバーヘッドはあまりありません。

isRunningWithEmptyQueues(String...) を使用して、ルールの実行時にテストキューを宣言および / またはパージします。

@After メソッドから removeTestQueues(String...) を呼び出して、これらのキュー (およびオプションで他のキュー) を削除します。

CI サーバーなどでブローカーを強制的に使用可能にしたい場合は、環境変数 "RABBITMQ_SERVER_REQUIRED" を true に設定すると、テストはすぐに失敗します。

導入:
1.7
作成者:
Dave Syer, Gary Russell, Artem Bilan

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    org.junit.runners.model.Statement
    apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static void
    clearEnvironmentVariableOverrides()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    setEnvironmentVariableOverrides(Map) で設定された環境変数オーバーライドをすべてクリアします。
    void
    deleteExchanges(StringSE... exchanges)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ブローカーから任意の取引所を削除します。
    void
    deleteQueues(StringSE... queuesToDelete)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ブローカーから任意のキューを削除します。
    static boolean
    fatal()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    StringSE
    generateId()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ルールの接続ファクトリで使用される接続の接続 ID を生成します。
    StringSE
    getAdminPassword()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    管理者パスワードを返します。
    StringSE
    getAdminUri()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    管理 uri を返します。
    StringSE
    getAdminUser()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    管理者ユーザーを返します。
    com.rabbitmq.client.ConnectionFactory
    getConnectionFactory()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    このルールで使用される接続ファクトリを取得します。
    StringSE
    getHostName()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ポートを返します。
    StringSE
    getPassword()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    パスワードを返します。
    int
    getPort()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ポートを返します。
    StringSE
    getUser()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ユーザーを返します。
    static BrokerRunning
    isBrokerAndManagementRunning()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static BrokerRunning
    isBrokerAndManagementRunningWithEmptyQueues(StringSE... queues)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static BrokerRunning
    isNotRunning()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static BrokerRunning
    isRunning()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    static BrokerRunning
    isRunningWithEmptyQueues(StringSE... names)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。
    void
    isUp()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    purgeTestQueues()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    構成されたすべてのキューを削除して再宣言します。
    void
    removeTestQueues(StringSE... additionalQueues)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    isRunningWithEmptyQueues(String...) メソッドによって作成されたテストキューをすべて削除します。
    void
    setAdminPassword(StringSE password)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。
    void
    setAdminUri(StringSE adminUri)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    REST API の uri を設定します。
    void
    setAdminUser(StringSE user)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。
    static void
    setEnvironmentVariableOverrides(MapSE<StringSE,StringSE> environmentVariables)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    ホスト、ポートなどの環境変数のオーバーライドを設定します。
    void
    setHostName(StringSE hostName)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setPassword(StringSE password)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    amqp 接続のデフォルト "guest" のパスワードを設定します。
    void
    setPort(int port)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setUser(StringSE user)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    amqp 接続のデフォルト「ゲスト」のユーザーを設定します。

    クラス org.junit.rules.TestWatcher から継承されたメソッド

    failed, finished, skipped, skipped, starting, succeeded

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • メソッドの詳細

    • setEnvironmentVariableOverrides

      public static void setEnvironmentVariableOverrides(MapSE<StringSE,StringSE> environmentVariables)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ホスト、ポートなどの環境変数のオーバーライドを設定します。存在する場合、実際の環境変数をオーバーライドします。

      変数は、このメソッドが呼び出された後に作成されたルールインスタンスにのみ適用されます。オーバーライドは、clearEnvironmentVariableOverrides() が呼び出されるまで残ります。

      パラメーター:
      environmentVariables - 変数。

    • clearEnvironmentVariableOverrides

      public static void clearEnvironmentVariableOverrides()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      setEnvironmentVariableOverrides(Map) で設定された環境変数オーバーライドをすべてクリアします。

    • isRunningWithEmptyQueues

      public static BrokerRunning isRunningWithEmptyQueues(StringSE... names)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ブローカーが実行中であり、デフォルト交換に指定された名前の空のキューがあることを確認してください。
      パラメーター:
      names - テストのために宣言するキュー。
      戻り値:
      既存の実行中のブローカーを想定する新しいルール

    • isRunning

      public static BrokerRunning isRunning()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      戻り値:
      既存の実行中のブローカーを想定する新しいルール

    • isNotRunning

      public static BrokerRunning isNotRunning()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      戻り値:
      既存のブローカーが存在しないことを前提とする新しいルール

    • isBrokerAndManagementRunning

      public static BrokerRunning isBrokerAndManagementRunning()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      戻り値:
      管理プラグインを備えた既存のブローカーを想定する新しいルール

    • isBrokerAndManagementRunningWithEmptyQueues

      public static BrokerRunning isBrokerAndManagementRunningWithEmptyQueues(StringSE... queues)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パラメーター:
      queues - キュー。
      戻り値:
      提供されたキューが宣言された (必要に応じて空にされた) 管理プラグインを備えた既存のブローカーを想定する新しいルール。

    • setPort

      public void setPort(int port)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パラメーター:
      port - 設定するポート

    • setHostName

      public void setHostName(StringSE hostName)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パラメーター:
      hostName - 設定する hostName

    • setUser

      public void setUser(StringSE user)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      amqp 接続のデフォルト「ゲスト」のユーザーを設定します。
      パラメーター:
      user - ユーザー。
      導入:
      1.7.2

    • setPassword

      public void setPassword(StringSE password)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      amqp 接続のデフォルト "guest" のパスワードを設定します。
      パラメーター:
      password - パスワード。
      導入:
      1.7.2

    • setAdminUri

      public void setAdminUri(StringSE adminUri)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      REST API の uri を設定します。
      パラメーター:
      adminUri - uri。
      導入:
      1.7.2

    • setAdminUser

      public void setAdminUser(StringSE user)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理 REST API 接続のデフォルトの「ゲスト」のユーザーを設定します。
      パラメーター:
      user - ユーザー。
      導入:
      1.7.2

    • setAdminPassword

      public void setAdminPassword(StringSE password)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理 REST API 接続のデフォルトの「ゲスト」のパスワードを設定します。
      パラメーター:
      password - パスワード。
      導入:
      1.7.2

    • getPort

      public int getPort()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ポートを返します。
      戻り値:
      ポート。
      導入:
      1.7.2

    • getHostName

      public StringSE getHostName()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ポートを返します。
      戻り値:
      ポート。
      導入:
      1.7.2

    • getUser

      public StringSE getUser()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ユーザーを返します。
      戻り値:
      ユーザー。
      導入:
      1.7.2

    • getPassword

      public StringSE getPassword()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パスワードを返します。
      戻り値:
      パスワード。
      導入:
      1.7.2

    • getAdminUser

      public StringSE getAdminUser()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理者ユーザーを返します。
      戻り値:
      ユーザー。
      導入:
      1.7.2

    • getAdminPassword

      public StringSE getAdminPassword()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理者パスワードを返します。
      戻り値:
      パスワード。
      導入:
      1.7.2

    • apply

      public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      次で指定:
      インターフェース org.junit.rules.TestRule の apply 
      オーバーライド:
      クラス org.junit.rules.TestWatcher の apply 

    • isUp

      public void isUp()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • fatal

      public static boolean fatal()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • generateId

      public StringSE generateId()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ルールの接続ファクトリで使用される接続の接続 ID を生成します。
      戻り値:
      ID。

    • removeTestQueues

      public void removeTestQueues(StringSE... additionalQueues)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      isRunningWithEmptyQueues(String...) メソッドによって作成されたテストキューをすべて削除します。
      パラメーター:
      additionalQueues - テストによって作成された可能性のある削除する追加のキュー。

    • purgeTestQueues

      public void purgeTestQueues()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      構成されたすべてのキューを削除して再宣言します。テストが古いデータを残す可能性があり、複数のテストが同じキューを使用する場合に、テスト間で使用できます。

    • deleteQueues

      public void deleteQueues(StringSE... queuesToDelete)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ブローカーから任意のキューを削除します。
      パラメーター:
      queuesToDelete - 削除するキュー。

    • deleteExchanges

      public void deleteExchanges(StringSE... exchanges)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      ブローカーから任意の取引所を削除します。
      パラメーター:
      exchanges - 削除する取引所。

    • getConnectionFactory

      public com.rabbitmq.client.ConnectionFactory getConnectionFactory()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      このルールで使用される接続ファクトリを取得します。
      戻り値:
      接続ファクトリ。

    • getAdminUri

      public StringSE getAdminUri()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      管理 uri を返します。
      戻り値:
      uri。
      導入:
      1.7.2