YiWebDriver.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_WEBDRIVER_H_
#define _YI_WEBDRIVER_H_

#include "framework/YiPredef.h"
#include "scenetree/YiSceneManager.h"
#include "signal/YiSignal.h"
#include "signal/YiSignalHandler.h"
#include "utility/YiRapidJSONUtility.h"
#include "utility/YiString.h"
#include "utility/YiTimer.h"
#include "view/YiSceneView.h"
#include "view/YiScrollingView.h"

class CYIKeyEvent;
class CYIAppiumTCPServer;
class CYIWebDriverPriv;

class CYIWebDriver : public CYISignalHandler
{
public:
    CYIWebDriver();
    virtual ~CYIWebDriver();

    void Start();

    /*
     \details
     https://github.com/SeleniumHQ/selenium/blob/master/py/selenium/webdriver/remote/errorhandler.py

     """
     Error codes defined in the WebDriver wire protocol.
     """
     # Keep in sync with org.openqa.selenium.remote.ErrorCodes and errorcodes.h
     SUCCESS = 0
     NO_SUCH_ELEMENT = [7, 'no such element']
     NO_SUCH_FRAME = [8, 'no such frame']
     UNKNOWN_COMMAND = [9, 'unknown command']
     STALE_ELEMENT_REFERENCE = [10, 'stale element reference']
     ELEMENT_NOT_VISIBLE = [11, 'element not visible']
     INVALID_ELEMENT_STATE = [12, 'invalid element state']
     UNKNOWN_ERROR = [13, 'unknown error']
     ELEMENT_IS_NOT_SELECTABLE = [15, 'element not selectable']
     JAVASCRIPT_ERROR = [17, 'javascript error']
     XPATH_LOOKUP_ERROR = [19, 'invalid selector']
     TIMEOUT = [21, 'timeout']
     NO_SUCH_WINDOW = [23, 'no such window']
     INVALID_COOKIE_DOMAIN = [24, 'invalid cookie domain']
     UNABLE_TO_SET_COOKIE = [25, 'unable to set cookie']
     UNEXPECTED_ALERT_OPEN = [26, 'unexpected alert open']
     NO_ALERT_OPEN = [27, 'no such alert']
     SCRIPT_TIMEOUT = [28, 'script timeout']
     INVALID_ELEMENT_COORDINATES = [29, 'invalid element coordinates']
     IME_NOT_AVAILABLE = [30, 'ime not available']
     IME_ENGINE_ACTIVATION_FAILED = [31, 'ime engine activation failed']
     INVALID_SELECTOR = [32, 'invalid selector']
     MOVE_TARGET_OUT_OF_BOUNDS = [34, 'move target out of bounds']
     INVALID_XPATH_SELECTOR = [51, 'invalid selector']
     INVALID_XPATH_SELECTOR_RETURN_TYPER = [52, 'invalid selector']
     METHOD_NOT_ALLOWED = [405, 'unsupported operation']
     */

    enum RESPONSE_STATUS
    {
        WEBDRIVER_SUCCESS                     = 0,
        WEBDRIVER_NO_SUCH_ELEMENT             = 7,
        WEBDRIVER_UNKNOWN_COMMAND             = 9,
        WEBDRIVER_STALE_ELEMENT_REFERENCE     = 10,
        WEBDRIVER_ELEMENT_NOT_VISIBLE         = 11,
        WEBDRIVER_INVALID_ELEMENT_STATE       = 12,
        WEBDRIVER_UNKNOWN_ERROR               = 13,
        WEBDRIVER_ELEMENT_IS_NOT_SELECTABLE   = 15,
        WEBDRIVER_NO_SUCH_WINDOW              = 23,
        WEBDRIVER_INVALID_SELECTOR            = 32
    };

private:
    static const int32_t LONG_PRESS_ACTION_DELAY = YI_LONG_PRESS_DELAY * 2;

    /*
     \details
     https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/Keys.html

     "Representations of pressable keys that aren't text."
     */
    enum WEB_DRIVER_KEY_CODE
    {
        NULL_KEY = 128,
        CANCEL,
        HELP,
        BACKSPACE,
        TAB,
        CLEAR,
        RETURN,
        ENTER,
        SHIFT,
        CONTROL,
        ALT,
        PAUSE,
        ESCAPE,
        SPACE,
        PAGE_UP,
        PAGE_DOWN,
        END,
        HOME,
        ARROW_LEFT,
        ARROW_UP,
        ARROW_RIGHT,
        ARROW_DOWN,
        INSERT,
        DELETE_KEY,
        SEMI_COLON,
        EQUALS,
        NUMPAD_0,
        NUMPAD_1,
        NUMPAD_2,
        NUMPAD_3,
        NUMPAD_4,
        NUMPAD_5,
        NUMPAD_6,
        NUMPAD_7,
        NUMPAD_8,
        NUMPAD_9,
        MULTIPLY,
        ADD,
        SEPARATOR,
        SUBTRACT,
        DECIMAL,
        DIVIDE,//169

