Make application name optional in the schema, and stop adding it to n…

…ew config Change-type: minor
balena-io-modules · Apr 13, 2020 · 2ce6676 · 2ce6676
1 parent 15d4d43
commit 2ce6676
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,6 @@ Documentation
 ```js
 config = deviceConfig.generate
 	application:
-		app_name: 'HelloWorldApp'
 		id: 18
 		device_type: 'raspberry-pi'
 	user:
@@ -75,7 +74,6 @@ console.log(config)
 ```js
 config = deviceConfig.generate
 	application:
-		app_name: 'HelloWorldApp'
 		id: 18
 		device_type: 'raspberry-pi2'
 	deviceType: 'raspberrypi3'
@@ -115,7 +113,6 @@ console.log(config)
 ```js
 config = deviceConfig.generate
 	application:
-		app_name: 'HelloWorldApp'
 		id: 18
 		device_type: 'raspberry-pi'
 	user:

diff --git a/lib/config.coffee b/lib/config.coffee
@@ -36,7 +36,6 @@ schema = require('./schema')
 # @example
 # config = deviceConfig.generate
 # 	application:
-# 		app_name: 'HelloWorldApp'
 # 		id: 18
 # 		device_type: 'raspberry-pi'
 # 	user:
@@ -59,7 +58,6 @@ schema = require('./schema')
 # @example
 # config = deviceConfig.generate
 # 	application:
-# 		app_name: 'HelloWorldApp'
 # 		id: 18
 # 		device_type: 'raspberry-pi2'
 # 	deviceType: 'raspberrypi3'
@@ -86,7 +84,6 @@ exports.generate = (options, params = {}) ->
 		vpnPort: 443
 
 	config =
-		applicationName: options.application.app_name
 		applicationId: options.application.id
 		deviceType: options.deviceType or options.application.device_type
 
@@ -131,7 +128,6 @@ exports.generate = (options, params = {}) ->
 # @example
 # config = deviceConfig.generate
 # 	application:
-# 		app_name: 'HelloWorldApp'
 # 		id: 18
 # 		device_type: 'raspberry-pi'
 # 	user:

diff --git a/lib/schema.coffee b/lib/schema.coffee
@@ -28,10 +28,11 @@ _ = require('lodash')
 ###
 module.exports =
 	properties:
+		# Included for backwards compatibility - it does not exist in modern config files
 		applicationName:
 			description: 'application name'
 			type: 'string'
-			required: true
+			required: false
 			allowEmpty: false
 		applicationId:
 			description: 'application id'

diff --git a/tests/config.spec.coffee b/tests/config.spec.coffee
@@ -8,7 +8,6 @@ describe 'Device Config:', ->
 		it 'should pass validation', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -35,7 +34,6 @@ describe 'Device Config:', ->
 		it 'should default appUpdatePollInterval to 1 second', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -58,7 +56,6 @@ describe 'Device Config:', ->
 		it 'should default to the application device type when an explicit one is not provided', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi2'
 				user:
@@ -83,7 +80,6 @@ describe 'Device Config:', ->
 		it 'should use the provided device type instead of the application one', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi2'
 				deviceType: 'raspberrypi3'
@@ -109,7 +105,6 @@ describe 'Device Config:', ->
 		it 'should include files section if no version is given', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -132,7 +127,6 @@ describe 'Device Config:', ->
 		it 'should include files and connectivity sections if the given version is < 2.0.0', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -158,7 +152,6 @@ describe 'Device Config:', ->
 		it 'should not include files or connectivity sections if the given version is >= 2.0.0', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -184,7 +177,6 @@ describe 'Device Config:', ->
 		it 'should default appUpdatePollInterval to 1 second if NaN', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -208,7 +200,6 @@ describe 'Device Config:', ->
 		it 'should default vpnPort to 443', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -230,7 +221,6 @@ describe 'Device Config:', ->
 		it 'should handle wifi configuration', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -255,7 +245,6 @@ describe 'Device Config:', ->
 		it 'should handle multiple network configurations', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -289,7 +278,6 @@ describe 'Device Config:', ->
 		it 'should parse vpnPort as an integer automatically', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -315,7 +303,6 @@ describe 'Device Config:', ->
 			m.chai.expect ->
 				deviceConfig.generate
 					application:
-						app_name: 'HelloWorldApp'
 						id: 18
 						device_type: 'raspberry-pi'
 					user:
@@ -340,7 +327,6 @@ describe 'Device Config:', ->
 			m.chai.expect ->
 				deviceConfig.generate
 					application:
-						app_name: 'HelloWorldApp'
 						id: 18
 						device_type: 'raspberry-pi'
 					user:
@@ -366,7 +352,6 @@ describe 'Device Config:', ->
 			m.chai.expect ->
 				config = deviceConfig.generate
 					application:
-						app_name: 'HelloWorldApp'
 						id: 18
 						device_type: 'raspberry-pi'
 					user:
@@ -393,7 +378,6 @@ describe 'Device Config:', ->
 			m.chai.expect ->
 				deviceConfig.generate
 					application:
-						id: 18
 						device_type: 'raspberry-pi'
 					user:
 						id: 7
@@ -408,12 +392,11 @@ describe 'Device Config:', ->
 						delta: 'https://delta.resin.io'
 				,
 					network: 'ethernet'
-			.to.throw('Validation: applicationName is required')
+			.to.throw('Validation: applicationId is required')
 
 		it 'should throw an error if the config json contains extra properties', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user:
@@ -440,7 +423,6 @@ describe 'Device Config:', ->
 		it 'should allow balenaRootCA to be undefined', ->
 			config = deviceConfig.generate
 				application:
-					app_name: 'HelloWorldApp'
 					id: 18
 					device_type: 'raspberry-pi'
 				user: