Chore: add/update sqlstore-related helper functions (#77408)

* add/update sqlstore-related helper functions * add documentation & tests for InsertQuery and UpdateQuery, make generated SQL deterministic by sorting columns * remove old log line
2023-11-03 10:30:52 -04:00
parent 6b729389b5
commit 67b2972052
9 changed files with 237 additions and 11 deletions
@@ -0,0 +1,117 @@
+package migrator
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestInsertQuery(t *testing.T) {
+	tests := []struct {
+		name                  string
+		tableName             string
+		values                map[string]any
+		expectedErr           bool
+		expectedPostgresQuery string
+		expectedPostgresArgs  []any
+		expectedMySQLQuery    string
+		expectedMySQLArgs     []any
+		expectedSQLiteQuery   string
+		expectedSQLiteArgs    []any
+	}{
+		{
+			"insert one",
+			"some_table",
+			map[string]any{"col1": "val1", "col2": "val2", "col3": "val3"},
+			false,
+			"INSERT INTO \"some_table\" (\"col1\", \"col2\", \"col3\") VALUES (?, ?, ?)",
+			[]any{"val1", "val2", "val3"},
+			"INSERT INTO `some_table` (`col1`, `col2`, `col3`) VALUES (?, ?, ?)",
+			[]any{"val1", "val2", "val3"},
+			"INSERT INTO `some_table` (`col1`, `col2`, `col3`) VALUES (?, ?, ?)",
+			[]any{"val1", "val2", "val3"},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			var db Dialect
+			db = NewPostgresDialect()
+			q, args, err := db.InsertQuery(tc.tableName, tc.values)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedPostgresQuery, q, "Postgres query incorrect")
+			require.Equal(t, tc.expectedPostgresArgs, args, "Postgres args incorrect")
+
+			db = NewMysqlDialect()
+			q, args, err = db.InsertQuery(tc.tableName, tc.values)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedMySQLQuery, q, "MySQL query incorrect")
+			require.Equal(t, tc.expectedMySQLArgs, args, "MySQL args incorrect")
+
+			db = NewSQLite3Dialect()
+			q, args, err = db.InsertQuery(tc.tableName, tc.values)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedSQLiteQuery, q, "SQLite query incorrect")
+			require.Equal(t, tc.expectedSQLiteArgs, args, "SQLite args incorrect")
+		})
+	}
+}
+
+func TestUpdateQuery(t *testing.T) {
+	tests := []struct {
+		name                  string
+		tableName             string
+		values                map[string]any
+		where                 map[string]any
+		expectedErr           bool
+		expectedPostgresQuery string
+		expectedPostgresArgs  []any
+		expectedMySQLQuery    string
+		expectedMySQLArgs     []any
+		expectedSQLiteQuery   string
+		expectedSQLiteArgs    []any
+	}{
+		{
+			"insert one",
+			"some_table",
+			map[string]any{"col1": "val1", "col2": "val2", "col3": "val3"},
+			map[string]any{"key1": 10},
+			false,
+			"UPDATE \"some_table\" SET \"col1\"=?, \"col2\"=?, \"col3\"=? WHERE \"key1\"=?",
+			[]any{"val1", "val2", "val3", 10},
+			"UPDATE `some_table` SET `col1`=?, `col2`=?, `col3`=? WHERE `key1`=?",
+			[]any{"val1", "val2", "val3", 10},
+			"UPDATE `some_table` SET `col1`=?, `col2`=?, `col3`=? WHERE `key1`=?",
+			[]any{"val1", "val2", "val3", 10},
+		},
+	}
+
+	for _, tc := range tests {
+		t.Run(tc.name, func(t *testing.T) {
+			var db Dialect
+			db = NewPostgresDialect()
+			q, args, err := db.UpdateQuery(tc.tableName, tc.values, tc.where)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedPostgresQuery, q, "Postgres query incorrect")
+			require.Equal(t, tc.expectedPostgresArgs, args, "Postgres args incorrect")
+
+			db = NewMysqlDialect()
+			q, args, err = db.UpdateQuery(tc.tableName, tc.values, tc.where)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedMySQLQuery, q, "MySQL query incorrect")
+			require.Equal(t, tc.expectedMySQLArgs, args, "MySQL args incorrect")
+
+			db = NewSQLite3Dialect()
+			q, args, err = db.UpdateQuery(tc.tableName, tc.values, tc.where)
+
+			require.True(t, (err != nil) == tc.expectedErr)
+			require.Equal(t, tc.expectedSQLiteQuery, q, "SQLite query incorrect")
+			require.Equal(t, tc.expectedSQLiteArgs, args, "SQLite args incorrect")
+		})
+	}
+}