Change CLI option behavior for OTA-R and OTA-P to revert back to the success case after using the CLI supplied values #16095

isiu-apple · 2022-03-11T05:38:12Z

Problem

Currently the values supplied in CLI options for OTA-P and OTA-R remain the same for the duration of its runtime. Therefore real world scenarios where Provider replies Busy, and then on subsequent tries UpdateAvailable is not possible.

Fixes: #15656

Change overview

Change the behavior of the following CLI supplied values to use the supplied value only once, and then revert back to the success value on subsequent request/responses.

Provider:

-q/--queryImageStatus <updateAvailable | busy | updateNotAvailable> 
-a/--applyUpdateAction <proceed | awaitNextAction | discontinue>
-t/--delayedQueryActionTimeSec <time>
-p/--delayedApplyActionTimeSec <time>
-u/--userConsentState <granted | denied | deferred>

Requestor:

-u/--userConsentState <granted | denied | deferred>

Testing

Tested various combinations of the above CLI options and ensured that subsequent QueryImage commands succeed and default to the success path. Also ensured that the delayedQueryActionTimeSec and delayedApplyActionTimeSec values supplied is applied to the first QueryImageResponse and ApplyUpdateResponses only respectively and reverts back to 0 on subsequent QueryImageResponse and ApplyUpdateResponses respectively.

examples/ota-requestor-app/linux/README.md

examples/ota-requestor-app/linux/main.cpp

examples/ota-provider-app/linux/README.md

…QueryImageResponse and ApplyImageResponse commands - For OTA-P, make -q, -a, and -u be applied just once and then revert back to the success case.

- Remove counters and just revert behavior to success case after first use - Fix userConsentState ignore once case

- Remove count variables.

- Update comments.

- Split -t command line arg into -t and -p.

github-actions · 2022-03-14T17:32:37Z

PR #16095: Size comparison from 6e76729 to b8a1945

Full report (16 builds for cyw30739, efr32, k32w, linux, mbed, nrfconnect, p6, telink)

platform	target	config	section	`6e76729`	`b8a1945`
cyw30739	light	cyw930739m2evb_01	(read/write)	602466	602466
			.app_xip_area	509644	509644
			.bss	75576	75576
			.data	596	596
			.rodata	0	0
			.text	0	0
	lock	cyw930739m2evb_01	(read/write)	560326	560326
			.app_xip_area	469032	469032
			.bss	74080	74080
			.data	560	560
			.rodata	0	0
			.text	0	0
	ota-requestor-no-progress-logging	cyw930739m2evb_01	(read/write)	570426	570426
			.app_xip_area	469484	469484
			.bss	83384	83384
			.data	520	520
			.rodata	0	0
			.text	112	112
efr32	lighting-app	BRD4161A	(read only)	918452	918452
			(read/write)	128656	128656
			.bss	126648	126648
			.data	2008	2008
			.text	918444	918444
		BRD4161A+rpc	(read only)	947272	947272
			(read/write)	144616	144616
			.bss	142424	142424
			.data	2188	2188
			.text	947264	947264
	window-app	BRD4161A	(read only)	850328	850328
			(read/write)	126632	126632
			.bss	124768	124768
			.data	1864	1864
			.text	850320	850320
k32w	light	k32w061+release	(read/write)	699324	699324
			.bss	77560	77560
			.data	1888	1888
			.text	614076	614076
	lock	k32w061+release	(read/write)	699596	699596
			.bss	77552	77552
			.data	1908	1908
			.text	614336	614336
linux	chip-tool-ipv6only	arm64	(read only)	9727740	9727740
			(read/write)	475425	475425
			.bss	44017	44017
			.data	1128	1128
			.data.rel.ro	371232	371232
			.dynamic	560	560
			.got	55256	55256
			.init	24	24
			.init_array	192	192
			.rodata	492244	492244
			.text	`8185652`	`8185652`
	thermostat-no-ble	arm64	(read only)	`2206900`	`2206900`
			(read/write)	149377	149377
			.bss	65649	65649
			.data	1024	1024
			.data.rel.ro	75368	75368
			.dynamic	560	560
			.got	4352	4352
			.init	24	24
			.init_array	360	360
			.rodata	136756	136756
			.text	`1850832`	`1850832`
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224
			(read/write)	2352692	2352692
			.bss	186652	186652
			.data	5752	5752
			.text	1315292	1315292
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read/write)	1153995	1153995
			bss	146644	146644
			rodata	145276	145276
			text	786960	786960
p6	all-clusters-app	default	(read/write)	`2492072`	`2492072`
			.bss	120080	120080
			.data	2632	2632
			.text	`1450336`	`1450336`
	light-app	default	(read/write)	2395920	2395920
			.bss	113544	113544
			.data	2488	2488
			.text	1354184	1354184
	lock-app	default	(read/write)	2359464	2359464
			.bss	113288	113288
			.data	2448	2448
			.text	1317728	1317728
