lava-oushudb-dt-sql-parser/test/parser/mysql/contextCollect/entityCollector.test.ts
Hayden bb0fad1dbe
refactor: standard naming (#278)
* refactor: rename flinksql to flink

* refactor: rename pgsql to postgresql

* refactor: rename trinosql to trino

* refactor: replace all default exports with named export

* refactor: rename basicParser to basicSQL

* refactor: rename basic-parser-types to types

* refactor: replace arrow func with plain func
2024-03-27 10:33:25 +08:00

496 lines
18 KiB
TypeScript

import fs from 'fs';
import path from 'path';
import { MySQL } from 'src/parser/mysql';
import { MySqlEntityCollector, MysqlSplitListener } from 'src/parser/mysql';
import { ParseTreeListener } from 'antlr4ng';
import { MySqlParserListener } from 'src/lib/mysql/MySqlParserListener';
import { EntityContextType } from 'src/parser/common/types';
import { StmtContextType } from 'src/parser/common/entityCollector';
const commonSql = fs.readFileSync(path.join(__dirname, 'fixtures', 'common.sql'), 'utf-8');
describe('MySQL entity collector tests', () => {
const mysql = new MySQL();
const parseTree = mysql.parse(commonSql);
const splitListener = new MysqlSplitListener();
mysql.listen(splitListener as MySqlParserListener, parseTree);
test('validate common sql', () => {
expect(mysql.validate(commonSql).length).toBe(0);
});
test('split results', () => {
expect(splitListener.statementsContext.length).toBe(15);
});
test('create table by columns', () => {
const columnCreateTableContext = splitListener.statementsContext[0];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, columnCreateTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const tableCreateEntity = allEntities[0];
expect(tableCreateEntity.entityContextType).toBe(EntityContextType.TABLE_CREATE);
expect(tableCreateEntity.text).toBe('new_tb_with_col');
expect(tableCreateEntity.position).toEqual({
startIndex: 13,
endIndex: 27,
line: 1,
startColumn: 14,
endColumn: 29,
});
expect(tableCreateEntity.belongStmt.stmtContextType).toBe(
StmtContextType.CREATE_TABLE_STMT
);
expect(tableCreateEntity.belongStmt.position).toEqual({
startIndex: 0,
endIndex: 45,
startLine: 1,
endLine: 1,
startColumn: 1,
endColumn: 47,
});
expect(tableCreateEntity.relatedEntities).toBeNull();
expect(tableCreateEntity.columns.length).toBe(2);
tableCreateEntity.columns.forEach((columEntity) => {
expect(columEntity.entityContextType).toBe(EntityContextType.COLUMN_CREATE);
expect(columEntity.belongStmt).toBe(tableCreateEntity.belongStmt);
expect(columEntity.text).toBe(
commonSql.slice(columEntity.position.startIndex, columEntity.position.endIndex + 1)
);
});
});
test('create table by select', () => {
const createTableBySelectContext = splitListener.statementsContext[1];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, createTableBySelectContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(3);
const tableCreateEntity = allEntities[0];
expect(tableCreateEntity.entityContextType).toBe(EntityContextType.TABLE_CREATE);
expect(tableCreateEntity.text).toBe('new_tb_from_old');
expect(tableCreateEntity.position).toEqual({
startIndex: 62,
endIndex: 76,
line: 3,
startColumn: 14,
endColumn: 29,
});
expect(tableCreateEntity.belongStmt.stmtContextType).toBe(
StmtContextType.CREATE_TABLE_STMT
);
expect(tableCreateEntity.belongStmt.position).toEqual({
startIndex: 49,
endIndex: 265,
startLine: 3,
endLine: 12,
startColumn: 1,
endColumn: 34,
});
expect(tableCreateEntity.columns).toBeNull();
expect(tableCreateEntity.relatedEntities.length).toBe(2);
tableCreateEntity.relatedEntities.forEach((relatedEntity) => {
expect(relatedEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(allEntities.some((en) => relatedEntity === en)).toBeTruthy();
});
expect(allEntities[1].text).toBe('old_tb1');
expect(allEntities[1].belongStmt.rootStmt).toBe(allEntities[0].belongStmt);
expect(allEntities[1].position).toEqual({
startIndex: 161,
endIndex: 167,
line: 8,
startColumn: 9,
endColumn: 16,
});
expect(allEntities[2].text).toBe('old_tb2');
expect(allEntities[2].belongStmt.rootStmt).toBe(allEntities[0].belongStmt);
expect(allEntities[2].position).toEqual({
startIndex: 187,
endIndex: 193,
line: 10,
startColumn: 9,
endColumn: 16,
});
});
test('create table like', () => {
const createTableLikeContext = splitListener.statementsContext[2];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, createTableLikeContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(2);
const tableCreateEntity = allEntities[0];
const originTableEntity = allEntities[1];
expect(tableCreateEntity.entityContextType).toBe(EntityContextType.TABLE_CREATE);
expect(tableCreateEntity.text).toBe('new_tb_like_old');
expect(tableCreateEntity.belongStmt.stmtContextType).toBe(
StmtContextType.CREATE_TABLE_STMT
);
expect(tableCreateEntity.columns).toBeNull();
expect(tableCreateEntity.relatedEntities.length).toBe(1);
expect(tableCreateEntity.relatedEntities[0]).toBe(originTableEntity);
expect(originTableEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(originTableEntity.text).toBe('old_tb');
expect(originTableEntity.belongStmt).toBe(tableCreateEntity.belongStmt);
});
test('common select from table', () => {
const selectTableContext = splitListener.statementsContext[3];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, selectTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const tableEntity = allEntities[0];
expect(tableEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(tableEntity.text).toBe('select_tb');
expect(tableEntity.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(tableEntity.columns).toBeNull();
expect(tableEntity.relatedEntities).toBeNull();
});
test('select into from table', () => {
const selectTableContext = splitListener.statementsContext[4];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, selectTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const tableEntity = allEntities[0];
expect(tableEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(tableEntity.text).toBe('into_select_tb');
expect(tableEntity.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(tableEntity.columns).toBeNull();
expect(tableEntity.relatedEntities).toBeNull();
});
test('select from table join', () => {
const selectTableContext = splitListener.statementsContext[5];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, selectTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(2);
const tableEntity1 = allEntities[0];
const tableEntity2 = allEntities[1];
expect(tableEntity1.entityContextType).toBe(EntityContextType.TABLE);
expect(tableEntity1.text).toBe('from_tb');
expect(tableEntity1.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(tableEntity1.columns).toBeNull();
expect(tableEntity1.relatedEntities).toBeNull();
expect(tableEntity2.entityContextType).toBe(EntityContextType.TABLE);
expect(tableEntity2.text).toBe('join_tb');
expect(tableEntity2.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(tableEntity2.columns).toBeNull();
expect(tableEntity2.relatedEntities).toBeNull();
expect(tableEntity1.belongStmt).toBe(tableEntity2.belongStmt);
});
test('insert into table values', () => {
const insertTableContext = splitListener.statementsContext[6];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, insertTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const tableEntity = allEntities[0];
expect(tableEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(tableEntity.text).toBe('insert_tb');
expect(tableEntity.belongStmt.stmtContextType).toBe(StmtContextType.INSERT_STMT);
expect(tableEntity.columns).toBeNull();
expect(tableEntity.relatedEntities).toBeNull();
});
test('insert into table select', () => {
const insertTableContext = splitListener.statementsContext[7];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, insertTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(3);
const insertTableEntity = allEntities[0];
const fromTableEntity1 = allEntities[1];
const fromTableEntity2 = allEntities[2];
expect(insertTableEntity.entityContextType).toBe(EntityContextType.TABLE);
expect(insertTableEntity.text).toBe('insert_from_tb');
expect(insertTableEntity.belongStmt.stmtContextType).toBe(StmtContextType.INSERT_STMT);
expect(fromTableEntity1.entityContextType).toBe(EntityContextType.TABLE);
expect(fromTableEntity1.text).toBe('from_tb1');
expect(fromTableEntity1.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(fromTableEntity2.entityContextType).toBe(EntityContextType.TABLE);
expect(fromTableEntity2.text).toBe('from_tb2');
expect(fromTableEntity2.belongStmt.stmtContextType).toBe(StmtContextType.SELECT_STMT);
expect(fromTableEntity1.belongStmt.parentStmt).toBe(insertTableEntity.belongStmt);
expect(fromTableEntity2.belongStmt.parentStmt).toBe(insertTableEntity.belongStmt);
expect(fromTableEntity1.belongStmt.rootStmt).toBe(insertTableEntity.belongStmt);
expect(fromTableEntity2.belongStmt.rootStmt).toBe(insertTableEntity.belongStmt);
});
test('create view with col', () => {
const insertTableContext = splitListener.statementsContext[8];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, insertTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
expect(allEntities[0].entityContextType).toBe(EntityContextType.VIEW_CREATE);
expect(allEntities[0].text).toBe('new_view');
expect(allEntities[0].belongStmt.stmtContextType).toBe(StmtContextType.CREATE_VIEW_STMT);
expect(allEntities[0].columns.length).toBe(2);
expect(allEntities[0].columns[0].text).toBe('col1');
expect(allEntities[0].columns[1].text).toBe('col2');
expect(allEntities[0].columns[0].entityContextType).toBe(EntityContextType.COLUMN_CREATE);
expect(allEntities[0].columns[0].belongStmt).toBe(allEntities[0].belongStmt);
});
test('create view as select table', () => {
const insertTableContext = splitListener.statementsContext[9];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, insertTableContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(2);
expect(allEntities[0].entityContextType).toBe(EntityContextType.VIEW_CREATE);
expect(allEntities[0].text).toBe('db.new_view');
expect(allEntities[0].belongStmt.stmtContextType).toBe(StmtContextType.CREATE_VIEW_STMT);
});
test('create database', () => {
const dbCreateContext = splitListener.statementsContext[10];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, dbCreateContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const dbEntity = allEntities[0];
expect(dbEntity.entityContextType).toBe(EntityContextType.DATABASE_CREATE);
expect(dbEntity.text).toBe('db_name');
expect(dbEntity.position).toEqual({
endColumn: 24,
endIndex: 778,
line: 31,
startColumn: 17,
startIndex: 772,
});
expect(dbEntity.belongStmt.stmtContextType).toBe(StmtContextType.CREATE_DATABASE_STMT);
expect(dbEntity.belongStmt.position).toEqual({
endColumn: 47,
endIndex: 801,
endLine: 31,
startColumn: 1,
startIndex: 756,
startLine: 31,
});
expect(dbEntity.columns).toBeNull();
expect(dbEntity.relatedEntities).toBeNull();
});
test('create schema', () => {
const schemaCreateContext = splitListener.statementsContext[11];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, schemaCreateContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const schemaEntity = allEntities[0];
expect(schemaEntity.entityContextType).toBe(EntityContextType.DATABASE_CREATE);
expect(schemaEntity.text).toBe('db_name');
expect(schemaEntity.position).toEqual({
endColumn: 36,
endIndex: 839,
line: 33,
startColumn: 29,
startIndex: 833,
});
expect(schemaEntity.belongStmt.stmtContextType).toBe(StmtContextType.CREATE_DATABASE_STMT);
expect(schemaEntity.belongStmt.position).toEqual({
endColumn: 59,
endIndex: 862,
endLine: 33,
startColumn: 1,
startIndex: 805,
startLine: 33,
});
expect(schemaEntity.columns).toBeNull();
expect(schemaEntity.relatedEntities).toBeNull();
});
test('show create database', () => {
const dbCreateContext = splitListener.statementsContext[12];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, dbCreateContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const dbEntity = allEntities[0];
expect(dbEntity.entityContextType).toBe(EntityContextType.DATABASE);
expect(dbEntity.text).toBe('db_name');
expect(dbEntity.position).toEqual({
endColumn: 41,
endIndex: 905,
line: 35,
startColumn: 34,
startIndex: 899,
});
expect(dbEntity.belongStmt.stmtContextType).toBe(StmtContextType.COMMON_STMT);
expect(dbEntity.belongStmt.position).toEqual({
endColumn: 42,
endIndex: 906,
endLine: 35,
startColumn: 1,
startIndex: 866,
startLine: 35,
});
expect(dbEntity.columns).toBeNull();
expect(dbEntity.relatedEntities).toBeNull();
});
test('drop database', () => {
const dbDropContext = splitListener.statementsContext[13];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, dbDropContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const dbEntity = allEntities[0];
expect(dbEntity.entityContextType).toBe(EntityContextType.DATABASE);
expect(dbEntity.text).toBe('db_name');
expect(dbEntity.position).toEqual({
endColumn: 30,
endIndex: 937,
line: 37,
startColumn: 23,
startIndex: 931,
});
expect(dbEntity.belongStmt.stmtContextType).toBe(StmtContextType.COMMON_STMT);
expect(dbEntity.belongStmt.position).toEqual({
endColumn: 31,
endIndex: 938,
endLine: 37,
startColumn: 1,
startIndex: 909,
startLine: 37,
});
expect(dbEntity.columns).toBeNull();
expect(dbEntity.relatedEntities).toBeNull();
});
test('create function', () => {
const functionCreateContext = splitListener.statementsContext[14];
const collectListener = new MySqlEntityCollector(commonSql);
mysql.listen(collectListener as ParseTreeListener, functionCreateContext);
const allEntities = collectListener.getEntities();
expect(allEntities.length).toBe(1);
const functionEntity = allEntities[0];
expect(functionEntity.entityContextType).toBe(EntityContextType.FUNCTION_CREATE);
expect(functionEntity.text).toBe('my_concat_ws');
expect(functionEntity.position).toEqual({
endColumn: 43,
endIndex: 982,
line: 39,
startColumn: 31,
startIndex: 971,
});
expect(functionEntity.belongStmt.stmtContextType).toBe(
StmtContextType.CREATE_FUNCTION_STMT
);
expect(functionEntity.belongStmt.position).toEqual({
endColumn: 87,
endIndex: 1026,
endLine: 39,
startColumn: 1,
startIndex: 941,
startLine: 39,
});
expect(functionEntity.columns).toBeNull();
expect(functionEntity.relatedEntities).toBeNull();
});
});