Initial implementation of Mouse and Keyboard abstractions

Author: jvelilla

src/interaction/se_actions.e

@@ -7,9 +7,62 @@ note
 class
 	SE_ACTIONS
 
+create
+	make
+
+feature {NONE} -- Initialization
+
+	make (a_web_driver: WEB_DRIVER)
+			-- Create an object Actions using webdriver input devices (mouse and keyboard)
+		do
+			make_with_parameters (a_web_driver.mouse, a_web_driver.keyboard )
+		ensure
+			keyboard_set: attached keyboard
+			mouse_set: attached mouse
+			actions_set: actions.is_empty
+		end
+
+	make_with_parameters (a_mouse: SE_MOUSE; a_keyboard: SE_KEYBOARD)
+			-- Create an object Actions with `a_mouse' and `a_keyboard'
+		do
+			set_keyboard (a_keyboard)
+			set_mouse (a_mouse)
+			reset
+		ensure
+			keyboard_set: keyboard = a_keyboard
+			mouse_set: mouse = a_mouse
+			actions_set: actions.is_empty
+		end
 
 feature -- Access
 
---	keyboard: SE_KEYBOARD
---	mouse: SE_MOUSE
+	keyboard: SE_KEYBOARD
+	mouse: SE_MOUSE
+	actions: SE_COMPOSITE_ACTION
+
+feature -- Change Element
+
+	reset
+			-- Create a new instance of composite actions.
+		do
+			create actions.make
+		end
+
+
+	set_keyboard (a_keyboard: SE_KEYBOARD)
+			-- Set `keyboard' with `a_keyboard'
+		do
+			keyboard := a_keyboard
+		ensure
+			keyboard_set: keyboard = a_keyboard
+		end
+
+	set_mouse (a_mouse: SE_MOUSE)
+			-- Set `mouse' 	with `a_mouse'
+		do
+			mouse := a_mouse
+		ensure
+			mouse_set: mouse = a_mouse
+		end
+
 end

src/interaction/se_base_action.e

@@ -0,0 +1,17 @@
+note
+	description: "Summary description for {SE_BASE_ACTION}."
+	author: ""
+	date: "$Date$"
+	revision: "$Revision$"
+
+deferred class
+	SE_BASE_ACTION
+
+feature {NONE} -- Initialization
+
+
+feature -- Access
+
+	location: detachable SE_COORDINATES
+
+end

src/interaction/se_composite_action.e

@@ -17,10 +17,11 @@ create
 feature {NONE} -- Initialization
 
 	make
+			-- Create an empty composite actions
 		do
 			create {ARRAYED_LIST[SE_ACTION]}actions.make (5)
 		ensure
-			actions_empty: actions.is_empty
+			actions_empty: is_empty
 		end
 
 feature -- Execute
@@ -33,10 +34,19 @@ feature -- Execute
 feature -- Access
 
 	count: INTEGER
+			-- Number of items
 		do
 			Result := actions.count
 		end
 
+feature -- Status report
+
+	is_empty: BOOLEAN
+			-- Is the current list of actions empty?
+		do
+			Result := actions.is_empty
+		end
+
 feature -- Change Element
 
 	add_action (a_action: SE_ACTION)

src/interaction/se_coordinates.e

@@ -16,48 +16,49 @@ create
 
 feature {NONE} -- Initialization
 
-	make ( a_web_driver : like driver)
+	make (a_web_driver: like driver)
 			-- Create an object se_mouse with his driver
 		do
 			driver := a_web_driver
 		ensure
-			web_driver_set : driver = a_web_driver
+			web_driver_set: driver = a_web_driver
 		end
 
-
 feature -- Access
 
 	on_screen: detachable SE_POINT
+			-- Gets Coordinates on the element relative to the top-left corner of the monitor (screen).
 		do
 			to_implement ("Not supported yet.")
 		end
 
 	in_view_port: detachable SE_POINT
