fix: overhaul test suite of attribute(s)ToSQL

packages/core/src/abstract-dialect/query-generator.internal-types.ts

@@ -1,6 +1,7 @@
 import type { Nullish } from '@sequelize/utils';
 import type { Literal } from '../expression-builders/literal.js';
 import type { BindOrReplacements } from '../sequelize.js';
+import type { TableOrModel } from './query-generator.types.js';
 
 export interface AddLimitOffsetOptions {
   limit?: number | Literal | Nullish;
@@ -10,7 +11,7 @@ export interface AddLimitOffsetOptions {
 
 export interface AttributeToSqlOptions {
   context: 'addColumn' | 'changeColumn' | 'createTable';
-  schema?: string;
-  table: string;
+  table?: TableOrModel;
   withoutForeignKeyConstraints?: boolean;
+  foreignKey?: string;
 }

packages/core/src/abstract-dialect/query-generator.js

@@ -1891,7 +1891,7 @@ export class AbstractQueryGenerator extends AbstractQueryGeneratorTypeScript {
       // To capture output rows when there is a trigger on MSSQL DB
       if (options.hasTrigger && this.dialect.supports.tmpTableTrigger) {
         const tmpColumns = returnFields.map((field, i) => {
-          return `${field} ${attributeTypeToSql(returnTypes[i], { dialect: this.dialect })}`;
+          return `${field} ${attributeTypeToSql(returnTypes[i])}`;
         });
 
         tmpTable = `DECLARE @tmp TABLE (${tmpColumns.join(',')}); `;

packages/core/test/integration/query-interface/changeColumn.test.js

@@ -265,7 +265,12 @@ describe(Support.getTestDialectTeaser('QueryInterface'), () => {
           });
 
           const describedTable2 = await this.queryInterface.describeTable({ tableName: 'users' });
-          expect(describedTable2.level_id.comment).to.equal('FooBar');
+          if (dialect === 'mssql') {
+            // TODO: this should be unescaped by query.formatResult
+            expect(describedTable2.level_id.comment).to.equal("N'FooBar'");
+          } else {
+            expect(describedTable2.level_id.comment).to.equal('FooBar');
+          }
         });
       }
     });

packages/core/test/integration/query-interface/describeTable.test.js

@@ -170,9 +170,13 @@ describe(Support.getTestDialectTeaser('QueryInterface'), () => {
         expect(enumVals.type).to.eql("ENUM('hello','world')");
       }
 
-      if (['postgres', 'mysql', 'mssql'].includes(dialect)) {
+      if (['postgres', 'mysql'].includes(dialect)) {
         expect(city.comment).to.equal('Users City');
         expect(username.comment).to.equal(null);
+      } else if (dialect === 'mssql') {
+        // TODO: this should be unescaped by query.formatResult
+        expect(city.comment).to.equal("N'Users City'");
+        expect(username.comment).to.equal(null);
       }
     });
 

packages/core/test/support.ts

