etcher/lib/cli/etcher.js

/*
 * Copyright 2016 resin.io
 *
 * 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.
 */

'use strict'

const _ = require('lodash')
const Bluebird = require('bluebird')
const visuals = require('resin-cli-visuals')
const form = require('resin-cli-form')
const bytes = require('pretty-bytes')
const ImageWriter = require('../sdk/writer')
const utils = require('./utils')
const options = require('./options')
const messages = require('../shared/messages')
const EXIT_CODES = require('../shared/exit-codes')
const errors = require('../shared/errors')
const permissions = require('../shared/permissions')

/* eslint-disable no-magic-numbers */

const ARGV_IMAGE_PATH_INDEX = 0
const imagePath = options._[ARGV_IMAGE_PATH_INDEX]

permissions.isElevated().then((elevated) => {
  if (!elevated) {
    throw errors.createUserError({
      title: messages.error.elevationRequired(),
      description: 'This tool requires special permissions to write to external drives'
    })
  }

  return form.run([
    {
      message: 'Select drive',
      type: 'drive',
      name: 'drive'
    },
    {
      message: 'This will erase the selected drive. Are you sure?',
      type: 'confirm',
      name: 'yes',
      default: false
    }
  ], {
    override: {
      drive: options.drive,

      // If `options.yes` is `false`, pass `null`,
      // otherwise the question will not be asked because
      // `false` is a defined value.
      yes: options.yes || null
    }
  })
}).then((answers) => {
  if (!answers.yes) {
    throw errors.createUserError({
      title: 'Aborted',
      description: 'We can\'t proceed without confirmation'
    })
  }

  const progressBars = {
    write: new visuals.Progress('Flashing'),
    check: new visuals.Progress('Validating')
  }

  return new Bluebird((resolve, reject) => {
    /**
     * @summary Progress update handler
     * @param {Object} state - progress state
     * @private
     * @example
     * writer.on('progress', onProgress)
     */
    const onProgress = (state) => {
      state.message = state.active > 1
        ? `${bytes(state.totalSpeed)}/s total, ${bytes(state.speed)}/s x ${state.active}`
        : `${bytes(state.totalSpeed)}/s`

      state.message = `${state.type === 'write' ? 'Flashing' : 'Validating'}: ${state.message}`

      // Update progress bar
      progressBars[state.type].update(state)
    }

    const writer = new ImageWriter({
      verify: options.check,
      unmountOnSuccess: options.unmount,
      checksumAlgorithms: options.check ? [ 'xxhash' ] : []
    })

    /**
     * @summary Finish handler
     * @private
     * @example
     * writer.on('finish', onFinish)
     */
    const onFinish = function () {
      resolve(Array.from(writer.destinations.values()))
    }

    writer.on('progress', onProgress)
    writer.on('error', reject)
    writer.on('finish', onFinish)

    // NOTE: Drive can be (String|Array)
    const destinations = [].concat(answers.drive)

    writer.write(imagePath, destinations)
  })
}).then((results) => {
  let exitCode = EXIT_CODES.SUCCESS

  if (options.check) {
    console.log('')
    console.log('Checksums:')

    _.forEach(results, (result) => {
      if (result.error) {
        exitCode = EXIT_CODES.GENERAL_ERROR
        console.log(`  - ${result.device.device}: ${result.error.message}`)
      } else {
        console.log(`  - ${result.device.device}: ${result.checksum.xxhash}`)
      }
    })
  }

  process.exit(exitCode)
}).catch((error) => {
  return Bluebird.try(() => {
    utils.printError(error)
    return Bluebird.resolve()
  }).then(() => {
    if (error.code === 'EVALIDATION') {
      process.exit(EXIT_CODES.VALIDATION_ERROR)
    }

    process.exit(EXIT_CODES.GENERAL_ERROR)
  })
})