Stručný návod, jak spouštět kontejnery z testů

Používám Spring Boot v projekt snížit počet šablon. Testovací kontejnery jsou nezávislé na Spring Framework a můžete je používat i bez nich.

Používám Testcontainers verze 1.17.3, ale klidně použijte nejnovější verzi. Testy s kontejnerem Postgres.

Nejprve definujte kontejner:

public class Postgres13TC extends PostgreSQLContainer {
  private static final Postgres13TC TC = new Postgres13TC();

  private Postgres13TC() {
    super("postgres:13.2");
  }

  public static Postgres13TC getInstance() {
    return TC;
  }

  @Override
  public void start() {
    super.start();
    System.setProperty("DB_URL", TC.getJdbcUrl());
    System.setProperty("DB_USERNAME", TC.getUsername());
    System.setProperty("DB_PASSWORD", TC.getPassword());
  }

  @Override
  public void stop() {
    // nic nedělat. Toto je sdílená instance. Nechte tuto operaci na JVM.
  }
}

Poté inicializujte kontext aplikace Spring. Získáme všechny konfigurace datových zdrojů z instance kontejneru a nastavíme je jako konfiguraci Spring:

veřejná třída ContainerInit implementuje ApplicationContextInitializer {

  public static Postgres13TC postgres13TC;

  static {
    postgres13TC = Postgres13TC.getInstance();
    postgres13TC.start();
  }

  @Override
  public void initialize(ConfigurableApplicationContext applicationContext) {
    TestPropertySourceUtils.addInlinedPropertiesToEnvironment(
        applicationContext,
        "spring.datasource.url=" + postgres13TC.getJdbcUrl(),
        "spring.datasource.username=" + postgres13TC.getUsername(),
        "spring.datasource.password=" + postgres13TC.getPassword(),
        "db.host=" + postgres13TC.getHost(),
        "db.port=" + postgres13TC.getMappedPort(postgres13TC.POSTGRESQL_PORT),
        "db.name=" + postgres13TC.getDatabaseName(),
        "db.username=" + postgres13TC.getUsername(),
        "db.password=" + postgres13TC.getPassword()
    );
  }
}

Nakonec můžeme spustit náš test a vše se spustí pod kapotou:

@SpringBootTest(webEnvironment = RANDOM_PORT)
@AutoConfigureTestDatabase(replace = NONE)
@ContextConfiguration(initializers = ContainerInit.class)
@Testcontainers
class DummyRepositoryTest {

  @Autowired
  private DummyRepository dummyRepository;

  @Test
  void shouldReturnDummy() {
    var byId = dummyRepository.getById(10L);
    var expected = new Dummy();
    expected.setId(10L);
    assertThat(byId).completes().emitsCount(1).emits(expected);
  }
}

Nebo pokud chceme spustit test nezávislý na jaru, můžeme použít přímo kontejner:

@Testcontainers
class SimpleDbTest {

  @Container
  private static final Postgres13TC postgres13TC = Postgres13TC.getInstance();

  @Test
  void testConnection() {
    assumeThat(postgres13TC.isRunning());
    var connectionProps = new Properties();
    connectionProps.put("user", postgres13TC.getUsername());
    connectionProps.put("password", postgres13TC.getPassword());
    try (Connection connection = DriverManager.getConnection(postgres13TC.getJdbcUrl(),
        connectionProps)) {
    var resultSet = connection.prepareStatement("Select 1").executeQuery();
    resultSet.next();
    assertThat(resultSet.getInt(1)).isEqualTo(1);
    } catch (SQLException sqlException) {
    assertThat((Exception) sqlException).doesNotThrowAnyException();
    }
  }
}

Shrnutí

Testovací kontejnery jsou velmi snadno použitelné nástroje, které pomáhají nás vytvořit integrační testy, které používají Docker kontejnery. To nám dává větší flexibilitu a zvyšuje rychlost vývoje. Správné nastavení konfigurace testů zkracuje dobu potřebnou k nástupu nových vývojářů. Nemusí nastavovat všechny závislosti, stačí jim spustit napsané testy s vybranými konfiguračními soubory.