Change to artifact installer

Author: a7ul

README.md

@@ -0,0 +1,8 @@
+# Artifact installer
+
+Artifact installer is used to setup Qt
+
+This downloads prebuilt binary dependencies such as Qt binaries and sets it up.
+Supports caching the downloaded binaries so that its not downloaded again and again.
+
+Currently support extraction only using 7zip.

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@nodegui/qt-installer",
+  "name": "@nodegui/artifact-installer",
   "version": "1.0.0",
-  "description": "A minimal qt installer for nodegui",
+  "description": "An artifact or prebuilt binary installer for for nodegui",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
@@ -15,6 +15,7 @@
   "license": "ISC",
   "devDependencies": {
     "@types/7zip-min": "^1.1.0",
+    "@types/empty-dir": "^2.0.0",
     "@types/jest": "^25.1.2",
     "@types/node-fetch": "^2.5.4",
     "@types/progress": "^2.0.3",
@@ -30,6 +31,7 @@
   },
   "dependencies": {
     "7zip-min": "^1.1.1",
+    "empty-dir": "^2.0.0",
     "env-paths": "^2.2.0",
     "make-dir": "^3.0.0",
     "node-fetch": "^2.6.0",

src/index.ts

@@ -1,3 +1,3 @@
 export { download } from './downloader';
 export { extract } from './extractor';
-export { setupQt } from './setup';
+export { setupArtifact } from './setup';

src/metadata.json

@@ -1,26 +1,36 @@
 import { download } from './downloader';
 import { extract } from './extractor';
 import path from 'path';
-import metadata from './metadata.json';
 import envPaths from 'env-paths';
+import emptyDir from 'empty-dir';
+import mkdirp from 'make-dir';
 
-const appPaths = envPaths('nodegui-qt');
-
-type SupportedOs = 'linux' | 'win32' | 'darwin';
 type SetupOptions = {
-  qtDir: string;
-  downloadLink?: string;
+  outDir: string;
+  downloadLink: string;
   cacheDir?: string;
-  osType: SupportedOs;
+  force?: boolean;
+  id: string;
+  displayName?: string;
 };
 
-export async function setupQt(options: SetupOptions): Promise<string> {
-  const downloadLink = options.downloadLink || metadata[options.osType];
-  const cacheDir = options.cacheDir || appPaths.cache;
+export async function setupArtifact(options: SetupOptions): Promise<string> {
+  const downloadLink = options.downloadLink;
+  const cacheDir = options.cacheDir || envPaths(`${options.id}`).cache;
+  const force = Boolean(options.force);
+  const displayName = options.displayName || options.id;
   const archivePath = path.resolve(cacheDir, path.basename(downloadLink));
-  const extractDir = options.qtDir;
-  await download(downloadLink, archivePath, { name: 'Mini Qt', skipIfExist: true });
-  await extract(archivePath, extractDir);
-  console.log(`Mini Qt was setup successfully.  QtDir: ${extractDir}`);
-  return extractDir;
+  const outDir = options.outDir;
+
+  await mkdirp(outDir);
+
+  if (!(await emptyDir(outDir)) && !force) {
+    console.log(`Skipping setup for ${displayName}...`);
+    return outDir;
+  }
+
+  await download(downloadLink, archivePath, { name: displayName, skipIfExist: !force });
+  await extract(archivePath, outDir);
+  console.log(`${displayName} was setup successfully.  outDir: ${outDir}`);
+  return outDir;
 }

src/setup.ts

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

src/tests/darwin.test.ts

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

src/tests/linux.test.ts

@@ -2,3 +2,12 @@ import path from 'path';
 
 export const TIMEOUT = 60000;
 export const outputDir = (osName: string): string => path.resolve(__dirname, '..', '..', 'out', osName);
+
+export const metadata = {
+  darwin:
+    'https://download.qt.io/online/qtsdkrepository/mac_x64/desktop/qt5_5130/qt.qt5.5130.clang_64/5.13.0-0-201906171525qtbase-MacOS-MacOS_10_13-Clang-MacOS-MacOS_10_13-X86_64.7z',
+  win32:
+    'https://download.qt.io/online/qtsdkrepository/windows_x86/desktop/qt5_5130/qt.qt5.5130.win64_msvc2017_64/5.13.0-0-201906171525qtbase-Windows-Windows_10-MSVC2017-Windows-Windows_10-X86_64.7z',
+  linux:
+    'https://download.qt.io/online/qtsdkrepository/linux_x64/desktop/qt5_5130/qt.qt5.5130.gcc_64/5.13.0-0-201906171524qtbase-Linux-RHEL_7_6-GCC-Linux-RHEL_7_6-X86_64.7z',
+};

src/tests/utils.ts

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

src/tests/win32.test.ts

@@ -387,6 +387,13 @@
   resolved "https://registry.yarnpkg.com/@types/color-name/-/color-name-1.1.1.tgz#1c1261bbeaa10a8055bbc5d8ab84b7b2afc846a0"
   integrity sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==
 
+"@types/empty-dir@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@types/empty-dir/-/empty-dir-2.0.0.tgz#fc40e385727b1625c5cb5021ecf9cd28efeafe8a"
+  integrity sha512-wyXug9Ay49frbC8fd+QDnoe1ByBk+wDz+acg+cacXWSnrph2v1wyLm3dSVnGLYAzMsfmga0asuBl2Da9IeQx2w==
+  dependencies:
+    "@types/node" "*"
+
 "@types/eslint-visitor-keys@^1.0.0":
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/@types/eslint-visitor-keys/-/eslint-visitor-keys-1.0.0.tgz#1ee30d79544ca84d68d4b3cdb0af4f205663dd2d"
@@ -1130,6 +1137,11 @@ emoji-regex@^8.0.0:
   resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37"
   integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==
 
+empty-dir@^2.0.0:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/empty-dir/-/empty-dir-2.0.0.tgz#c59b4e73b9909d3c4bd49c1fbdaea52031fe22ac"
+  integrity sha512-XAedXlNAQZxMmbllXY9cxuESlNVjZ8xd67bSIUZwbS7VoLyhlNehVN3Iy35yDTGFHKR1opBRgORkp3am0so+WQ==
+
 end-of-stream@^1.1.0:
   version "1.4.4"
   resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0"