Implement autogenerate detection for foreign key constraints

Issue #178

diff --git a/alembic/autogenerate/compare.py b/alembic/autogenerate/compare.py
index b60321291d5ce7cb9e79c51ae4f5da2885c4bbd3..9cdf21671357cfbe1efef3203cf3beb5ffff2c44 100644 (file)
--- a/alembic/autogenerate/compare.py
+++ b/alembic/autogenerate/compare.py
@@ -1,3 +1,4 @@
+import collections
 from sqlalchemy import schema as sa_schema, types as sqltypes
 from sqlalchemy import event
 import logging
@@ -110,6 +111,9 @@ def _compare_tables(conn_table_names, metadata_table_names,
                                          conn_table,
                                          metadata_table,
                                          diffs, autogen_context, inspector)
+            _compare_foreign_keys(s, tname, object_filters, conn_table,
+                                  metadata_table, diffs, autogen_context,
+                                  inspector)
 
     # TODO:
     # table constraints
@@ -558,3 +562,44 @@ def _compare_server_default(schema, tname, cname, conn_col, metadata_col,
                  tname,
                  cname
                  )
+
+FKInfo = collections.namedtuple('fk_info', ['constrained_columns',
+                                            'referred_table',
+                                            'referred_columns'])
+
+
+def _compare_foreign_keys(schema, tname, object_filters, conn_table,
+            metadata_table, diffs, autogen_context, inspector):
+        # This methods checks foreign keys that tables contain in models with
+        # foreign keys that are in db.
+            # Get all necessary information about key of current table from db
+        fk_db = dict((_get_fk_info_from_db(i), i['name']) for i in
+                     inspector.get_foreign_keys(tname))
+        fk_db_set = set(fk_db.keys())
+        # Get all necessary information about key of current table from
+        # models
+        fk_models = dict((_get_fk_info_from_model(fk), fk) for fk in
+                         metadata_table.foreign_keys)
+        fk_models_set = set(fk_models.keys())
+        for key in (fk_db_set - fk_models_set):
+                diffs.append(('drop_key', fk_db[key], conn_table, key))
+                log.info(("Detected removed foreign key %(fk)r on "
+                          "table %(table)r"), {'fk': fk_db[key],
+                                               'table': conn_table})
+        for key in (fk_models_set - fk_db_set):
+                diffs.append(('add_key', fk_models[key], key))
+                log.info((
+                    "Detected added foreign key for column %(fk)r on table "
+                    "%(table)r"), {'fk': fk_models[key].column.name,
+                                   'table': conn_table})
+        return diffs
+
+
+def _get_fk_info_from_db(self, fk):
+    return self.FKInfo(tuple(fk['constrained_columns']),
+                       fk['referred_table'],
+                       tuple(fk['referred_columns']))
+
+def _get_fk_info_from_model(self, fk):
+    return self.FKInfo((fk.parent.name,), fk.column.table.name,
+                       (fk.column.name,))
\ No newline at end of file