Adds basic test cases and optional download link

Author: a7ul

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package.json

@@ -1,31 +1,35 @@
 {
-  "name": "nodegui-qt-installer",
+  "name": "@nodegui/qt-installer",
   "version": "1.0.0",
   "description": "A minimal qt installer for nodegui",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
     "start": "node dist/index.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --verbose"
   },
   "author": "atulanand94@gmail.com",
   "license": "ISC",
   "devDependencies": {
     "@types/7zip-min": "^1.1.0",
+    "@types/jest": "^25.1.2",
     "@types/node-fetch": "^2.5.4",
     "@types/progress": "^2.0.3",
     "@typescript-eslint/eslint-plugin": "^2.19.0",
     "@typescript-eslint/parser": "^2.19.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-plugin-prettier": "^3.1.2",
+    "jest": "^25.1.0",
     "prettier": "^1.19.1",
+    "ts-jest": "^25.2.0",
     "typescript": "^3.7.5"
   },
   "dependencies": {
     "7zip-min": "^1.1.1",
     "mkdirp": "^1.0.3",
     "node-fetch": "^2.6.0",
-    "progress": "^2.0.3"
+    "progress": "^2.0.3",
+    "tempy": "^0.3.0"
   }
 }

src/index.ts

@@ -1,22 +1,2 @@
-import { download } from './downloader';
-import { extract } from './extractor';
-import os from 'os';
-import metadata from './metadata.json';
-
-type SupportedOs = 'linux' | 'win32' | 'darwin';
-const setupQt = async (): Promise<void> => {
-  const currentOs = os.platform() as SupportedOs;
-  const downloadLink = metadata[currentOs];
-  const archivePath = './out/test/123/download.7zip';
-  const extractDir = './out/test2/extracted';
-  await download(downloadLink, archivePath, { name: 'Qt for Mac' });
-  await extract(archivePath, extractDir);
-};
-
-const main = async (): Promise<void> => {
-  await setupQt();
-};
-
-main()
-  .then(console.log)
-  .catch(console.error);
+import './types';
+export { setupQt } from './setup';

src/setup.ts

@@ -0,0 +1,21 @@
+import { download } from './downloader';
+import { extract } from './extractor';
+import metadata from './metadata.json';
+import tempy from 'tempy';
+
+type SupportedOs = 'linux' | 'win32' | 'darwin';
+type SetupOptions = {
+  qtDir: string;
+  downloadLink?: string;
+  osType: SupportedOs;
+};
+
+export async function setupQt(options: SetupOptions): Promise<string> {
+  const downloadLink = options.downloadLink || metadata[options.osType];
+  const archivePath = tempy.file({ extension: '7z' });
+  const extractDir = options.qtDir;
+  await download(downloadLink, archivePath, { name: 'Qt for Mac' });
+  await extract(archivePath, extractDir);
+  console.log(`Qt was setup successfully.  QtDir: ${extractDir}`);
+  return extractDir;
+}

src/tests/darwin.test.ts

@@ -0,0 +1,24 @@
+import path from 'path';
+import fs from 'fs';
+import { setupQt } from '../index';
+import { outputDir, TIMEOUT } from './utils';
+
+describe('Setup QT for darwin', () => {
+  const osType = 'darwin';
+  const qtDir = outputDir(osType);
+  let outPath = '';
+
+  beforeAll(async () => {
+    outPath = await setupQt({ qtDir, osType });
+  }, TIMEOUT);
+
+  test('check if output path is same as specified: ', () => {
+    expect(outPath).toBe(qtDir);
+  });
+
+  test('check if qt exists', () => {
+    const expectedPath = `5.13.0/clang_64`;
+    const doesQtExist = fs.existsSync(path.resolve(qtDir, expectedPath));
+    expect(doesQtExist).toBe(true);
+  });
+});

src/tests/linux.test.ts

@@ -0,0 +1,24 @@
+import path from 'path';
+import fs from 'fs';
+import { setupQt } from '../index';
+import { outputDir, TIMEOUT } from './utils';
+
+describe('Setup QT for linux', () => {
+  const osType = 'linux';
+  const qtDir = outputDir(osType);
+  let outPath = '';
+
+  beforeAll(async () => {
+    outPath = await setupQt({ qtDir, osType });
+  }, TIMEOUT);
+
+  test('check if output path is same as specified: ', () => {
+    expect(outPath).toBe(qtDir);
+  });
+
+  test('check if qt exists', () => {
+    const expectedPath = `5.13.0/gcc_64`;
+    const doesQtExist = fs.existsSync(path.resolve(qtDir, expectedPath));
+    expect(doesQtExist).toBe(true);
+  });
+});

src/tests/utils.ts

@@ -0,0 +1,4 @@
+import path from 'path';
+
+export const TIMEOUT = 60000;
+export const outputDir = (osName: string): string => path.resolve(__dirname, '..', '..', 'out', osName);

src/tests/win32.test.ts

@@ -0,0 +1,24 @@
+import path from 'path';
+import fs from 'fs';
+import { setupQt } from '../index';
+import { outputDir, TIMEOUT } from './utils';
+
+describe('Setup QT for win32', () => {
+  const osType = 'win32';
+  const qtDir = outputDir(osType);
+  let outPath = '';
+
+  beforeAll(async () => {
+    outPath = await setupQt({ qtDir, osType });
+  }, TIMEOUT);
+
+  test('check if output path is same as specified: ', () => {
+    expect(outPath).toBe(qtDir);
+  });
+
+  test('check if qt exists', () => {
+    const expectedPath = `5.13.0/msvc2017_64`;
+    const doesQtExist = fs.existsSync(path.resolve(qtDir, expectedPath));
+    expect(doesQtExist).toBe(true);
+  });
+});

src/types.d.ts src/types.tssrc/types.d.ts renamed to src/types.ts

@@ -14,5 +14,5 @@
     "moduleResolution": "node",
     "resolveJsonModule": true
   },
-  "include": ["src"]
+  "include": ["src/index.ts"]
 }