Package org.springframework.shell.test.autoconfigure

Annotation Interface ShellTest

@Target(TYPE) @Retention(RUNTIME) @Documented @Inherited @BootstrapWith(ShellTestContextBootstrapper.class) @ExtendWith(org.springframework.test.context.junit.jupiter.SpringExtension.class) @OverrideAutoConfiguration(enabled=false) @TypeExcludeFilters(ShellTypeExcludeFilter.class) @AutoConfigureShell @AutoConfigureShellTestClient @ImportAutoConfiguration public @interface ShellTest
Annotation that can be used for a Shell test that focuses only on Shell components.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>[]
    excludeAutoConfiguration
    Auto-configuration exclusions that should be applied for this test.
    org.springframework.context.annotation.ComponentScan.Filter[]
    excludeFilters
    A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
    org.springframework.context.annotation.ComponentScan.Filter[]
    includeFilters
    A set of include filters which can be used to add otherwise filtered beans to the application context.
    String[]
    properties
    Properties in form key=value that should be added to the Spring Environment before the test runs.
    int
    terminalHeight
    Set emulated terminal height.
    int
    terminalWidth
    Set emulated terminal width.
    boolean
    useDefaultFilters
    Determines if default filtering should be used with @SpringBootApplication.

  • Element Details

    • properties

      String[] properties
      Properties in form key=value that should be added to the Spring Environment before the test runs.
      Returns:
      the properties to add
      Default:
      {}

    • terminalWidth

      @PropertyMapping(value="spring.shell.test.terminal-width", skip=ON_DEFAULT_VALUE) int terminalWidth
      Set emulated terminal width.
      Returns:
      emulated terminal width
      Default:
      80

    • terminalHeight

      @PropertyMapping(value="spring.shell.test.terminal-height", skip=ON_DEFAULT_VALUE) int terminalHeight
      Set emulated terminal height.
      Returns:
      emulated terminal height
      Default:
      24

    • useDefaultFilters

      boolean useDefaultFilters
      Determines if default filtering should be used with @SpringBootApplication.
      Returns:
      if default filters should be used
      See Also:
      Default:
      true

    • includeFilters

      org.springframework.context.annotation.ComponentScan.Filter[] includeFilters
      A set of include filters which can be used to add otherwise filtered beans to the application context.
      Returns:
      include filters to apply
      Default:
      {}

    • excludeFilters

      org.springframework.context.annotation.ComponentScan.Filter[] excludeFilters
      A set of exclude filters which can be used to filter beans that would otherwise be added to the application context.
      Returns:
      exclude filters to apply
      Default:
      {}

    • excludeAutoConfiguration

      @AliasFor(annotation=org.springframework.boot.autoconfigure.ImportAutoConfiguration.class, attribute="exclude") Class<?>[] excludeAutoConfiguration
      Auto-configuration exclusions that should be applied for this test.
      Returns:
      auto-configuration exclusions to apply
      Default:
      {}