feat: add option to set database

src/cli.ts

@@ -36,6 +36,7 @@ import databaseFactory from "./database/databaseFactory";
     .option("--host <string>", "The host for the connection")
     .option("--user <string>", "The user for the connection")
     .option("--password <string>", "The password for the connection")
+    .option("--database <string>", "The database for the connection")
     .option("--port <string>", "The port for the connection")
     .option("--config <string>", "The path to the configuration file")
     .parse(process.argv);
@@ -96,6 +97,7 @@ import databaseFactory from "./database/databaseFactory";
       program.host || configuration?.host || "localhost",
       program.user || configuration?.user || "root", // bad practice but unfortunately common, make it easier for the user
       program.password || configuration?.password,
+      program.database || configuration?.database,
       program.port || configuration?.port || undefined // let mysql2 or pg figure out the default port
     );
   }

src/database/databaseFactory.ts

@@ -7,13 +7,14 @@ export default function databaseFactory(
   host: string,
   user: string,
   password: string,
+  database: string,
   port?: number
 ): IDatabase {
   switch (driver) {
     case "mysql":
-      return new MySqlDatabase(host, user, password, port);
+      return new MySqlDatabase(host, user, password, database, port);
     case "postgres":
-      return new PostgresDatabase(host, user, password, port);
+      return new PostgresDatabase(host, user, password, database, port);
     default:
       throw new Error(`${driver} driver is unsupported`);
   }

src/database/mySqlDatabase.ts

@@ -4,11 +4,18 @@ import IDatabase, { sqlError } from "./interface";
 export default class MySqlDatabase implements IDatabase {
   private connection: mysql.Connection;
 
-  constructor(host: string, user: string, password: string, port?: number) {
+  constructor(
+    host: string,
+    user: string,
+    password: string,
+    database: string,
+    port?: number
+  ) {
     this.connection = mysql.createConnection({
       host,
       user,
       password,
+      database,
       port,
     });
   }

src/database/postgresDatabase.ts

@@ -4,11 +4,18 @@ import IDatabase, { sqlError } from "./interface";
 export default class PostgresDatabase implements IDatabase {
   private pool: Pool;
 
-  constructor(host: string, user: string, password: string, port?: number) {
+  constructor(
+    host: string,
+    user: string,
+    password: string,
+    database: string,
+    port?: number
+  ) {
     this.pool = new Pool({
       host,
       user,
       password,
+      database,
       port,
     });
   }

src/main.ts

@@ -14,48 +14,34 @@ interface Parameters {
   driver?: string;
   prefix?: string;
   password?: string;
+  database?: string;
   verbosity?: number;
 }
 
 export default async ({
   sql,
   host,
   port,
-  user = '',
-  prefix = '',
-  password = '',
+  user = "",
+  prefix = "",
+  password = "",
+  database = "",
   verbosity = 0,
-  driver = 'mysql',
+  driver = "mysql",
 }: Parameters): Promise<IMessage[]> => {
-  const printer = new Printer(
-    verbosity,
-    new JsonFormat(),
-  );
+  const printer = new Printer(verbosity, new JsonFormat());
 
-  let db: IDatabase|undefined;
+  let db: IDatabase | undefined;
   if (host) {
-    db = databaseFactory(
-      driver,
-      host,
-      user,
-      password,
-      port,
-    )
+    db = databaseFactory(driver, host, user, password, database, port);
   }
 
   const runner = new CheckerRunner();
-  await runner.run(
-    putContentIntoLines(sql),
-    printer,
-    prefix,
-    [],
-    driver,
-    db,
-  )
+  await runner.run(putContentIntoLines(sql), printer, prefix, [], driver, db);
 
   if (db) {
     db.end();
   }
 
   return printer.messages;
-}
+};

test/unit/database/databaseFactory.test.ts

@@ -27,14 +27,22 @@ test.each([
     "localhost",
     "user",
     "password",
+    "database",
     3306
   );
   expect(database).toBeInstanceOf(expected);
 });
 
 test("it throws an exception if driver is not supported", () => {
   const t = () =>
-    databaseFactory("mongodb", "localhost", "user", "password", 3306);
+    databaseFactory(
+      "mongodb",
+      "localhost",
+      "user",
+      "password",
+      "database",
+      3306
+    );
   expect(t).toThrow(Error);
 });
 

test/unit/database/mysqlDatabase.test.ts

@@ -7,6 +7,7 @@ jest.mock("mysql2", () => {
         host: "localhost",
         user: "user",
         password: "password",
+        database: "database",
         port: 3306,
       });
       return mock;
@@ -22,17 +23,38 @@ jest.mock("mysql2", () => {
 });
 
 test("it calls createConnection", () => {
-  const db = new MySqlDatabase("localhost", "user", "password", 3306);
+  const db = new MySqlDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    3306
+  );
 });
 
 test("it calls callback if there is an error", async () => {
-  const db = new MySqlDatabase("localhost", "user", "password", 3306);
+  const db = new MySqlDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    3306
+  );
   const sql = "SELECT some_column FROM some_table WHERE id = 1";
-  expect(await db.lintQuery(sql)).toHaveProperty("sqlMessage", "table does not exist");
+  expect(await db.lintQuery(sql)).toHaveProperty(
+    "sqlMessage",
+    "table does not exist"
+  );
 });
 
 test("it calls end on connection", () => {
-  const db = new MySqlDatabase("localhost", "user", "password", 3306);
+  const db = new MySqlDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    3306
+  );
   db.end();
 });
 

test/unit/database/postgresDatabase.test.ts

@@ -7,6 +7,7 @@ jest.mock("pg", () => {
         host: "localhost",
         user: "user",
         password: "password",
+        database: "database",
         port: 5432,
       });
       return mock;
@@ -23,11 +24,23 @@ jest.mock("pg", () => {
 });
 
 test("it calls createConnection", () => {
-  const db = new PostgresDatabase("localhost", "user", "password", 5432);
+  const db = new PostgresDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    5432
+  );
 });
 
 test("it calls callback if there is an error", async () => {
-  const db = new PostgresDatabase("localhost", "user", "password", 5432);
+  const db = new PostgresDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    5432
+  );
   const sql = "SELECT some_column FROM some_table WHERE id = 1";
 
   expect(await db.lintQuery(sql)).toMatchObject({
@@ -37,7 +50,13 @@ test("it calls callback if there is an error", async () => {
 });
 
 test("it calls end on connection", () => {
-  const db = new PostgresDatabase("localhost", "user", "password", 5432);
+  const db = new PostgresDatabase(
+    "localhost",
+    "user",
+    "password",
+    "database",
+    5432
+  );
   db.end();
 });
 

test/unit/main.test.ts

@@ -70,6 +70,7 @@ jest.mock("mysql2", () => {
         user: "user",
         host: "localhost",
         password: "password",
+        database: "database",
       });
       return mock;
     },
@@ -90,6 +91,7 @@ test("it uses db connection is provided", async () => {
     user: "user",
     host: "localhost",
     password: "password",
+    database: "database",
     sql: "SELECT some_column FROM my_database.some_table;",
   };
 
@@ -108,6 +110,7 @@ jest.mock("pg", () => {
         host: "localhost",
         user: "user",
         password: "password",
+        database: "database",
         port: 5432,
       });
       return mock;
@@ -128,6 +131,7 @@ test("it uses correct driver when provided", async () => {
     driver: "postgres",
     host: "localhost",
     password: "password",
+    database: "database",
     port: 5432,
     sql: "SELECT some_column FROM my_database.some_table;",
     user: "user",