パッケージ org.springframework.boot.test.autoconfigure.graphql

アノテーションインターフェース GraphQlTest

@TargetSE(TYPESE) @RetentionSE(RUNTIMESE) @DocumentedSE @InheritedSE @BootstrapWith(org.springframework.boot.test.autoconfigure.graphql.GraphQlTestContextBootstrapper.class) @ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class) @OverrideAutoConfiguration(enabled=false) @TypeExcludeFilters(GraphQlTypeExcludeFilter.class) @AutoConfigureCache @AutoConfigureJson @AutoConfigureGraphQl @AutoConfigureGraphQlTester @ImportAutoConfiguration public @interface GraphQlTest
Web レイヤーなしで GraphQL リクエストの実行に焦点を合わせ、アプリケーション構成のサブセットのみをロードする GraphQL テストを実行するためのアノテーション。

アノテーションは完全な自動構成を無効にし、代わりに次のような GraphQL テストに関連するコンポーネントのみをロードします。

  • @Controller
  • RuntimeWiringConfigurer
  • @JsonComponent
  • Converter
  • GenericConverter
  • DataFetcherExceptionResolver
  • Instrumentation
  • GraphQlSourceBuilderCustomizer

アノテーションは、@Component、@Service、@Repository およびその他の Bean を自動的にロードしません。

デフォルトでは、@GraphQlTest でアノテーションが付けられたテストには GraphQlTester が構成されています。GraphQlTester をよりきめ細かく制御するには、@AutoConfigureGraphQlTester を使用します。

通常、@GraphQlTest は @MockBean または @Import と組み合わせて使用され、テストに必要なコラボレーターやその他のコンポーネントをロードします。

代わりに完全なアプリケーション構成をロードし、HttpGraphQlTester を介してテストするには、@SpringBootTest を @AutoConfigureHttpGraphQlTester と組み合わせて使用することを検討してください。

導入:
2.7.0
作成者:
Brian Clozel
関連事項:

  • オプション要素のサマリー

    オプション要素
    修飾子と型
    オプションの要素
    説明
    ClassSE<?>[]
    controllers
    テストするコントローラーを指定します。
    ClassSE<?>[]
    excludeAutoConfiguration
    このテストに適用する必要がある自動構成の除外。
    ComponentScan.Filter[]
    excludeFilters
    それ以外の場合はアプリケーションコンテキストに追加される Bean のフィルタリングに使用できる除外フィルターのセット。
    ComponentScan.Filter[]
    includeFilters
    他の方法でフィルタリングされた Bean をアプリケーションコンテキストに追加するために使用できる一連の組み込みフィルター。
    StringSE[]
    properties
    テストの実行前に Spring Environment に追加する必要がある key = value 形式のプロパティ。
    boolean
    useDefaultFilters
    @SpringBootApplication でデフォルトのフィルタリングを使用するかどうかを決定します。
    ClassSE<?>[]
    value
    テストするコントローラーを指定します。

  • 要素の詳細

    • properties

      StringSE[] properties
      テストの実行前に Spring Environment に追加する必要がある key = value 形式のプロパティ。
      戻り値:
      追加するプロパティ
      デフォルト:
      {}

    • value

      @AliasFor("controllers") ClassSE<?>[] value
      テストするコントローラーを指定します。これは、他の属性が定義されていない場合に簡潔にするために使用できる controllers() のエイリアスです。詳細については、controllers() を参照してください。
      戻り値:
      テストするコントローラー
      関連事項:
      デフォルト:
      {}

    • controllers

      @AliasFor("value") ClassSE<?>[] controllers
      テストするコントローラーを指定します。すべての @Controller Bean をアプリケーションコンテキストに追加する必要がある場合は、空白のままにすることができます。
      戻り値:
      テストするコントローラー
      関連事項:
      デフォルト:
      {}

    • useDefaultFilters

      boolean useDefaultFilters
      デフォルトのフィルタリングを @SpringBootApplication で使用するかどうかを決定します。デフォルトでは、@Controller （明示的な controllers が定義されていない場合）、RuntimeWiringConfigurer、@JsonComponent、Converter、GenericConverter、DataFetcherExceptionResolver、Instrumentation、GraphQlSourceBuilderCustomizer Bean のみが含まれます。
      戻り値:
      デフォルトのフィルターを使用する必要がある場合
      関連事項:
      デフォルト:
      true

    • includeFilters

      ComponentScan.Filter[] includeFilters
      他の方法でフィルタリングされた Bean をアプリケーションコンテキストに追加するために使用できる一連の組み込みフィルター。
      戻り値:
      適用するフィルターを含める
      デフォルト:
      {}

    • excludeFilters

      ComponentScan.Filter[] excludeFilters
      それ以外の場合はアプリケーションコンテキストに追加される Bean のフィルタリングに使用できる除外フィルターのセット。
      戻り値:
      適用するフィルターを除外する
      デフォルト:
      {}

    • excludeAutoConfiguration

      @AliasFor(annotation=ImportAutoConfiguration.class, attribute="exclude") ClassSE<?>[] excludeAutoConfiguration
      このテストに適用する必要がある自動構成の除外。
      戻り値:
      適用する自動構成除外
      デフォルト:
      {}