Merge pull request #1431 from balena-io/application-create-uuid

application.create: Allow specifying the uuid of the new application

Author: thgreasi

DOCUMENTATION.md

@@ -1828,7 +1828,8 @@ balena.models.application.hasAny().then(function(hasAny) {
 | Param | Type | Description |
 | --- | --- | --- |
 | options | <code>Object</code> | application creation parameters |
-| options.name | <code>String</code> | application names |
+| options.name | <code>String</code> | application name |
+| [options.uuid] | <code>String</code> | application uuid |
 | [options.applicationType] | <code>String</code> | application type slug e.g. microservices |
 | [options.applicationClass] | <code>String</code> | application class: 'app' | 'fleet' | 'block' |
 | options.deviceType | <code>String</code> | device type slug |

src/models/application.ts

@@ -664,7 +664,8 @@ const getApplicationModel = function (
 		 * @memberof balena.models.application
 		 *
 		 * @param {Object} options - application creation parameters
-		 * @param {String} options.name - application names
+		 * @param {String} options.name - application name
+		 * @param {String} [options.uuid] - application uuid
 		 * @param {String} [options.applicationType] - application type slug e.g. microservices
 		 * @param {String} [options.applicationClass] - application class: 'app' | 'fleet' | 'block'
 		 * @param {String} options.deviceType - device type slug
@@ -691,13 +692,15 @@ const getApplicationModel = function (
 		 */
 		async create({
 			name,
+			uuid,
 			applicationType,
 			applicationClass,
 			deviceType,
 			parent,
 			organization,
 		}: {
 			name: string;
+			uuid?: string;
 			/** @deprecated TODO: drop me in the next major */
 			applicationType?: string;
 			applicationClass?: 'app' | 'fleet' | 'block';
@@ -773,6 +776,7 @@ const getApplicationModel = function (
 			]);
 			const body: SubmitBody<Application> = {
 				app_name: name,
+				uuid,
 				is_for__device_type: deviceTypeId,
 			};
 

tests/integration/models/application.spec.ts

@@ -243,6 +243,22 @@ describe('Application Model', function () {
 						});
 				});
 
+				it('...should be able to create an application and specify a custom uuid', async function () {
+					const uuid = balena.models.device.generateUniqueKey();
+					const app = await balena.models.application.create({
+						name: `${TEST_APPLICATION_NAME_PREFIX}_FooBarCustomUuid`,
+						uuid,
+						deviceType: 'raspberry-pi',
+						organization: this.initialOrg.id,
+					});
+					expect(app).to.have.property('uuid', uuid);
+					const apps = await balena.models.application.getAll(
+						{},
+						'directly_accessible',
+					);
+					expect(apps).to.have.length(appCount);
+				});
+
 				it('...should be able to create an application with a specific application type', function () {
 					return balena.models.application
 						.create({