Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Support FKs for SQLite in tests (#72142)

Cam Saul2fd986a3f716
diff --git a/modules/drivers/sqlite/test/metabase/test/data/sqlite.clj b/modules/drivers/sqlite/test/metabase/test/data/sqlite.clj
index a0d8b800e10..2ed0c485773 100644
--- a/modules/drivers/sqlite/test/metabase/test/data/sqlite.clj
+++ b/modules/drivers/sqlite/test/metabase/test/data/sqlite.clj
@@ -1,10 +1,12 @@
(ns metabase.test.data.sqlite
(:require
[clojure.java.io :as io]
- [metabase.config.core :as config]
+ [clojure.string :as str]
+ [clojure.test :refer :all]
[metabase.driver :as driver]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
[metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
+ [metabase.test :as mt]
[metabase.test.data.interface :as tx]
[metabase.test.data.sql :as sql.tx]
[metabase.test.data.sql-jdbc :as sql-jdbc.tx]
@@ -18,11 +20,6 @@
[_driver _feature _database]
false)
-;; TODO: It seems that foreign keys sync does not work on sqlite. The [[metabase.driver-test/describe-table-fks-test]]
-;; is failing. Resolve that and re-enable feature!
-;; Tracked by: https://github.com/metabase/metabase/issues/45788
-(defmethod driver/database-supports? [:sqlite :metadata/key-constraints] [_driver _feature _db] (not config/is-test?))
-
(defn- db-file-name [dbdef]
(str (tx/escaped-database-name dbdef) ".sqlite"))
@@ -61,7 +58,99 @@
(defmethod sql.tx/drop-db-if-exists-sql :sqlite [& _] nil)
(defmethod sql.tx/create-db-sql :sqlite [& _] nil)
-(defmethod sql.tx/add-fk-sql :sqlite [& _] nil) ; TODO - fix me
+(defmethod sql.tx/add-fk-sql :sqlite [& _] nil) ; SQLite FKs have to be added at Table creation time
+
+(defmethod sql.tx/create-table-sql :sqlite
+ [driver {:keys [database-name], :as dbdef} {:keys [table-name field-definitions], :as _tabledef}]
+ (letfn [(spaces [& args]
+ (interpose \space args))
+ (table [table-name]
+ (sql.tx/qualify-and-quote driver database-name table-name))
+ (commas [& args]
+ (interpose ", " args))
+ (sql-list [& args]
+ (concat ["("] (apply commas args) [")"]))
+ (field [field-name]
+ (sql.tx/format-and-quote-field-name driver field-name))
+ (field-def [field-definition]
+ (sql.tx/field-definition-sql driver field-definition))
+ (field-defs []
+ (map field-def field-definitions))
+ (primary-key []
+ (spaces
+ "PRIMARY KEY"
+ (apply sql-list (map field (sql.tx/fielddefs->pk-field-names field-definitions)))))
+ (foreign-key [field-definition]
+ (let [dest-table-name (name (:fk field-definition))
+ pk-names (->> (sql.tx/get-tabledef dbdef dest-table-name)
+ :field-definitions
+ sql.tx/fielddefs->pk-field-names)]
+ (spaces
+ "FOREIGN KEY"
+ (sql-list (field (:field-name field-definition)))
+ "REFERENCES"
+ (table dest-table-name)
+ (apply sql-list (map field pk-names)))))
+ (foreign-keys []
+ (->> field-definitions
+ (filter :fk)
+ (map foreign-key)))]
+ (let [parts (spaces
+ "CREATE TABLE"
+ (table table-name)
+ (apply sql-list (concat (field-defs)
+ [(primary-key)]
+ (foreign-keys))))]
+ (str/join (flatten parts)))))
+
+(deftest ^:parallel create-table-ddl-test
+ (testing "CREATE TABLE for SQLite should include inline FOREIGN KEY declarations (#45788, QUE2-59)"
+ (let [db-def {:database-name "country"
+ :table-definitions [{:table-name "continent"
+ :field-definitions [{:field-name "id"
+ :base-type {:native "INTEGER"}
+ :semantic-type :type/PK
+ :pk? true}]}
+ {:table-name "country"
+ :field-definitions [{:field-name "id"
+ :base-type {:native "INTEGER"}
+ :semantic-type :type/PK
+ :pk? true}
+ {:field-name "name"
+ :base-type :type/Text}
+ {:field-name "continent_id"
+ :base-type :type/Integer
+ :fk :continent}]}]}
+ table-def (second (:table-definitions db-def))
+ sql (sql.tx/create-table-sql :sqlite db-def table-def)]
+ (is (= ["CREATE TABLE \"country\" ("
+ " \"id\" INTEGER,"
+ " \"name\" TEXT,"
+ " \"continent_id\" INTEGER,"
+ " PRIMARY KEY (\"id\"),"
+ " FOREIGN KEY (\"continent_id\") REFERENCES \"continent\" (\"id\")"
+ ")"]
+ (str/split-lines (driver/prettify-native-form :sqlite sql)))))))
+
+(deftest ^:parallel create-table-ddl-test-2
+ (testing "CREATE TABLE for SQLite should include inline FOREIGN KEY declarations should handle custom PKs (#45788, QUE2-59)"
+ (let [db-def (mt/dataset-definition "custom-pk"
+ [["user"
+ [{:field-name "custom_id" :base-type :type/Integer :pk? true}]
+ []]
+ ["group"
+ [{:field-name "id" :base-type {:native "INTEGER"} :pk? true}
+ {:field-name "user_custom_id" :base-type :type/Integer :fk "user"}]
+ []]])
+ table-def (second (:table-definitions db-def))
+ sql (sql.tx/create-table-sql :sqlite db-def table-def)]
+ (is (= ["CREATE TABLE \"group\" ("
+ " \"id\" INTEGER,"
+ " \"user_custom_id\" INTEGER,"
+ " PRIMARY KEY (\"id\"),"
+ " FOREIGN KEY (\"user_custom_id\") REFERENCES \"user\" (\"custom_id\")"
+ ")"]
+ (str/split-lines (driver/prettify-native-form :sqlite sql)))))))
(defmethod tx/destroy-db! :sqlite
[_driver dbdef]
diff --git a/test/metabase/test/data/dataset_definition_test.clj b/test/metabase/test/data/dataset_definition_test.clj
index 9b76226f286..d0e9702f3d5 100644
--- a/test/metabase/test/data/dataset_definition_test.clj
+++ b/test/metabase/test/data/dataset_definition_test.clj
@@ -25,13 +25,14 @@
:semantic_type :type/PK}]
user-fields)))
(testing "user_custom_id is a FK non user.custom_id"
- (is (= #{{:name (format-name "user_custom_id")
- :fk_target_field_id (mt/id :user :custom_id)
- :semantic_type :type/FK}
- {:name (format-name "id")
- :fk_target_field_id nil
- :semantic_type :type/PK}}
- (set group-fields))))))))
+ (is (= (sort-by :name
+ [{:name (format-name "id")
+ :fk_target_field_id nil
+ :semantic_type :type/PK}
+ {:name (format-name "user_custom_id")
+ :fk_target_field_id (mt/id :user :custom_id)
+ :semantic_type :type/FK}])
+ (sort-by :name group-fields))))))))
(mt/defdataset composite-pk
[["songs"
diff --git a/test/metabase/test/data/sql.clj b/test/metabase/test/data/sql.clj
index 801fdbf0c71..38edc0cf163 100644
--- a/test/metabase/test/data/sql.clj
+++ b/test/metabase/test/data/sql.clj
@@ -4,6 +4,7 @@
[clojure.string :as str]
[clojure.walk :as walk]
[honey.sql :as sql]
+ [medley.core :as m]
[metabase.driver :as driver]
[metabase.driver.ddl.interface :as ddl.i]
[metabase.driver.sql]
@@ -276,7 +277,8 @@
(defmethod default-column-sql :default [_ expr]
(format "DEFAULT (%s)" expr))
-(defn- field-definition-sql
+(defn field-definition-sql
+ "Generate the fragment of a `CREATE TABLE` DDL statement for a specific column."
[driver {:keys [field-name base-type field-comment not-null? unique? default-expr generated-expr], :as field-definition}]
(let [field-name (format-and-quote-field-name driver field-name)
field-type (or (cond
@@ -343,12 +345,11 @@
tx/dispatch-on-driver-with-test-extensions
:hierarchy #'driver/hierarchy)
-(defn- get-tabledef
- [dbdef table-name]
- (->> dbdef
- :table-definitions
- (filter #(= (:table-name %) table-name))
- first))
+(defn get-tabledef
+ "Find the first table definition with `table-name`."
+ [{:keys [table-definitions], :as _dbdef} table-name]
+ (m/find-first #(= (:table-name %) table-name)
+ table-definitions))
(defmethod add-fk-sql :sql/test-extensions
[driver {:keys [database-name] :as dbdef} {:keys [table-name]} {dest-table-name :fk, field-name :field-name}]