acts_tests/tests/google/tel/lab/TelLabGFTInOutServiceTest.py

#!/usr/bin/env python3
#
#   Copyright 2021 - The Android Open Source Project
#
#   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.


import time
import datetime
import logging

from acts import asserts
from acts.test_decorators import test_info
from acts.test_decorators import test_tracker_info

from acts.base_test import BaseTestClass
from acts_contrib.test_utils.tel.TelephonyBaseTest import TelephonyBaseTest
from acts_contrib.test_utils.tel.GFTInOutBaseTest import GFTInOutBaseTest

from acts_contrib.test_utils.tel.tel_test_utils import get_service_state_by_adb
from acts_contrib.test_utils.tel.tel_test_utils import multithread_func
from acts_contrib.test_utils.tel.tel_test_utils import run_multithread_func
from acts_contrib.test_utils.tel.tel_test_utils import ensure_wifi_connected
from acts_contrib.test_utils.tel.tel_test_utils import get_screen_shot_log
from acts_contrib.test_utils.tel.tel_test_utils import get_screen_shot_logs
from acts_contrib.test_utils.tel.tel_test_utils import log_screen_shot
from acts_contrib.test_utils.tel.tel_test_utils import hangup_call
from acts_contrib.test_utils.tel.tel_test_utils import active_file_download_test

from acts_contrib.test_utils.tel.tel_data_utils import wait_for_cell_data_connection
from acts_contrib.test_utils.tel.gft_inout_utils import check_no_service_time
from acts_contrib.test_utils.tel.gft_inout_utils import check_back_to_service_time
from acts_contrib.test_utils.tel.gft_inout_utils import mo_voice_call
from acts_contrib.test_utils.tel.gft_inout_utils import get_voice_call_type

from acts_contrib.test_utils.tel.tel_defines import DATA_STATE_CONNECTED
from acts_contrib.test_utils.tel.tel_defines import DATA_STATE_DISCONNECTED
from acts_contrib.test_utils.tel.tel_defines import SERVICE_STATE_EMERGENCY_ONLY
from acts_contrib.test_utils.tel.tel_defines import SERVICE_STATE_IN_SERVICE
from acts_contrib.test_utils.tel.tel_defines import SERVICE_STATE_UNKNOWN
from acts_contrib.test_utils.tel.tel_defines import SERVICE_STATE_OUT_OF_SERVICE
from acts_contrib.test_utils.tel.tel_defines import SERVICE_STATE_POWER_OFF

from acts_contrib.test_utils.tel.gft_inout_defines import VOICE_CALL
from acts_contrib.test_utils.tel.gft_inout_defines import VOLTE_CALL
from acts_contrib.test_utils.tel.gft_inout_defines import CSFB_CALL
from acts_contrib.test_utils.tel.gft_inout_defines import WFC_CALL
from acts_contrib.test_utils.tel.gft_inout_defines import NO_SERVICE_POWER_LEVEL
from acts_contrib.test_utils.tel.gft_inout_defines import IN_SERVICE_POWER_LEVEL
from acts_contrib.test_utils.tel.gft_inout_defines import NO_SERVICE_AREA
from acts_contrib.test_utils.tel.gft_inout_defines import IN_SERVICE_AREA
from acts_contrib.test_utils.tel.gft_inout_defines import WIFI_AREA
from acts_contrib.test_utils.tel.gft_inout_defines import NO_WIFI_AREA
from acts_contrib.test_utils.tel.gft_inout_defines import NO_SERVICE_TIME
from acts_contrib.test_utils.tel.gft_inout_defines import WAIT_FOR_SERVICE_TIME


IDLE_CASE = 1
DATA_TRANSFER_CASE = 2
PDP_OFF_CASE = 3
IN_CALL_CASE = 4
CALL_DATA_CASE = 5

