Merge pull request #36 from Sebastian-Webster/add-username-option

Add username option

Author: Sebastian-Webster

README.md

@@ -58,6 +58,8 @@ The port that the MySQL database is listening on
 The port that MySQLX is listening on
 - `dbName: string`
 The database that was created on database initialization
+- `username: string`
+The name of the user to use to login to the database
 - `stop: () => Promise<void>`
 The method to stop the database. The returned promise resolves when the database has successfully stopped.
 
@@ -122,6 +124,14 @@ Default: 1,000
 
 Description: If `downloadBinaryOnce` is set to `true`, `lockRetryWait` is the number of milliseconds to wait before checking if the lock has been released.
 
+- `username: string`
+
+Required: No
+
+Default: root
+
+Description: The username of the user that is used to login to the database.
+
 ## If using Ubuntu 24.04 and newer
 
 Selecting what MySQL version to use is not currently supported on Ubuntu 24.04 and newer. To use this package on Ubuntu 24.04 and newer you must have the `mysql-server` package installed on your system and `ServerOptions.version` must either be the version that is installed on the system or undefined.

src/index.ts

@@ -14,7 +14,8 @@ const defaultOptions: InternalServerOptions = {
     portRetries: 10,
     downloadBinaryOnce: true,
     lockRetries: 1_000,
-    lockRetryWait: 1_000
+    lockRetryWait: 1_000,
+    username: 'root'
 }
 
 process.on('exit', () => {

src/libraries/Executor.ts

@@ -92,6 +92,7 @@ class Executor {
                             port,
                             xPort: mySQLXPort,
                             dbName: options.dbName,
+                            username: options.username,
                             stop: () => {
                                 return new Promise(async (resolve, reject) => {
                                     resolveFunction = resolve;
@@ -203,7 +204,13 @@ class Executor {
                 return reject(err || stderr)
             }
 
-            await fsPromises.writeFile(`${dbPath}/init.sql`, `CREATE DATABASE ${options.dbName};`, {encoding: 'utf8'})
+            let initText = `CREATE DATABASE ${options.dbName};`;
+
+            if (options.username !== 'root') {
+                initText += `RENAME USER 'root'@'localhost' TO '${options.username}'@'localhost';`
+            }
+
+            await fsPromises.writeFile(`${dbPath}/init.sql`, initText, {encoding: 'utf8'})
 
             let retries = 0;
 

tests/sql.test.ts

@@ -9,10 +9,9 @@ let db: MySQLDB;
 let connection: sql.Connection;
 
 beforeEach(async () => {
-    db = await createDB()
+    db = await createDB({username: ''})
     connection = await sql.createConnection({
         host: '127.0.0.1',
-        user: 'root',
         port: db.port
     })
 })

tests/versions.test.ts

@@ -9,10 +9,9 @@ jest.setTimeout(900_000);
 
 for (const version of versions) {
     test(`running on version ${version}`, async () => {
-        const db = await createDB({version, dbName: 'testingdata'})
+        const db = await createDB({version, dbName: 'testingdata', username: ''})
         const connection = await sql.createConnection({
             host: '127.0.0.1',
-            user: 'root',
             port: db.port
         })
 

types/index.ts

@@ -9,7 +9,8 @@ export type ServerOptions = {
     portRetries?: number,
     downloadBinaryOnce?: boolean,
     lockRetries?: number,
-    lockRetryWait?: number
+    lockRetryWait?: number,
+    username?: string
 }
 
 export type InternalServerOptions = {
@@ -19,7 +20,8 @@ export type InternalServerOptions = {
     portRetries: number,
     downloadBinaryOnce: boolean,
     lockRetries: number,
-    lockRetryWait: number
+    lockRetryWait: number,
+    username: string
 }
 
 export type ExecutorOptions = {
@@ -36,6 +38,7 @@ export type MySQLDB = {
     port: number,
     xPort: number,
     dbName: string,
+    username: string,
     stop: () => Promise<void>
 }