undeexcepturi/tests/SchemaHelper.test.ts

TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.

import type { Column } from '@mikro-orm/sqlite';
import { SchemaHelper, SqlitePlatform } from '@mikro-orm/sqlite';
import { MySqlPlatform } from '@mikro-orm/mysql';
import { ColumnDifference, PostgreSqlPlatform, TableDifference } from '@mikro-orm/postgresql';
import { Dictionary, Type, EnumType, StringType } from '@mikro-orm/core';

class SchemaHelperTest extends SchemaHelper { }

describe('SchemaHelper', () => {

  test('default schema helpers', async () => {
    const helper = new SchemaHelperTest(new MySqlPlatform());
    expect(helper.getSchemaBeginning('utf8')).toBe('\n\n');
    expect(helper.getSchemaEnd()).toBe('\n');
    expect(helper.getChangeColumnCommentSQL('a', {} as any)).toBe('');
    await expect(helper.getEnumDefinitions(jest.fn() as any, [], '')).resolves.toEqual({});
    expect(() => helper.getListTablesSQL()).toThrow('Not supported by given driver');
    expect(() => helper.getAlterNativeEnumSQL('table')).toThrow('Not supported by given driver');
    expect(() => helper.getDropNativeEnumSQL('table')).toThrow('Not supported by given driver');
    expect(() => helper.getForeignKeysSQL('table')).toThrow('Not supported by given driver');
    await expect(helper.getColumns({} as any, 'table')).rejects.toThrow('Not supported by given driver');
    await expect(helper.getIndexes({} as any, 'table')).rejects.toThrow('Not supported by given driver');
    await expect(helper.getChecks({} as any, 'table')).rejects.toThrow('Not supported by given driver');
  });

  test('mysql schema helper', async () => {
    const helper = new MySqlPlatform().getSchemaHelper()!;
    const from = 'test1';
    const to = { name: 'test_123', nullable: false, type: 'int' } as Column;
    expect(helper.getRenameColumnSQL('table', from, to)).toBe('alter table `table` change `test1` `test_123` int not null');

    const mock = {
      engine: jest.fn(),
      charset: jest.fn(),
      collate: jest.fn(),
    } as any;
    helper.finalizeTable(mock, 'charset', 'collate');
    expect(mock.engine).toHaveBeenCalledWith('InnoDB');
    expect(mock.charset).toHaveBeenCalledWith('charset');
    expect(mock.collate).toHaveBeenCalledWith('collate');
  });

  test('sqlite schema helper', async () => {
    const helper = new SqlitePlatform().getSchemaHelper()!;
    expect(helper.getRenameColumnSQL('table', 'test1', { name: 'test_123' } as Column)).toBe('alter table `table` rename column `test1` to `test_123`');
  });

  describe('postgresql schema helper', () => {
    test('helper quotes schema name when dropping contraints', () => {
      const helper = new PostgreSqlPlatform().getSchemaHelper()!;
      const fromEnum = { name: 'test_enum', nullable: false, mappedType: Type.getType(EnumType) } as Column;
      const toEnum = { name: 'test_enum', nullable: false, mappedType: Type.getType(StringType) } as Column;
      const fromUuid = { name: 'test_uuid', nullable: false, type: 'uuid' } as Column;
      const toUuid = { name: 'test_uuid', nullable: false, type: 'uuid' } as Column;
      const changedColumns = {
        test_enum: {
          oldColumnName: 'test_column',
          column: toEnum,
          fromColumn: fromEnum,
          changedProperties: new Set(),
        },
        test_uuid: {
          oldColumnName: 'test_uuid',
          column: toUuid,
          fromColumn: fromUuid,
          changedProperties: new Set(['type']),
        },
      } as Dictionary<ColumnDifference>;

      const tableDifference: TableDifference = {
        name: 'test',
        changedColumns,
      } as TableDifference;

      expect(helper.getPreAlterTable(tableDifference, true)).toEqual(`alter table "test" drop constraint if exists "test_test_enum_check";\nalter table "test" alter column "test_uuid" type text using ("test_uuid"::text)`);

      const schemaTableDifference: TableDifference = {
        name: 'my_schema.test',
        changedColumns,
      } as TableDifference;

      expect(helper.getPreAlterTable(schemaTableDifference, true)).toEqual(`alter table "my_schema"."test" drop constraint if exists "test_test_enum_check";\nalter table "my_schema"."test" alter column "test_uuid" type text using ("test_uuid"::text)`);
    });
  });
});