Krótki przewodnik po tym, jak uruchamiać kontenery z poziomu testów

Używam Spring Boot w projekt aby zmniejszyć ilość szablonów. Kontenery testowe są niezależne od Spring Framework i można ich używać bez tego.

Używam Testcontainers w wersji 1.17.3, ale możesz użyć najnowszej wersji. Testy z kontenerem Postgres.

Najpierw należy zdefiniować kontener:

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 nie rób. To jest współdzielona instancja. Niech JVM zajmie się tą operacją.
  }
}

Następnie inicjalizujemy kontekst aplikacji Spring. Pobieramy całą konfigurację źródła danych z instancji kontenera i ustawiamy je jako konfigurację Spring:

public class ContainerInit implements 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()
    );
  }
}

Wreszcie możemy uruchomić nasz test, a wszystko zostanie uruchomione pod maską:

@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);
  }
}

Lub jeśli chcemy uruchomić niezależny test Spring, możemy użyć kontenera bezpośrednio:

@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 (wyjątek SQLException sqlException) {
    assertThat((Exception) sqlException).doesNotThrowAnyException();
    }
  }
}

Podsumowanie

Testcontainers to bardzo łatwe w użyciu narzędzia, które pomagają nam tworzyć testy integracyjne wykorzystujące kontenery Docker. Daje nam to większą elastyczność i zwiększa szybkość rozwoju. Odpowiednia konfiguracja testów skraca czas potrzebny na wdrożenie nowych programistów. Nie muszą oni ustawiać wszystkich zależności, wystarczy, że uruchomią napisane testy z wybranymi plikami konfiguracyjnymi.