refactor: create a generic MSI Installer class

dhensby · dhensby · commit 27e800f4da2f · 2023-09-12T22:17:54.000+01:00
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ See [action.yml](./action.yml):
     # Default: latest
     sqlserver-version: ''
 
-    # Version of native client to installer. Only 11 is supported.
+    # Version of native client to install. Only 11 is supported.
     native-client-version: ''
 
     # The SA user password to use.
diff --git a/action.yml b/action.yml
@@ -9,7 +9,7 @@ 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.'
   sa-password:
     description: 'The SA user password to use.'
     default: 'yourStrong(!)Password'
diff --git a/lib/main/index.js b/lib/main/index.js
diff --git a/package.json b/package.json
@@ -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": [
diff --git a/src/install-native-client.ts b/src/install-native-client.ts
@@ -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();
 }
diff --git a/src/install.ts b/src/install.ts
@@ -77,7 +77,7 @@ 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));
     }
     // Initial checks complete - fetch the installer
     const toolPath = await core.group(`Fetching install media for ${version}`, () => findOrDownloadTool(config));
diff --git a/src/installers/index.ts b/src/installers/index.ts
@@ -0,0 +1 @@
+export * from './msi-installer';
diff --git a/src/installers/installer.ts b/src/installers/installer.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>;
+}
diff --git a/src/installers/msi-installer.ts b/src/installers/msi-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');
+    }
+}
diff --git a/test/install-native-client.ts b/test/install-native-client.ts
@@ -2,7 +2,7 @@ import { match, restore, SinonStubbedInstance, stub } from 'sinon';
 import * as core from '@actions/core';
 import * as tc from '@actions/tool-cache';
 import * as exec from '@actions/exec';
-import * as utils from '../src/utils';
+import * as io from '@actions/io';
 import installNativeClient from '../src/install-native-client';
 import { expect, use } from 'chai';
 import sinonChai from 'sinon-chai';
