Merge branch 'DBTOOLS-1725-additional-dependencies' into 'master'

AXEPOH · AXEPOH · commit 70d76341adc4 · 2025-09-09T15:25:18.000+05:00
DBTOOLS-1725 added new overloads of the diff method to PgCodeKeeperApi

See merge request codekeeper/pgcodekeeper-core!70
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - Added connection test with databases.
+- Added new overloads of the diff method to PgCodeKeeperApi.
 
 ### Changed
 
diff --git a/CHANGELOG.ru.md b/CHANGELOG.ru.md
@@ -10,6 +10,7 @@
 ### Добавлено
 
 - Добавлены тесты соединения с базами данных.
+- Добавлены новые перегрузки метода diff в PgCodeKeeperApi.
 
 ### Изменено
 
diff --git a/src/main/java/org/pgcodekeeper/core/PgDiff.java b/src/main/java/org/pgcodekeeper/core/PgDiff.java
@@ -73,50 +73,34 @@ public List<Object> getErrors() {
         return Collections.unmodifiableList(errors);
     }
 
-    /**
-     * Selects all objects for diff, compares them between source and target
-     * and generates a migration script.
-     *
-     * @param oldDb      the source database schema
-     * @param newDb      the target database schema
-     * @param ignoreList list of objects to ignore during comparison
-     * @return SQL migration script
-     * @throws InterruptedException if the operation is interrupted
-     * @throws IOException          if an I/O error occurs
-     */
-    public String diff(AbstractDatabase oldDb, AbstractDatabase newDb, IgnoreList ignoreList)
-            throws InterruptedException, IOException {
-        TreeElement root = DiffTree.create(settings, oldDb, newDb);
-        root.setAllChecked();
-
-        return diff(root, oldDb, newDb, null, null, ignoreList);
-    }
-
     /**
      * Gets selected elements from root, compares them between source and target
      * and generates a migration script.
      *
-     * @param root                   the root of the diff tree
-     * @param oldDb                  the source database schema
-     * @param newDb                  the target database schema
-     * @param additionalDepciesOldDb additional dependencies in old database
-     * @param additionalDepciesNewDb additional dependencies in new database
-     * @param ignoreList             list of objects to ignore during comparison
+     * @param root                        the root of the diff tree
+     * @param oldDb                       the source database schema
+     * @param newDb                       the target database schema
+     * @param additionalDependenciesOldDb additional dependencies in old database
+     * @param additionalDependenciesNewDb additional dependencies in new database
+     * @param ignoreList                  list of objects to ignore during comparison
      * @return SQL migration script
      * @throws IOException if an I/O error occurs
      */
     public String diff(TreeElement root,
-            AbstractDatabase oldDb, AbstractDatabase newDb,
-            List<Entry<PgStatement, PgStatement>> additionalDepciesOldDb,
-            List<Entry<PgStatement, PgStatement>> additionalDepciesNewDb, IgnoreList ignoreList) throws IOException {
+                       AbstractDatabase oldDb,
+                       AbstractDatabase newDb,
+                       List<Entry<PgStatement, PgStatement>> additionalDependenciesOldDb,
+                       List<Entry<PgStatement, PgStatement>> additionalDependenciesNewDb,
+                       IgnoreList ignoreList)
+            throws IOException {
         List<TreeElement> selected = getSelectedElements(root, ignoreList);
         if (selected.isEmpty()) {
             return EMPTY_SCRIPT;
         }
 
         Set<PgStatement> toRefresh = new LinkedHashSet<>();
-        var actions = resolveDependencies(selected, oldDb, newDb, additionalDepciesOldDb,
-                additionalDepciesNewDb, toRefresh);
+        var actions = resolveDependencies(selected, oldDb, newDb, additionalDependenciesOldDb,
+                additionalDependenciesNewDb, toRefresh);
         if (actions.isEmpty()) {
             return EMPTY_SCRIPT;
         }
@@ -220,9 +204,11 @@ protected List<TreeElement> getSelectedElements(TreeElement root, IgnoreList ign
     }
 
     private Set<ActionContainer> resolveDependencies(List<TreeElement> selected,
-            AbstractDatabase oldDb, AbstractDatabase newDb,
-            List<Entry<PgStatement, PgStatement>> additionalDepciesOldDb,
-            List<Entry<PgStatement, PgStatement>> additionalDepciesNewDb, Set<PgStatement> toRefresh) {
+                                                     AbstractDatabase oldDb,
+                                                     AbstractDatabase newDb,
+                                                     List<Entry<PgStatement, PgStatement>> additionalDependenciesOldDb,
+                                                     List<Entry<PgStatement, PgStatement>> additionalDependenciesNewDb,
+                                                     Set<PgStatement> toRefresh) {
         addColumnsAsElements(oldDb, newDb, selected);
 
         selected.sort(new CompareTree());
@@ -246,7 +232,7 @@ private Set<ActionContainer> resolveDependencies(List<TreeElement> selected,
             objects.add(new DbObject(oldStatement, newStatement));
         }
         return DepcyResolver.resolve(oldDb, newDb,
-                additionalDepciesOldDb, additionalDepciesNewDb, toRefresh, objects, settings);
+                additionalDependenciesOldDb, additionalDependenciesNewDb, toRefresh, objects, settings);
     }
 
     @Deprecated