        F1 = 177,
        F2,
        F3,
        F4,
        F5,
        F6,
        F7,
        F8,
        F9,
        F10,
        F11,
        F12,
        META,

        KEY_CODE_MAX
    };

    enum GET_NODE_STRATEGY
    {
         GET_NODE_BY_ID                       = 0,
         GET_NODE_BY_NAME,
         GET_NODE_BY_TYPE
    };

    enum ATTRIBUTE_TAG
    {
        ATTRIBUTE_BOOL,  //Attribute contains a bool
        ATTRIBUTE_FLOAT, //Attribute contains a float
        ATTRIBUTE_STRING,//Attribute contains a string
        ATTRIBUTE_NONE};
    
    struct AttributeValue
    {
        ATTRIBUTE_TAG etag;
        CYIString value;
        bool bValue;
        float fValue;

        AttributeValue() :
        etag(ATTRIBUTE_NONE),
        bValue(false),
        fValue(0)
        {
        }
    };

    struct SourceTreeFilter
    {
        CYIString attributeType;
        CYIString attributeValue;

        SourceTreeFilter()
        {
        }
    };

    /*
     \details Parses each key in \a keys into a CYIKeyEvent and adds it to \a rKeysOutput.
     */
    static std::vector<std::unique_ptr<CYIKeyEvent>> CreateWebDriverKeyEvents(const CYIString &keys);

    /*
     \details Returns a new CYIKeyEvent if \a eKey is a web driver key, otherwise returns null.
     */
    static std::unique_ptr<CYIKeyEvent> CreateWebDriverKeyEvent(WEB_DRIVER_KEY_CODE eKey);

    /*
     \details Helper method for GetWebDriverKeyEvent(std::vector<CYIKeyEvent *> &rKeysOutput, WEB_DRIVER_KEY_CODE eKey).
     Return a new CYIEvent::YI_KEY_DOWN with \a eKeyCode, and \a eKeyVaue.
     */
    static std::unique_ptr<CYIKeyEvent> CreateWebDriverKeyEvent(YI_KEY_CODE eKeyCode, YI_ASCII_CODE eKeyValue = YI_ASCII_NULL);

    /*
     \details Helper method for GetWebDriverKeyEvent(std::vector<CYIKeyEvent *> &rKeysOutput, WEB_DRIVER_KEY_CODE eKey).
     Returns a new CYIEvent::YI_KEY_INPUT event with the value of \a eKeyValue and CYIKeyEvent::KEY_LOCATION_NUMPAD.
     */
    static std::unique_ptr<CYIKeyEvent> CreateNumpadKeyEvent(YI_ASCII_CODE eKeyValue);

    /*
     \details Returns a new CYIEvent::YI_KEY_INPUT event with the value of \a key.
     */
    static std::unique_ptr<CYIKeyEvent> CreateSimpleKeyEvent(char32_t key);

    class LongPressGestureHandler : public CYISignalHandler
    {
    public:
        CYISignal<> LongPressComplete;
        LongPressGestureHandler();
        void Start(uint64_t uDelayLength);

        void SetDeltaCoords(const glm::vec3 &deltaCoords);
        void SetReleaseCoords(const glm::vec3 &releaseCoords);
        void SetDownCoords(const glm::vec3 &DownCoords);
        
        const glm::vec3 & GetDeltaCoords() const;
        const glm::vec3 & GetReleaseCoords() const;
        const glm::vec3 & GetDownCoords() const;
        
    private:
        CYITimer m_delayTimer;
        void OnTimeOut();
        
        glm::vec3 m_deltaCoords;
        glm::vec3 m_releaseCoords;
        glm::vec3 m_downCoords;

    };

    void ReceiveCommand(const CYIString &strCommand);
    void SendByteResponse(const std::vector<uint8_t> byteData);
    void SendStringResponse(const CYIString &strData) const;
    void GetSource();
    void RetrieveScreenshot();

    /*
    \details This will get the width and height of the app surface.
    
     The name comes from the WebDriver Wire Protocol and is meant to reflect the browser's window size. In Appium, it represents the app size.
    */
    void GetWindowSize();

    void RespondGetElementByStrategy(GET_NODE_STRATEGY eStrategy, const std::vector<CYIString> &strategyArguments);

    void RespondGetElementsByStrategy(GET_NODE_STRATEGY eStrategy, const std::vector<CYIString> &strategyArguments);

    std::list<CYISceneNode *> FindNodesByStrategy(GET_NODE_STRATEGY eStrategy, const CYIString &strategyValue, const CYIString &referenceAddress);

    void RespondGetAttribute(const std::vector<CYIString> &attributeArguments);

    RESPONSE_STATUS ValidateAttribute(const CYIString &attributeString);

    RESPONSE_STATUS FindNodeAttribute(const CYISceneNode *pNode, const CYIString &attributeString, AttributeValue &attributeValue) const;
   
