Touch up README for utils, code formatting, links

emmax86 · emmax86 · commit 34977321cd35 · 2018-09-27T13:13:51.000-07:00
diff --git a/utils/README.md b/utils/README.md
@@ -6,16 +6,16 @@
   Determines how NodeGit should build. Use `BUILD_ONLY` environment variable to build from source.
 
   ## discoverOpenSSLDistros
-  Crawls a series of static links on the [Conan package manager](https://conan.io/) for the [latest release of OpenSSL](https://bintray.com/conan-community/conan/OpenSSL%3Aconan#files/conan%2FOpenSSL%2F1.1.0i) (1.1.0i at the time of writing). It acquires statically linked binaries and header files of OpenSSL for Mac and Windows. The provided binaries are compiled on:
+  Crawls a series of static URLS on the [Conan package manager](https://conan.io/) for the [latest release of OpenSSL](https://bintray.com/conan-community/conan/OpenSSL%3Aconan#files/conan%2FOpenSSL%2F1.1.0i) (1.1.0i at the time of writing). It acquires URLS for releases of statically linked binaries and header files of OpenSSL for Mac and Windows. The provided binaries are compiled on:
   
   * Mac: clang-8.1 or clang-9.
   * Windows: vs12, vs14, vs15
 
   The discovered distributions are written into `vendor/openssl_distributions.json`. This script does not need to be run unless you are updating the version of OpenSSL to build against.
 
   ### acquireOpenSSL
-  Download the OpenSSL binaries and headers applicable to the current OS for the latest compiler version (clang-9/vs15).
+  Download the OpenSSL binaries and headers applicable to the current OS for the latest compiler version (clang-9/vs15). Uses links from `vendor/openssl_distributions.json`.
   
   TODO:
-    * Make the script pull the debug versions if node-gyp is building in debug mode
-    * Make the script pull down a version of the binaries that matches the sytem compiler
+  * Make the script pull the debug versions if node-gyp is building in debug mode
+  * Make the script pull down a version of the binaries that matches the system compiler
diff --git a/utils/acquireOpenSSL.js b/utils/acquireOpenSSL.js
@@ -1,64 +1,65 @@
-const fse = require('fs-extra');
-const path = require('path');
-const R = require('ramda');
-const request = require('request-promise-native');
-const stream = require('stream');
-const tar = require('tar-fs');
-const zlib = require('zlib');
+const fse = require("fs-extra");
+const path = require("path");
+const R = require("ramda");
+const request = require("request-promise-native");
+const stream = require("stream");
+const tar = require("tar-fs");
+const zlib = require("zlib");
 
-const vendorPath = path.resolve(__dirname, '..', 'vendor');
-const distrosFilePath = path.join(vendorPath, 'openssl_distributions.json');
-const extractPath = path.join(vendorPath, 'openssl');
+const vendorPath = path.resolve(__dirname, "..", "vendor");
+const distrosFilePath = path.join(vendorPath, "openssl_distributions.json");
+const extractPath = path.join(vendorPath, "openssl");
 
 const getOSName = () => {
-  if (process.platform === 'win32') {
+  if (process.platform === "win32") {
     if (process.arch === "x64" || process.env.hasOwnProperty("PROCESSOR_ARCHITEW6432")) {
-      return 'win64';
+      return "win64";
     } else {
-      return 'win32';
+      return "win32";
     }
-  } else if (process.platform === 'darwin') {
-    return 'macOS';
+  } else if (process.platform === "darwin") {
+    return "macOS";
   } else {
-    // We only discover distros for Mac and Windows. We don't care about any other OS.
-    return 'unknown';
+    // We only discover distros for Mac and Windows. We don"t care about any other OS.
+    return "unknown";
   }
-}
+};
 
 const getCompilerVersion = () => {
   // TODO: Get actual compiler version. For now, just assume latest compiler for distros in openssl_distributions.js
   const osName = getOSName();
-  if (osName === 'win32' || osName === 'win64') {
-    return 'vs15';
-  } else if (osName === 'macOS') {
-    return 'clang-9';
+  if (osName === "win32" || osName === "win64") {
+    return "vs15";
+  } else if (osName === "macOS") {
+    return "clang-9";
   } else {
-    // We only discover distros for Mac and Windows. We don't care about any other OS.
-    return 'unknown';
+    // We only discover distros for Mac and Windows. We don"t care about any other OS.
+    return "unknown";
   }
-}
+};
 
-const getIsDebug = () => false // TODO: Determine if we are GYPing in Debug
+// TODO: Determine if we are GYPing in Debug
+const getIsDebug = () => false;
 
 const getMatchingDistributionName = () =>
-  `${getOSName()}-${getCompilerVersion()}-static${getIsDebug() ? '-debug' : '-release'}`;
+  `${getOSName()}-${getCompilerVersion()}-static${getIsDebug() ? "-debug" : "-release"}`;
 
 const getDistributionsConfig = () =>
-  fse.readFile(distrosFilePath, 'utf8')
-    .then(JSON.parse)
+  fse.readFile(distrosFilePath, "utf8")
+    .then(JSON.parse);
 
 const getDistrbutionURLFromConfig = (config) => {
   const distName = getMatchingDistributionName();
   const distURL = R.propOr(null, distName, config);
 
   if (!distURL) {
-    return Promise.reject(new Error('No matching distribution for this operating system'));
+    return Promise.reject(new Error("No matching distribution for this operating system"));
   }
   return Promise.resolve(distURL);
-}
+};
 
 const fetchFileFromURL = (distUrl) => request({
-  method: 'GET',
+  method: "GET",
   uri: distUrl,
   encoding: null,
   gzip: true
@@ -70,10 +71,10 @@ const extractFile = (body) => new Promise((resolve, reject) => {
   streamableBody.push(null);
   streamableBody
     .pipe(zlib.createGunzip())
-    .on('error', reject)
+    .on("error", reject)
     .pipe(tar.extract(extractPath))
-    .on('error', reject)
-    .on('close', resolve);
+    .on("error", reject)
+    .on("close", resolve);
 });
 
 const acquireOpenSSL = () =>
diff --git a/utils/discoverOpenSSLDistros.js b/utils/discoverOpenSSLDistros.js
@@ -1,13 +1,13 @@
-const cheerio = require('cheerio');
-const fse = require('fs-extra');
-const path = require('path');
-const R = require('ramda');
-const request = require('request-promise-native');
+const cheerio = require("cheerio");
+const fse = require("fs-extra");
+const path = require("path");
+const R = require("ramda");
+const request = require("request-promise-native");
 
 const windowsCommonConditions = [
   R.test(/^\s*os=Windows$/gm),
   R.test(/^\s*shared=False$/gm)
-]
+];
 
 const macCommonConditions = [
   R.test(/^\s*arch=x86_64$/gm),
@@ -17,113 +17,113 @@ const macCommonConditions = [
 ];
 
 const debugPairs = R.toPairs({
-  'win32-vs12-static-debug': R.allPass([
+  "win32-vs12-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=12$/gm)
   ]),
-  'win32-vs14-static-debug': R.allPass([
+  "win32-vs14-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=14$/gm)
   ]),
-  'win32-vs15-static-debug': R.allPass([
+  "win32-vs15-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=15$/gm)
   ]),
 
-  'win64-vs12-static-debug': R.allPass([
+  "win64-vs12-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=12$/gm)
   ]),
-  'win64-vs14-static-debug': R.allPass([
+  "win64-vs14-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=14$/gm)
   ]),
-  'win64-vs15-static-debug': R.allPass([
+  "win64-vs15-static-debug": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.runtime=MTd$/gm),
     R.test(/^\s*compiler\.version=15$/gm)
   ]),
   
-  'macOS-clang-9-static-debug': R.allPass([
+  "macOS-clang-9-static-debug": R.allPass([
     ...macCommonConditions,
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.version=9.0$/gm)
   ]),
-  'macOS-clang-8.1-static-debug': R.allPass([
+  "macOS-clang-8.1-static-debug": R.allPass([
     ...macCommonConditions,
     R.test(/^\s*build_type=Debug$/gm),
     R.test(/^\s*compiler\.version=8\.1$/gm)
   ])
-})
+});
 
 const releasePairs = R.toPairs({
-  'win32-vs12-static-release': R.allPass([
+  "win32-vs12-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=12$/gm)
   ]),
-  'win32-vs14-static-release': R.allPass([
+  "win32-vs14-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=14$/gm)
   ]),
-  'win32-vs15-static-release': R.allPass([
+  "win32-vs15-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=15$/gm)
   ]),
 
-  'win64-vs12-static-release': R.allPass([
+  "win64-vs12-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=12$/gm)
   ]),
-  'win64-vs14-static-release': R.allPass([
+  "win64-vs14-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=14$/gm)
   ]),
-  'win64-vs15-static-release': R.allPass([
+  "win64-vs15-static-release": R.allPass([
     ...windowsCommonConditions,
     R.test(/^\s*arch=x86_64$/gm),
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.runtime=MT$/gm),
     R.test(/^\s*compiler\.version=15$/gm)
   ]),
 
-  'macOS-clang-9-static-release': R.allPass([
+  "macOS-clang-9-static-release": R.allPass([
     ...macCommonConditions,
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.version=9.0$/gm)
   ]),
-  'macOS-clang-8.1-static-release': R.allPass([
+  "macOS-clang-8.1-static-release": R.allPass([
     ...macCommonConditions,
     R.test(/^\s*build_type=Release$/gm),
     R.test(/^\s*compiler\.version=8\.1$/gm)
@@ -133,13 +133,13 @@ const releasePairs = R.toPairs({
 const distributionPairs = [...debugPairs, ...releasePairs];
 
 const getDistributionConfigURLFromHash = itemHash =>
-  `https://bintray.com/conan-community/conan/download_file?file_path=conan%2FOpenSSL%2F1.1.0i%2Fstable%2Fpackage%2F${itemHash}%2Fconaninfo.txt`
+  `https://dl.bintray.com/conan-community/conan/conan/OpenSSL/1.1.0i/stable/package/${itemHash}/conaninfo.txt`;
 
 const getDistributionDownloadURLFromHash = itemHash =>
-  `https://dl.bintray.com/conan-community/conan/conan/OpenSSL/1.1.0i/stable/package/${itemHash}/conan_package.tgz`
+  `https://dl.bintray.com/conan-community/conan/conan/OpenSSL/1.1.0i/stable/package/${itemHash}/conan_package.tgz`;
 
 const getDistributionsRootURL = () =>
-  'https://bintray.com/package/files/conan-community/conan/OpenSSL%3Aconan?order=asc&sort=name&basePath=conan%2FOpenSSL%2F1.1.0i%2Fstable%2Fpackage&tab=files'
+  "https://dl.bintray.com/conan-community/conan/conan/OpenSSL/1.1.0i/stable/package/";
 
 const detectDistributionPairFromConfig = (itemHash, body) => R.reduce(
   (acc, [releaseName, predicate]) => R.cond([
@@ -158,12 +158,13 @@ const discoverDistributions = (treeHtml) => {
   const releaseHashes = [];
 
   const $ = cheerio.load(treeHtml);
-  const links = $('#treeBrowseTable > tbody > tr > td.nameCol > a');
-  links.each((_, link) => {
-    const releaseHash = link.children[0].data;
-    if (!releaseHash) {
+  $("a").each((_, link) => {
+    const linkText = link.children[0].data;
+    if (!linkText) {
       return;
     }
+    // Trim off the trailing '/'
+    const releaseHash = linkText.substring(0, linkText.length - 1);
     releaseHashes.push(releaseHash);
   });
 
@@ -172,7 +173,7 @@ const discoverDistributions = (treeHtml) => {
   );
 }
 
-const outputPath = path.resolve(__dirname, '..', 'vendor', 'openssl_distributions.json');
+const outputPath = path.resolve(__dirname, "..", "vendor", "openssl_distributions.json");
 request(getDistributionsRootURL())
   .then(discoverDistributions)
   .then(R.filter(R.identity))