telink	lighting-app	tlsr9518adk80d	(read/write)	893706	893706
			bss	87432	87432
			noinit	37160	37160
			text	631808	631808

.github/.wordlist.txt

examples/ota-provider-app/linux/README.md

examples/ota-provider-app/linux/main.cpp

- Update readme and CLI info texts.

github-actions · 2022-03-14T18:21:57Z

PR #16095: Size comparison from 6e76729 to 6c532ab

Increases (18 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)

platform	target	config	section	`6e76729`	`6c532ab`	change
cyw30739	light	cyw930739m2evb_01	(read/write)	602466	602578	112
			.app_xip_area	509644	509756	112
	lock	cyw930739m2evb_01	(read/write)	560326	560430	104
			.app_xip_area	469032	469136	104
	ota-requestor-no-progress-logging	cyw930739m2evb_01	(read/write)	570426	570538	112
			.app_xip_area	469484	469596	112
efr32	lighting-app	BRD4161A	(read only)	918452	918532	80
			.text	918444	918524	80
		BRD4161A+rpc	(read only)	947272	947336	64
			.text	947264	947328	64
	window-app	BRD4161A	(read only)	850328	850392	64
			.text	850320	850384	64
esp32	all-clusters-app	c3devkit	(read only)	961328	961388	60
			.flash.text	961328	961388	60
		m5stack	(read only)	1016939	1017011	72
			.flash.text	1011555	1011627	72
k32w	light	k32w061+release	(read/write)	699324	699388	64
			.text	614076	614140	64
	lock	k32w061+release	(read/write)	699596	699644	48
			.text	614336	614384	48
linux	chip-tool-ipv6only	arm64	(read only)	9727740	9727964	224
			.text	`8185652`	8185876	224
	thermostat-no-ble	arm64	(read only)	`2206900`	2207236	336
			.text	`1850832`	1851168	336
mbed	lock-app	CY8CPROTO_062_4343W+release	(read/write)	2352692	`2352756`	64
			.text	1315292	1315356	64
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read/write)	1153995	`1154043`	48
			text	786960	787016	56
p6	all-clusters-app	default	(read/write)	`2492072`	2492152	80
			.text	`1450336`	1450416	80
	light-app	default	(read/write)	2395920	2396000	80
			.text	1354184	`1354264`	80
	lock-app	default	(read/write)	2359464	2359544	80
			.text	1317728	1317808	80
telink	lighting-app	tlsr9518adk80d	(read/write)	893706	893770	64
			text	631808	631868	60

Full report (18 builds for cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, p6, telink)

platform	target	config	section	`6e76729`	`6c532ab`	change
cyw30739	light	cyw930739m2evb_01	(read/write)	602466	602578	112
			.app_xip_area	509644	509756	112
			.bss	75576	75576	0
			.data	596	596	0
			.rodata	0	0	0
			.text	0	0	0
	lock	cyw930739m2evb_01	(read/write)	560326	560430	104
			.app_xip_area	469032	469136	104
			.bss	74080	74080	0
			.data	560	560	0
			.rodata	0	0	0
			.text	0	0	0
	ota-requestor-no-progress-logging	cyw930739m2evb_01	(read/write)	570426	570538	112
			.app_xip_area	469484	469596	112
			.bss	83384	83384	0
			.data	520	520	0
			.rodata	0	0	0
			.text	112	112	0
efr32	lighting-app	BRD4161A	(read only)	918452	918532	80
			(read/write)	128656	128656	0
			.bss	126648	126648	0
			.data	2008	2008	0
			.text	918444	918524	80
		BRD4161A+rpc	(read only)	947272	947336	64
			(read/write)	144616	144616	0
			.bss	142424	142424	0
			.data	2188	2188	0
			.text	947264	947328	64
	window-app	BRD4161A	(read only)	850328	850392	64
			(read/write)	126632	126632	0
			.bss	124768	124768	0
			.data	1864	1864	0
			.text	850320	850384	64
esp32	all-clusters-app	c3devkit	(read only)	961328	961388	60
			(read/write)	1394938	1394938	0
			.dram0.bss	64056	64056	0
			.dram0.data	14188	14188	0
			.flash.rodata	197776	197776	0
			.flash.text	961328	961388	60
			.iram0.text	62016	62016	0
		m5stack	(read only)	1016939	1017011	72
			(read/write)	462148	462148	0
			.dram0.bss	69576	69576	0
			.dram0.data	34016	34016	0
			.flash.rodata	226720	226720	0
			.flash.text	1011555	1011627	72
			.iram0.text	123107	123107	0
