Merge pull request tediousjs#5 from dhensby/pulls/installers

feat: add ODBC driver install step

Author: dhensby

.github/workflows/release.yml

@@ -146,6 +146,7 @@ jobs:
         with:
           sqlserver-version: ${{ matrix.sqlserver }}
           native-client-version: 11
+          odbc-version: 17
   release:
     name: Release
     concurrency: release

README.md

@@ -11,22 +11,25 @@ See [action.yml](./action.yml):
   with:
     # Skip OS checks that will stop installation attempts preemptively.
     # Default: false
-    skip-os-check: ''
+    skip-os-check: false
 
     # Version to use. Examples: 2008, 2012, 2014, etc. "latest" can also be used.
     # Default: latest
-    sqlserver-version: ''
+    sqlserver-version: 'latest'
 
-    # Version of native client to installer. Only 11 is supported.
+    # Version of native client to install. Only 11 is supported.
     native-client-version: ''
 
+    # Version of ODBC to install. Supported versions: 17, 18.
+    odbc-version: ''
+
     # The SA user password to use.
     # Default: yourStrong(!)Password
-    sa-password: ''
+    sa-password: 'yourStrong(!)Password'
 
     # The database collation to use.
     # Default: SQL_Latin1_General_CP1_CI_AS
-    db-collation: ''
+    db-collation: 'SQL_Latin1_General_CP1_CI_AS'
 
     # Any custom install arguments you wish to use. These must be in the format of
     # "/ARG=VAL".
@@ -35,7 +38,7 @@ See [action.yml](./action.yml):
     # Wait for the database to respond successfully to queries before completing the
     # action. A maximum of 10 attempts is made.
     # Default: true