@@ -64,7 +64,7 @@ function withInlineCause(cb: () => any): () => void {
 
 export function inlineErrorCause(error: unknown): string {
   if (!(error instanceof Error)) {
-    return String(error);
+    return inspect(error);
   }
 
   let message = error.message;

packages/core/test/unit/dialects/db2/query-generator.test.js

@@ -15,104 +15,6 @@ const { createSequelizeInstance } = require('../../../support');
 if (dialect === 'db2') {
   describe('[DB2 Specific] QueryGenerator', () => {
     const suites = {
-      attributesToSQL: [
-        {
-          arguments: [{ id: 'INTEGER' }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: 'INTEGER', foo: 'VARCHAR(255)' }],
-          expectation: { id: 'INTEGER', foo: 'VARCHAR(255)' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER' } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: false } }],
-          expectation: { id: 'INTEGER NOT NULL' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: true } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', primaryKey: true, autoIncrement: true } }],
-          expectation: {
-            id: 'INTEGER NOT NULL GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY',
-          },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', defaultValue: 0 } }],
-          expectation: { id: 'INTEGER DEFAULT 0' },
-        },
-        {
-          title: 'Add column level comment',
-          arguments: [{ id: { type: 'INTEGER', comment: 'Test' } }],
-          expectation: { id: 'INTEGER COMMENT Test' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', unique: true } }],
-          expectation: { id: 'INTEGER UNIQUE' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', after: 'Bar' } }],
-          expectation: { id: 'INTEGER' },
-        },
-        // No Default Values allowed for certain types
-        // TODO: this test is broken. It adds the default value because the data type is a string, which can't have special behaviors.
-        //  change type to an actual Sequelize DataType & re-enable
-        // {
-        //   title: 'No Default value for DB2 BLOB allowed',
-        //   arguments: [{ id: { type: 'BLOB', defaultValue: Buffer.from([]) } }],
-        //   expectation: { id: 'BLOB DEFAULT ' },
-        // },
-        {
-          title: 'No Default value for DB2 TEXT allowed',
-          arguments: [{ id: { type: 'TEXT', defaultValue: 'abc' } }],
-          expectation: { id: 'TEXT' },
-        },
-        // New references style
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar' } } }],
-          expectation: { id: 'INTEGER REFERENCES "Bar" ("id")' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar', key: 'pk' } } }],
-          expectation: { id: 'INTEGER REFERENCES "Bar" ("pk")' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onDelete: 'CASCADE' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES "Bar" ("id") ON DELETE CASCADE' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onUpdate: 'RESTRICT' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES "Bar" ("id") ON UPDATE RESTRICT' },
-        },
-        {
-          arguments: [
-            {
-              id: {
-                type: 'INTEGER',
-                allowNull: false,
-                autoIncrement: true,
-                defaultValue: 1,
-                references: { table: 'Bar' },
-                onDelete: 'CASCADE',
-                onUpdate: 'RESTRICT',
-              },
-            },
-          ],
-          expectation: {
-            id: 'INTEGER NOT NULL GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) DEFAULT 1 REFERENCES "Bar" ("id") ON DELETE CASCADE ON UPDATE RESTRICT',
-          },
-        },
-      ],
-
       selectQuery: [
         {
           arguments: ['myTable'],

packages/core/test/unit/dialects/mariadb/query-generator.test.js

@@ -15,110 +15,6 @@ const { createSequelizeInstance } = require('../../../support');
 if (dialect === 'mariadb') {
   describe('[MARIADB Specific] QueryGenerator', () => {
     const suites = {
-      attributesToSQL: [
-        {
-          arguments: [{ id: 'INTEGER' }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: 'INTEGER', foo: 'VARCHAR(255)' }],
-          expectation: { id: 'INTEGER', foo: 'VARCHAR(255)' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER' } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: false } }],
-          expectation: { id: 'INTEGER NOT NULL' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: true } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', primaryKey: true, autoIncrement: true } }],
-          expectation: { id: 'INTEGER auto_increment PRIMARY KEY' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', defaultValue: 0 } }],
-          expectation: { id: 'INTEGER DEFAULT 0' },
-        },
-        {
-          title: 'Add column level comment',
-          arguments: [{ id: { type: 'INTEGER', comment: 'Test' } }],
-          expectation: { id: "INTEGER COMMENT 'Test'" },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', unique: true } }],
-          expectation: { id: 'INTEGER UNIQUE' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', after: 'Bar' } }],
-          expectation: { id: 'INTEGER AFTER `Bar`' },
-        },
-        // No Default Values allowed for certain types
-        {
-          title: 'No Default value for MariaDB BLOB allowed',
-          arguments: [{ id: { type: 'BLOB', defaultValue: [] } }],
-          expectation: { id: 'BLOB' },
-        },
-        {
-          title: 'No Default value for MariaDB TEXT allowed',
-          arguments: [{ id: { type: 'TEXT', defaultValue: [] } }],
-          expectation: { id: 'TEXT' },
-        },
-        {
-          title: 'No Default value for MariaDB GEOMETRY allowed',
-          arguments: [{ id: { type: 'GEOMETRY', defaultValue: [] } }],
-          expectation: { id: 'GEOMETRY' },
-        },
-        {
-          title: 'No Default value for MariaDB JSON allowed',
-          arguments: [{ id: { type: 'JSON', defaultValue: [] } }],
-          expectation: { id: 'JSON' },
-        },
-        // New references style
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar' } } }],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`)' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar', key: 'pk' } } }],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`pk`)' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onDelete: 'CASCADE' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`) ON DELETE CASCADE' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onUpdate: 'RESTRICT' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`) ON UPDATE RESTRICT' },
-        },
-        {
-          arguments: [
-            {
-              id: {
-                type: 'INTEGER',
-                allowNull: false,
-                autoIncrement: true,
-                defaultValue: 1,
-                references: { table: 'Bar' },
-                onDelete: 'CASCADE',
-                onUpdate: 'RESTRICT',
-              },
-            },
-          ],
-          expectation: {
-            id: 'INTEGER NOT NULL auto_increment DEFAULT 1 REFERENCES `Bar` (`id`) ON DELETE CASCADE ON UPDATE RESTRICT',
-          },
-        },
-      ],
-
       selectQuery: [
         {
           arguments: ['myTable'],

packages/core/test/unit/dialects/mysql/query-generator.test.js

@@ -15,110 +15,6 @@ const { createSequelizeInstance } = require('../../../support');
 if (dialect === 'mysql') {
   describe('[MYSQL Specific] QueryGenerator', () => {
     const suites = {
-      attributesToSQL: [
-        {
-          arguments: [{ id: 'INTEGER' }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: 'INTEGER', foo: 'VARCHAR(255)' }],
-          expectation: { id: 'INTEGER', foo: 'VARCHAR(255)' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER' } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: false } }],
-          expectation: { id: 'INTEGER NOT NULL' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', allowNull: true } }],
-          expectation: { id: 'INTEGER' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', primaryKey: true, autoIncrement: true } }],
-          expectation: { id: 'INTEGER auto_increment PRIMARY KEY' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', defaultValue: 0 } }],
-          expectation: { id: 'INTEGER DEFAULT 0' },
-        },
-        {
-          title: 'Add column level comment',
-          arguments: [{ id: { type: 'INTEGER', comment: 'Test' } }],
-          expectation: { id: "INTEGER COMMENT 'Test'" },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', unique: true } }],
-          expectation: { id: 'INTEGER UNIQUE' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', after: 'Bar' } }],
-          expectation: { id: 'INTEGER AFTER `Bar`' },
-        },
-        // No Default Values allowed for certain types
-        {
-          title: 'No Default value for MySQL BLOB allowed',
-          arguments: [{ id: { type: 'BLOB', defaultValue: [] } }],
-          expectation: { id: 'BLOB' },
-        },
-        {
-          title: 'No Default value for MySQL TEXT allowed',
-          arguments: [{ id: { type: 'TEXT', defaultValue: [] } }],
-          expectation: { id: 'TEXT' },
-        },
-        {
-          title: 'No Default value for MySQL GEOMETRY allowed',
-          arguments: [{ id: { type: 'GEOMETRY', defaultValue: [] } }],
-          expectation: { id: 'GEOMETRY' },
-        },
-        {
-          title: 'No Default value for MySQL JSON allowed',
-          arguments: [{ id: { type: 'JSON', defaultValue: [] } }],
-          expectation: { id: 'JSON' },
-        },
-        // New references style
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar' } } }],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`)' },
-        },
-        {
-          arguments: [{ id: { type: 'INTEGER', references: { table: 'Bar', key: 'pk' } } }],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`pk`)' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onDelete: 'CASCADE' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`) ON DELETE CASCADE' },
-        },
-        {
-          arguments: [
-            { id: { type: 'INTEGER', references: { table: 'Bar' }, onUpdate: 'RESTRICT' } },
-          ],
-          expectation: { id: 'INTEGER REFERENCES `Bar` (`id`) ON UPDATE RESTRICT' },
-        },
-        {
-          arguments: [
-            {
-              id: {
-                type: 'INTEGER',
-                allowNull: false,
-                autoIncrement: true,
-                defaultValue: 1,
-                references: { table: 'Bar' },
-                onDelete: 'CASCADE',
-                onUpdate: 'RESTRICT',
-              },
-            },
-          ],
-          expectation: {
-            id: 'INTEGER NOT NULL auto_increment DEFAULT 1 REFERENCES `Bar` (`id`) ON DELETE CASCADE ON UPDATE RESTRICT',
-          },
-        },
-      ],
-
       selectQuery: [
         {
           arguments: ['myTable'],