feat: use self-containe fpm on OS X — don't need to install ruby anymore

develar · develar · commit e7cee5eab876 · 2016-05-04T17:16:35.000+02:00
diff --git a/.idea/libraries/electron_builder_for_tests.xml b/.idea/libraries/electron_builder_for_tests.xml
diff --git a/.idea/runConfigurations/linuxPackagerTest.xml b/.idea/runConfigurations/linuxPackagerTest.xml
diff --git a/.travis.yml b/.travis.yml
@@ -11,14 +11,15 @@ env:
   - NODE_VERSION=4
   - NODE_VERSION=6
 
-language: ruby
+language: c
 
 cache:
+  apt: true
+  bundler: true
   directories:
     - node_modules
     - test/testApp/node_modules
     - $HOME/.electron
-    - $HOME/.npm
 
 addons:
   apt:
@@ -33,16 +34,15 @@ before_install:
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update ; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install gnu-tar dpkg libicns graphicsmagick git-lfs; fi
   - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then git lfs pull; fi
-  - gem install --no-rdoc --no-ri fpm
   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then test/install-linux-dependencies.sh; fi
   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then curl -L https://github.com/github/git-lfs/releases/download/v1.2.0/git-lfs-linux-amd64-1.2.0.tar.gz | tar -xz; fi
   - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then git-lfs-1.2.0/git-lfs pull; fi
 
 install:
 - nvm install $NODE_VERSION
 - npm install npm -g
-- npm prune
 - npm install
+- npm prune
 
 script:
 - npm run test
diff --git a/docs/Multi Platform Build.md b/docs/Multi Platform Build.md
@@ -22,8 +22,7 @@ brew install Caskroom/cask/xquartz wine mono
 
 To build app in distributable format for Linux on OS X:
 ```
-brew install ruby gnu-tar libicns graphicsmagick
-gem install fpm
+brew install gnu-tar libicns graphicsmagick
 ```
 
 ## Linux
diff --git a/package.json b/package.json
@@ -20,7 +20,8 @@
     "test": "node ./test/out/helpers/runTests.js",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post",
     "//": "Update wiki if docs changed. Update only if functionalily are generally available (latest release, not next)",
-    "update-wiki": "git subtree split -b wiki --prefix docs/ && git push wiki wiki:master"
+    "update-wiki": "git subtree split -b wiki --prefix docs/ && git push wiki wiki:master",
+    "whitespace": "whitespace src/*.ts"
   },
   "repository": {
     "type": "git",
@@ -64,7 +65,7 @@
     "electron-osx-sign-tf": "~0.5.0-beta.0",
     "electron-packager-tf": "^7.0.2-beta.0",
     "electron-winstaller-fixed": "~2.4.0-beta.1",
-    "fs-extra-p": "^1.0.0",
+    "fs-extra-p": "^1.0.1",
     "globby": "^4.0.0",
     "hosted-git-info": "^2.1.4",
     "image-size": "^0.5.0",
@@ -76,15 +77,18 @@
     "signcode-tf": "^0.5.0",
     "source-map-support": "^0.4.0",
     "tmp": "0.0.28",
-    "typescript": "^1.9.0-dev.20160502"
+    "typescript": "^1.9.0-dev.20160503"
   },
   "optionalDependencies": {
     "appdmg-tf": "^0.3.11"
   },
   "config": {
     "pre-git": {
       "commit-msg": "conventional"
-    }
+    },
+    "pre-commit": [
+      "npm run whitespace"
+    ]
   },
   "devDependencies": {
     "ava-tf": "^0.12.4-beta.6",
@@ -102,7 +106,8 @@
     "ts-babel": "^0.8.6",
     "tsconfig-glob": "^0.4.3",
     "tslint": "next",
-    "typescript": "^1.9.0-dev.20160414"
+    "typescript": "^1.9.0-dev.20160414",
+    "whitespace": "^2.0.0"
   },
   "babel": {
     "plugins": [
@@ -118,5 +123,8 @@
       "test/out/*"
     ]
   },