class TelLabGFTInOutServiceTest(GFTInOutBaseTest):
    def __init__(self, controllers):
        GFTInOutBaseTest.__init__(self, controllers)
        self.my_error_msg = ""

    def setup_test(self):
        self.adjust_cellular_signal(IN_SERVICE_POWER_LEVEL)
        self.adjust_wifi_signal(IN_SERVICE_POWER_LEVEL)
        GFTInOutBaseTest.setup_test(self)
        self.check_network()
        self.my_error_msg = ""


    @test_tracker_info(uuid="c602e556-8273-4c75-b8fa-4d51ba514654")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_idle_1min(self, idle_time=60):
        """ UE is in idle
            Move UE from coverage area to no service area and UE shows no service
            Wait for 1 min, then re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time)

    @test_tracker_info(uuid="c602e556-8273-4c75-b8fa-4d51ba514654")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_idle_2min(self, idle_time=120):
        """ UE is in idle
            Move UE from coverage area to no service area and UE shows no service
            Wait for 2 min, then re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time)


    @test_tracker_info(uuid="1d437482-caff-4695-9f3f-f3daf6793540")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_idle_5min(self, idle_time=300):
        """ UE is in idle
            Move UE from coverage area to no service area and UE shows no service
            Wait for 5 min, then re-enter coverage area

            Args:
                loop: cycle
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time)

    @test_tracker_info(uuid="339b4bf5-57a1-48f0-b26a-83a7db21b08b")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_idle_10min(self, idle_time=600):
        """ UE is in idle
            Move UE from coverage area to no service area and UE shows no service
            Wait for 10 min, then re-enter coverage area

            Args:
                loop: cycle
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time)


    @test_tracker_info(uuid="65ebac02-8d5a-48c2-bd26-6d931d6048f1")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_data_transfer_1min(self, idle_time=60):
        """ In/Out service - Stationary data transfer - 1 min
            UE is performing data transfer (E.g. Use FTP or browse tools)
            move UE from coverage area to no service area and UE shows no service
            Wait for 1 min, then re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, DATA_TRANSFER_CASE)


    @test_tracker_info(uuid="ec3e7de4-bcf6-4a8a-ae04-868bd7925191")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_data_transfer_2min(self, idle_time=120):
        """ In/Out service - Stationary data transfer - 2 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, DATA_TRANSFER_CASE)


    @test_tracker_info(uuid="8bd7017d-0a88-4423-a94b-1e37060bba1d")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_data_transfer_5min(self, idle_time=300):
        """ In/Out service - Stationary data transfer - 5 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, DATA_TRANSFER_CASE)


    @test_tracker_info(uuid="c3b9c52d-41d3-449c-99ff-4bb830ca0219")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_no_service_data_transfer_10min(self, idle_time=600):
        """ In/Out service - Stationary data transfer - 10 min

            Args:
                idle_time: idle time in service area
                file_name: download filename

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, DATA_TRANSFER_CASE)


    @test_tracker_info(uuid="86a6b3b3-e754-4bde-b418-d4273b1ad907")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_incall_1min(self, idle_time=60):
        """ In/Out service - Stationary incall - 1 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, IN_CALL_CASE)


    @test_tracker_info(uuid="0f8772cd-6f86-48eb-b583-4cbaf80a21a9")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_incall_2min(self, idle_time=120):
        """ In/Out service - Stationary incall - 2 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, IN_CALL_CASE)


    @test_tracker_info(uuid="11f24c0f-db33-4eb3-b847-9aed447eb820")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_incall_5min(self, idle_time=300):
        """ In/Out service - Stationary incall - 5 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, IN_CALL_CASE)


    @test_tracker_info(uuid="e318921b-de6b-428b-b2c4-3db7786d7558")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_incall_10min(self, idle_time=600):
        """ In/Out service - Stationary incall - 10 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, IN_CALL_CASE)


    @test_tracker_info(uuid="f6cf0019-e123-4ebd-990b-0fa5b236840c")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_call_date_1min(self, idle_time=60):
        """ In/Out service - Stationary incall + data transfer - 1 mins

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, CALL_DATA_CASE)


    @test_tracker_info(uuid="2f49a9de-0383-4ec6-a8ee-c62f52ea0cf2")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_call_date_2min(self, idle_time=120):
        """ In/Out service - Stationary incall + data transfer - 2 mins

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, CALL_DATA_CASE)


    @test_tracker_info(uuid="73a6eedb-791f-4486-b815-8067a95efd5c")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_call_date_5min(self, idle_time=300):
        """ In/Out service - Stationary incall + data transfer - 5 mins

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, CALL_DATA_CASE)

    @test_tracker_info(uuid="5cfbc90a-97e1-43e9-a69e-4ce2815c544d")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_call_date_10min(self, idle_time=600):
        """ In/Out service - Stationary incall + data transfer - 10 mins

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, CALL_DATA_CASE)



    @test_tracker_info(uuid="c70180c9-5a36-4dc5-9ccc-3e6c0b5e6d37")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_pdp_off_1min(self, idle_time=60):
        """ In/Out service - Stationary data off - 1 min
            Disable UE mobile data
            Move UE from coverage area to no service area and UE shows no service
            Wait for 1 min, then re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, PDP_OFF_CASE)


    @test_tracker_info(uuid="50cc8e73-d96f-45a6-91cd-bf51de5241d2")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_pdp_off_2min(self, idle_time=120):
        """ In/Out service - Stationary data off - 2 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, PDP_OFF_CASE)


    @test_tracker_info(uuid="1f25d40c-1bfe-4d18-b57c-d7be69664f0d")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_pdp_off_5min(self, idle_time=300):
        """ In/Out service - Stationary data off - 5 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, PDP_OFF_CASE)


    @test_tracker_info(uuid="b076b0d0-a105-4be9-aa0b-db0d782f70f2")
    @TelephonyBaseTest.tel_test_wrap
    def test_in_out_service_pdp_off_10min(self, idle_time=600):
        """ In/Out service - Stationary data off - 10 min

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        return self._test_in_out_service_idle(idle_time, PDP_OFF_CASE)



    def _test_in_out_service_idle(self, idle_time, case= IDLE_CASE, loop=1):
        """ UE is in idle
            Move UE from coverage area to no service area and UE shows no service
            Args:
                idle_time: idle time in service area
                case: include IDLE_CAS, DATA_TRANSFER_CASE, PDP_OFF_CASE,
                    IN_CALL_CASE, CALL_DATA_CASE
                loop: cycle
            Returns:
                True if pass; False if fail.
        """
        test_result = True
        if 'autoio_cycle' in self.user_params:
            loop = self.user_params.get('autoio_cycle')

        for x in range (loop):
            self.log.info("%s loop: %s/%s" %(self.current_test_name,x+1, loop))
            if case == IDLE_CASE:
                if not self._in_out_service_idle_only(idle_time):
                    test_result = False
            elif case == DATA_TRANSFER_CASE:
                if not self._data_transfer_mode(idle_time):
                    test_result = False
            elif case == PDP_OFF_CASE:
                if not self._in_out_service_pdp_off(idle_time):
                    test_result = False
            elif case == IN_CALL_CASE:
                if not self._in_call_in_out_service(idle_time):
                    test_result = False
            elif case == CALL_DATA_CASE:
                if not self._call_data_in_out_service(idle_time):
                    test_result = False
            asserts.assert_true(test_result, "Fail: %s." %(self.my_error_msg),
                extras={"failure_cause": self.my_error_msg})
        return test_result


    def _in_out_service_idle_only(self, no_service_time=60, check_back_to_service=True,
        check_no_service=True):
        """ Move UE from coverage area to no service area and UE shows no service
            Wait for no_service_time sec , then re-enter coverage area

            Args:
                no_service_time: stay at no service area time in sec
                check_back_to_service: check device is back to service flag
                check_no_service: check device is no service flag

            Returns:
                True if pass; False if fail.
        """
        test_result = True
        error_msg = ""
        for ad in self.android_devices:
            network_type = ad.droid.telephonyGetNetworkType()
            service_state = get_service_state_by_adb(self.log,ad)
            ad.log.info("service_state=%s. network_type=%s"
                %(service_state ,network_type))
            if service_state != SERVICE_STATE_IN_SERVICE:
                error_msg = "Device is not ready for test. Service_state=%s." %(service_state)
                ad.log.info("Device is not ready for test. Service_state=%s." %(service_state))
                self.my_error_msg += error_msg
                return False

        self.log.info("Move UE from coverage area to no service area")
        self.adjust_cellular_signal(NO_SERVICE_POWER_LEVEL)

        if check_no_service:
            tasks = [(check_no_service_time, (ad, )) for ad in self.android_devices]
            if not multithread_func(self.log, tasks):
                self.check_network()
                error_msg = "Device does not become no service"
                self.my_error_msg += error_msg
                self.log.info(error_msg)
                return False
            else:
                self.log.info("wait for %s sec in no/limited service area" %(no_service_time))
                time.sleep(no_service_time)
        self.log.info("Move UE back to service area")
        self.adjust_cellular_signal(IN_SERVICE_POWER_LEVEL)
        if check_back_to_service:
            test_result = self._check_after_no_service()
        return test_result

    def _data_transfer_mode(self, idle_time, file_name="10MB"):
        """ Download file and in/out service

            Args:
                idle_time: stay at no service area time in sec
                file_name: file to be download

            Returns:
                True if pass; False if fail.
        """
        error_msg =""
        tasks_a = [(self._in_out_service_idle_only, (idle_time, False,))]
        tasks_b = [(active_file_download_test, (self.log, ad, file_name))
            for ad in self.android_devices]
        tasks_b.extend(tasks_a)
        if not multithread_func(self.log, tasks_b):
            error_msg = " data transfer fail. "
            self.my_error_msg +=  error_msg
            self.log.info(error_msg)
            return False
        return self._check_after_no_service()

    def _in_out_service_pdp_off(self, idle_time):
        """ UE is in idle
            Disable UE mobile data
            Move UE from coverage area to no/limited service area
            enable UE mobile data
            After UE show no service, re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        error_msg =""
        for ad in self.android_devices:
            ad.log.info("Turn off mobile data")
            ad.droid.telephonyToggleDataConnection(False)
            if not wait_for_cell_data_connection(self.log, ad, False):
                self.my_error_msg += "fail to turn off mobile data"
                return False

        if not self._in_out_service_idle_only(idle_time, False):
            return False

        for ad in self.android_devices:
            ad.log.info("Turn on mobile data")
            ad.droid.telephonyToggleDataConnection(True)
            #If True, it will wait for status to be DATA_STATE_CONNECTED
            if not wait_for_cell_data_connection(self.log, ad, True):
                self.my_error_msg += "fail to turn on mobile data"
                return False
        return self._check_after_no_service()

    def _in_call_in_out_service(self, idle_time):
        """ UE is in call
            Move UE from coverage area to no/limited service area
            After UE show no service, re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        error_msg = ""
        tasks = [(mo_voice_call, (self.log, ad, VOICE_CALL, False)) for ad in self.android_devices]
        if not multithread_func(self.log, tasks):
            error_msg = "MO voice call fail"
            self.my_error_msg += error_msg
            self.log.info(error_msg)
            return False

        if not self._in_out_service_idle_only(idle_time, False):
            return False
        return self._check_after_no_service()

    def _call_data_in_out_service(self, idle_time):
        """ UE is performing data transfer (E.g. Use FTP or browse tools)
            UE makes a MO call
            Move UE from coverage area to no/limited service area
            After UE show no service, re-enter coverage area

            Args:
                idle_time: idle time in service area

            Returns:
                True if pass; False if fail.
        """
        tasks_a = [(active_file_download_test, (self.log, ad, )) for ad in self.android_devices]
        tasks_b= [(mo_voice_call, (self.log, ad, VOICE_CALL, False)) for ad in self.android_devices]
        tasks_b.extend(tasks_a)
        if not multithread_func(self.log, tasks_b):
            error_msg = "fail to perfrom data transfer/voice call"
            self.my_error_msg += error_msg
            return False

        if not self._in_out_service_idle_only(idle_time, False):
            return False
        return self._check_after_no_service()

    def _check_after_no_service(self):
        """ check device is back to service or not

            Returns:
                True if pass; False if fail.
        """
        tasks = [(check_back_to_service_time, (ad,)) for ad in self.android_devices]
        if not multithread_func(self.log, tasks):
            error_msg = "Device is not back to the service"
            self.my_error_msg += error_msg
            self.log.info(error_msg)
            return False
        return True