###########################################################################
#
# Copyright (c) 2019-2021 Diality Inc. - All Rights Reserved.
#
# THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
# WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
#
# @file    utils.py
#
# @author  (last)      Joseph varghese
# @date    (last)      15-Jan-2022
#
############################################################################

import builtins
import names
import os
import csv
import glob
import object
import sys
import test
import time
import squish
from configuration import config
from builtins import int as pyInt
    
    
def get_bullet_object(screen_obj, num):
    """
        To obtain a bullet object based on occurrence provided.
        @param screen_obj: provides the container on which the bullet must be present
        @param num: provides the occurrence value 
        @returns a real name object
    """     
    names.o_bullet_object["container"] = screen_obj
    names.o_bullet_object["occurrence"] = num + 1
    return names.o_bullet_object  
    

def  get_indicators(screen_obj, txt):
    """
        Verifying the busy indicators for BiCarb Pump Check and Acid Pump Check.
        indicator object of expected text
        @param step - (str) expected text
        @return indicators - (obj) list of busy and check indicator
    """
    parent_obj = object.parent(squish.waitForObjectExists(get_text_object(screen_obj,txt)))
    children_obj = object.children(parent_obj)
    indicator_parent = children_obj[2]
    indicators = object.children(indicator_parent)
    return indicators


def check_if_object_is_within_the_container(obj=None, container=None):
    """
    check if an object is inside a container
    @param obj - child UI object
    @param container - container UI object
    @return boolean true and false
    """
    container = squish.findObject(container)
    containerPos = container.mapToGlobal(squish.QPoint(0, 0))
    container_x, container_y = pyInt(containerPos.x), pyInt(containerPos.y)
    container_width, container_height = pyInt(container.width), pyInt(container.height)
     
    obj = squish.findObject(obj)
    objPos = obj.mapToGlobal(squish.QPoint(0, 0))
    obj_x, obj_y = pyInt(objPos.x), pyInt(objPos.y)
    obj_width, obj_height = pyInt(obj.width), pyInt(obj.height)
     
    if obj_x >= container_x and obj_y >= container_y:
        if (obj_x + obj_width) <= (container_x + container_width) and (obj_y + obj_height) <= (container_y + container_height):
            return True
         
    return False


def scroll_to_zone(zone=None, screen_object=None, direction = None):
    """
        scroll to the UI, if object is hidden
        @param zone - object to be find out.
        @param screen_object - object of the screen.
        @return boolean
    """
    counter = 0
    while counter <= 100:
        try:
            counter += 1
            squish.snooze(0.5)
            squish.findObject(zone)
            squish.snooze(0.5)
            if check_if_object_is_within_the_container(obj=zone, container=screen_object):
                return True
            else:
                raise RuntimeError
        except RuntimeError:
            ScreenObj = squish.findObject(screen_object)
            screenHeight = pyInt(ScreenObj.height)
            screenWidth = pyInt(ScreenObj.width)
            if direction is None:
                squish.mouseWheel(ScreenObj, (screenWidth-100),
                107, 0, -(screenHeight-460), squish.Qt.NoModifier)
            else:
                squish.mouseWheel(ScreenObj, (screenWidth-100),
                -(screenHeight-700), 0, 50, squish.Qt.NoModifier)
                
    raise LookupError("zone object is not in view to the user after " + \
             "trying 100 times")    


def convert_seconds_into_min_and_sec(seconds, time_format="%M:%S"):
    """
        Method to convert seconds into minute format.
        @param seconds - time in seconds.
        @param time_format (str) - time format.
        @return (int) - minute time
    """
    seconds = builtins.int(seconds)
    min_and_sec = time.strftime(time_format, time.gmtime(seconds))
    return min_and_sec



def get_extracted_file():
    """
    This function is the handler for getting file from log folder. 
    
    This handler will go inside log folder and looks for newly added log based on current time. 
    if it satisfied that condition, it will return the exact path of newly created log. 
    
    @return latest_file - (string) returns latest file that append on log folder from sd-data
    """
    try:
        list_of_files = glob.glob(config.TREATMENT_LOG_LOCATION)
        latest_file = max(list_of_files, key=os.path.getctime)
        return latest_file
    except:
        test.fail("log file is not created during application interaction")
        return False


def get_text_object(screen_obj, txt):
    """
        To obtain a text object based on text provided
        @param screen_obj: provides the container on which the txt must be present 
        @returns a real name object
    """         
    names.o_text_object["container"] = screen_obj
    names.o_text_object["text"] = txt
    return names.o_text_object

    