k32w	light	k32w061+release	(read/write)	699324	699388	64
			.bss	77560	77560	0
			.data	1888	1888	0
			.text	614076	614140	64
	lock	k32w061+release	(read/write)	699596	699644	48
			.bss	77552	77552	0
			.data	1908	1908	0
			.text	614336	614384	48
linux	chip-tool-ipv6only	arm64	(read only)	9727740	9727964	224
			(read/write)	475425	475425	0
			.bss	44017	44017	0
			.data	1128	1128	0
			.data.rel.ro	371232	371232	0
			.dynamic	560	560	0
			.got	55256	55256	0
			.init	24	24	0
			.init_array	192	192	0
			.rodata	492244	492244	0
			.text	`8185652`	8185876	224
	thermostat-no-ble	arm64	(read only)	`2206900`	2207236	336
			(read/write)	149377	149377	0
			.bss	65649	65649	0
			.data	1024	1024	0
			.data.rel.ro	75368	75368	0
			.dynamic	560	560	0
			.got	4352	4352	0
			.init	24	24	0
			.init_array	360	360	0
			.rodata	136756	136756	0
			.text	`1850832`	1851168	336
mbed	lock-app	CY8CPROTO_062_4343W+release	(read only)	6224	6224	0
			(read/write)	2352692	`2352756`	64
			.bss	186652	186652	0
			.data	5752	5752	0
			.text	1315292	1315356	64
nrfconnect	all-clusters-app	nrf52840dk_nrf52840	(read/write)	1153995	`1154043`	48
			bss	146644	146644	0
			rodata	145276	145276	0
			text	786960	787016	56
p6	all-clusters-app	default	(read/write)	`2492072`	2492152	80
			.bss	120080	120080	0
			.data	2632	2632	0
			.text	`1450336`	1450416	80
	light-app	default	(read/write)	2395920	2396000	80
			.bss	113544	113544	0
			.data	2488	2488	0
			.text	1354184	`1354264`	80
	lock-app	default	(read/write)	2359464	2359544	80
			.bss	113288	113288	0
			.data	2448	2448	0
			.text	1317728	1317808	80
telink	lighting-app	tlsr9518adk80d	(read/write)	893706	893770	64
			bss	87432	87432	0
			noinit	37160	37160	0
			text	631808	631868	60

…success case after using the CLI supplied values (project-chip#16095) * Issue project-chip#15656 [ota-provider-app] Add counters for various QueryImageResponse and ApplyImageResponse commands - For OTA-P, make -q, -a, and -u be applied just once and then revert back to the success case. * - Remove debug logs - Remove counters and just revert behavior to success case after first use - Fix userConsentState ignore once case * - Update ReadMes and CLI comments. * - Remove debug code. - Remove count variables. * scripts/helpers/restyle-diff.sh * Resolve spellcheck errors. * Code review changes. - Update comments. * scripts/helpers/restyle-diff.sh * Code review changes. - Split -t command line arg into -t and -p. * scripts/helpers/restyle-diff.sh * Code review changes. - Update readme and CLI info texts.

boring-cyborg bot added app examples labels Mar 11, 2022

carol-apple reviewed Mar 12, 2022

View reviewed changes

examples/ota-requestor-app/linux/README.md Outdated Show resolved Hide resolved

carol-apple reviewed Mar 12, 2022

View reviewed changes

examples/ota-requestor-app/linux/main.cpp Outdated Show resolved Hide resolved

carol-apple reviewed Mar 12, 2022

View reviewed changes

examples/ota-provider-app/linux/README.md Outdated Show resolved Hide resolved

isiu-apple added 10 commits March 14, 2022 10:10

Issue project-chip#15656 [ota-provider-app] Add counters for various …

f1c6297

…QueryImageResponse and ApplyImageResponse commands - For OTA-P, make -q, -a, and -u be applied just once and then revert back to the success case.

- Remove debug logs

96d5087

- Remove counters and just revert behavior to success case after first use - Fix userConsentState ignore once case

- Update ReadMes and CLI comments.

9c5b760

- Remove debug code.

ce9564f

- Remove count variables.

scripts/helpers/restyle-diff.sh

553372e

Resolve spellcheck errors.

875c108

Code review changes.

5451493

- Update comments.

scripts/helpers/restyle-diff.sh

c3eab78

Code review changes.

b1d037c

- Split -t command line arg into -t and -p.

scripts/helpers/restyle-diff.sh

b8a1945

isiu-apple force-pushed the issue_15656 branch from 8afd4a8 to b8a1945 Compare March 14, 2022 17:11

boring-cyborg bot added the github label Mar 14, 2022