Add tests for database structure #1

mfvanek · mfvanek · commit a8348c512df1 · 2024-10-13T20:19:06.000+04:00
diff --git a/docker/docker-compose-base.yml b/docker/docker-compose-base.yml
@@ -22,7 +22,7 @@ services:
             - jaeger-example
 
     zookeeper1:
-        image: confluentinc/cp-zookeeper:7.5.3
+        image: confluentinc/cp-zookeeper:7.7.1
         hostname: zookeeper1
         container_name: zookeeper1
         ports:
@@ -35,7 +35,7 @@ services:
             - jaeger-example
 
     kafka1:
-        image: confluentinc/cp-kafka:7.5.3
+        image: confluentinc/cp-kafka:7.7.1
         hostname: kafka1
         container_name: kafka1
         ports:
@@ -86,7 +86,7 @@ services:
 
     postgres:
         container_name: postgres
-        image: postgres:16.2
+        image: postgres:16.4
         shm_size: "2gb"
         environment:
             POSTGRES_DB: "otel_demo_db"
diff --git a/spring-boot-2-demo-app/build.gradle.kts b/spring-boot-2-demo-app/build.gradle.kts
@@ -42,6 +42,7 @@ dependencies {
     testImplementation("org.testcontainers:kafka")
     testImplementation("org.springframework.kafka:spring-kafka-test")
     testImplementation("org.awaitility:awaitility")
+    testImplementation("io.github.mfvanek:pg-index-health-test-starter")
 }
 
 springBoot {
diff --git a/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/IndexesMaintenanceTest.java b/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/IndexesMaintenanceTest.java
@@ -0,0 +1,57 @@
+package io.github.mfvanek.spring.boot2.test;
+
+import io.github.mfvanek.pg.common.maintenance.DatabaseCheckOnHost;
+import io.github.mfvanek.pg.common.maintenance.Diagnostic;
+import io.github.mfvanek.pg.model.DbObject;
+import io.github.mfvanek.pg.model.column.Column;
+import io.github.mfvanek.pg.model.table.Table;
+import io.github.mfvanek.spring.boot2.test.support.TestBase;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.InstanceOfAssertFactories.list;
+
+class IndexesMaintenanceTest extends TestBase {
+
+    @Autowired
+    private List<DatabaseCheckOnHost<? extends DbObject>> checks;
+
+    @Test
+    @DisplayName("Always check PostgreSQL version in your tests")
+    void checkPostgresVersion() {
+        final String pgVersion = jdbcTemplate.queryForObject("select version();", String.class);
+        assertThat(pgVersion)
+            .startsWith("PostgreSQL 16.4");
+    }
+
+    @Test
+    void databaseStructureCheckForPublicSchema() {
+        assertThat(checks)
+            .hasSameSizeAs(Diagnostic.values());
+
+        checks.forEach(check -> {
+            switch (check.getDiagnostic()) {
+                case TABLES_WITHOUT_PRIMARY_KEY, TABLES_WITHOUT_DESCRIPTION -> assertThat(check.check())
+                    .asInstanceOf(list(Table.class))
+                    .hasSize(1)
+                    .containsExactly(Table.of("databasechangelog", 0L));
+
+                case COLUMNS_WITHOUT_DESCRIPTION -> assertThat(check.check())
+                    .asInstanceOf(list(Column.class))
+                    .hasSize(14)
+                    .allSatisfy(column -> assertThat(column.getTableName()).isEqualTo("databasechangelog"));
+
+                case TABLES_WITH_MISSING_INDEXES -> assertThat(check.check())
+                    .hasSizeLessThanOrEqualTo(1); // TODO skip runtime checks after https://github.com/mfvanek/pg-index-health/issues/456
+
+                default -> assertThat(check.check())
+                    .as(check.getDiagnostic().name())
+                    .isEmpty();
+            }
+        });
+    }
+}
diff --git a/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/support/KafkaInitializer.java b/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/support/KafkaInitializer.java
@@ -16,7 +16,7 @@ public class KafkaInitializer implements ApplicationContextInitializer<Configura
     private static final String KAFKA_USER_NAME = "sb-ot-demo-user";
     private static final String KAFKA_USER_PASSWORD = "pwdForSbOtDemoApp";
 
-    private static final DockerImageName IMAGE_NAME = DockerImageName.parse("confluentinc/cp-kafka:7.5.3");
+    private static final DockerImageName IMAGE_NAME = DockerImageName.parse("confluentinc/cp-kafka:7.7.1");
 
     private static final KafkaContainer KAFKA_CONTAINER = new KafkaContainer(IMAGE_NAME)
             .withEnv("KAFKA_LISTENER_SECURITY_PROTOCOL_MAP", "PLAINTEXT:SASL_PLAINTEXT,BROKER:PLAINTEXT")
diff --git a/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/support/PostgresInitializer.java b/spring-boot-2-demo-app/src/test/java/io/github/mfvanek/spring/boot2/test/support/PostgresInitializer.java
@@ -10,7 +10,7 @@
 
 public class PostgresInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
-    private static final DockerImageName IMAGE = DockerImageName.parse("postgres:16.2");
+    private static final DockerImageName IMAGE = DockerImageName.parse("postgres:16.4");
     private static final Network NETWORK = Network.newNetwork();
     private static final PostgreSQLContainer<?> CONTAINER = new PostgreSQLContainer<>(IMAGE);
 
diff --git a/spring-boot-3-demo-app/build.gradle.kts b/spring-boot-3-demo-app/build.gradle.kts
@@ -34,6 +34,7 @@ dependencies {
     testImplementation("org.testcontainers:kafka")
     testImplementation("org.springframework.kafka:spring-kafka-test")
     testImplementation("org.awaitility:awaitility")
+    testImplementation("io.github.mfvanek:pg-index-health-test-starter")
 }
 
 springBoot {
diff --git a/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/controllers/TimeControllerTest.java b/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/controllers/TimeControllerTest.java
@@ -47,7 +47,7 @@ class TimeControllerTest extends TestBase {
     @Autowired
     private Clock clock;
     @Autowired
-    private NamedParameterJdbcTemplate jdbcTemplate;
+    private NamedParameterJdbcTemplate namedParameterJdbcTemplate;
 
     @BeforeAll
     void setUpKafkaConsumer() {
@@ -64,7 +64,7 @@ void tearDownKafkaConsumer() {
 
     @BeforeEach
     void cleanUpDatabase() {
-        jdbcTemplate.getJdbcTemplate().execute("truncate table otel_demo.storage");
+        jdbcTemplate.execute("truncate table otel_demo.storage");
     }
 
     @SneakyThrows
@@ -111,14 +111,14 @@ void spanShouldBeReportedInLogs(@Nonnull final CapturedOutput output) {
             .until(() -> countRecordsInTable() >= 1L);
         assertThat(output.getAll())
             .contains("Received record: " + received.value() + " with traceId " + traceId);
-        final String messageFromDb = jdbcTemplate.queryForObject("select message from otel_demo.storage where trace_id = :traceId",
+        final String messageFromDb = namedParameterJdbcTemplate.queryForObject("select message from otel_demo.storage where trace_id = :traceId",
             Map.of("traceId", traceId), String.class);
         assertThat(messageFromDb)
             .isEqualTo(received.value());
     }
 
     private long countRecordsInTable() {
-        final Long queryResult = jdbcTemplate.getJdbcTemplate().queryForObject("select count(*) from otel_demo.storage", Long.class);
+        final Long queryResult = jdbcTemplate.queryForObject("select count(*) from otel_demo.storage", Long.class);
         return Objects.requireNonNullElse(queryResult, 0L);
     }
 }
diff --git a/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/support/KafkaInitializer.java b/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/support/KafkaInitializer.java
@@ -16,7 +16,7 @@ public class KafkaInitializer implements ApplicationContextInitializer<Configura
     private static final String KAFKA_USER_NAME = "sb-ot-demo-user";
     private static final String KAFKA_USER_PASSWORD = "pwdForSbOtDemoApp";
 
-    private static final DockerImageName IMAGE_NAME = DockerImageName.parse("confluentinc/cp-kafka:7.5.3");
+    private static final DockerImageName IMAGE_NAME = DockerImageName.parse("confluentinc/cp-kafka:7.7.1");
 
     private static final KafkaContainer KAFKA_CONTAINER = new KafkaContainer(IMAGE_NAME)
         .withEnv("KAFKA_LISTENER_SECURITY_PROTOCOL_MAP", "PLAINTEXT:SASL_PLAINTEXT,BROKER:PLAINTEXT")
diff --git a/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/support/PostgresInitializer.java b/spring-boot-3-demo-app/src/test/java/io/github/mfvanek/spring/boot3/test/support/PostgresInitializer.java
@@ -10,7 +10,7 @@
 
 public class PostgresInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
 
-    private static final DockerImageName IMAGE = DockerImageName.parse("postgres:16.2");
+    private static final DockerImageName IMAGE = DockerImageName.parse("postgres:16.4");
     private static final Network NETWORK = Network.newNetwork();
     private static final PostgreSQLContainer<?> CONTAINER = new PostgreSQLContainer<>(IMAGE);
 

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ dependencies {`
`42`	`42`	`testImplementation("org.testcontainers:kafka")`
`43`	`43`	`testImplementation("org.springframework.kafka:spring-kafka-test")`
`44`	`44`	`testImplementation("org.awaitility:awaitility")`
	`45`	`+ testImplementation("io.github.mfvanek:pg-index-health-test-starter")`
`45`	`46`	`}`
`46`	`47`
`47`	`48`	`springBoot {`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ dependencies {`
`34`	`34`	`testImplementation("org.testcontainers:kafka")`
`35`	`35`	`testImplementation("org.springframework.kafka:spring-kafka-test")`
`36`	`36`	`testImplementation("org.awaitility:awaitility")`
	`37`	`+ testImplementation("io.github.mfvanek:pg-index-health-test-starter")`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`springBoot {`