tests: Add tests for mysql and postgres socket path option

.github/workflows/ci.yml

@@ -51,6 +51,13 @@ jobs:
           POSTGRES_PASSWORD: postgres
         ports:
           - 5432:5432
+      postgressocket:
+        image: postgres:12
+        volumes:
+          - /mnt:/var/run/postgresql
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
       mysql:
         image: mysql:5.7
         env:
@@ -60,6 +67,14 @@ jobs:
         ports:
           - 33306:3306
         options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+      mysqlsocket:
+        image: mysql:5.7
+        volumes:
+          - /mnt:/var/run/mysqld
+        env:
+          MYSQL_ROOT_PASSWORD: mysql
+          MYSQL_DATABASE: test
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -74,12 +89,17 @@ jobs:
           echo "::set-env name=CHROME_PATH::$(which google-chrome-stable)"
           echo "::set-env name=POSTGRES_DB_URL::postgres://postgres:postgres@localhost/lighthouse_ci_test"
           echo "::set-env name=MYSQL_DB_URL::mysql://root:[email protected]:33306/lighthouse_ci_test"
+          echo "::set-env name=MYSQL_SOCKET_PATH::/mnt/mysqld.sock"
+          echo "::set-env name=POSTGRES_SOCKET_PATH::/mnt/.s.PGSQL.5432"
 
           export PGPASSWORD="postgres"
           export MYSQL_PWD="mysql"
           psql -h localhost -p 5432 -c 'create database lighthouse_ci_test;' -U postgres
           mysql --host=127.0.0.1 --port=33306 -e 'create database lighthouse_ci_test;' -u root
 
+          psql --host /mnt -c 'create database lighthouse_ci_test;' -U postgres
+          mysql --socket=/mnt/mysqld.sock -e 'create database lighthouse_ci_test;' -u root
+
           google-chrome-stable --version
       - run: yarn
       - run: yarn build

docs/configuration.md

@@ -892,15 +892,6 @@ _sqlDialect=sqlite only_
 
 The path to the sqlite database on the local filesystem relative to the current working directory.
 
-##### `storage.sqlSocketPath`
-
-_sqlDialect=mysql or sqlDialect=postgres only_
-
-The database Unix socket file path for the MySQL or PostgreSQL database.
-
-Note: If used, this option will require to specify the `database`, `username` and `password` sequelize options.
-See `storage.sequelizeOptions` for more information.
-
 ##### `storage.sqlConnectionUrl`
 
 _sqlDialect=mysql or sqlDialect=postgres only_
@@ -1213,7 +1204,9 @@ module.exports = {
     "server": {
       "storage": {
         "sqlDialect": "mysql",
-        "sqlSocketPath": "/var/lib/mysql/mysql.sock",
+        "sqlDialectOptions": {
+          "socketPath": "/var/lib/mysql/mysql.sock"
+        },
         "sequelizeOptions": {
           "database": "reports",
           "username": "admin",

packages/server/src/api/storage/sql/sql.js

@@ -92,7 +92,7 @@ function createSequelize(options) {
     });
   }
 
-  if (options.sqlSocketPath) {
+  if (options.sqlDialectOptions && options.sqlDialectOptions.socketPath) {
     if (
       !options.sequelizeOptions ||
       !options.sequelizeOptions.database ||
@@ -111,7 +111,6 @@ function createSequelize(options) {
       {
         ...sequelizeOptions,
         dialect: options.sqlDialect,
-        host: options.sqlSocketPath,
         ssl: !!options.sqlConnectionSsl,
         dialectOptions: options.sqlDialectOptions,
       }

packages/server/test/mysql-socket-path-server.test.js

@@ -0,0 +1,52 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+/* eslint-env jest */
+
+const runTests = require('./server-test-suite.js').runTests;
+const runServer = require('../src/server.js').createServer;
+
+describe('mysql server (socket path)', () => {
+  if (!process.env.MYSQL_SOCKET_PATH) {
+    it.skip('should work on mysql', () => {});
+    return;
+  }
+
+  const state = {
+    port: undefined,
+    closeServer: undefined,
+  };
+
+  beforeAll(async () => {
+    const {port, close, storageMethod} = await runServer({
+      logLevel: 'silent',
+      port: 0,
+      storage: {
+        storageMethod: 'sql',
+        sqlDialect: 'mysql',
+        sqlDialectOptions: {
+          socketPath: process.env.MYSQL_SOCKET_PATH,
+        },
+        sequelizeOptions: {
+          database: 'lighthouse_ci_test',
+          username: 'root',
+          password: 'mysql',
+        },
+      },
+    });
+
+    state.port = port;
+    state.closeServer = close;
+    state.storageMethod = storageMethod;
+  });
+
+  afterAll(() => {
+    state.closeServer();
+  });
+
+  runTests(state);
+});

packages/server/test/postgres-socket-path-server.test.js

@@ -0,0 +1,52 @@
+/**
+ * @license Copyright 2019 Google Inc. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+
+/* eslint-env jest */
+
+const runTests = require('./server-test-suite.js').runTests;
+const runServer = require('../src/server.js').createServer;
+
+describe('postgres server', () => {
+  if (!process.env.POSTGRES_DB_URL) {
+    it.skip('should work on postgres', () => {});
+    return;
+  }
+
+  const state = {
+    port: undefined,
+    closeServer: undefined,
+  };
+
+  beforeAll(async () => {
+    const {port, close, storageMethod} = await runServer({
+      logLevel: 'silent',
+      port: 0,
+      storage: {
+        storageMethod: 'sql',
+        sqlDialect: 'postgres',
+        sqlDialectOptions: {
+          socketPath: process.env.POSTGRES_SOCKET_PATH,
+        },
+        sequelizeOptions: {
+          database: 'lighthouse_ci_test',
+          username: 'postgres',
+          password: 'postgres',
+        },
+      },
+    });
+
+    state.port = port;
+    state.closeServer = close;
+    state.storageMethod = storageMethod;
+  });
+
+  afterAll(() => {
+    state.closeServer();
+  });
+
+  runTests(state);
+});

types/server.d.ts

@@ -161,6 +161,7 @@ declare global {
         storageMethod: 'sql' | 'spanner';
         sqlDialect: 'sqlite' | 'mysql' | 'postgres';
         sqlDialectOptions?: {
+          socketPath?: string;
           ssl?: {
             ca?: string;
             key?: string;
@@ -170,7 +171,6 @@ declare global {
         sqlDatabasePath?: string;
         sqlConnectionSsl?: string;
         sqlConnectionUrl?: string;
-        sqlSocketPath?: string;
         sqlDangerouslyResetDatabase?: boolean;
         sequelizeOptions?: import('sequelize').Options;
       }