utest_greentea_handlers.cpp

00001 /****************************************************************************
00002  * Copyright (c) 2015, ARM Limited, All Rights Reserved
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License"); you may
00006  * not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00013  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  ****************************************************************************
00017  */
00018 
00019 #include "utest/utest_default_handlers.h"
00020 #include "utest/utest_case.h"
00021 #include "greentea-client/test_env.h"
00022 #include "utest/utest_stack_trace.h"
00023 #include "utest/utest_serial.h"
00024 #include "mbed_stats.h"
00025 
00026 using namespace utest::v1;
00027 
00028 static void selftest_failure_handler(const failure_t);
00029 static void test_failure_handler(const failure_t);
00030 
00031 
00032 const handlers_t utest::v1::greentea_abort_handlers = {
00033     default_greentea_test_setup_handler,
00034     greentea_test_teardown_handler,
00035     test_failure_handler,
00036     greentea_case_setup_handler,
00037     greentea_case_teardown_handler,
00038     greentea_case_failure_abort_handler
00039 };
00040 
00041 const handlers_t utest::v1::greentea_continue_handlers = {
00042     default_greentea_test_setup_handler,
00043     greentea_test_teardown_handler,
00044     test_failure_handler,
00045     greentea_case_setup_handler,
00046     greentea_case_teardown_handler,
00047     greentea_case_failure_continue_handler
00048 };
00049 
00050 const handlers_t utest::v1::selftest_handlers = {
00051     default_greentea_test_setup_handler,
00052     greentea_test_teardown_handler,
00053     selftest_failure_handler,
00054     greentea_case_setup_handler,
00055     greentea_case_teardown_handler,
00056     greentea_case_failure_continue_handler
00057 };
00058 
00059 
00060 // --- SPECIAL HANDLERS ---
00061 
00062 static void selftest_failure_handler(const failure_t failure) {
00063     UTEST_LOG_FUNCTION();
00064     if (failure.location == LOCATION_TEST_SETUP || failure.location == LOCATION_TEST_TEARDOWN || failure.reason == REASON_ASSERTION) {
00065         verbose_test_failure_handler(failure);
00066     }
00067     if (failure.reason == REASON_ASSERTION) {
00068         UTEST_DUMP_TRACE
00069         GREENTEA_TESTSUITE_RESULT(false);
00070         while(1) ;
00071     }
00072 }
00073 
00074 static void test_failure_handler(const failure_t failure) {
00075     UTEST_LOG_FUNCTION();
00076     if (failure.location == LOCATION_TEST_SETUP || failure.location == LOCATION_TEST_TEARDOWN) {
00077         verbose_test_failure_handler(failure);
00078         GREENTEA_TESTSUITE_RESULT(false);
00079         while(1) ;
00080     }
00081 }
00082 
00083 // --- GREENTEA HANDLERS ---
00084 
00085 void utest::v1::greentea_testcase_notification_handler(const char *testcase)
00086 {
00087     UTEST_LOG_FUNCTION();
00088     greentea_send_kv(GREENTEA_TEST_ENV_TESTCASE_NAME, testcase);
00089 }
00090 
00091 utest::v1::status_t utest::v1::default_greentea_test_setup_handler(const size_t number_of_cases)
00092 {
00093     UTEST_LOG_FUNCTION();
00094     GREENTEA_SETUP(UTEST_DEFAULT_GREENTEA_TIMEOUT, UTEST_DEFAULT_HOST_TEST_NAME);
00095     return greentea_test_setup_handler(number_of_cases);
00096 }
00097 
00098 
00099 utest::v1::status_t utest::v1::greentea_test_setup_handler(const size_t number_of_cases)
00100 {
00101     UTEST_LOG_FUNCTION();
00102     greentea_send_kv(TEST_ENV_TESTCASE_COUNT, number_of_cases);
00103     return verbose_test_setup_handler(number_of_cases);
00104 }
00105 
00106 void utest::v1::greentea_test_teardown_handler(const size_t passed, const size_t failed, const failure_t failure)
00107 {
00108     UTEST_LOG_FUNCTION();
00109     mbed_stats_heap_t heap_stats;
00110     verbose_test_teardown_handler(passed, failed, failure);
00111     mbed_stats_heap_get(&heap_stats);
00112     greentea_send_kv("max_heap_usage",heap_stats.max_size);
00113     greentea_send_kv(TEST_ENV_TESTCASE_SUMMARY, passed, failed);
00114     int result = !(failed || (failure.reason && !(failure.reason & REASON_IGNORE)));
00115     GREENTEA_TESTSUITE_RESULT(result);
00116 }
00117 
00118 void utest::v1::greentea_test_failure_handler(const failure_t failure)
00119 {
00120     UTEST_LOG_FUNCTION();
00121     verbose_test_failure_handler(failure);
00122 }
00123 
00124 // --- GREENTEA CASE HANDLERS ---
00125 utest::v1::status_t utest::v1::greentea_case_setup_handler(const Case *const source, const size_t index_of_case)
00126 {
00127     UTEST_LOG_FUNCTION();
00128     utest::v1::status_t status = verbose_case_setup_handler(source, index_of_case);
00129     greentea_send_kv(TEST_ENV_TESTCASE_START, source->get_description ());
00130     return status;
00131 }
00132 
00133 utest::v1::status_t utest::v1::greentea_case_teardown_handler(const Case *const source, const size_t passed, const size_t failed, const failure_t failure)
00134 {
00135     UTEST_LOG_FUNCTION();
00136     greentea_send_kv(TEST_ENV_TESTCASE_FINISH, source->get_description (), passed, failed);
00137     return verbose_case_teardown_handler(source, passed, failed, failure);
00138 }
00139 
00140 utest::v1::status_t utest::v1::greentea_case_failure_abort_handler(const Case *const source, const failure_t failure)
00141 {
00142     UTEST_LOG_FUNCTION();
00143     utest::v1::status_t status = verbose_case_failure_handler(source, failure);
00144     return (status == STATUS_IGNORE) ? STATUS_IGNORE : STATUS_ABORT;
00145 }
00146 
00147 utest::v1::status_t utest::v1::greentea_case_failure_continue_handler(const Case *const source, const failure_t failure)
00148 {
00149     UTEST_LOG_FUNCTION();
00150     return verbose_case_failure_handler(source, failure);
00151 }