DBTOOLS-2082 fixed deleting non project files during update

Author: Ямалиев Рашит Азатович yamaliev_ra

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+- Fixed full project update to clean only the project's own directories.
 - Fixed adding library objects to a project during export.
 - Fixed code generation for index when altering in CONCURRENTLY mode.
 - Fixed migration script generation when changing a generated column in PostgreSQL.

CHANGELOG.ru.md

@@ -15,6 +15,7 @@
 
 ### Исправлено
 
+- Исправлено полное обновление проекта: очищаются только папки самого проекта.
 - Исправлено добавление объектов библиотек в проект при экспорте.
 - Исправлена генерация кода индекса при его изменении в режиме CONCURRENTLY.
 - Исправлена генерация скрипта миграции при изменении генерируемой колонки в PostgreSQL.

src/main/java/org/pgcodekeeper/core/database/api/project/IProjectUpdater.java

@@ -34,5 +34,19 @@ public interface IProjectUpdater {
      * @param projectOnly whether to preserve overrides directory during update
      * @throws IOException if update operation fails
      */
-    void updateFull(boolean projectOnly) throws IOException;
+    default void updateFull(boolean projectOnly) throws IOException {
+        updateFull(projectOnly, null);
+    }
+
+    /**
+     * Performs full update of database project.
+     * Completely regenerates project structure with optional overrides preservation.
+     * Only the project's own working directories are cleaned.
+     *
+     * @param projectOnly      whether to preserve overrides directory during update
+     * @param previousWorkDirs the layout the project currently uses on disk, or {@code null}
+     *                         to clean only the new layout's directories
+     * @throws IOException if update operation fails
+     */
+    void updateFull(boolean projectOnly, IWorkDirs previousWorkDirs) throws IOException;
 }

src/main/java/org/pgcodekeeper/core/database/api/project/IWorkDirs.java

@@ -21,6 +21,7 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Map;
 
 /**
@@ -80,4 +81,20 @@ public interface IWorkDirs {
      * @throws IOException if the configuration file cannot be written
      */
     void saveAltDirs(Path projectPath) throws IOException;
+
+    /**
+     * Returns the distinct top-level directory names of this layout, i.e. the
+     * directories created directly under the project root.
+     *
+     * @return distinct top-level directory names of this layout
+     */
+    default List<String> getTopLevelDirNames() {
+        boolean split = isSplitBySchema();
+        return getDirMapping().values().stream()
+                .filter(rule -> !split || !rule.isSubElement())
+                .map(rule -> rule.getDirName().split("/")[0])
+                .filter(name -> !name.isBlank())
+                .distinct()
+                .toList();
+    }
 }

src/main/java/org/pgcodekeeper/core/database/base/project/AbstractModelExporter.java

@@ -160,6 +160,15 @@ public Path getRelativeFilePath(IStatement st) {
         return workDirs.getRelativeFilePath(st);
     }
 
+    /**
+     * Returns the directory layout used by this exporter.
+     *
+     * @return the work directories layout
+     */
+    public IWorkDirs getWorkDirs() {
+        return workDirs;
+    }
+
     @Override
     public void exportFull() throws IOException {
         createOutDir();

src/main/java/org/pgcodekeeper/core/database/base/project/AbstractProjectUpdater.java

@@ -16,6 +16,7 @@
 package org.pgcodekeeper.core.database.base.project;
 
 import org.pgcodekeeper.core.database.api.project.IProjectUpdater;
+import org.pgcodekeeper.core.database.api.project.IWorkDirs;
 import org.pgcodekeeper.core.database.api.schema.IDatabase;
 import org.pgcodekeeper.core.exception.PgCodeKeeperException;
 import org.pgcodekeeper.core.localizations.Messages;
@@ -32,7 +33,9 @@
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.LinkedHashSet;
 import java.util.List;
+import java.util.Set;
 import java.util.stream.Stream;
 
 import static org.pgcodekeeper.core.database.base.loader.AbstractProjectLoader.OVERRIDES_DIR;
@@ -199,15 +202,16 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
     }
 
     @Override