-    wait-for-ready: ''
+    wait-for-ready: true
 ```
 <!-- end usage -->
 

action.yml

@@ -9,7 +9,9 @@ inputs:
     description: 'Version to use. Examples: 2008, 2012, 2014, etc. "latest" can also be used.'
     default: 'latest'
   native-client-version:
-    description: 'Version of native client to installer. Only 11 is supported.'
+    description: 'Version of native client to install. Only 11 is supported.'
+  odbc-version:
+    description: 'Version of ODBC to install. Supported versions: 17, 18.'
   sa-password:
     description: 'The SA user password to use.'
     default: 'yourStrong(!)Password'

lib/main/index.js

@@ -95,7 +95,7 @@ function updateUsage(
         // Constrain the width of the description
         const width = 80;
         let description = (input.description as string)
-            .trimRight()
+            .trimEnd()
             .replace(/\r\n/g, '\n') // Convert CR to LF
             .replace(/ +/g, ' ') //    Squash consecutive spaces
             .replace(/ \n/g, '\n'); //  Squash space followed by newline
@@ -123,15 +123,15 @@ function updateUsage(
             }
 
             // Append segment
-            newReadme.push(`    # ${segment}`.trimRight());
+            newReadme.push(`    # ${segment}`.trimEnd());
 
             // Remaining
             description = description.substr(segment.length);
         }
 
         if (input.default !== undefined) {
             // Append blank line if description had paragraphs
-            if ((input.description as string).trimRight().match(/\n[ ]*\r?\n/)) {
+            if ((input.description as string).trimEnd().match(/\n[ ]*\r?\n/)) {
                 newReadme.push(`    #`);
             }
 
@@ -140,7 +140,16 @@ function updateUsage(
         }
 
         // Input name
-        newReadme.push(`    ${key}: ''`);
+        let inputValue: string;
+        switch (input.default) {
+            case 'true':
+            case 'false':
+                inputValue = input.default;
+                break;
+            default:
+                inputValue = `'${input.default ?? ''}'`;
+        }
+        newReadme.push(`    ${key}: ${inputValue}`);
 
         firstInput = false;
     }

misc/generate-docs.ts

@@ -10,7 +10,7 @@
     "lint": "eslint --config ./.eslintrc.json ./src ./misc ./test",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "npm run build",
-    "test": "mocha -r ts-node/register './test/**.ts'",
+    "test": "mocha -r ts-node/register './test/**/**.ts'",
     "test:coverage": "nyc --all npm run test --silent"
   },
   "files": [

package.json

@@ -1,36 +1,24 @@
-import * as core from '@actions/core';
-import * as tc from '@actions/tool-cache';
-import * as exec from '@actions/exec';
-import { downloadTool } from './utils';
-import { join as joinPaths } from 'path';
+import { MsiInstaller, Urls } from './installers';
 
-const x64_URL = 'https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x64/sqlncli.msi';
-const x86_URL = 'https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x86/sqlncli.msi';
-
-export default async function installNativeClient(version: number) {
-    if (version !== 11) {
-        throw new Error('Unsupported Native Client version, only 11 is valid.');
-    }
-    const arch = process.arch === 'x64' ? 'x64' : 'x86';
-    let path = tc.find('sqlncli', '11.0', arch);
-    if (!path) {
-        core.info(`Downloading client installer for ${arch}.`);
-        path = await downloadTool(arch === 'x64' ? x64_URL : x86_URL).then((tmp) => {
-            return tc.cacheFile(tmp, 'sqlncli.msi', 'sqlncli', '11.0', arch);
-        });
-    } else {
-        core.info('Loaded client installer from cache.');
+const VERSIONS = new Map<string, Urls>([
+    ['11', {
+        x64: 'https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x64/sqlncli.msi',
+        x86: 'https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x86/sqlncli.msi',
+    }],
+]);
+export default async function installNativeClient(version: string) {
+    if (!VERSIONS.has(version)) {
+        throw new TypeError(`Invalid native client version supplied ${version}. Must be one of ${Array.from(VERSIONS.keys()).join(', ')}.`);
     }
-    path = joinPaths(path, 'sqlncli.msi');
-    core.info('Installing SQL Native Client 11.0');
     // see https://learn.microsoft.com/en-us/previous-versions/sql/sql-server-2012/ms131321(v=sql.110)
-    await exec.exec('msiexec', [
-        '/passive',
-        '/i',
-        path,
-        'APPGUID={0CC618CE-F36A-415E-84B4-FB1BFF6967E1}',
-        'IACCEPTSQLNCLILICENSETERMS=YES',
-    ], {
-        windowsVerbatimArguments: true,
+    const installer = new MsiInstaller({
+        name: 'sqlncli',
+        urls: VERSIONS.get(version)!,
+        appGuid: '0CC618CE-F36A-415E-84B4-FB1BFF6967E1',
+        version,
+        extraArgs: [
+            'IACCEPTSQLNCLILICENSETERMS=YES',
+        ],
     });
+    return installer.install();
 }

src/install-native-client.ts

@@ -0,0 +1,28 @@
+import { MsiInstaller, Urls } from './installers';
+
+// https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16
+const VERSIONS = new Map<string, Urls>([
+    ['18', {
+        x64: 'https://go.microsoft.com/fwlink/?linkid=2242886',
+        x86: 'https://go.microsoft.com/fwlink/?linkid=2242980',
+    }],
+    ['17', {
+        x64: 'https://go.microsoft.com/fwlink/?linkid=2239168',
+        x86: 'https://go.microsoft.com/fwlink/?linkid=2238791',
+    }],
+]);
+
+export default async function installOdbc(version: string) {
+    if (!VERSIONS.has(version)) {
+        throw new TypeError(`Invalid ODBC version supplied ${version}. Must be one of ${Array.from(VERSIONS.keys()).join(', ')}.`);
+    }
+    const installer = new MsiInstaller({
+        name: 'msodbcsql',
+        urls: VERSIONS.get(version)!,
+        version,
+        extraArgs: [
+            'IACCEPTMSODBCSQLLICENSETERMS=YES',
+        ],
+    });
+    return installer.install();
+}

src/install-odbc.ts

@@ -14,6 +14,7 @@ import {
     waitForDatabase,
 } from './utils';
 import installNativeClient from './install-native-client';
+import installOdbc from './install-odbc';
 
 /**
  * Attempt to load the installer from the tool-cache, otherwise, fetch it.
@@ -42,6 +43,7 @@ export default async function install() {
         wait,
         skipOsCheck,
         nativeClientVersion,
+        odbcVersion,
     } = gatherInputs();
     // we only support windows for now. But allow crazy people to skip this check if they like...
     if (!skipOsCheck && os.platform() !== 'win32') {
@@ -77,7 +79,10 @@ export default async function install() {
         }
     }
     if (nativeClientVersion) {
-        await core.group('Installing SQL Native Client', () => installNativeClient(parseInt(nativeClientVersion, 10)));
+        await core.group('Installing SQL Native Client', () => installNativeClient(nativeClientVersion));
+    }
+    if (odbcVersion) {
+        await core.group('Installing ODBC', () => installOdbc(odbcVersion));
     }
     // Initial checks complete - fetch the installer
     const toolPath = await core.group(`Fetching install media for ${version}`, () => findOrDownloadTool(config));

src/install.ts

@@ -0,0 +1 @@
+export * from './msi-installer';

src/installers/index.ts

@@ -0,0 +1,38 @@
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+import { basename, dirname, extname, join as joinPaths } from 'path';
+import * as io from '@actions/io';
+
+export interface InstallerConfig {
+    name: string;
+    version: string;
+}
+
+export abstract class Installer {
+    public readonly name: string;
+    public readonly version: string;
+
+    constructor(config: InstallerConfig) {
+        this.name = config.name;
+        this.version = config.version;
+    }
+
+    protected getArch(): string {
+        return process.arch === 'x32' ? 'x86' : 'x64';
+    }
+
+    protected downloadInstaller(url: string, extName?: string) {
+        core.debug(`Downloading from ${url}`);
+        return tc.downloadTool(url).then((path) => {
+            const ext = extName ?? extname(url);
+            const downloadDir = dirname(path);
+            const destination = joinPaths(downloadDir, `${basename(path, `${ext}`)}${ext}`);
+            return io.mv(path, destination).then(() => {
+                core.debug(`Downloaded to ${destination}`);
+                return destination;
+            });
+        });
+    }
+
+    abstract install(): Promise<void>;
+}

src/installers/installer.ts

@@ -0,0 +1,71 @@
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+import { Installer, InstallerConfig } from './installer';
+import { join as joinPaths } from 'path';
+import * as exec from '@actions/exec';
+
+export interface Urls {
+    x64?: string;
+    x86?: string;
+}
+
+export interface MsiInstallerConfig extends InstallerConfig {
+    urls: Urls;
+    appGuid?: string;
+    extraArgs?: string[];
+    silent?: boolean;
+}
+
+export class MsiInstaller extends Installer {
+    private readonly urls: Urls;
+    private readonly guid: string | undefined;
+    private readonly silent: boolean;
+    private readonly extraArgs: string[];
+    constructor(config: MsiInstallerConfig) {
+        super(config);
+        this.urls = { ...config.urls };
+        this.guid = config.appGuid;
+        this.silent = config.silent ?? true;
+        this.extraArgs = config.extraArgs ?? [];
+    }
+
+    private get installUrl(): string {
+        const arch = this.getArch();
+        if (this.urls[arch]) {
+            return this.urls[arch];
+        }
+        return Object.values(this.urls).find((val) => val && typeof val === 'string');
+    }
+
+    public async install() {
+        let path = tc.find(this.name, this.version, this.getArch());
+        if (path) {
+            core.info(`Found ${this.name} installer in cache @ ${path}`);
+        } else {
+            core.info(`Download ${this.name} installer from ${this.installUrl}`);
+            path = await this.downloadInstaller(this.installUrl, '.msi').then((tmp) => {
+                return tc.cacheFile(tmp, `${this.name}.msi`, this.name, this.version);
+            });
+            core.info(`Downloaded ${this.name} installer to cache @ ${path}`);
+        }
+        path = joinPaths(path, `${this.name}.msi`);
+        core.info('Running installer');
+        const args: string[] = [
+            '/i',
+            path,
+        ];
+        if (this.guid) {
+            args.push(`APPGUID={${this.guid}}`);
+        }
+        if (this.extraArgs.length) {
+            args.push(...this.extraArgs);
+        }
+        if (this.silent) {
+            args.unshift('/passive');
+        }
+        await exec.exec('msiexec', args, {
+            windowsVerbatimArguments: true,
+        });
+        core.info('Install complete');
+    }
+}

src/installers/msi-installer.ts

@@ -49,6 +49,7 @@ export interface Inputs {
     wait: boolean;
     skipOsCheck: boolean;
     nativeClientVersion: string;
+    odbcVersion: string;
 }
 
 /**
@@ -66,6 +67,7 @@ export function gatherInputs(): Inputs {
         wait: core.getBooleanInput('wait-for-ready'),
         skipOsCheck: core.getBooleanInput('skip-os-check'),
         nativeClientVersion: core.getInput('native-client-version'),
+        odbcVersion: core.getInput('odbc-version'),
     };
 }