Merge pull request #1144 from balena-io/config-txt-fix

Create empty config.txt in case there isn't one present

src/config/backend.ts

@@ -1,12 +1,8 @@
-import * as Promise from 'bluebird';
-import * as childProcessSync from 'child_process';
 import * as _ from 'lodash';
-import { fs } from 'mz';
+import { child_process, fs } from 'mz';
 
 import * as constants from '../lib/constants';
-import * as fsUtils from '../lib/fs-utils';
-
-const childProcess: any = Promise.promisifyAll(childProcessSync);
+import { writeFileAtomic } from '../lib/fs-utils';
 
 import log from '../lib/supervisor-console';
 
@@ -25,18 +21,15 @@ interface ExtlinuxFile {
 
 const bootMountPoint = `${constants.rootMountPoint}${constants.bootMountPoint}`;
 
-function remountAndWriteAtomic(file: string, data: string): Promise<void> {
-	// TODO: Find out why the below Promise.resolve() is required
+async function remountAndWriteAtomic(
+	file: string,
+	data: string,
+): Promise<void> {
 	// Here's the dangerous part:
-	return Promise.resolve(
-		childProcess.execAsync(
+	await child_process.exec(
 		`mount -t vfat -o remount,rw ${constants.bootBlockDevice} ${bootMountPoint}`,
-		),
-	)
-		.then(() => {
-			return fsUtils.writeFileAtomic(file, data);
-		})
-		.return();
+	);
+	await writeFileAtomic(file, data);
 }
 
 export abstract class DeviceConfigBackend {
@@ -106,12 +99,20 @@ export class RPiConfigBackend extends DeviceConfigBackend {
 		return _.startsWith(deviceType, 'raspberry') || deviceType === 'fincm3';
 	}
 
-	public getBootConfig(): Promise<ConfigOptions> {
-		return Promise.resolve(
-			fs.readFile(RPiConfigBackend.bootConfigPath, 'utf-8'),
-		).then(confStr => {
+	public async getBootConfig(): Promise<ConfigOptions> {
+		let configContents = '';
+
+		if (await fs.exists(RPiConfigBackend.bootConfigPath)) {
+			configContents = await fs.readFile(
+				RPiConfigBackend.bootConfigPath,
+				'utf-8',
+			);
+		} else {
+			await fs.writeFile(RPiConfigBackend.bootConfigPath, '');
+		}
+
 		const conf: ConfigOptions = {};
-			const configStatements = confStr.split(/\r?\n/);
+		const configStatements = configContents.split(/\r?\n/);
 
 		for (const configStr of configStatements) {
 			// Don't show warnings for comments and empty lines
@@ -150,10 +151,9 @@ export class RPiConfigBackend extends DeviceConfigBackend {
 		}
 
 		return conf;
-		});
 	}
 
-	public setBootConfig(opts: ConfigOptions): Promise<void> {
+	public async setBootConfig(opts: ConfigOptions): Promise<void> {
 		let confStatements: string[] = [];
 
 		_.each(opts, (value, key) => {
@@ -170,7 +170,7 @@ export class RPiConfigBackend extends DeviceConfigBackend {
 
 		const confStr = `${confStatements.join('\n')}\n`;
 
-		return remountAndWriteAtomic(RPiConfigBackend.bootConfigPath, confStr);
+		await remountAndWriteAtomic(RPiConfigBackend.bootConfigPath, confStr);
 	}
 
 	public isSupportedConfig(configName: string): boolean {
@@ -215,11 +215,25 @@ export class ExtlinuxConfigBackend extends DeviceConfigBackend {
 		return _.startsWith(deviceType, 'jetson-tx');
 	}
 
-	public getBootConfig(): Promise<ConfigOptions> {
-		return Promise.resolve(
-			fs.readFile(ExtlinuxConfigBackend.bootConfigPath, 'utf-8'),
-		).then(confStr => {
-			const parsedBootFile = ExtlinuxConfigBackend.parseExtlinuxFile(confStr);
+	public async getBootConfig(): Promise<ConfigOptions> {
+		let confContents: string;
+
+		try {
+			confContents = await fs.readFile(
+				ExtlinuxConfigBackend.bootConfigPath,
+				'utf-8',
+			);
+		} catch {
+			// In the rare case where the user might have deleted extlinux conf file between linux boot and supervisor boot
+			// We do not have any backup to fallback too; warn the user of a possible brick
+			throw new Error(
+				'Could not find extlinux file. Device is possibly bricked',
+			);
+		}
+
+		const parsedBootFile = ExtlinuxConfigBackend.parseExtlinuxFile(
+			confContents,
+		);
 
 		// First find the default label name
 		const defaultLabel = _.find(parsedBootFile.globals, (_v, l) => {
@@ -265,16 +279,27 @@ export class ExtlinuxConfigBackend extends DeviceConfigBackend {
 		}
 
 		return conf;
-		});
 	}
 
-	public setBootConfig(opts: ConfigOptions): Promise<void> {
+	public async setBootConfig(opts: ConfigOptions): Promise<void> {
 		// First get a representation of the configuration file, with all balena-supported configuration removed
-		return Promise.resolve(
-			fs.readFile(ExtlinuxConfigBackend.bootConfigPath),
-		).then(data => {
+		let confContents: string;
+
+		try {
+			confContents = await fs.readFile(
+				ExtlinuxConfigBackend.bootConfigPath,
+				'utf-8',
+			);
+		} catch {
+			// In the rare case where the user might have deleted extlinux conf file between linux boot and supervisor boot
+			// We do not have any backup to fallback too; warn the user of a possible brick
+			throw new Error(
+				'Could not find extlinux file. Device is possibly bricked',
+			);
+		}
+
 		const extlinuxFile = ExtlinuxConfigBackend.parseExtlinuxFile(
-				data.toString(),
+			confContents.toString(),
 		);
 		const defaultLabel = extlinuxFile.globals.DEFAULT;
 		if (defaultLabel == null) {
@@ -311,11 +336,10 @@ export class ExtlinuxConfigBackend extends DeviceConfigBackend {
 			extlinuxFile,
 		);
 
-			return remountAndWriteAtomic(
+		await remountAndWriteAtomic(
 			ExtlinuxConfigBackend.bootConfigPath,
 			extlinuxString,
 		);
-		});
 	}
 
 	public isSupportedConfig(configName: string): boolean {

test/13-device-config.spec.coffee

@@ -13,7 +13,7 @@ fsUtils = require '../src/lib/fs-utils'
 extlinuxBackend = new ExtlinuxConfigBackend()
 rpiConfigBackend = new RPiConfigBackend()
 
-childProcess = require 'child_process'
+{ child_process } = require 'mz'
 
 describe 'DeviceConfig', ->
 	before ->
@@ -111,7 +111,7 @@ describe 'DeviceConfig', ->
 
 	it 'writes the target config.txt', ->
 		stub(fsUtils, 'writeFileAtomic').resolves()
-		stub(childProcess, 'execAsync').resolves()
+		stub(child_process, 'exec').resolves()
 		current = {
 			HOST_CONFIG_initramfs: 'initramf.gz 0x00800000'
 			HOST_CONFIG_dtparam: '"i2c=on","audio=on"'
@@ -131,7 +131,7 @@ describe 'DeviceConfig', ->
 		promise.then =>
 			@deviceConfig.setBootConfig(rpiConfigBackend, target)
 			.then =>
-				expect(childProcess.execAsync).to.be.calledOnce
+				expect(child_process.exec).to.be.calledOnce
 				expect(@fakeLogger.logSystemMessage).to.be.calledTwice
 				expect(@fakeLogger.logSystemMessage.getCall(1).args[2]).to.equal('Apply boot config success')
 				expect(fsUtils.writeFileAtomic).to.be.calledWith('./test/data/mnt/boot/config.txt', '\
@@ -143,7 +143,7 @@ describe 'DeviceConfig', ->
 					foobaz=bar\n\
 				')
 				fsUtils.writeFileAtomic.restore()
-				childProcess.execAsync.restore()
+				child_process.exec.restore()
 				@fakeLogger.logSystemMessage.resetHistory()
 
 	it 'accepts RESIN_ and BALENA_ variables', ->
@@ -186,7 +186,7 @@ describe 'DeviceConfig', ->
 
 		it 'should correctly write to extlinux.conf files', ->
 			stub(fsUtils, 'writeFileAtomic').resolves()
-			stub(childProcess, 'execAsync').resolves()
+			stub(child_process, 'exec').resolves()
 
 			current = {
 			}
@@ -200,7 +200,7 @@ describe 'DeviceConfig', ->
 			promise.then =>
 				@deviceConfig.setBootConfig(extlinuxBackend, target)
 				.then =>
-					expect(childProcess.execAsync).to.be.calledOnce
+					expect(child_process.exec).to.be.calledOnce
 					expect(@fakeLogger.logSystemMessage).to.be.calledTwice
 					expect(@fakeLogger.logSystemMessage.getCall(1).args[2]).to.equal('Apply boot config success')
 					expect(fsUtils.writeFileAtomic).to.be.calledWith('./test/data/mnt/boot/extlinux/extlinux.conf', '\
@@ -213,7 +213,7 @@ describe 'DeviceConfig', ->
 									APPEND ${cbootargs} ${resin_kernel_root} ro rootwait isolcpus=2\n\
 					')
 					fsUtils.writeFileAtomic.restore()
-					childProcess.execAsync.restore()
+					child_process.exec.restore()
 					@fakeLogger.logSystemMessage.resetHistory()
 
 	describe 'Balena fin', ->

test/23-local-mode.ts

@@ -12,6 +12,7 @@ import LocalModeManager, {
 	EngineSnapshotRecord,
 } from '../src/local-mode';
 import Logger from '../src/logger';
+import ShortStackError from './lib/errors';
 
 describe('LocalModeManager', () => {
 	let dbFile: tmp.FileResult;
@@ -188,7 +189,7 @@ describe('LocalModeManager', () => {
 				) => {
 					const res = sinon.createStubInstance(c);
 					if (removeThrows) {
-						res.remove.rejects(`test error removing ${type}`);
+						res.remove.rejects(new ShortStackError(`error removing ${type}`));
 					} else {
 						res.remove.resolves();
 					}

test/lib/errors.ts

@@ -0,0 +1,8 @@
+import TypedError = require('typed-error');
+
+export default class ShortStackError extends TypedError {
+	constructor(err: Error | string = '') {
+		Error.stackTraceLimit = 1;
+		super(err);
+	}
+}