ADR

Author: Joern Wellniak

…hitecture/decisions/ADR-008-autowired.md …ture/decisions/ADR-008-springboottest.mddocs/architecture/decisions/ADR-008-autowired.md renamed to docs/architecture/decisions/ADR-008-springboottest.md docs/architecture/decisions/ADR-008-autowired.md renamed to docs/architecture/decisions/ADR-008-springboottest.md

@@ -0,0 +1,75 @@
+
+# ADR-011: Use Flyway for All DDL Operations
+
+Date: 2025-10-24
+
+## Status
+
+Accepted
+
+## Context
+
+Database schema changes (DDL operations) are currently managed manually or through ad-hoc scripts.
+This approach can lead to inconsistencies, difficulties in tracking changes, and challenges in
+maintaining a reliable migration history. Flyway provides a structured and version-controlled way to
+manage database migrations, ensuring consistency and traceability.
+
+## Decision
+
+All DDL operations will be managed using Flyway scripts. Each table will have its own dedicated
+Flyway script to ensure modularity and clarity. This approach will standardize database migrations
+and simplify collaboration among developers.
+
+## Consequences
+
+- **Positive**:
+    - Ensures a consistent and version-controlled approach to database schema changes.
+    - Simplifies tracking and auditing of database changes.
+    - Reduces the risk of conflicts and errors during migrations.
+    - Modular scripts improve clarity and maintainability.
+
+- **Negative**:
+    - Requires developers to learn and adopt Flyway conventions.
+    - Initial setup effort to migrate existing schema changes into Flyway scripts.
+
+## Implementation
+
+1. Add Flyway as a dependency in the `pom.xml`:
+   ```xml
+   <dependency>
+       <groupId>org.flywaydb</groupId>
+       <artifactId>flyway-core</artifactId>
+       <version>9.0.0</version>
+   </dependency>
+   ```
+
+2. Configure Flyway in the `application.properties` file:
+   ```properties
+   spring.flyway.enabled=true
+   spring.flyway.locations=classpath:db/migration
+   spring.flyway.baseline-on-migrate=true
+   ```
+
+3. Create a new Flyway script for each table:
+    - Scripts should follow the naming convention `V<version>__<description>.sql`.
+    - Example for a `users` table:
+      ```sql
+      -- File: V1__Create_users_table.sql
+      CREATE TABLE users (
+          id BIGINT PRIMARY KEY,
+          username VARCHAR(255) NOT NULL,
+          password VARCHAR(255) NOT NULL,
+          created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+      );
+      
+      ```
+      
+the table and the columns in the table should be described using SQL comments.
+
+Use varchar without limitation instead of varchar(xxx)
+
+4. Store all Flyway scripts in the `src/main/resources/db/migration` directory.
+
+5. Document this decision in the project's development guidelines to ensure all new DDL operations
+   are added as Flyway scripts.
+````

docs/architecture/decisions/ADR-011-flyway.md

@@ -0,0 +1,65 @@
+# ADR-012: Use Flyway Scripts for Database Initialization in Integration Tests
+
+Date: 2025-10-24
+
+## Status
+
+Accepted
+
+## Context
+
+Integration tests (IT) require a consistent and reliable database state to ensure accurate and
+reproducible results. Currently, database initialization for integration tests is managed manually
+or through ad-hoc scripts, which can lead to inconsistencies and errors. Using the same Flyway
+scripts for both production and integration tests ensures that the database schema and data are
+consistent across environments.
+
+## Decision
+
+Flyway scripts will be used to initialize the database for integration tests. This ensures that the
+database schema and data are consistent with the production environment, reducing the risk of
+discrepancies and improving test reliability.
+
+## Consequences
+
+- **Positive**:
+    - Ensures consistency between production and test environments.
+    - Reduces duplication of effort in maintaining separate initialization scripts.
+    - Simplifies debugging by using the same schema and data definitions.
+
+- **Negative**:
+    - May increase test setup time due to Flyway migrations.
+    - Requires integration tests to handle potential migration errors.
+
+## Implementation
+
+1. Configure Flyway in the `application-test.properties` file:
+   ```properties
+   spring.flyway.enabled=true
+   spring.flyway.locations=classpath:db/migration
+   spring.flyway.clean-on-validation-error=true
+   spring.flyway.baseline-on-migrate=true
+   ```
+
+2. Ensure that the integration test database is cleaned and migrated before each test run:
+    - Use the `@BeforeEach` or `@BeforeAll` lifecycle methods to trigger Flyway migrations.
+    - Example:
+      ```java
+      @SpringBootTest
+      public class ExampleIntegrationTest {
+ 
+          @Autowired
+          private Flyway flyway;
+ 
+          @BeforeEach
+          public void setupDatabase() {
+              flyway.clean();
+              flyway.migrate();
+          }
+ 
+          @Test
+          public void testExample() {
+              // Test logic here
+          }
+      }
+      ```