def get_bullet_object(screen_obj, num):
    """
        To obtain a bullet object based on occurrence provided.
        @param screen_obj: provides the container on which the bullet must be present
        @param num: provides the occurrence value 
        @returns a real name object
    """     
    names.o_bullet_object["container"] = screen_obj
    names.o_bullet_object["occurrence"] = num + 1
    return names.o_bullet_object  
    

def  get_indicators(screen_obj, txt):
    """
        Verifying the busy indicators for BiCarb Pump Check and Acid Pump Check.
        indicator object of expected text
        @param step - (str) expected text
        @return indicators - (obj) list of busy and check indicator
    """
    parent_obj = object.parent(squish.waitForObjectExists(get_text_object(screen_obj,txt)))
    children_obj = object.children(parent_obj)
    indicator_parent = children_obj[2]
    indicators = object.children(indicator_parent)
    return indicators


def verify_missing_object(object_to_check):
    """ 
    Method to verify the given object is invisible or is not present on the screen
    @param object_to_check: the object whose invisibility must be verified
    """    
    try:
        squish.testSettings.objectNotFoundDebugging = False
        squish.waitForObject(object_to_check,3000)
        test.fail("Given object should not be present initially")
    except LookupError as _:
        test.passes("object is not present as expected")
        
    squish.testSettings.objectNotFoundDebugging = True   
    
    
def verify_page_step_indicator_post_treatment(screen_obj, post_treatment_step):
    """    
        Method to verify the Page Step indicators [the object on top of the screen which indicates the steps passed, current, remained]
        @param pre_treatment_step : indicates the Current pre-treatment step 
    """  
    test.startSection("verification of page step indicators")
    for page in range(len(config.POST_TREATMENT_SCREENS)):
        bullet_children = object.children(squish.waitForObjectExists(get_bullet_object(screen_obj, page)))
        bullet_circle_color = bullet_children[0].color.name 
        bullet_border_color = bullet_children[0].border.color.name
        step_title =  squish.waitForObjectExists(get_text_object(screen_obj, config.POST_TREATMENT_SCREENS[page])) 
        
        if page < post_treatment_step:
            test.log("To verify the step indicator of the completed post-treatment screen " + config.POST_TREATMENT_SCREENS[page]) 
            test.verify(squish.waitForObjectExists(get_bullet_object(screen_obj, page)).complete)
            test.verify(not squish.waitForObjectExists(get_bullet_object(screen_obj, page)).current)
            test.compare(bullet_circle_color, config.COMPLETE_COLOR, " the bullet color must be " + str(config.COMPLETE_COLOR))
            test.compare(bullet_border_color, config.COMPLETE_COLOR," the bullet border color must be " + str(config.COMPLETE_COLOR)) 
            test.compare(step_title.color.name, config.ENABLED_COLOR, " the text color must be " + str(config.ENABLED_COLOR))

        elif page == post_treatment_step:
            test.log("To verify the step indicators of the current post-treatment screen " + config.POST_TREATMENT_SCREENS[page]) 
            test.verify(squish.waitForObjectExists(get_bullet_object(screen_obj, page)).current)
            test.verify(not squish.waitForObjectExists(get_bullet_object(screen_obj, page)).complete)
            test.compare(bullet_circle_color,config.CURRENT_COLOR," the bullet color must be " + str(config.CURRENT_COLOR))
            test.compare(bullet_border_color,config.COMPLETE_COLOR, " the bullet border color must be " + str(config.COMPLETE_COLOR))
            test.compare(step_title.color.name,config.ENABLED_COLOR, " the text color must be " + str(config.ENABLED_COLOR))
            test.verify(step_title.font.bold, " the current text must be in bold")  

        else:
            test.log("To verify the step indicators of the remaining post-treatment screen " + config.POST_TREATMENT_SCREENS[page])
            test.verify(not squish.waitForObjectExists(get_bullet_object(screen_obj, page)).current,)
            test.verify(not squish.waitForObjectExists(get_bullet_object(screen_obj, page)).complete,)
            test.compare(step_title.color.name,config.INCOMPLETE_COLOR, " the text color must be " + str(config.INCOMPLETE_COLOR))
            test.compare(bullet_circle_color,config.CURRENT_COLOR," the bullet color must be " + str(config.CURRENT_COLOR)) 
            test.compare(bullet_border_color,config.INCOMPLETE_COLOR, " the bullet border color must be " + str(config.INCOMPLETE_COLOR))
    test.endSection()