Add tests for dtoverlay management in config.txt

test/integration/config/config-txt.spec.ts

@@ -4,6 +4,7 @@ import { stripIndent } from 'common-tags';
 import { expect } from 'chai';
 import * as hostUtils from '~/lib/host-utils';
 
+import { promises as fs } from 'fs';
 import { ConfigTxt } from '~/src/config/backends/config-txt';
 
 describe('config/config-txt', () => {
@@ -18,7 +19,8 @@ describe('config/config-txt', () => {
 					avoid_warnings=1
 					gpu_mem=16
 					hdmi_force_hotplug:1=1
-					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13`,
+					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
+					dtparam=gpio_out_pin=17`,
 		}).enable();
 
 		const configTxt = new ConfigTxt();
@@ -26,18 +28,147 @@ describe('config/config-txt', () => {
 		// Will try to parse /test/data/mnt/boot/config.txt
 		await expect(configTxt.getBootConfig()).to.eventually.deep.equal({
 			dtparam: ['i2c=on', 'audio=on'],
-			dtoverlay: ['ads7846', 'lirc-rpi,gpio_out_pin=17,gpio_in_pin=13'],
+			dtoverlay: [
+				'ads7846',
+				'lirc-rpi,gpio_out_pin=17,gpio_in_pin=13,gpio_out_pin=17',
+			],
 			enable_uart: '1',
 			avoid_warnings: '1',
 			gpu_mem: '16',
 			initramfs: 'initramf.gz 0x00800000',
-			// This syntax is supported by the backend but not the cloud side
 			'hdmi_force_hotplug:1': '1',
 		});
 
 		await tfs.restore();
 	});
 
+	it('correctly parses a config.txt file with an empty overlay', async () => {
+		const tfs = await testfs({
+			[hostUtils.pathOnBoot('config.txt')]: stripIndent`
+	        initramfs initramf.gz 0x00800000
+					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
+					dtparam=gpio_out_pin=17
+					enable_uart=1
+					avoid_warnings=1
+					dtoverlay=
+					dtparam=i2c=on
+					dtparam=audio=on
+					dtoverlay=ads7846
+					gpu_mem=16
+					hdmi_force_hotplug:1=1
+					`,
+		}).enable();
+
+		const configTxt = new ConfigTxt();
+
+		// Will try to parse /test/data/mnt/boot/config.txt
+		await expect(configTxt.getBootConfig()).to.eventually.deep.equal({
+			dtparam: ['i2c=on', 'audio=on'],
+			dtoverlay: [
+				'lirc-rpi,gpio_out_pin=17,gpio_in_pin=13,gpio_out_pin=17',
+				'ads7846',
+			],
+			enable_uart: '1',
+			avoid_warnings: '1',
+			gpu_mem: '16',
+			initramfs: 'initramf.gz 0x00800000',
+			'hdmi_force_hotplug:1': '1',
+		});
+
+		await tfs.restore();
+	});
+
+	it('maintains ordering of dtoverlays and dtparams', async () => {
+		const tfs = await testfs({
+			[hostUtils.pathOnBoot('config.txt')]: stripIndent`
+	        initramfs initramf.gz 0x00800000
+					dtparam=i2c=on
+					dtparam=audio=on
+					dtoverlay=ads7846
+					enable_uart=1
+					avoid_warnings=1
+					gpu_mem=16
+					hdmi_force_hotplug:1=1
+					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
+					dtoverlay=ads1015,addr=0x48,cha_enable=true
+					dtparam=chb_enable=true
+					dtparam=chc_enable=true
+			`,
+		}).enable();
+
+		const configTxt = new ConfigTxt();
+
+		// Will try to parse /test/data/mnt/boot/config.txt
+		await expect(configTxt.getBootConfig()).to.eventually.deep.equal({
+			dtparam: ['i2c=on', 'audio=on'],
+			dtoverlay: [
+				'ads7846',
+				'lirc-rpi,gpio_out_pin=17,gpio_in_pin=13',
+				'ads1015,addr=0x48,cha_enable=true,chb_enable=true,chc_enable=true',
+			],
+			enable_uart: '1',
+			avoid_warnings: '1',
+			gpu_mem: '16',
+			initramfs: 'initramf.gz 0x00800000',
+			'hdmi_force_hotplug:1': '1',
+		});
+
+		await tfs.restore();
+	});
+
+	it('splits dtoverlays into params to stay under the 80 char limit', async () => {
+		const tfs = await testfs({
+			[hostUtils.pathOnBoot('config.txt')]: stripIndent`
+	        enable_uart=1
+					dtparam=i2c_arm=on
+					dtparam=spi=on
+					disable_splash=1
+					dtparam=audio=on
+					gpu_mem=16
+					`,
+		}).enable();
+
+		const configTxt = new ConfigTxt();
+
+		await configTxt.setBootConfig({
+			dtparam: ['i2c=on', 'audio=on'],
+			dtoverlay: [
+				'ads7846',
+				'lirc-rpi,gpio_out_pin=17,gpio_in_pin=13',
+				'ads1015,addr=0x48,cha_enable=true,chb_enable=true',
+			],
+			enable_uart: '1',
+			avoid_warnings: '1',
+			gpu_mem: '256',
+			initramfs: 'initramf.gz 0x00800000',
+			'hdmi_force_hotplug:1': '1',
+		});
+
+		// Confirm that the file was written correctly
+		await expect(
+			fs.readFile(hostUtils.pathOnBoot('config.txt'), 'utf8'),
+		).to.eventually.equal(
+			stripIndent`
+					dtparam=i2c=on
+					dtparam=audio=on
+					enable_uart=1
+					avoid_warnings=1
+					gpu_mem=256
+					initramfs initramf.gz 0x00800000
+					hdmi_force_hotplug:1=1
+					dtoverlay=ads7846
+					dtoverlay=lirc-rpi
+					dtparam=gpio_out_pin=17
+					dtparam=gpio_in_pin=13
+					dtoverlay=ads1015
+					dtparam=addr=0x48
+					dtparam=cha_enable=true
+					dtparam=chb_enable=true
+				` + '\n',
+		);
+		await tfs.restore();
+	});
+
 	it('ensures required fields are written to config.txt', async () => {
 		const tfs = await testfs({
 			[hostUtils.pathOnBoot('config.txt')]: stripIndent`

test/integration/device-config.spec.ts

@@ -260,10 +260,12 @@ describe('device-config', () => {
 					initramfs initramf.gz 0x00800000
 					dtparam=i2c=on
 					dtparam=audio=off
-					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
-					dtoverlay=balena-fin
 					foobar=bat
 					foobaz=bar
+					dtoverlay=lirc-rpi
+					dtparam=gpio_out_pin=17
+					dtparam=gpio_in_pin=13
+					dtoverlay=balena-fin
 				` + '\n', // add newline because stripIndent trims last newline
 			);
 		});
@@ -301,10 +303,12 @@ describe('device-config', () => {
 					initramfs initramf.gz 0x00800000
 					dtparam=i2c=on
 					dtparam=audio=off
-					dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
-					dtoverlay=balena-fin
 					foobar=bat
 					foobaz=bar
+					dtoverlay=lirc-rpi
+					dtparam=gpio_out_pin=17
+					dtparam=gpio_in_pin=13
+					dtoverlay=balena-fin
 				` + '\n', // add newline because stripIndent trims last newline
 			);
 		});