Merge pull request #2432 from balena-os/host-os-release-feature-label

Support io.balena.features.host-os.board-rev feature label

Author: flowzone-app[bot]

src/compose/utils.ts

@@ -19,8 +19,8 @@ import type {
 } from './types';
 
 import log from '../lib/supervisor-console';
-
 import * as apiKeys from '../lib/api-keys';
+import { getOSBoardRev } from '../lib/os-release';
 
 export function camelCaseConfig(
 	literalConfig: ConfigMap,
@@ -404,6 +404,12 @@ export async function addFeaturesFromLabels(
 				Capabilities: [['gpu']],
 				Options: {},
 			} as Dockerode.DeviceRequest),
+		'io.balena.features.host-os.board-rev': async () => {
+			const osBoardRev = await getOSBoardRev(constants.hostOSVersionPath);
+			if (osBoardRev) {
+				setEnvVariables('HOST_OS_BOARD_REV', osBoardRev);
+			}
+		},
 	};
 
 	for (const feature of Object.keys(features) as [keyof typeof features]) {

src/lib/os-release.ts

@@ -1,12 +1,12 @@
-import _ from 'lodash';
+import memoizee from 'memoizee';
 import { promises as fs } from 'fs';
 
 import { InternalInconsistencyError } from './errors';
 import { exec } from './fs-utils';
 import log from './supervisor-console';
 
 // Retrieve the data for the OS once only per path
-const getOSReleaseData = _.memoize(
+const getOSReleaseData = memoizee(
 	async (path: string): Promise<Dictionary<string>> => {
 		const releaseItems: Dictionary<string> = {};
 		try {
@@ -17,8 +17,11 @@ const getOSReleaseData = _.memoize(
 				const [key, ...values] = line.split('=');
 
 				// Remove enclosing quotes: http://stackoverflow.com/a/19156197/2549019
-				const value = _.trim(values.join('=')).replace(/^"(.+(?="$))"$/, '$1');
-				releaseItems[_.trim(key)] = value;
+				const value = values
+					.join('=')
+					.trim()
+					.replace(/^"(.+(?="$))"$/, '$1');
+				releaseItems[key.trim()] = value;
 			}
 		} catch (e: any) {
 			throw new InternalInconsistencyError(
@@ -28,6 +31,7 @@ const getOSReleaseData = _.memoize(
 
 		return releaseItems;
 	},
+	{ promise: true },
 );
 
 async function getOSReleaseField(
@@ -68,6 +72,10 @@ export function getOSSemver(path: string): Promise<string | undefined> {
 	return getOSReleaseField(path, 'VERSION');
 }
 
+export function getOSBoardRev(path: string): Promise<string | undefined> {
+	return getOSReleaseField(path, 'BALENA_BOARD_REV');
+}
+
 export async function getMetaOSRelease(
 	path: string,
 ): Promise<string | undefined> {

test/data/etc/os-release

@@ -1,12 +1,11 @@
 ID="balena-os"
 NAME="balenaOS"
-VERSION="2.0.6"
-VERSION_ID="2.0.6+rev1"
-PRETTY_NAME="balenaOS 2.0.6+rev1"
-MACHINE="raspberrypi4-64"
-VARIANT="Development"
-VARIANT_ID="dev"
-META_BALENA_VERSION="2.0.6"
-RESIN_BOARD_REV="b57b01a"
-META_RESIN_REV="ef55525"
-SLUG="raspberrypi4-64"
+VERSION="6.5.44+rev2"
+VERSION_ID="6.5.44+rev2"
+PRETTY_NAME="balenaOS 6.5.44+rev2"
+DISTRO_CODENAME="kirkstone"
+MACHINE="raspberrypi3-64"
+META_BALENA_VERSION="6.5.44"
+BALENA_BOARD_REV="a21c12f4"
+META_BALENA_REV="4e67673a"
+SLUG="raspberrypi3-64"

test/integration/compose/service.spec.ts

@@ -64,5 +64,50 @@ describe('compose/service: integration tests', () => {
 				).to.be.equal(mykey);
 			});
 		});
+
+		describe('io.balena.features.host-os.board-rev', () => {
+			it('should set BALENA_HOST_OS_BOARD_REV environment variable when the feature is enabled', async () => {
+				const s = await Service.fromComposeObject(
+					{
+						appId: 123,
+						serviceId: 123,
+						serviceName: 'test',
+						labels: {
+							'io.balena.features.host-os.board-rev': '1',
+						},
+					},
+					{ appName: 'test' } as any,
+				);
+
+				expect(s.config.environment).to.have.property(
+					'BALENA_HOST_OS_BOARD_REV',
+				);
+				expect(s.config.environment).to.have.property(
+					'RESIN_HOST_OS_BOARD_REV',
+				);
+				expect(s.config.environment['BALENA_HOST_OS_BOARD_REV']).to.equal(
+					'a21c12f4',
+				);
+			});
+
+			it('should not set BALENA_HOST_OS_BOARD_REV when the feature is not enabled', async () => {
+				const s = await Service.fromComposeObject(
+					{
+						appId: 123,
+						serviceId: 123,
+						serviceName: 'test',
+						labels: {},
+					},
+					{ appName: 'test' } as any,
+				);
+
+				expect(s.config.environment).to.not.have.property(
+					'BALENA_HOST_OS_BOARD_REV',
+				);
+				expect(s.config.environment).to.not.have.property(
+					'RESIN_HOST_OS_BOARD_REV',
+				);
+			});
+		});
 	});
 });