feat: Add build and deployment tools (#2943)

Author: ffflorian

README.md

@@ -67,7 +67,14 @@ export LINUX_TARGET=<target>
 yarn build:linux
 ```
 
-Replace `<target>` with your desired target (e.g. `"rpm"`). Have a look at the [documentation for `electron-builder`](https://www.electron.build/configuration/linux) for the available options. Note that we cannot offer support for uncommon targets.
+Replace `<target>` with your desired target (e.g. `rpm`). Have a look at the [documentation for `electron-builder`](https://www.electron.build/configuration/linux) for the available targets. Multiple targets can be combined by comma separation (e.g. `rpm,deb`). Note that we cannot offer support for uncommon targets.
+
+Furthermore, you can disable [asar packaging](https://electronjs.org/docs/tutorial/application-packaging) (not recommended, but e.g. needed for target `dir`) by setting `ENABLE_ASAR="false"` before building. Example:
+
+```shell
+export ENABLE_ASAR="false"
+yarn build:linux
+```
 
 ### Troubleshooting
 

bin/bin-utils.ts

@@ -0,0 +1,51 @@
+/*
+ * Wire
+ * Copyright (C) 2019 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+
+import {LogFactory, Logger} from '@wireapp/commons/dist/commonjs/LogFactory';
+import commander from 'commander';
+
+export const getLogger = (namespace: string, name: string) =>
+  LogFactory.getLogger(name, {namespace: `@wireapp/${namespace}`, forceEnable: true, separator: '/'});
+
+export function checkCommanderOptions(
+  commanderInstance: typeof commander,
+  logdownInstance: Logger,
+  options: string[],
+): void {
+  options.forEach(option => {
+    if (!commanderInstance.hasOwnProperty(option)) {
+      logdownInstance.error(`Required option "${option}" was not provided.`);
+      commanderInstance.outputHelp();
+      process.exit(1);
+    }
+  });
+}
+
+export const logEntries = <T extends Object>(config: T, name: string, callee: string): void => {
+  const logger = getLogger(callee, 'build-tools');
+
+  Object.entries(config).forEach(([key, value]) => {
+    if (Array.isArray(value)) {
+      value = value.join(',');
+    } else if (value instanceof Object) {
+      logEntries(value, `${name}.${key}`, callee);
+    } else {
+      logger.info(`${name}.${key} set to "${value}". `);
+    }
+  });
+};

bin/build-tools/build-cli.ts

@@ -0,0 +1,108 @@
+/*
+ * Wire
+ * Copyright (C) 2019 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+
+import {LogFactory} from '@wireapp/commons';
+import commander from 'commander';
+import path from 'path';
+
+import {logEntries} from '../bin-utils';
+import {buildLinuxConfig, buildLinuxWrapper} from './lib/build-linux';
+import {buildMacOSConfig, buildMacOSWrapper} from './lib/build-macos';
+import {buildWindowsConfig, buildWindowsWrapper} from './lib/build-windows';
+import {buildWindowsInstaller, buildWindowsInstallerConfig} from './lib/build-windows-installer';
+
+const toolName = path.basename(__filename).replace('.ts', '');
+const logger = LogFactory.getLogger(toolName, {namespace: '@wireapp/build-tools', forceEnable: true});
+const appSource = path.join(__dirname, '../../');
+
+commander
+  .name(toolName)
+  .description(
+    'Build the Wire wrapper for your platform.\n\nValid values for platform are: "windows", "windows-installer", "macos", "linux".',
+  )
+  .option('-e, --env-file <path>', 'Specify the env file path', path.join(appSource, '.env.defaults'))
+  .option('-m, --manual-sign', `Manually sign and package the app (i.e. don't use electron-packager, macOS only)`)
+  .option('-p, --package-json <path>', 'Specify the package.json path', path.join(appSource, 'package.json'))
+  .option('-w, --wire-json <path>', 'Specify the wire.json path', path.join(appSource, 'electron/wire.json'))
+  .arguments('<platform>')
+  .parse(process.argv);
+
+const platform = (commander.args[0] || '').toLowerCase();
+
+new Promise(() => {
+  switch (platform) {
+    case 'win':
+    case 'windows': {
+      const {packagerConfig} = buildWindowsConfig(commander.wireJson, commander.envFile);
+
+      logEntries(packagerConfig, 'packagerConfig', toolName);
+
+      return buildWindowsWrapper(packagerConfig, commander.packageJson, commander.wireJson, commander.envFile);
+    }
+
+    case 'windows-installer': {
+      const {wInstallerOptions} = buildWindowsInstallerConfig(commander.wireJson, commander.envFile);
+
+      logEntries(wInstallerOptions, 'wInstallerOptions', toolName);
+
+      return buildWindowsInstaller(commander.wireJson, commander.envFile, wInstallerOptions);
+    }
+
+    case 'mac':
+    case 'macos': {
+      const {macOSConfig, packagerConfig} = buildMacOSConfig(
+        commander.wireJson,
+        commander.envFile,
+        commander.manualSign,
+      );
+
+      logEntries(packagerConfig, 'builderConfig', toolName);
+
+      return buildMacOSWrapper(
+        packagerConfig,
+        macOSConfig,
+        commander.packageJson,
+        commander.wireJson,
+        commander.manualSign,
+      );
+    }
+
+    case 'linux': {
+      const {linuxConfig, builderConfig} = buildLinuxConfig(commander.wireJson, commander.envFile);
+
+      logEntries(builderConfig, 'builderConfig', toolName);
+
+      return buildLinuxWrapper(
+        builderConfig,
+        linuxConfig,
+        commander.packageJson,
+        commander.wireJson,
+        commander.envFile,
+      );
+    }
+
+    default: {
+      logger.error(`Invalid or no platform specified.`);
+      return commander.help();
+    }
+  }
+}).catch(error => {
+  logger.error(error);
+  process.exit(1);
+});

bin/build-tools/lib/Config.ts

@@ -0,0 +1,66 @@
+/*
+ * Wire
+ * Copyright (C) 2019 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+
+export interface CommonConfig {
+  adminUrl: string;
+  appBase: string;
+  buildDir: string;
+  buildNumber: string;
+  copyright: string;
+  customProtocolName: string;
+  description: string;
+  distDir: string;
+  electronDirectory: string;
+  enableAsar: boolean;
+  environment: 'internal' | 'production';
+  legalUrl: string;
+  licensesUrl: string;
+  maximumAccounts: string;
+  name: string;
+  nameShort: string;
+  privacyUrl: string;
+  raygunApiKey: string;
+  supportUrl: string;
+  updateUrl?: string;
+  version: string;
+  websiteUrl: string;
+}
+
+export interface LinuxConfig {
+  artifactName: string;
+  categories: string;
+  executableName: string;
+  keywords: string;
+  targets: string[];
+}
+
+export interface MacOSConfig {
+  bundleId: string;
+  category: string;
+  certNameApplication: string | null;
+  certNameInstaller: string | null;
+  notarizeAppleId: string | null;
+  notarizeApplePassword: string | null;
+}
+
+export interface WindowsConfig {
+  installerIconUrl: string;
+  loadingGif: string;
+  updateUrl: string;
+}

bin/build-tools/lib/build-linux.test.ts

@@ -0,0 +1,54 @@
+/*
+ * Wire
+ * Copyright (C) 2019 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ */
+
+import * as assert from 'assert';
+import * as path from 'path';
+import uuid from 'uuid/v4';
+
+import {buildLinuxConfig} from './build-linux';
+
+const wireJsonPath = path.join(__dirname, '../../../electron/wire.json');
+const envFilePath = path.join(__dirname, '../../../.env.defaults');
+
+describe('build-linux', () => {
+  describe('buildLinuxConfig', () => {
+    it('honors environment variables', () => {
+      const categories = uuid();
+      const keywords = uuid();
+      const nameShort = uuid();
+      const targets = [uuid(), uuid()];
+
+      process.env.LINUX_CATEGORIES = categories;
+      process.env.LINUX_KEYWORDS = keywords;
+      process.env.LINUX_NAME_SHORT = nameShort;
+      process.env.LINUX_TARGET = targets.join(',');
+
+      const {linuxConfig} = buildLinuxConfig(wireJsonPath, envFilePath);
+
+      assert.strictEqual(linuxConfig.categories, categories);
+      assert.strictEqual(linuxConfig.executableName, nameShort);
+      assert.strictEqual(linuxConfig.keywords, keywords);
+      assert.deepStrictEqual(linuxConfig.targets, targets);
+
+      delete process.env.LINUX_CATEGORIES;
+      delete process.env.LINUX_NAME_SHORT;
+      delete process.env.LINUX_KEYWORDS;
+      delete process.env.LINUX_TARGET;
+    });
+  });
+});