@@ -12,7 +12,7 @@ describe('install-native-client', () => {
     // let coreStub: SinonStubbedInstance<typeof core>;
     let tcStub: SinonStubbedInstance<typeof tc>;
     let execStub: SinonStubbedInstance<typeof exec>;
-    let utilsStub: SinonStubbedInstance<typeof utils>;
+    let ioStub: SinonStubbedInstance<typeof io>;
     let arch: PropertyDescriptor;
     beforeEach('stub deps', () => {
         stub(core);
@@ -21,8 +21,8 @@ describe('install-native-client', () => {
         tcStub.find.returns('');
         execStub = stub(exec);
         execStub.exec.resolves();
-        utilsStub = stub(utils);
-        utilsStub.downloadTool.resolves('c:/tmp/downloads');
+        ioStub = stub(io);
+        ioStub.mv.resolves();
     });
     afterEach('restore stubs', () => {
         Object.defineProperty(process, 'arch', arch);
@@ -31,17 +31,17 @@ describe('install-native-client', () => {
     describe('.installNativeClient()', () => {
         it('throws for bad version', async () => {
             try {
-                await installNativeClient(10);
+                await installNativeClient('10');
             } catch (e) {
-                expect(e).to.have.property('message', 'Unsupported Native Client version, only 11 is valid.');
+                expect(e).to.have.property('message', 'Invalid native client version supplied 10. Must be one of 11.');
                 return;
             }
             expect.fail('expected to throw');
         });
         it('installs from cache', async () => {
             tcStub.find.returns('C:/tmp/');
-            await installNativeClient(11);
-            expect(utilsStub.downloadTool).to.have.callCount(0);
+            await installNativeClient('11');
+            expect(tcStub.downloadTool).to.have.callCount(0);
             expect(execStub.exec).to.have.been.calledOnceWith('msiexec', match.array, {
                 windowsVerbatimArguments: true,
             });
@@ -52,8 +52,9 @@ describe('install-native-client', () => {
                 value: 'x64',
             });
             tcStub.cacheFile.resolves('C:/tmp/cache/');
-            await installNativeClient(11);
-            expect(utilsStub.downloadTool).to.have.been.calledOnceWith('https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x64/sqlncli.msi');
+            tcStub.downloadTool.resolves('C:/tmp/downloads');
+            await installNativeClient('11');
+            expect(tcStub.downloadTool).to.have.been.calledOnceWith('https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x64/sqlncli.msi');
             expect(tcStub.cacheFile).to.have.callCount(1);
             expect(execStub.exec).to.have.been.calledOnceWith('msiexec', match.array, {
                 windowsVerbatimArguments: true,
@@ -65,8 +66,9 @@ describe('install-native-client', () => {
                 value: 'x32',
             });
             tcStub.cacheFile.resolves('C:/tmp/cache/');
-            await installNativeClient(11);
-            expect(utilsStub.downloadTool).to.have.been.calledOnceWith('https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x86/sqlncli.msi');
+            tcStub.downloadTool.resolves('C:/tmp/downloads');
+            await installNativeClient('11');
+            expect(tcStub.downloadTool).to.have.been.calledOnceWith('https://download.microsoft.com/download/B/E/D/BED73AAC-3C8A-43F5-AF4F-EB4FEA6C8F3A/ENU/x86/sqlncli.msi');
             expect(tcStub.cacheFile).to.have.callCount(1);
             expect(execStub.exec).to.have.been.calledOnceWith('msiexec', match.array, {
                 windowsVerbatimArguments: true,
diff --git a/test/install.ts b/test/install.ts
@@ -315,6 +315,6 @@ describe('install', () => {
             nativeClientVersion: '11',
         });
         await install();
-        expect(stubNc.default).to.have.been.calledOnceWith(11);
+        expect(stubNc.default).to.have.been.calledOnceWith('11');
     });
 });
diff --git a/test/installers/installer.ts b/test/installers/installer.ts
@@ -0,0 +1,82 @@
+import { Installer } from '../../src/installers/installer';
+import { expect } from 'chai';
+import { stub, restore, SinonStubbedInstance } from 'sinon';
+import * as core from '@actions/core';
+import * as tc from '@actions/tool-cache';
+import * as io from '@actions/io';
+import { randomUUID } from 'crypto';
+
+class TestInstaller extends Installer {
+    install(): Promise<void> {
+        return Promise.resolve();
+    }
+
+    public getArch() {
+        return super.getArch();
+    }
+
+    public downloadInstaller(url: string, extName?: string) {
+        return super.downloadInstaller(url, extName);
+    }
+}
+
+describe('Installer', () => {
+    let stubTc: SinonStubbedInstance<typeof tc>;
+    let stubIo: SinonStubbedInstance<typeof io>;
+    beforeEach('stub libs', () => {
+        stub(core);
+        stubTc = stub(tc);
+        stubIo = stub(io);
+    });
+    afterEach('restore stubs', () => {
+        restore();
+    });
+    describe('.constructor()', () => {
+        it('populates name/version', () => {
+            const installer = new TestInstaller({
+                name: 'test',
+                version: '1.0.0',
+            });
+            expect(installer.name).to.equal('test');
+            expect(installer.version).to.equal('1.0.0');
+        });
+    });
+    describe('.getArch()', () => {
+        let arch: PropertyDescriptor;
+        beforeEach('store arch', () => {
+            arch = Object.getOwnPropertyDescriptor(process, 'arch')!;
+        });
+        afterEach('reset arch', () => {
+            Object.defineProperty(process, 'arch', arch);
+        });
+        it('returns x386 for 32 bit', () => {
+            Object.defineProperty(process, 'arch', {
+                value: 'x32',
+            });
+            expect(new TestInstaller({ name: 'test', version: '1.0.0' }).getArch()).to.equal('x86');
+        });
+        it('returns x64 for 64 bit', () => {
+            Object.defineProperty(process, 'arch', {
+                value: 'x64',
+            });
+            expect(new TestInstaller({ name: 'test', version: '1.0.0' }).getArch()).to.equal('x64');
+        });
+    });
+    describe('.downloadInstaller()', () => {
+        beforeEach('stub deps', () => {
+            stubIo.mv.resolves();
+        });
+        it('downloads the tool', async () => {
+            const fileName = randomUUID();
+            stubTc.downloadTool.withArgs('https://example.com/setup.exe').resolves(`C:/path/to/${fileName}`);
+            const res = await new TestInstaller({ name: 'test', version: '1.0.0' }).downloadInstaller('https://example.com/setup.exe');
+            expect(res).to.equal(`C:/path/to/${fileName}.exe`);
+        });
+        it('downloads the tool with custom extension', async () => {
+            const fileName = randomUUID();
+            stubTc.downloadTool.withArgs('https://example.com/setup.exe').resolves(`C:/path/to/${fileName}`);
+            const res = await new TestInstaller({ name: 'test', version: '1.0.0' }).downloadInstaller('https://example.com/setup.exe', '.html');
+            expect(res).to.equal(`C:/path/to/${fileName}.html`);
+        });
+    });
+});
diff --git a/test/installers/msi-installer.ts b/test/installers/msi-installer.ts

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ export default async function install() {`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`	`if (nativeClientVersion) {`
`80`		`- await core.group('Installing SQL Native Client', () => installNativeClient(parseInt(nativeClientVersion, 10)));`
	`80`	`+ await core.group('Installing SQL Native Client', () => installNativeClient(nativeClientVersion));`
`81`	`81`	`}`
`82`	`82`	`// Initial checks complete - fetch the installer`
`83`	`83`	const toolPath = await core.group(`Fetching install media for ${version}`, () => findOrDownloadTool(config));