+			-- Gets coordinates on the element relative to the top-left corner of OS-window being used
+			-- to display the content. Usually it is the browser window's viewport.
 		do
-			if attached driver.active_element as l_element and then
-				attached driver.session  as l_session then
+			if attached driver.active_element as l_element and then attached driver.session as l_session then
 				Result := driver.api.location_in_view (l_session.session_id, l_element.element)
 			end
 		end
 
 	on_page: detachable SE_POINT
+			-- Gets coordinates on the element relative to the top-left corner of the page.
 		do
-			if attached driver.active_element as l_element and then
-				attached driver.session  as l_session then
+			if attached driver.active_element as l_element and then attached driver.session as l_session then
 				Result := driver.api.element_location (l_session.session_id, l_element.element)
 			end
 		end
 
-	auxiliary: detachable ANY
+	auxiliary: detachable WEB_ELEMENT
 		do
 			if attached driver.active_element as l_element then
-				Result := l_element.element
+				Result := l_element
 			end
 		end
 
-
 feature -- {NONE} -- Implementations
-	driver : WEB_DRIVER
-		-- web_driver
+
+	driver: WEB_DRIVER
+			-- web_driver
 
 end

src/interaction/se_mouse.e

@@ -22,61 +22,74 @@ feature {NONE} -- Initialization
 
 feature  -- Mouse Actions
 
-	click (a_coordinates: SE_COORDINATES)
+	click (a_coordinates: detachable SE_COORDINATES)
 		do
+			move_if_needed (a_coordinates)
+			if attached driver.session as l_session then
+				driver.api.click (l_session.session_id, create {SE_BUTTON}.make_left)
+			end
 		end
 
-	double_click (a_coordinates: SE_COORDINATES)
+	double_click (a_coordinates: detachable SE_COORDINATES)
 		do
-
+			move_if_needed (a_coordinates)
+			if attached driver.session as l_session then
+				driver.api.double_click (l_session.session_id)
+			end
 		end
 
-	mouse_down (a_coordinates: SE_COORDINATES)
+	mouse_down (a_coordinates: detachable SE_COORDINATES)
 		do
-
+			move_if_needed (a_coordinates)
+			if attached driver.session as l_session then
+				driver.api.button_down (l_session.session_id, create {SE_BUTTON}.make_left)
+			end
 		end
 
 
-	mouse_up (a_coordinates: SE_COORDINATES)
+	mouse_up (a_coordinates: detachable SE_COORDINATES)
 		do
-
+			move_if_needed (a_coordinates)
+			if attached driver.session as l_session then
+				driver.api.button_up (l_session.session_id, create {SE_BUTTON}.make_left)
+			end
 		end
 
 	mouse_move (a_coordinates: SE_COORDINATES)
 		do
-
+			if attached driver.session as l_session and then attached a_coordinates.auxiliary as l_element then
+				driver.api.move_to_default (l_session.session_id,l_element)
+			end
 		end
 
 	mouse_move_by_params (a_coordinates: SE_COORDINATES; a_param1: INTEGER_64; a_param2: INTEGER_64)
 		do
-
+			if attached driver.session as l_session and then attached a_coordinates.auxiliary as l_element then
+				driver.api.move_to (l_session.session_id,l_element,a_param1, a_param2)
+			end
 		end
 
-	context_click (a_coordinates: SE_COORDINATES)
+	context_click (a_coordinates: detachable  SE_COORDINATES)
+			-- Right click an element
 		do
-
+			move_if_needed (a_coordinates)
+			if attached driver.session as l_session then
+				driver.api.click (l_session.session_id, create {SE_BUTTON}.make_right)
+			end
 		end
 
 
 
 feature {NONE} -- Implementation
 
-
-	params_from_coordinates (a_where: SE_COORDINATES): HASH_TABLE[ANY,STRING]
+	move_if_needed (a_coordinates: detachable SE_COORDINATES)
 		do
-			create Result.make(1)
-			if attached {STRING} a_where.auxiliary as l_id then
-				Result.force (l_id,"element")
+			if attached a_coordinates as l_coordinates then
+				mouse_move (a_coordinates)
 			end
 		end
 
