Small refactor of Migrator.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

app/src/test/java/org/lfenergy/compas/scl/data/rest/CompasMigratorStartupTest.java

@@ -10,8 +10,7 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.*;
 
 @ExtendWith(MockitoExtension.class)
 class CompasMigratorStartupTest {
@@ -23,6 +22,8 @@ class CompasMigratorStartupTest {
 
     @Test
     void migrate_WhenCalled_ThenMigratorIsCalled() {
+        when(compasMigratorService.migrate()).thenReturn(true);
+
         compasMigratorStartup.migrate();
 
         verify(compasMigratorService, times(1)).migrate();

repository-basex/src/main/java/org/lfenergy/compas/scl/data/basex/repository/CompasBaseXMigrator.java

@@ -13,7 +13,8 @@
 @ApplicationScoped
 public class CompasBaseXMigrator implements CompasMigrator {
     @Override
-    public void migrate() {
+    public boolean migrate() {
         // For now there is no migration needed in the BaseX Implementation of the repository.
+        return true;
     }
 }

repository-basex/src/test/java/org/lfenergy/compas/scl/data/basex/repository/CompasBaseXMigratorTest.java

@@ -8,6 +8,8 @@
 import org.mockito.InjectMocks;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 @ExtendWith({MockitoExtension.class})
 class CompasBaseXMigratorTest {
     @InjectMocks
@@ -16,7 +18,7 @@ class CompasBaseXMigratorTest {
     @Test
     void migrate_WhenCalled_ThenMigratorIsCalled() {
         // Call should just work, because nothing is done.
-        compasBaseXMigrator.migrate();
+        assertTrue(compasBaseXMigrator.migrate());
     }
 
 }

repository-postgresql/src/main/java/org/lfenergy/compas/scl/data/repository/postgres/CompasFlywayMigrator.java

@@ -39,9 +39,10 @@ public CompasFlywayMigrator(DataSource dataSource, String... locations) {
     }
 
     @Override
-    public void migrate() {
+    public boolean migrate() {
         // After the bean is created we will execute the migration to the latest version.
         LOGGER.info("Migrating database using Flyway.");
-        flyway.migrate();
+        var result = flyway.migrate();
+        return result.success;
     }
 }

repository-postgresql/src/test/java/org/lfenergy/compas/scl/data/repository/postgres/CompasFlywayMigratorTest.java

@@ -7,6 +7,8 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 @ExtendWith({PostgreSQLServerJUnitExtension.class})
 class CompasFlywayMigratorTest {
     private CompasFlywayMigrator compasFlywayMigrator;
@@ -18,6 +20,6 @@ void beforeEach() {
 
     @Test
     void migrate_WhenCalled_ThenFlywayMigratesDatabaseAndNoErrorShouldOccur() {
-        compasFlywayMigrator.migrate();
+        assertTrue(compasFlywayMigrator.migrate());
     }
 }

repository/src/main/java/org/lfenergy/compas/scl/data/repository/CompasMigrator.java

@@ -10,6 +10,8 @@
 public interface CompasMigrator {
     /**
      * Method called to migrate the database to the new version of the software.
+     *
+     * @return Indicates if the migrations was successful.
      */
-    void migrate();
+    boolean migrate();
 }

service/src/main/java/org/lfenergy/compas/scl/data/service/CompasMigratorService.java

@@ -17,7 +17,7 @@ public CompasMigratorService(CompasMigrator compasMigrator) {
         this.compasMigrator = compasMigrator;
     }
 
-    public void migrate() {
-        compasMigrator.migrate();
+    public boolean migrate() {
+        return compasMigrator.migrate();
     }
 }

service/src/test/java/org/lfenergy/compas/scl/data/service/CompasMigratorServiceTest.java

@@ -10,8 +10,8 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.mockito.Mockito.*;
 
 @ExtendWith(MockitoExtension.class)
 class CompasMigratorServiceTest {
@@ -23,8 +23,9 @@ class CompasMigratorServiceTest {
 
     @Test
     void migrate_WhenCalled_ThenMigratorIsCalled() {
-        compasMigratorService.migrate();
+        when(compasMigrator.migrate()).thenReturn(true);
 
+        assertTrue(compasMigratorService.migrate());
         verify(compasMigrator, times(1)).migrate();
     }
 }