-  "typings": "./out/electron-builder.d.ts"
+  "typings": "./out/electron-builder.d.ts",
+  "publishConfig": {
+    "tag": "next"
+  }
 }
diff --git a/src/build-cli.ts b/src/build-cli.ts
@@ -38,7 +38,7 @@ if (args.help) {
 }
 else {
   if (args.appDir) {
-    warn(`-appDir CLI parameter is deprecated, please configure build.directories.app instead 
+    warn(`-appDir CLI parameter is deprecated, please configure build.directories.app instead
 See https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-app`)
   }
 
diff --git a/src/errorMessages.ts b/src/errorMessages.ts
@@ -1,5 +1,5 @@
 export const buildIsMissed = `Please specify 'build' configuration in the development package.json ('%s'), at least
-      
+
   build: {
     "app-bundle-id": "your.id",
     "app-category-type": "your.app.category.type",
@@ -14,11 +14,11 @@ export const authorEmailIsMissed = `Please specify author 'email' in the applica
 
 See https://docs.npmjs.com/files/package.json#people-fields-author-contributors
 
-It is required to set Linux .deb package maintainer. Or you can set maintainer in the custom linux options. 
+It is required to set Linux .deb package maintainer. Or you can set maintainer in the custom linux options.
 (see https://github.com/electron-userland/electron-builder#distributable-format-configuration).
 `
 
-export const buildInAppSpecified = `'build' in the application package.json ('%s') is not supported since 3.0 anymore 
+export const buildInAppSpecified = `'build' in the application package.json ('%s') is not supported since 3.0 anymore
 
 Please move 'build' into the development package.json ('%s')
 `
diff --git a/src/fpmDownload.ts b/src/fpmDownload.ts
@@ -0,0 +1,59 @@
+import { statOrNull, spawn, debug } from "./util"
+import { emptyDir, move, remove } from "fs-extra-p"
+import { download } from "./httpRequest"
+import { path7za } from "7zip-bin"
+import * as path from "path"
+import { tmpdir } from "os"
+import { Promise as BluebirdPromise } from "bluebird"
+
+//noinspection JSUnusedLocalSymbols
+const __awaiter = require("./awaiter")
+
+let tmpDirCounter = 0
+
+function getTempName(prefix?: string | n): string {
+  return `${prefix == null ? "" : prefix + "-"}${process.pid}-${tmpDirCounter++}-${Date.now()}`
+}
+
+const versionToPromise = new Map<string, BluebirdPromise<string>>()
+
+// can be called in parallel, all calls for the same version will get the same promise - will be downloaded only once
+export function downloadFpm(version: string): Promise<string> {
+  let promise = versionToPromise.get(version)
+  // if rejected, we will try to download again
+  if (<any>promise != null && !promise!.isRejected()) {
+    return promise!
+  }
+
+  promise = <BluebirdPromise<string>>doDownloadFpm(version)
+  versionToPromise.set(version, promise)
+  return promise
+}
+
+async function doDownloadFpm(version: string): Promise<string> {
+  const dirName = `fpm-${version}-osx`
+  const url = `https://github.com/develar/fpm-self-contained/releases/download/v${version}/${dirName}.7z`
+  const cache = path.join(__dirname, "..",  "node_modules", ".fpm")
+  const fpmDir = path.join(cache, dirName)
+
+  const stat = await statOrNull(fpmDir)
+  if (stat != null && stat.isDirectory()) {
+    return path.join(fpmDir, "fpm")
+  }
+
+  // the only version currently supported (i.e. all clients are consumed the same version
+  await emptyDir(cache)
+
+  const archiveName = path.join(tmpdir(), getTempName("fpm-download") + ".7z")
+  await download(url, archiveName)
+  const tempUnpackDir = path.join(cache, getTempName())
+  await spawn(path7za, ["x", archiveName, "-o" + tempUnpackDir, "-bb" + (debug.enabled ? "3" : "0"), "-bd"], {
+    cwd: cache,
+    stdio: ["ignore", "inherit", "inherit"],
+  })
+
+  await move(path.join(tempUnpackDir, dirName), fpmDir, {clobber: true})
+  await BluebirdPromise.all([remove(tempUnpackDir), remove(archiveName)])
+
+  return path.join(fpmDir, "fpm")
+}
diff --git a/src/gitHubRequest.ts b/src/gitHubRequest.ts
@@ -38,7 +38,7 @@ export function doGitHubRequest<T>(options: RequestOptions, token: string | null
         if (response.statusCode === 404) {
           // error is clear, we don't need to read detailed error description
           reject(new HttpError(response, `method: ${options.method} url: https://${options.hostname}${options.path}
-          
+
 Please double check that your GitHub Token is correct. Due to security reasons GitHub doesn't report actual status, but 404.
 `))
         }
diff --git a/src/httpRequest.ts b/src/httpRequest.ts
@@ -29,7 +29,7 @@ function doDownload(url: string, destination: string, redirectCount: number, cal
     hostname: parsedUrl.hostname,
     path: parsedUrl.path,
     headers: {
-      "User-Agent": "electron-complete-builder"
+      "User-Agent": "electron-builder"
     }
   }, (response: IncomingMessage) => {
     if (response.statusCode >= 400) {
diff --git a/src/linuxPackager.ts b/src/linuxPackager.ts
@@ -5,6 +5,7 @@ import { Platform, LinuxBuildOptions } from "./metadata"
 import { dir as _tpmDir, TmpOptions } from "tmp"
 import { exec, log, use } from "./util"
 import { outputFile, readFile, readdir } from "fs-extra-p"
+import { downloadFpm } from "./fpmDownload"
 const template = require("lodash.template")
 
 //noinspection JSUnusedLocalSymbols
@@ -18,6 +19,8 @@ export class LinuxPackager extends PlatformPackager<LinuxBuildOptions> {
   private readonly packageFiles: Promise<Array<string>>
   private readonly scriptFiles: Promise<Array<string>>
 
+  private readonly fpmPath: Promise<string>
+
   constructor(info: BuildInfo) {
     super(info)
 
@@ -33,6 +36,13 @@ export class LinuxPackager extends PlatformPackager<LinuxBuildOptions> {
       })
       this.packageFiles = this.computePackageFiles(tempDir)
       this.scriptFiles = this.createScripts(tempDir)
+
+      if (process.platform === "darwin" && process.env.USE_SYSTEM_FPM !== "true") {
+        this.fpmPath = downloadFpm("1.5.0-1")
+      }
+      else {
+        this.fpmPath = BluebirdPromise.resolve("fpm")
+      }
     }
   }
 
@@ -201,7 +211,7 @@ Icon=${this.metadata.name}
 
     args.push(`${appOutDir}/=/opt/${this.appName}`)
     args.push(...<any>(await this.packageFiles)!)
-    await exec("fpm", args)
+    await exec(await this.fpmPath, args)
     return destination
   }
 }
diff --git a/test/install-linux-dependencies.sh b/test/install-linux-dependencies.sh
@@ -1,3 +1,5 @@
+gem install --no-rdoc --no-ri fpm
+
 wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
 
 sudo dpkg --add-architecture i386
diff --git a/test/src/helpers/avaEx.ts b/test/src/helpers/avaEx.ts
@@ -5,6 +5,7 @@ declare module "ava-tf" {
     export const ifNotWindows: typeof test;
     export const ifOsx: typeof test;
     export const ifNotCi: typeof test;
+    export const ifNotCiOsx: typeof test;
     export const ifNotTravis: typeof test;
   }
   
@@ -24,6 +25,11 @@ Object.defineProperties(test, {
       return process.env.CI ? this.skip : this
     }
   },
+  "ifNotCiOsx": {
+    get: function () {
+      return process.env.CI && process.platform === "darwin" ? this.skip : this
+    }
+  },
   "ifNotTravis": {
     get: function () {
       return process.env.TRAVIS ? this.skip : this
diff --git a/test/src/linuxPackagerTest.ts b/test/src/linuxPackagerTest.ts
@@ -7,9 +7,7 @@ import { Platform } from "out"
 //noinspection JSUnusedLocalSymbols
 const __awaiter = require("out/awaiter")
 
-test.ifNotWindows("linux", async () => {
-  await assertPack("test-app-one", platform(Platform.LINUX))
-})
+test.ifNotWindows("linux", () => assertPack("test-app-one", platform(Platform.LINUX)))
 
 test.ifNotWindows("linux - icons from ICNS", async () => {
   await assertPack("test-app-one", {
diff --git a/test/src/winPackagerTest.ts b/test/src/winPackagerTest.ts
@@ -11,7 +11,7 @@ import * as assertThat from "should/as-function"
 //noinspection JSUnusedLocalSymbols
 const __awaiter = require("out/awaiter")
 
-test.ifNotTravis("win", () => assertPack("test-app-one", platform(Platform.WINDOWS),
+test.ifNotCiOsx("win", () => assertPack("test-app-one", platform(Platform.WINDOWS),
   {
     tempDirCreated: process.env.TEST_DELTA ? it => modifyPackageJson(it, data => {
       data.build.win = {
@@ -21,7 +21,7 @@ test.ifNotTravis("win", () => assertPack("test-app-one", platform(Platform.WINDO
   }
 ))
 
-test.ifNotTravis("noMsi as string", t => t.throws(assertPack("test-app-one", platform(Platform.WINDOWS),
+test.ifNotCiOsx("noMsi as string", t => t.throws(assertPack("test-app-one", platform(Platform.WINDOWS),
   {
     tempDirCreated: it => modifyPackageJson(it, data => {
       data.build.win = {
@@ -67,7 +67,7 @@ test("detect install-spinner", () => {
   })
 })
 
-test.ifNotTravis("icon < 256", (t: any) => t.throws(assertPack("test-app-one", platform(Platform.WINDOWS), {
+test.ifNotCiOsx("icon < 256", (t: any) => t.throws(assertPack("test-app-one", platform(Platform.WINDOWS), {
   tempDirCreated: projectDir => move(path.join(projectDir, "build", "incorrect.ico"), path.join(projectDir, "build", "icon.ico"), {clobber: true})
 }), /Windows icon image size must be at least 256x256/))
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -61,6 +61,7 @@
     "src/builder.ts",
     "src/codeSign.ts",
     "src/errorMessages.ts",
+    "src/fpmDownload.ts",
     "src/gitHubPublisher.ts",
     "src/gitHubRequest.ts",
     "src/httpRequest.ts",

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ if (args.help) {`
`38`	`38`	`}`
`39`	`39`	`else {`
`40`	`40`	`if (args.appDir) {`
`41`		- warn(`-appDir CLI parameter is deprecated, please configure build.directories.app instead
	`41`	+ warn(`-appDir CLI parameter is deprecated, please configure build.directories.app instead
`42`	`42`	See https://github.com/electron-userland/electron-builder/wiki/Options#MetadataDirectories-app`)
`43`	`43`	`}`
`44`	`44`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ export function doGitHubRequest<T>(options: RequestOptions, token: string \| null`
`38`	`38`	`if (response.statusCode === 404) {`
`39`	`39`	`// error is clear, we don't need to read detailed error description`
`40`	`40`	reject(new HttpError(response, `method: ${options.method} url: https://${options.hostname}${options.path}
`41`		`-`
	`41`	`+`
`42`	`42`	`Please double check that your GitHub Token is correct. Due to security reasons GitHub doesn't report actual status, but 404.`
`43`	`43`	`))
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ function doDownload(url: string, destination: string, redirectCount: number, cal`
`29`	`29`	`hostname: parsedUrl.hostname,`
`30`	`30`	`path: parsedUrl.path,`
`31`	`31`	`headers: {`
`32`		`- "User-Agent": "electron-complete-builder"`
	`32`	`+ "User-Agent": "electron-builder"`
`33`	`33`	`}`
`34`	`34`	`}, (response: IncomingMessage) => {`
`35`	`35`	`if (response.statusCode >= 400) {`