Diff: simple-mbed-cloud-client/TESTS/dev_mgmt/update/main.cpp

Revision:

0:11cc2b7889af

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/simple-mbed-cloud-client/TESTS/dev_mgmt/update/main.cpp	Tue Nov 19 09:49:38 2019 +0000
@@ -0,0 +1,403 @@
+/*
+ * mbed Microcontroller Library
+ * Copyright (c) 2006-2018 ARM Limited
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "mbed.h"
+#include "FATFileSystem.h"
+#include "LittleFileSystem.h"
+#include "simple-mbed-cloud-client.h"
+#include "greentea-client/test_env.h"
+#include "common_defines_test.h"
+
+#ifndef MBED_CONF_APP_TESTS_FS_SIZE
+  #define MBED_CONF_APP_TESTS_FS_SIZE (2*1024*1024)
+#endif
+
+uint32_t test_timeout = 30*60;
+
+#if !defined(MBED_CONF_APP_NO_LED)
+DigitalOut led1(LED1);
+DigitalOut led2(LED2);
+void led_thread() {
+    led1 = !led1;
+    led2 = !led1;
+}
+#endif
+RawSerial pc(USBTX, USBRX);
+
+void wait_nb(uint16_t ms) {
+    wait_ms(ms);
+}
+
+void logger(const char* message, const char* decor) {
+    wait_nb(10);
+    pc.printf(message, decor);
+    wait_nb(10);
+}
+void logger(const char* message) {
+    wait_nb(10);
+    pc.printf(message);
+    wait_nb(10);
+}
+void test_failed() {
+    greentea_send_kv("test_failed", 1);
+}
+void test_case_start(const char *name, size_t index) {
+    wait_nb(10);
+    pc.printf("\r\n>>> Running case #%u: '%s'...\n", index, name);
+    GREENTEA_TESTCASE_START(name);
+}
+void test_case_finish(const char *name, size_t passed, size_t failed) {
+    GREENTEA_TESTCASE_FINISH(name, passed, failed);
+    wait_nb(10);
+    pc.printf(">>> '%s': %u passed, %u failed\r\n", name, passed, failed);
+}
+
+uint32_t dl_last_rpercent = 0;
+bool dl_started = false;
+Timer dl_timer;
+void update_progress(uint32_t progress, uint32_t total) {
+    if (!dl_started) {
+        dl_started = true;
+        dl_timer.start();
+        pc.printf("[INFO] Firmware download started. Size: %.2fKB\r\n", float(total) / 1024);
+    } else {
+        float speed = float(progress) / dl_timer.read();
+        float percent = float(progress) * 100 / float(total);
+        uint32_t time_left = (total - progress) / speed;
+        pc.printf("[INFO] Downloading: %.2f%% (%.2fKB/s, ETA: %02d:%02d:%02d)\r\n", percent, speed / 1024,
+            time_left / 3600, (time_left / 60) % 60, time_left % 60);
+
+        // // this is disabled until htrun is extended to support dynamic change of the duration of tests
+        // // see https://github.com/ARMmbed/htrun/pull/228
+        // // extend the timeout of the test based on current progress
+        // uint32_t round_percent = progress * 100 / total;
+        // if (round_percent != dl_last_rpercent) {
+        //     dl_last_rpercent = round_percent;
+        //     uint32_t new_timeout = test_timeout + int(dl_timer.read() * (round_percent + 1) / round_percent);
+        //     greentea_send_kv("__timeout_set", new_timeout);
+        // }
+    }
+
+    if (progress == total) {
+        dl_timer.stop();
+        dl_started = false;
+        pc.printf("[INFO] Firmware download completed. %.2fKB in %.2f seconds (%.2fKB/s)\r\n",
+            float(total) / 1024, dl_timer.read(), float(total) / dl_timer.read() / 1024);
+        test_case_finish("Pelion Firmware Download", 1, 0);
+        test_case_start("Pelion Firmware Update", 9);
+    }
+}
+
+static const ConnectorClientEndpointInfo* endpointInfo;
+void registered(const ConnectorClientEndpointInfo *endpoint) {
+    logger("[INFO] Connected to Pelion Device Management. Device ID: %s\n",
+            endpoint->internal_endpoint_name.c_str());
+    endpointInfo = endpoint;
+}
+
+void spdmc_testsuite_update(void) {
+    int i = 0;
+    int iteration = 0;
+    char _key[20] = { };
+    char _value[128] = { };
+
+    greentea_send_kv("spdmc_ready_chk", true);
+    while (1) {
+        greentea_parse_kv(_key, _value, sizeof(_key), sizeof(_value));
+
+        if (strcmp(_key, "iteration") == 0) {
+            iteration = atoi(_value);
+            break;
+        }
+    }
+
+    // provide manifest to greentea so it can correct show skipped and failed tests
+    if (iteration == 0) {
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_COUNT, 10);
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Initialize " TEST_BLOCK_DEVICE_TYPE "+" TEST_FILESYSTEM_TYPE);
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Connect to " TEST_NETWORK_TYPE);
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Format " TEST_FILESYSTEM_TYPE);
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Initialize Simple PDMC");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Bootstrap & Reg.");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Directory");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Firmware Prepare");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Firmware Download");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Firmware Update");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Pelion Re-register");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Post-update Erase");
+        greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, "Post-update Identity");
+    } else {
+        test_case_finish("Pelion Firmware Update", true, false);
+    }
+
+    test_case_start("Initialize " TEST_BLOCK_DEVICE_TYPE "+" TEST_FILESYSTEM_TYPE, 1);
+    logger("[INFO] Attempting to initialize storage.\r\n");
+
+    // Default storage definition.
+    BlockDevice* bd = BlockDevice::get_default_instance();
+    SlicingBlockDevice sd(bd, 0, MBED_CONF_APP_TESTS_FS_SIZE);
+#if TEST_USE_FILESYSTEM == FS_FAT
+    FATFileSystem fs("fs", &sd);
+#else
+    LittleFileSystem fs("fs", &sd);
+#endif
+
+    test_case_finish("Initialize " TEST_BLOCK_DEVICE_TYPE "+" TEST_FILESYSTEM_TYPE, iteration + 1, 0);
+
+    // Corrupt the image after successful firmware update to ensure that the bootloader won't try to apply it for other test runs
+    if (iteration) {
+#if defined(MBED_CONF_UPDATE_CLIENT_STORAGE_ADDRESS) && defined(MBED_CONF_UPDATE_CLIENT_STORAGE_SIZE)
+        test_case_start("Post-update Erase", 11);
+
+        int erase_status;
+        if (bd->get_erase_value() >= 0) {
+            // Blockdevice supports a straight erase
+            erase_status = bd->erase(MBED_CONF_UPDATE_CLIENT_STORAGE_ADDRESS, bd->get_erase_size(MBED_CONF_UPDATE_CLIENT_STORAGE_ADDRESS));
+        } else {
+            // Blockdevice supports an overwrite
+            uint32_t garbage[8];
+            erase_status = bd->program(garbage, MBED_CONF_UPDATE_CLIENT_STORAGE_ADDRESS, bd->get_program_size());
+        }
+        if (erase_status != 0) {
+            logger("[ERROR] Post-update image invalidation failed.\n");
+        }
+        test_case_finish("Post-update Erase", (erase_status == 0), (erase_status != 0));
+#endif
+    }
+
+    // Start network connection test.
+    test_case_start("Connect to " TEST_NETWORK_TYPE, 2);
+    logger("[INFO] Attempting to connect to network.\r\n");
+
+    // Connection definition.
+    NetworkInterface *net = NetworkInterface::get_default_instance();
+    nsapi_error_t net_status = -1;
+    for (int tries = 0; tries < 3; tries++) {
+        net_status = net->connect();
+        if (net_status == NSAPI_ERROR_OK) {
+            break;
+        } else {
+            logger("[WARN] Unable to connect to network. Retrying...");
+        }
+    }
+
+    // Report status to console.
+    if (net_status != 0) {
+        logger("[ERROR] Device failed to connect to Network.\r\n");
+        test_failed();
+    } else {
+        logger("[INFO] Connected to network successfully. IP address: %s\n", net->get_ip_address());
+    }
+
+    test_case_finish("Connect to " TEST_NETWORK_TYPE, iteration + (net_status == 0), (net_status != 0));
+
+    if (iteration == 0) {
+        test_case_start("Format " TEST_FILESYSTEM_TYPE, 3);
+        logger("[INFO] Resetting storage to a clean state for test.\n");
+
+        int storage_status = fs.reformat(&sd);
+        if (storage_status != 0) {
+            storage_status = sd.erase(0, sd.size());
+            if (storage_status == 0) {
+                storage_status = fs.format(&sd);
+                if (storage_status != 0) {
+                    logger("[ERROR] Filesystem init failed\n");
+                }
+            }
+        }
+
+        // Report status to console.
+        if (storage_status == 0) {
+            logger("[INFO] Storage format successful.\r\n");
+        } else {
+            logger("[ERROR] Storage format failed.\r\n");
+            test_failed();
+        }
+
+        test_case_finish("Format " TEST_FILESYSTEM_TYPE, (storage_status == 0), (storage_status != 0));
+    }
+
+    // SimpleMbedCloudClient initialization must be successful.
+    test_case_start("Initialize Simple PDMC", 4);
+
+    SimpleMbedCloudClient client(net, &sd, &fs);
+    int client_status = client.init();
+
+    // Report status to console.
+    if (client_status == 0) {
+        logger("[INFO] Simple PDMC initialization successful.\r\n");
+    } else {
+        logger("[ERROR] Simple PDMC failed to initialize.\r\n");
+        // End the test early, cannot continue without successful cloud client initialization.
+        test_failed();
+    }
+
+    test_case_finish("Initialize Simple PDMC", iteration + (client_status == 0), (client_status != 0));
+
+    //Create LwM2M resources
+    MbedCloudClientResource *res_get_test;
+    res_get_test = client.create_resource("5000/0/1", "get_resource");
+    res_get_test->observable(true);
+    res_get_test->methods(M2MMethod::GET);
+    res_get_test->set_value("test0");
+
+    // Register to Pelion Device Management.
+    if (iteration == 0) {
+        test_case_start("Pelion Bootstrap & Reg.", 5);
+    } else {
+        test_case_start("Pelion Re-register", 10);
+    }
+    // Set client callback to report endpoint name.
+    client.on_registered(&registered);
+    client.register_and_connect();
+
+    i = 600; // wait 60 seconds
+    while (i-- > 0 && !client.is_client_registered()) {
+        wait_ms(100);
+    }
+
+    // Get registration status.
+    bool client_registered = client.is_client_registered();
+    if (client_registered) {
+        client_status = 0;
+        wait_nb(100);
+        logger("[INFO] Device successfully registered to Pelion DM.\r\n");
+    } else {
+        client_status = -1;
+        logger("[ERROR] Device failed to register.\r\n");
+        test_failed();
+    }
+    if (iteration == 0) {
+        test_case_finish("Pelion Bootstrap & Reg.", (client_status == 0), (client_status != 0));
+    } else {
+        test_case_finish("Pelion Re-register", (client_status == 0), (client_status != 0));
+    }
+
+    if (iteration == 0) {
+        //Start registration status test
+        test_case_start("Pelion Directory", 6);
+        int reg_status;
+
+        logger("[INFO] Wait up to 10 seconds for Device Directory to update after initial registration.\r\n");
+        i = 100;
+        while (i-- > 0 and !endpointInfo) {
+            wait(100);
+        }
+
+        // Start host tests with device id
+        logger("[INFO] Starting Pelion verification using Python SDK...\r\n");
+        greentea_send_kv("verify_registration", endpointInfo->internal_endpoint_name.c_str());
+        while (1) {
+            greentea_parse_kv(_key, _value, sizeof(_key), sizeof(_value));
+
+            if (strcmp(_key, "registered") == 0) {
+                if (atoi(_value)) {
+                    reg_status = 0;
+                    logger("[INFO] Device is registered in the Device Directory.\r\n");
+                } else {
+                    reg_status = -1;
+                    logger("[ERROR] Device could not be verified as registered in Device Directory.\r\n");
+                    test_failed();
+                }
+                break;
+            }
+        }
+
+        test_case_finish("Pelion Directory", (reg_status == 0), (reg_status != 0));
+
+        if (reg_status == 0) {
+            test_case_start("Pelion Firmware Prepare", 7);
+            wait_nb(500);
+            int fw_status;
+            greentea_send_kv("firmware_prepare", 1);
+            while (1) {
+                greentea_parse_kv(_key, _value, sizeof(_key), sizeof(_value));
+                if (strcmp(_key, "firmware_sent") == 0) {
+                    if (atoi(_value)) {
+                        fw_status = 0;
+                    } else {
+                        fw_status = -1;
+                        logger("[ERROR] While preparing firmware.\r\n");
+                    }
+                    break;
+                }
+            }
+            test_case_finish("Pelion Firmware Prepare", (fw_status == 0), (fw_status != 0));
+
+            test_case_start("Pelion Firmware Download", 8);
+            logger("[INFO] Update campaign has started.\r\n");
+            // The device should download firmware and reset at this stage
+        }
+
+        while (1) {
+            wait_nb(1000);
+        }
+    } else {
+        //Start consistent identity test.
+        test_case_start("Post-update Identity", 12);
+        int identity_status;
+
+        logger("[INFO] Wait up to 5 seconds for Device Directory to update after reboot.\r\n");
+        i = 50;
+        while (i-- > 0 and !endpointInfo) {
+            wait(100);
+        }
+
+        // Wait for Host Test to verify consistent device ID (blocking here)
+        logger("[INFO] Verifying consistent Device ID...\r\n");
+        greentea_send_kv("verify_identity", endpointInfo->internal_endpoint_name.c_str());
+        while (1) {
+            greentea_parse_kv(_key, _value, sizeof(_key), sizeof(_value));
+
+            if (strcmp(_key, "verified") == 0) {
+                if (atoi(_value)) {
+                    identity_status = 0;
+                    logger("[INFO] Device ID consistent, SOTP and Secure Storage is preserved correctly.\r\n");
+                } else {
+                    identity_status = -1;
+                    logger("[ERROR] Device ID is inconsistent. SOTP and Secure Storage was not preserved.\r\n");
+                }
+                break;
+            }
+        }
+
+        test_case_finish("Post-update Identity", (identity_status == 0), (identity_status != 0));
+
+        GREENTEA_TESTSUITE_RESULT(identity_status == 0);
+
+        while (1) {
+            wait(100);
+        }
+    }
+}
+
+int main(void) {
+    //Create a thread to blink an LED and signal that the device is alive
+#if !defined(MBED_CONF_APP_NO_LED)
+    Ticker t;
+    t.attach(led_thread, 0.5);
+#endif
+
+    greentea_send_kv("device_booted", 1);
+
+    GREENTEA_SETUP(test_timeout, "sdk_host_tests");
+    spdmc_testsuite_update();
+
+    return 0;
+}