diff --git a/src/main/java/org/pgcodekeeper/core/api/PgCodeKeeperApi.java b/src/main/java/org/pgcodekeeper/core/api/PgCodeKeeperApi.java
@@ -22,6 +22,7 @@
 import org.pgcodekeeper.core.model.difftree.*;
 import org.pgcodekeeper.core.model.exporter.ModelExporter;
 import org.pgcodekeeper.core.schema.AbstractDatabase;
+import org.pgcodekeeper.core.schema.PgStatement;
 import org.pgcodekeeper.core.settings.ISettings;
 import org.pgcodekeeper.core.monitor.IMonitor;
 import org.pgcodekeeper.core.utils.ProjectUpdater;
@@ -31,6 +32,7 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Main API class for pgCodeKeeper database operations.
@@ -48,7 +50,7 @@ public final class PgCodeKeeperApi {
      * @throws InterruptedException if the thread is interrupted during the operation
      */
     public static String diff(ISettings settings, AbstractDatabase oldDb, AbstractDatabase newDb)
-            throws PgCodekeeperException, IOException, InterruptedException {
+            throws IOException, InterruptedException {
         return diff(settings, oldDb, newDb, Collections.emptyList());
     }
 
@@ -63,10 +65,63 @@ public static String diff(ISettings settings, AbstractDatabase oldDb, AbstractDa
      * @throws IOException          if I/O operations fail or ignore list file cannot be read
      * @throws InterruptedException if the thread is interrupted during the operation
      */
-    public static String diff(ISettings settings, AbstractDatabase oldDb, AbstractDatabase newDb,
-                              Collection<String> ignoreLists) throws IOException, InterruptedException {
+    public static String diff(ISettings settings,
+                              AbstractDatabase oldDb,
+                              AbstractDatabase newDb,
+                              Collection<String> ignoreLists)
+            throws IOException, InterruptedException {
+        return diff(settings, oldDb, newDb, null, null, ignoreLists);
+    }
+
+    /**
+     * Compares two databases and generates a migration script with filtering and additional dependencies.
+     *
+     * @param settings                    ISettings object
+     * @param oldDb                       the old database version to compare from
+     * @param newDb                       the new database version to compare to
+     * @param additionalDependenciesOldDb additional dependencies in old database
+     * @param additionalDependenciesNewDb additional dependencies in new database
+     * @param ignoreLists                 collection of paths to files containing objects to ignore
+     * @return the generated migration script as a string
+     * @throws IOException          if I/O operations fail or ignore list file cannot be read
+     * @throws InterruptedException if the thread is interrupted during the operation
+     */
+    public static String diff(ISettings settings,
+                              AbstractDatabase oldDb,
+                              AbstractDatabase newDb,
+                              List<Map.Entry<PgStatement, PgStatement>> additionalDependenciesOldDb,
+                              List<Map.Entry<PgStatement, PgStatement>> additionalDependenciesNewDb,
+                              Collection<String> ignoreLists)
+            throws IOException, InterruptedException {
+        TreeElement root = DiffTree.create(settings, oldDb, newDb);
+        root.setAllChecked();
+        return diff(settings, root, oldDb, newDb, additionalDependenciesOldDb, additionalDependenciesNewDb, ignoreLists);
+    }
+
+    /**
+     * Compares two databases and generates a migration script with filtering and additional dependencies.
+     *
+     * @param settings                    ISettings object
+     * @param root                        root element of tree
+     * @param oldDb                       the old database version to compare from
+     * @param newDb                       the new database version to compare to
+     * @param additionalDependenciesOldDb additional dependencies in old database
+     * @param additionalDependenciesNewDb additional dependencies in new database
+     * @param ignoreLists                 collection of paths to files containing objects to ignore
+     * @return the generated migration script as a string
+     * @throws IOException if I/O operations fail or ignore list file cannot be read
+     */
+    public static String diff(ISettings settings,
+                              TreeElement root,
+                              AbstractDatabase oldDb,
+                              AbstractDatabase newDb,
+                              List<Map.Entry<PgStatement, PgStatement>> additionalDependenciesOldDb,
+                              List<Map.Entry<PgStatement, PgStatement>> additionalDependenciesNewDb,
+                              Collection<String> ignoreLists)
+            throws IOException {
         IgnoreList ignoreList = IgnoreParser.parseLists(ignoreLists);
-        return new PgDiff(settings).diff(oldDb, newDb, ignoreList);
+        return new PgDiff(settings)
+                .diff(root, oldDb, newDb, additionalDependenciesOldDb, additionalDependenciesNewDb, ignoreList);
     }
 
     /**
@@ -101,8 +156,7 @@ public static void export(ISettings settings, AbstractDatabase dbToExport, Strin
                               Collection<String> ignoreLists, IMonitor monitor)
             throws IOException, InterruptedException {
         IgnoreList ignoreList = IgnoreParser.parseLists(ignoreLists);
-        TreeElement root;
-        root = DiffTree.create(settings, dbToExport, null, monitor);
+        TreeElement root = DiffTree.create(settings, dbToExport, null, monitor);
         root.setAllChecked();
 
         List<TreeElement> selected = getSelectedElements(settings, root, ignoreList);
diff --git a/src/main/java/org/pgcodekeeper/core/ignoreparser/IgnoreParser.java b/src/main/java/org/pgcodekeeper/core/ignoreparser/IgnoreParser.java
@@ -138,8 +138,10 @@ private void ruleRest(Rule_restContext ruleRest, boolean isShow) {
     public static IgnoreList parseLists(Collection<String> ignoreLists) throws IOException {
         IgnoreList ignoreList = new IgnoreList();
         IgnoreParser ignoreParser = new IgnoreParser(ignoreList);
-        for (String ignoreListPath : ignoreLists) {
-            ignoreParser.parse(Paths.get(ignoreListPath));
+        if (ignoreLists != null) {
+            for (String ignoreListPath : ignoreLists) {
+                ignoreParser.parse(Paths.get(ignoreListPath));
+            }
         }
         return ignoreList;
     }
diff --git a/src/main/java/org/pgcodekeeper/core/model/graph/DepcyResolver.java b/src/main/java/org/pgcodekeeper/core/model/graph/DepcyResolver.java
@@ -563,13 +563,16 @@ private Boolean getRecreatedObj(AbstractTable oldTable, AbstractTable newTable)
         return recreatedObjs.computeIfAbsent(oldTable.getQualifiedName(), x -> oldTable.isRecreated(newTable, settings));
     }
 
-    public static Set<ActionContainer> resolve(AbstractDatabase oldDb, AbstractDatabase newDb,
-                                               List<Entry<PgStatement, PgStatement>> additionalDepciesOldDb,
-                                               List<Entry<PgStatement, PgStatement>> additionalDepciesNewDb,
-                                               Set<PgStatement> toRefresh, List<DbObject> dbObjects, ISettings settings) {
+    public static Set<ActionContainer> resolve(AbstractDatabase oldDb,
+                                               AbstractDatabase newDb,
+                                               List<Entry<PgStatement, PgStatement>> additionalDependenciesOldDb,
+                                               List<Entry<PgStatement, PgStatement>> additionalDependenciesNewDb,
+                                               Set<PgStatement> toRefresh,
+                                               List<DbObject> dbObjects,
+                                               ISettings settings) {
         DepcyResolver depRes = new DepcyResolver(oldDb, newDb, settings, toRefresh);
-        depRes.oldDepcyGraph.addCustomDepcies(additionalDepciesOldDb);
-        depRes.newDepcyGraph.addCustomDepcies(additionalDepciesNewDb);
+        depRes.oldDepcyGraph.addCustomDepcies(additionalDependenciesOldDb);
+        depRes.newDepcyGraph.addCustomDepcies(additionalDependenciesNewDb);
         depRes.fillObjects(dbObjects);
         depRes.recreateDrops();
         depRes.removeExtraActions();
diff --git a/src/test/java/org/pgcodekeeper/core/it/IntegrationTestUtils.java b/src/test/java/org/pgcodekeeper/core/it/IntegrationTestUtils.java
@@ -17,6 +17,7 @@
 
 import org.junit.jupiter.api.Assertions;
 import org.pgcodekeeper.core.*;
+import org.pgcodekeeper.core.api.PgCodeKeeperApi;
 import org.pgcodekeeper.core.loader.DatabaseLoader;
 import org.pgcodekeeper.core.loader.PgDumpLoader;
 import org.pgcodekeeper.core.model.difftree.DbObjType;
@@ -87,7 +88,7 @@ public static void assertDiffSame(AbstractDatabase db, String template, ISetting
 
     public static void assertDiff(AbstractDatabase oldDb, AbstractDatabase newDb, ISettings settings, String errorMessage)
             throws IOException, InterruptedException {
-        String script = new PgDiff(settings).diff(oldDb, newDb, null);
+        String script = PgCodeKeeperApi.diff(settings, oldDb, newDb);
         Assertions.assertEquals("", script.trim(), errorMessage);
     }
 
@@ -129,7 +130,7 @@ public static String getScript(String fileNameTemplate, CoreSettings settings, C
         AbstractDatabase dbNew = loadTestDump(fileNameTemplate + FILES_POSTFIX.NEW_SQL, clazz, settings);
         assertDiffSame(dbNew, fileNameTemplate, settings);
 
-        return new PgDiff(settings).diff(dbOld, dbNew, null);
+        return PgCodeKeeperApi.diff(settings, dbOld, dbNew);
     }
 
     public static void assertEqualsDependencies(String dbTemplate, String userTemplateName,
@@ -144,7 +145,7 @@ public static void assertEqualsDependencies(String dbTemplate, String userTempla
         TreeElement tree = DiffTree.create(settings, oldDbFull, newDbFull, null);
 
         setSelected(selected, tree, oldDbFull, newDbFull);
-        String script = new PgDiff(settings).diff(tree, oldDbFull, newDbFull, null, null, null);
+        String script = PgCodeKeeperApi.diff(settings, tree, oldDbFull, newDbFull, null, null, null);
         var userSelTemplate = null == userTemplateName ? dbTemplate : dbTemplate + "_" + userTemplateName;
         assertResult(script, userSelTemplate, clazz);
     }
diff --git a/src/test/java/org/pgcodekeeper/core/it/diff/ms/MsMoveDataDiffTest.java b/src/test/java/org/pgcodekeeper/core/it/diff/ms/MsMoveDataDiffTest.java
@@ -19,7 +19,7 @@
 import org.junit.jupiter.params.provider.ValueSource;
 import org.pgcodekeeper.core.DatabaseType;
 import org.pgcodekeeper.core.FILES_POSTFIX;
-import org.pgcodekeeper.core.PgDiff;
+import org.pgcodekeeper.core.api.PgCodeKeeperApi;
 import org.pgcodekeeper.core.schema.AbstractDatabase;
 import org.pgcodekeeper.core.settings.CoreSettings;
 
@@ -58,7 +58,7 @@ void moveDataTest(String fileNameTemplate) throws IOException, InterruptedExcept
         assertDiffSame(dbOld, fileNameTemplate, settings);
         assertDiffSame(dbNew, fileNameTemplate, settings);
 
-        String script = new PgDiff(settings).diff(dbOld, dbNew, null);
+        String script = PgCodeKeeperApi.diff(settings, dbOld, dbNew);
         String content = script.replaceAll("([0-9a-fA-F]{32})", "randomly_generated_part");
 
         assertResult(content, fileNameTemplate, MsMoveDataDiffTest.class);
diff --git a/src/test/java/org/pgcodekeeper/core/it/diff/pg/LibDiffTest.java b/src/test/java/org/pgcodekeeper/core/it/diff/pg/LibDiffTest.java
@@ -19,8 +19,9 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
 import org.pgcodekeeper.core.FILES_POSTFIX;
-import org.pgcodekeeper.core.PgDiff;
 import org.pgcodekeeper.core.TestUtils;
+import org.pgcodekeeper.core.api.PgCodeKeeperApi;
+import org.pgcodekeeper.core.it.IntegrationTestUtils;
 import org.pgcodekeeper.core.loader.DatabaseLoader;
 import org.pgcodekeeper.core.loader.LibraryLoader;
 import org.pgcodekeeper.core.schema.AbstractDatabase;
@@ -31,8 +32,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import static org.pgcodekeeper.core.it.IntegrationTestUtils.*;
-
 class LibDiffTest {
 
     @ParameterizedTest
@@ -70,13 +69,13 @@ private void testLibrary(String fileNameTemplate, List<String> libList, boolean
             libs.add(TestUtils.getPathToResource(lib, getClass()).toString());
         }
         AbstractDatabase dbOld = DatabaseLoader.createDb(settings);
-        AbstractDatabase dbNew = loadTestDump(fileNameTemplate + FILES_POSTFIX.NEW_SQL, getClass(), settings);
+        AbstractDatabase dbNew = IntegrationTestUtils.loadTestDump(fileNameTemplate + FILES_POSTFIX.NEW_SQL, getClass(), settings);
         LibraryLoader loader = new LibraryLoader(dbNew, null, null);
 
         loader.loadLibraries(settings, isIgnorePrivileges, libs);
 
-        String script = new PgDiff(settings).diff(dbOld, dbNew, null);
+        String script = PgCodeKeeperApi.diff(settings, dbOld, dbNew);
 
-        assertResult(script, fileNameTemplate, getClass());
+        IntegrationTestUtils.assertResult(script, fileNameTemplate, getClass());
     }
 }
diff --git a/src/test/java/org/pgcodekeeper/core/it/diff/pg/PgMoveDataDiffTest.java b/src/test/java/org/pgcodekeeper/core/it/diff/pg/PgMoveDataDiffTest.java
@@ -19,7 +19,7 @@
 import org.junit.jupiter.params.provider.ValueSource;
 import org.pgcodekeeper.core.DatabaseType;
 import org.pgcodekeeper.core.FILES_POSTFIX;
-import org.pgcodekeeper.core.PgDiff;
+import org.pgcodekeeper.core.api.PgCodeKeeperApi;
 import org.pgcodekeeper.core.it.IntegrationTestUtils;
 import org.pgcodekeeper.core.schema.AbstractDatabase;
 import org.pgcodekeeper.core.settings.CoreSettings;
@@ -68,7 +68,7 @@ void moveDataTest(String fileNameTemplate) throws IOException, InterruptedExcept
         IntegrationTestUtils.assertDiffSame(dbOld, fileNameTemplate, settings);
         IntegrationTestUtils.assertDiffSame(dbNew, fileNameTemplate, settings);
 
-        String script = new PgDiff(settings).diff(dbOld, dbNew, null);
+        String script = PgCodeKeeperApi.diff(settings, dbOld, dbNew);
         String content = script.replaceAll("([0-9a-fA-F]{32})", "randomly_generated_part");
 
         IntegrationTestUtils.assertResult(content, fileNameTemplate, PgMoveDataDiffTest.class);

Original file line number	Diff line number	Diff line change
`@@ -138,8 +138,10 @@ private void ruleRest(Rule_restContext ruleRest, boolean isShow) {`
`138`	`138`	`public static IgnoreList parseLists(Collection<String> ignoreLists) throws IOException {`
`139`	`139`	`IgnoreList ignoreList = new IgnoreList();`
`140`	`140`	`IgnoreParser ignoreParser = new IgnoreParser(ignoreList);`
`141`		`- for (String ignoreListPath : ignoreLists) {`
`142`		`- ignoreParser.parse(Paths.get(ignoreListPath));`
	`141`	`+ if (ignoreLists != null) {`
	`142`	`+ for (String ignoreListPath : ignoreLists) {`
	`143`	`+ ignoreParser.parse(Paths.get(ignoreListPath));`
	`144`	`+ }`
`143`	`145`	`}`
`144`	`146`	`return ignoreList;`
`145`	`147`	`}`