SpringBootテストを備えたEmbeddedRedisサーバー

投稿日: 2019-10-18 2022-10-30
タグ: Spring Boot, Testing

1. 概要

Spring Data Redisは、Redisインスタンスと統合する簡単な方法を提供します。

ただし、場合によっては、実サーバーで環境を作成するよりも組み込みサーバーを使用する方が便利です。

したがって、EmbeddedRedisサーバーをセットアップして使用する方法を学習します。

2. 依存関係

必要な依存関係を追加することから始めましょう：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<dependency>
  <groupId>it.ozimov</groupId>
  <artifactId>embedded-redis</artifactId>
  <version>0.7.2</version>
  <scope>test</scope>
</dependency>

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
</dependency>

spring-boot-starter-test 依存関係には、統合テストを実行するために必要なすべてのものが含まれています。

さらに、 embedded-redis には、使用する組み込みサーバーが含まれています。

3. 設定

依存関係を追加した後、Redisサーバーとアプリケーション間の接続設定を定義する必要があります。

プロパティを保持するクラスを作成することから始めましょう。

@Configuration
public class RedisProperties {
    private int redisPort;
    private String redisHost;

    public RedisProperties(
      @Value("${spring.redis.port}") int redisPort, 
      @Value("${spring.redis.host}") String redisHost) {
        this.redisPort = redisPort;
        this.redisHost = redisHost;
    }

    // getters
}

次に、接続を定義し、プロパティを使用する構成クラスを作成する必要があります。

@Configuration
@EnableRedisRepositories
public class RedisConfiguration {

    @Bean
    public LettuceConnectionFactory redisConnectionFactory(
      RedisProperties redisProperties) {
        return new LettuceConnectionFactory(
          redisProperties.getRedisHost(), 
          redisProperties.getRedisPort());
    }

    @Bean
    public RedisTemplate<?, ?> redisTemplate(LettuceConnectionFactory connectionFactory) {
        RedisTemplate<byte[], byte[]> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);
        return template;
    }
}

設定は非常に簡単です。さらに、組み込みサーバーを別のポートで実行できます。

Spring Bootを使用したRedisの詳細については、 SpringDataRedisの概要の記事をご覧ください。

4. 組み込みRedisサーバー

次に、組み込みサーバーを構成し、テストの1つで使用します。

まず、テストリソースディレクトリ（ src / test / resources）に application.properties ファイルを作成しましょう：

spring.redis.host=localhost
spring.redis.port=6370

その後、@TestConfigurationアノテーション付きクラスを作成します。

@TestConfiguration
public class TestRedisConfiguration {

    private RedisServer redisServer;

    public TestRedisConfiguration(RedisProperties redisProperties) {
        this.redisServer = new RedisServer(redisProperties.getRedisPort());
    }

    @PostConstruct
    public void postConstruct() {
        redisServer.start();
    }

    @PreDestroy
    public void preDestroy() {
        redisServer.stop();
    }
}

コンテキストがアップすると、サーバーが起動します。プロパティで定義したポートのマシンで開始されます。たとえば、実際のRedisサーバーを停止せずにテストを実行できるようになりました。

理想的には、ランダムに使用可能なポートで開始したいのですが、組み込みRedisにはまだこの機能がありません。今できることは、ServerSocketAPIを介してランダムポートを取得することです。

さらに、コンテキストが破棄されるとサーバーは停止します。

サーバーには、独自の実行可能ファイルを提供することもできます。

this.redisServer = new RedisServer("/path/redis", redisProperties.getRedisPort());

さらに、実行可能ファイルはオペレーティングシステムごとに定義できます。

RedisExecProvider customProvider = RedisExecProvider.defaultProvider()
  .override(OS.UNIX, "/path/unix/redis")
  .override(OS.Windows, Architecture.x86_64, "/path/windows/redis")
  .override(OS.MAC_OS_X, Architecture.x86_64, "/path/macosx/redis")
  
this.redisServer = new RedisServer(customProvider, redisProperties.getRedisPort());

最後に、TestRedisConfigurationクラスを使用するテストを作成しましょう。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestRedisConfiguration.class)
public class UserRepositoryIntegrationTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void shouldSaveUser_toRedis() {
        UUID id = UUID.randomUUID();
        User user = new User(id, "name");

        User saved = userRepository.save(user);

        assertNotNull(saved);
    }
}

ユーザーは組み込みのRedisサーバーに保存されました。

さらに、手動で追加する必要がありました TestRedisConfiguration に SpringBootTest。前に述べたように、サーバーはテストの前に起動し、テストの後に停止しました。

5. 結論

Embedded Redisサーバーは、テスト環境で実際のサーバーを置き換えるのに最適なツールです。これを構成する方法と、テストで使用する方法を見てきました。

いつものように、例のコードはGitHubでから入手できます。

getdocs

13036