electron-installer-snap/src/snapcraft.js

Build snapcraft packages for Electron applications

'use strict'
/*
Copyright 2017, 2019 Mark Lee and contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

const debug = require('debug')('electron-installer-snap:snapcraft')
const { spawn } = require('@malept/cross-spawn-promise')
const which = require('which')

class Snapcraft {
  async ensureInstalled (snapcraftPath) {
    const cmd = snapcraftPath || 'snapcraft'
    try {
      this.snapcraftPath = await which(cmd)
      return true
    } catch (err) {
      throw new Error(
        `Cannot locate ${cmd} in your system. Either install snapcraft, or specify the ` +
        `absolute path to snapcraft in the options. Details:\n${err}`
      )
    }
  }

  /**
   * Converts Node-style archs to Snap-compatible archs.
   */
  translateArch (arch) {
    switch (arch) {
      case 'ia32': return 'i386'
      case 'x64': return 'amd64'
      case 'armv7l':
      case 'arm':
        return 'armhf'
      // arm64 => arm64
      default: return arch
    }
  }

  /**
   * Generate arguments to pass to snapcraft.
   */
  generateArgs (command, options, extraArgs) {
    const args = [command]
    for (const flag in options) {
      const value = options[flag]
      if (flag !== 'target-arch') {
        if (value) {
          args.push(`--${flag}=${value}`)
        } else {
          args.push(`--${flag}`)
        }
      }
    }
    /* istanbul ignore if */
    if (debug.enabled) {
      args.push('--destructive-mode')
      args.push('--debug')
    }

    if (extraArgs) {
      Array.prototype.push.apply(args, extraArgs)
    }

    return args
  }

  generateSpawnOptions (packageDir) {
    const spawnOptions = {
      cwd: packageDir,
      env: {
        LC_ALL: 'C.UTF-8',
        LOCALE: 'C.UTF-8',
        PATH: process.env.PATH
      },
      stdio: ['ignore', 'ignore', process.stderr]
    }
    /* istanbul ignore if */
    if (debug.enabled) {
      spawnOptions.stdio = 'inherit'
    }

    return spawnOptions
  }

  async run (packageDir, command, options) {
    const args = this.generateArgs(command, options)
    debug(`Running '${this.snapcraftPath} ${args.join(' ')}' in ${packageDir}`)
    try {
      return spawn(this.snapcraftPath, args, this.generateSpawnOptions(packageDir))
    } catch (error) /* istanbul ignore next */ {
      console.error(`Snapcraft failed (${error.exitStatus})`)
      if (!debug.enabled) {
        console.error('Re-run with the environment variable DEBUG=electron-installer-snap:snapcraft for details.')
      }
      throw error
    }
  }
}

module.exports = Snapcraft