From 5c50f656c33954de6f4c07f8b6c892b4bf9953cf Mon Sep 17 00:00:00 2001
From: Cameron Diver <cameron@balena.io>
Date: Fri, 6 Mar 2020 10:28:23 +0000
Subject: [PATCH] Allow semver comparison on l4t versions in contracts

We add an implicit .0 to the end of l4t versions which do not fulfill
semver, which allows us to always match using comparison operators, such
as < and <=.

Change-type: minor
Signed-off-by: Cameron Diver <cameron@balena.io>
---
 src/lib/os-release.ts |  10 +++-
 test/24-contracts.ts  | 135 +++++++++++++++++++++++++++++++++++-------
 2 files changed, 122 insertions(+), 23 deletions(-)

diff --git a/src/lib/os-release.ts b/src/lib/os-release.ts
index 71e3f2af..80ac78aa 100644
--- a/src/lib/os-release.ts
+++ b/src/lib/os-release.ts
@@ -69,7 +69,15 @@ export async function getL4tVersion(): Promise<string | undefined> {
 			return;
 		}
 
-		return match[1];
+		let res = match[1];
+		if (match[2] == null) {
+			// We were only provided with 2 version numbers
+			// We add a .0 onto the end, to allow always being
+			// able to use semver comparisons
+			res += '.0';
+		}
+
+		return res;
 	} catch (e) {
 		log.error('Could not detect l4t version! Error: ', e);
 		return;
diff --git a/test/24-contracts.ts b/test/24-contracts.ts
index 6ebce915..3dbfc3cb 100644
--- a/test/24-contracts.ts
+++ b/test/24-contracts.ts
@@ -410,36 +410,127 @@ describe('Container contracts', () => {
 });
 
 describe('L4T version detection', () => {
-	it('should correctly parse L4T version strings', async () => {
-		let execStub = stub(child_process, 'exec').returns(
-			Promise.resolve([
-				Buffer.from('4.9.140-l4t-r32.2+g3dcbed5'),
-				Buffer.from(''),
-			]),
-		);
-
-		expect(await osRelease.getL4tVersion()).to.equal('32.2');
-		expect(execStub.callCount).to.equal(1);
-
-		execStub.restore();
+	let execStub: SinonStub;
 
+	const seedExec = (version: string) => {
 		execStub = stub(child_process, 'exec').returns(
-			Promise.resolve([
-				Buffer.from('4.4.38-l4t-r28.2+g174510d'),
-				Buffer.from(''),
-			]),
+			Promise.resolve([Buffer.from(version), Buffer.from('')]),
 		);
-		expect(await osRelease.getL4tVersion()).to.equal('28.2');
+	};
+
+	afterEach(() => {
+		execStub.restore();
+	});
+
+	it('should correctly parse L4T version strings', async () => {
+		seedExec('4.9.140-l4t-r32.2+g3dcbed5');
+		expect(await osRelease.getL4tVersion()).to.equal('32.2.0');
 		expect(execStub.callCount).to.equal(1);
 		execStub.restore();
+
+		seedExec('4.4.38-l4t-r28.2+g174510d');
+		expect(await osRelease.getL4tVersion()).to.equal('28.2.0');
+		expect(execStub.callCount).to.equal(1);
+	});
+
+	it('should correctly handle l4t versions which contain three numbers', async () => {
+		seedExec('4.4.38-l4t-r32.3.1+g174510d');
+		expect(await osRelease.getL4tVersion()).to.equal('32.3.1');
+		expect(execStub.callCount).to.equal(1);
 	});
 
 	it('should return undefined when there is no l4t string in uname', async () => {
-		const execStub = stub(child_process, 'exec').returns(
-			Promise.resolve([Buffer.from('4.18.14-yocto-standard'), Buffer.from('')]),
-		);
-
+		seedExec('4.18.14-yocto-standard');
 		expect(await osRelease.getL4tVersion()).to.be.undefined;
-		execStub.restore();
+	});
+
+	describe('L4T comparison', () => {
+		it('should allow semver matching even when l4t does not fulfill semver', async () => {
+			seedExec('4.4.38-l4t-r31.0');
+
+			expect(
+				await containerContractsFulfilled({
+					service: {
+						contract: {
+							type: 'sw.container',
+							slug: 'user-container',
+							requires: [
+								{
+									type: 'sw.l4t',
+									version: '>=31.0.0',
+								},
+							],
+						},
+						optional: false,
+					},
+				}),
+			)
+				.to.have.property('valid')
+				.that.equals(true);
+
+			expect(
+				await containerContractsFulfilled({
+					service: {
+						contract: {
+							type: 'sw.container',
+							slug: 'user-container',
+							requires: [
+								{
+									type: 'sw.l4t',
+									version: '<31.0.0',
+								},
+							],
+						},
+						optional: false,
+					},
+				}),
+			)
+				.to.have.property('valid')
+				.that.equals(false);
+		});
+
+		it('should allow semver matching when l4t does fulfill semver', async () => {
+			seedExec('4.4.38-l4t-r31.0.1');
+
+			expect(
+				await containerContractsFulfilled({
+					service: {
+						contract: {
+							type: 'sw.container',
+							slug: 'user-container',
+							requires: [
+								{
+									type: 'sw.l4t',
+									version: '>=31.0.0',
+								},
+							],
+						},
+						optional: false,
+					},
+				}),
+			)
+				.to.have.property('valid')
+				.that.equals(true);
+
+			expect(
+				await containerContractsFulfilled({
+					service: {
+						contract: {
+							type: 'sw.container',
+							slug: 'user-container',
+							requires: [
+								{
+									type: 'sw.l4t',
+									version: '<31.0.0',
+								},
+							],
+						},
+						optional: false,
+					},
+				}),
+			)
+				.to.have.property('valid')
+				.that.equals(false);
+		});
 	});
 });