-
-
 	driver : WEB_DRIVER
 		-- web_driver
 
-	json_template : String = "[
-				{"value" :"$value",
-				"isdown" : $boolean}
-			]"
 end

src/protocol/se_json_wire_protocol.e

@@ -1704,7 +1704,7 @@ feature -- Commands
 			end
 		end
 
-	move_to (a_session_id: STRING_32; web_element : WEB_ELEMENT; xoffset : NATURAL; yoffset:NATURAL)
+	move_to (a_session_id: STRING_32; web_element : WEB_ELEMENT; xoffset : INTEGER_64; yoffset:INTEGER_64)
 			--	POST /session/:sessionId/moveto
 			--	Move the mouse by an offset of the specificed element.
 			--  If no element is specified, the move is relative to the current mouse cursor.
@@ -1736,6 +1736,34 @@ feature -- Commands
 			end
 		end
 
+	move_to_default (a_session_id: STRING_32; web_element : WEB_ELEMENT)
+			--	POST /session/:sessionId/moveto
+			--	Move the mouse by an offset of the specificed element.
+			--  If no element is specified, the move is relative to the current mouse cursor.
+			--  If an element is provided but no offset, the mouse will be moved to the center of the element.
+			--  If the element is not visible, it will be scrolled into view.
+			--	URL Parameters:
+			--		:sessionId - ID of the session to route the command to.
+			--	JSON Parameters:
+			--		element - {string} Opaque ID assigned to the element to move to, as described in the WebElement JSON Object. If not specified or is null, the offset is relative to current position of the mouse.
+			--		xoffset - {number} X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
+			--		yoffset - {number} Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
+		local
+			resp : SE_RESPONSE
+			l_json : STRING_32
+
+		do
+			l_json := "[
+				{ "element" : "$element"
+				}
+			]"
+			if commnad_executor.is_available then
+				l_json.replace_substring_all ("$element", web_element.element)
+				resp := commnad_executor.move_to (a_session_id, l_json)
+				check_response (resp)
+			end
+		end
+
 
 	modifier (a_session_id: STRING_32; data: STRING)
 			--	POST /session/:sessionId/modifier
@@ -1823,6 +1851,7 @@ feature -- Commands
 				check_response (resp)
 			end
 		end
+
 	double_click (a_session_id: STRING_32)
 			--	POST /session/:sessionId/doubleclick
 			--	Double-clicks at the current mouse coordinates (set by moveto).

src/se_button.e

@@ -6,7 +6,9 @@ note
 
 class
 	SE_BUTTON
+
 inherit {NONE}
+
 	ENUM
 
 
@@ -21,16 +23,22 @@ feature -- Initialization
 	make_left
 		do
 			set_left
+		ensure
+			left_set: is_left
 		end
 
 	make_middle
 		do
 			set_middle
+		ensure
+			middle_set: is_middle
 		end
 
 	make_right
 		do
 			set_right
+		ensure
+			right_set: is_right
 		end
 
 
@@ -85,6 +93,7 @@ feature -- Query
 
 
 feature  {NONE} -- Implementation
+
 --	{LEFT = 0, MIDDLE = 1 , RIGHT = 2}
 	left_value :INTEGER = 0
 	middle_value : INTEGER = 1

src/web_driver.e

@@ -476,7 +476,19 @@ feature {WEB_DRIVER, WEB_DRIVER_WAIT}
 			end
 		end
 
-feature {SE_KEYBOARD, SE_COORDINATES} -- Implementation
+feature -- Input Devices
+
+	keyboard: SE_KEYBOARD
+		do
+			create Result.make (Current)
+		end
+
+	mouse: SE_MOUSE
+		do
+			create Result.make (Current)
+		end
+
+feature {SE_KEYBOARD, SE_COORDINATES, SE_MOUSE} -- Implementation
 
 	session: detachable SE_SESSION