modules: fota: Rename events and add state transition

* Make events from the FOTA module more descriptive.
* Add state transition from STATE_DOWNLOADING_UPDATE
  to STATE_WAITING_FOR_POLL_REQUEST if the download is canceled
  from the cloud.
* Update tests accordingly.

Signed-off-by: Simen S. Røstad <simen.rostad@nordicsemi.no>

Author: simensrostad

app/src/main.c

@@ -377,7 +377,7 @@ static void periodic_triggering_entry(void *o)
 	}
 #endif /* CONFIG_APP_LED */
 
-	k_work_reschedule(&trigger_work, K_NO_WAIT);
+	k_work_reschedule(&trigger_work, K_SECONDS(10));
 }
 
 static void periodic_triggering_run(void *o)
@@ -421,7 +421,7 @@ static void fota_run(void *o)
 
 	if (state_object->chan == &FOTA_CHAN) {
 		switch (state_object->fota_status) {
-		case FOTA_CANCELED:
+		case FOTA_DOWNLOAD_CANCELED:
 			__fallthrough;
 		case FOTA_DOWNLOAD_TIMED_OUT:
 			__fallthrough;

app/src/modules/fota/fota.c

@@ -193,7 +193,7 @@ static void fota_status(enum nrf_cloud_fota_status status, const char *const sta
 	case NRF_CLOUD_FOTA_CANCELED:
 		LOG_WRN("Firmware download canceled");
 
-		evt = FOTA_CANCELED;
+		evt = FOTA_DOWNLOAD_CANCELED;
 		break;
 	case NRF_CLOUD_FOTA_TIMED_OUT:
 		LOG_WRN("Firmware download timed out");
@@ -265,7 +265,7 @@ static void state_running_run(void *o)
 	if (&FOTA_CHAN == state_object->chan) {
 		const enum fota_msg_type msg_type = MSG_TO_FOTA_TYPE(state_object->msg_buf);
 
-		if (msg_type == FOTA_CANCEL) {
+		if (msg_type == FOTA_DOWNLOAD_CANCEL) {
 			STATE_SET(fota_state, STATE_CANCELED);
 		}
 	}
@@ -287,7 +287,7 @@ static void state_waiting_for_poll_request_run(void *o)
 
 		if (msg_type == FOTA_POLL_REQUEST) {
 			STATE_SET(fota_state, STATE_POLLING_FOR_UPDATE);
-		} else if (msg_type == FOTA_CANCEL) {
+		} else if (msg_type == FOTA_DOWNLOAD_CANCEL) {
 			LOG_DBG("No ongoing FOTA update, nothing to cancel");
 
 			STATE_EVENT_HANDLED(fota_state);
@@ -343,7 +343,7 @@ static void state_polling_for_update_run(void *o)
 		case FOTA_NO_AVAILABLE_UPDATE:
 			STATE_SET(fota_state, STATE_WAITING_FOR_POLL_REQUEST);
 			break;
-		case FOTA_CANCEL:
+		case FOTA_DOWNLOAD_CANCEL:
 			LOG_DBG("No ongoing FOTA update, nothing to cancel");
 
 			STATE_EVENT_HANDLED(fota_state);
@@ -373,6 +373,10 @@ static void state_downloading_update_run(void *o)
 		case FOTA_IMAGE_APPLY_NEEDED:
 			STATE_SET(fota_state, STATE_WAITING_FOR_IMAGE_APPLY);
 			break;
+		case FOTA_DOWNLOAD_CANCELED:
+			__fallthrough;
+		case FOTA_DOWNLOAD_TIMED_OUT:
+			__fallthrough;
 		case FOTA_DOWNLOAD_FAILED:
 			STATE_SET(fota_state, STATE_WAITING_FOR_POLL_REQUEST);
 			break;
@@ -450,7 +454,7 @@ static void state_canceling_run(void *o)
 	if (&FOTA_CHAN == state_object->chan) {
 		const enum fota_msg_type msg = MSG_TO_FOTA_TYPE(state_object->msg_buf);
 
-		if (msg == FOTA_CANCELED) {
+		if (msg == FOTA_DOWNLOAD_CANCELED) {
 			STATE_SET(fota_state, STATE_WAITING_FOR_POLL_REQUEST);
 		}
 	}

app/src/modules/fota/fota.h

@@ -41,8 +41,8 @@ enum fota_msg_type {
 	 */
 	FOTA_IMAGE_APPLY_NEEDED,
 
-	/* Event notified when the FOTA update has been canceled. */
-	FOTA_CANCELED,
+	/* Event notified when the FOTA download has been canceled. */
+	FOTA_DOWNLOAD_CANCELED,
 
 	/* Input message types */
 
@@ -52,8 +52,8 @@ enum fota_msg_type {
 	/* Request to apply the downloaded firmware image. */
 	FOTA_IMAGE_APPLY,
 
-	/* Cancel the FOTA process. */
-	FOTA_CANCEL,
+	/* Cancel the FOTA download. */
+	FOTA_DOWNLOAD_CANCEL,
 };
 
 #define MSG_TO_FOTA_TYPE(_msg) (*(const enum fota_msg_type *)_msg)

tests/module/fota/src/fota_module_test.c

@@ -67,8 +67,8 @@ void tearDown(void)
 	no_events_expect(3600);
 
 	/* Reset DuTs internal state between each test case */
-	event_send(FOTA_CANCEL);
-	event_expect(FOTA_CANCEL);
+	event_send(FOTA_DOWNLOAD_CANCEL);
+	event_expect(FOTA_DOWNLOAD_CANCEL);
 }
 
 static void event_expect(enum fota_msg_type expected_fota_type)
@@ -187,6 +187,42 @@ void test_fota_module_should_fail_on_timeout(void)
 	event_expect(FOTA_DOWNLOAD_TIMED_OUT);
 }
 
+void test_fota_module_should_fail_on_fail(void)
+{
+	/* Given */
+	nrf_cloud_fota_poll_process_fake.return_val = 0;
+
+	/* 1. Poll for update */
+	event_send(FOTA_POLL_REQUEST);
+	event_expect(FOTA_POLL_REQUEST);
+
+	/* 2. Downloading update */
+	invoke_nrf_cloud_fota_callback_stub_status(NRF_CLOUD_FOTA_DOWNLOADING);
+	event_expect(FOTA_DOWNLOADING_UPDATE);
+
+	/* 3. Download failed */
+	invoke_nrf_cloud_fota_callback_stub_status(NRF_CLOUD_FOTA_FAILED);
+	event_expect(FOTA_DOWNLOAD_FAILED);
+}
+
+void test_fota_module_should_fail_on_cancelation(void)
+{
+	/* Given */
+	nrf_cloud_fota_poll_process_fake.return_val = 0;
+
+	/* 1. Poll for update */
+	event_send(FOTA_POLL_REQUEST);
+	event_expect(FOTA_POLL_REQUEST);
+
+	/* 2. Downloading update */
+	invoke_nrf_cloud_fota_callback_stub_status(NRF_CLOUD_FOTA_DOWNLOADING);
+	event_expect(FOTA_DOWNLOADING_UPDATE);
+
+	/* 3. Download canceled */
+	invoke_nrf_cloud_fota_callback_stub_status(NRF_CLOUD_FOTA_CANCELED);
+	event_expect(FOTA_DOWNLOAD_CANCELED);
+}
+
 /* This is required to be added to each test. That is because unity's
  * main may return nonzero, while zephyr's main currently must
  * return 0 in all cases (other values are reserved).