    void ClickNode(const std::vector<CYIString> &args);

    void DoTap(const std::vector<CYIString> &args, bool bLongPress = false);

    void DoSwipe(const std::vector<CYIString> &args, bool bLongPress = false);

    void SetSourceTreeFilter(const std::vector<CYIString> &args);

    void SetTimeDilation(const std::vector<CYIString> &args);

    void ClearNode(const std::vector<CYIString> &
                       args);

    void RespondGetText(const std::vector<CYIString> &args);

    CYIString FindNodeText(const CYISceneNode *pNode) const;

    void SendKeys(const std::vector<CYIString> &args);

    void RespondElementEnabled(const std::vector<CYIString> &args);

    bool IsElementEnabled(const CYISceneNode *pNode) const;

    bool IsElementFullyDisplayed(const CYISceneNode *pNode) const;

    bool IsElementHittable(const CYISceneNode *pNode) const;

    bool IsScrolling(const CYIScrollingView *pScrollingView) const;

    bool CoordinatesCanHitNode(const CYISceneNode *pNode, const glm::vec3 &coordinates) const;

    const glm::vec3 GetHitCoordinates(const CYISceneNode *pNode) const;

    void RespondElementSelected(const std::vector<CYIString> &args);

    bool IsElementSelected(const CYISceneNode *pNode) const;

    void RespondElementDisplayed(const std::vector<CYIString> &args) const;

    bool IsElementDisplayed(const CYISceneNode *pNode) const;

    bool IsElementOnScreen(const CYISceneNode *pNode) const;

     /*
     \details Sends a response back to the client containing the size of the node in screen coordinates.
     
     Sends a WEBDRIVER_NO_SUCH_ELEMENT error response if the element ID cannot be found.
     */
    void RetrieveNodeSize(const std::vector<CYIString> &args) const;

    /*
     \details Sends a response back to the client containing the top left corner of the node in screen coordinates.
     
     Sends a WEBDRIVER_NO_SUCH_ELEMENT error response if the element ID cannot be found.
     */
    void RetrieveNodeLocation(const std::vector<CYIString> &args) const;

    // higher-level responses
    void SendSuccessResponse(yi::rapidjson::Document &responseObject) const;
    void SendSuccessResponse(const CYIString &returnValue) const;
    void SendSuccessResponse(bool returnValue) const;
    void SendSuccessResponse(float returnValue) const;
    void SendSuccessResponse() const;
    void SendErrorResponse(RESPONSE_STATUS errorStatus, const CYIString &errorMessage = CYIString()) const;

    std::list<CYISceneNode*> GetAllNodesWithStrategyValue(GET_NODE_STRATEGY eStrategy, const CYIString &strategyValue);

    std::list<CYISceneNode*> GetAllNodesWithStrategyValueFromParent(GET_NODE_STRATEGY eStrategy, const CYIString &strategyValue, CYISceneNode *pParentNode);

    CYIString GetViewTreeSource(const CYISceneNode *pSceneNode, int32_t nIndentLevel = 0) const;

    CYIString EscapeXMLText(CYIString unescapedText) const;

    CYISceneNode *GetNodeFromAddressString(const CYIString &argString) const;

    bool IsDescendantOf(const CYISceneNode *pNode, const CYISceneNode *pParent) const;
    
    CYIAABB GetNodeScreenRect(const CYISceneNode *pNode) const;

    CYIAABB GetNodeMeshScreenRect(const CYISceneNode *pNode) const;

    CYIAABB GetSurfaceScreenRect() const;

    bool MatchesAttributeFilter(const CYISceneNode *pNode, const CYIString &attributeType, const CYIString &attributeValue) const;

    RESPONSE_STATUS ApplyAttributeFilter(std::list<CYISceneNode*> &sceneNodes, const CYIString &attributeType, const CYIString &attributeValue);

    std::list<CYISceneNode *> GetNodes(CYISceneNode *pSceneNode, const CYIString &propertyName, const CYIString &propertyValue);

    void GetNodesFromChildren(const CYISceneNode *pSceneNode, const CYIString &propertyName, const CYIString &propertyValue, std::list<CYISceneNode *> &list);

    void SimulateClick(const glm::vec3 &clickCoords, bool bLongPress = false);
    void SimulateSwipe(const glm::vec3 &downCoords, const glm::vec3 &deltaCoords, bool bLongPress = false);

    void OnLongPressUpTimeout();
    void OnLongPressMoveTimeout();

    void ActionUp(const glm::vec3 &releaseCoords);
    void ActionMove(const glm::vec3 &releaseCoords);

    CYIAppiumTCPServer *m_pServer;
    LongPressGestureHandler m_longPressHandler;
    SourceTreeFilter m_sourceTreeFilter;

    YI_DISALLOW_COPY_AND_ASSIGN(CYIWebDriver)
};


#endif