-    public void updateFull(boolean projectOnly) throws IOException {
+    public void updateFull(boolean projectOnly, IWorkDirs previousWorkDirs) throws IOException {
         LOG.info(Messages.ProjectUpdater_log_start_full_update);
         boolean caughtProcessingEx = false;
         try (TempDir tmp = new TempDir(dirExport, "tmp-export")) { //$NON-NLS-1$
             Path dirTmp = tmp.get();
 
             try {
-                safeCleanProjectDir(dirTmp);
-                createModelExporter(dirExport, dbNew, encoding).exportFull();
+                AbstractModelExporter exporter = createModelExporter(dirExport, dbNew, encoding);
+                safeCleanProjectDir(dirTmp, exporter.getWorkDirs(), previousWorkDirs);
+                exporter.exportFull();
                 if (projectOnly) {
                     restoreFolder(dirTmp, OVERRIDES_DIR);
                 }
@@ -227,8 +231,13 @@ public void updateFull(boolean projectOnly) throws IOException {
         }
     }
 
-    private void safeCleanProjectDir(Path dirTmp) throws IOException {
-        for (String subdirName : listProjectDirs(dirExport, dirTmp)) {
+    private void safeCleanProjectDir(Path dirTmp, IWorkDirs workDirs, IWorkDirs previousWorkDirs) throws IOException {
+        Set<String> ownedDirs = new LinkedHashSet<>(workDirs.getTopLevelDirNames());
+        if (previousWorkDirs != null) {
+            ownedDirs.addAll(previousWorkDirs.getTopLevelDirNames());
+        }
+        ownedDirs.add(OVERRIDES_DIR);
+        for (String subdirName : ownedDirs) {
             moveFolder(dirTmp, subdirName);
         }
     }
@@ -246,12 +255,15 @@ private void restoreProjectDir(Path dirTmp) throws IOException {
         }
     }
 
-    private static List<String> listProjectDirs(Path dir, Path exclude) throws IOException {
+    private List<String> listProjectDirs(Path dir, Path exclude) throws IOException {
         try (Stream<Path> stream = Files.list(dir)) {
             List<String> result = new ArrayList<>();
             for (Path path : Utils.streamIterator(stream)) {
-                if (Files.isDirectory(path) && !path.equals(exclude)) {
-                    result.add(path.getFileName().toString());
+                String name = path.getFileName().toString();
+                if (Files.isDirectory(path)
+                        && !path.equals(exclude)
+                        && !name.startsWith(".")) {
+                    result.add(name);
                 }
             }
             return result;

src/test/java/org/pgcodekeeper/core/api/PgCodeKeeperApiTest.java

@@ -19,14 +19,18 @@
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import java.io.IOException;
 import java.nio.file.*;
+import java.util.List;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.CsvSource;
 import org.junit.jupiter.params.provider.ValueSource;
 import org.pgcodekeeper.core.TestUtils;
+import org.pgcodekeeper.core.database.api.schema.IDatabase;
+import org.pgcodekeeper.core.database.base.project.AbstractWorkDirs;
 import org.pgcodekeeper.core.database.pg.PgDatabaseProvider;
+import org.pgcodekeeper.core.database.pg.project.PgWorkDirs;
 import org.pgcodekeeper.core.settings.CoreSettings;
 import org.pgcodekeeper.core.settings.DiffSettings;
 
@@ -172,6 +176,34 @@ void updateProjectWithIgnoreListTest(@TempDir Path tempDir) throws IOException,
         TestUtils.assertErrors(diffSettings.getErrors());
     }
 
+    @Test
+    void fullUpdatePreservesMetadataDirsTest(@TempDir Path tempDir) throws IOException, InterruptedException {
+        Path settingsDir = tempDir.resolve(".settings");
+        Files.createDirectories(settingsDir);
+
+        IDatabase newDb = provider.getDumpLoader(getFilePath("test_export.sql"), diffSettings).loadAndAnalyze();
+        provider.getProjectUpdater(newDb, null, List.of(), tempDir, false, new CoreSettings()).updateFull(true);
+
+        assertTrue(Files.exists(settingsDir));
+        TestUtils.assertErrors(diffSettings.getErrors());
+    }
+
+    @Test
+    void fullUpdateCleansRenamedDirsAndKeepsForeignTest(@TempDir Path tempDir)
+            throws IOException, InterruptedException {
+        Files.createDirectories(tempDir.resolve("MIGRATION"));
+        Files.createDirectories(tempDir.resolve("SCHEMA"));
+        Files.writeString(tempDir.resolve(AbstractWorkDirs.ALT_DIRS_FILENAME), "SCHEMA=DB\n");
+
+        IDatabase newDb = provider.getDumpLoader(getFilePath("test_export.sql"), diffSettings).loadAndAnalyze();
+        provider.getProjectUpdater(newDb, null, List.of(), tempDir, false, new CoreSettings())
+                .updateFull(true, new PgWorkDirs());
+
+        assertTrue(Files.exists(tempDir.resolve("MIGRATION")));
+        assertFalse(Files.exists(tempDir.resolve("SCHEMA")));
+        TestUtils.assertErrors(diffSettings.getErrors());
+    }
+
     private void setupUpdateProjectStructure(Path tempDir) throws IOException {
         Path publicDir = tempDir.resolve(PUBLIC_DIRECTORY);
         Path tablesDir = tempDir.resolve(TABLES_DIRECTORY);

src/test/java/org/pgcodekeeper/core/database/ch/project/ChWorkDirsTest.java

@@ -22,6 +22,7 @@
 
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
 
 final class ChWorkDirsTest {
 
@@ -50,4 +51,12 @@ void testLoadsAltDirsFromPropertiesFile(@TempDir Path tempDir) throws Exception
         Assertions.assertEquals("VIEW", workDirs.getDirMapping().get("VIEW").getDirName());
         Assertions.assertFalse(workDirs.isSplitBySchema());
     }
+
+    @Test
+    void testTopDirNames() {
+        var workDirs = new ChWorkDirs();
+        var expected = List.of("DATABASE", "FUNCTION", "USER", "POLICY", "ROLE");
+        var actual = workDirs.getTopLevelDirNames();
+        Assertions.assertEquals(expected, actual);
+    }
 }

src/test/java/org/pgcodekeeper/core/database/ms/project/MsWorkDirsTest.java

@@ -22,6 +22,7 @@
 
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
 
 final class MsWorkDirsTest {
 
@@ -51,4 +52,12 @@ void testLoadsAltDirsFromPropertiesFile(@TempDir Path tempDir) throws Exception
         Assertions.assertEquals("Views", workDirs.getDirMapping().get("VIEW").getDirName());
         Assertions.assertTrue(workDirs.isSplitBySchema());
     }
+
+    @Test
+    void testTopDirNames() {
+        var workDirs = new MsWorkDirs();
+        var expected = List.of("Security", "Assemblies", "Types", "Tables", "Views", "Sequences", "Functions", "Stored Procedures");
+        var actual = workDirs.getTopLevelDirNames();
+        Assertions.assertEquals(expected, actual);
+    }
 }

src/test/java/org/pgcodekeeper/core/database/pg/project/PgWorkDirsTest.java

@@ -27,6 +27,7 @@
 
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.List;
 import java.util.Properties;
 
 final class PgWorkDirsTest {
@@ -134,4 +135,12 @@ void testSaveDefaultAltDirs(@TempDir Path tempDir) throws Exception {
         boolean exists = Files.isRegularFile(tempDir.resolve(AbstractWorkDirs.ALT_DIRS_FILENAME));
         Assertions.assertFalse(exists);
     }
+
+    @Test
+    void testTopDirNames() {
+        var workDirs = new PgWorkDirs();
+        var expected = List.of("SCHEMA", "EXTENSION", "EVENT_TRIGGER", "USER_MAPPING", "CAST", "SERVER", "FDW");
+        var actual = workDirs.getTopLevelDirNames();
+        Assertions.assertEquals(expected, actual);
+    }
 }