Add a drag_and_drop() method

Author: mdmintz

help_docs/method_summary.md

@@ -123,6 +123,10 @@ self.hover_and_double_click(hover_selector, click_selector,
                             hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR,
                             timeout=None)
 
+self.drag_and_drop(drag_selector, drop_selector,
+                   drag_by=By.CSS_SELECTOR, drop_by=By.CSS_SELECTOR,
+                   timeout=None)
+
 self.select_option_by_text(dropdown_selector, option,
                            dropdown_by=By.CSS_SELECTOR,
                            timeout=None)

seleniumbase/fixtures/base_case.py

@@ -1291,6 +1291,41 @@ def hover_and_double_click(self, hover_selector, click_selector,
             self.__slow_mode_pause_if_active()
         return element
 
+    def drag_and_drop(self, drag_selector, drop_selector,
+                      drag_by=By.CSS_SELECTOR, drop_by=By.CSS_SELECTOR,
+                      timeout=None):
+        """ Drag and drop an element from one selector to another. """
+        if not timeout:
+            timeout = settings.SMALL_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        drag_selector, drag_by = self.__recalculate_selector(
+            drag_selector, drag_by)
+        drop_selector, drop_by = self.__recalculate_selector(
+            drop_selector, drop_by)
+        drag_element = self.wait_for_element_visible(
+            drag_selector, by=drag_by, timeout=timeout)
+        self.__demo_mode_highlight_if_active(drag_selector, drag_by)
+        self.wait_for_element_visible(
+            drop_selector, by=drop_by, timeout=timeout)
+        self.__demo_mode_highlight_if_active(drop_selector, drop_by)
+        self.scroll_to(drag_selector, by=drag_by)
+        drag_selector = self.convert_to_css_selector(
+            drag_selector, drag_by)
+        drop_selector = self.convert_to_css_selector(
+            drop_selector, drop_by)
+        drag_and_drop_script = js_utils.get_drag_and_drop_script()
+        self.safe_execute_script(
+            drag_and_drop_script + (
+                "$('%s').simulateDragDrop("
+                "{dropTarget: "
+                "'%s'});" % (drag_selector, drop_selector)))
+        if self.demo_mode:
+            self.__demo_mode_pause_if_active()
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
+        return drag_element
+
     def __select_option(self, dropdown_selector, option,
                         dropdown_by=By.CSS_SELECTOR, option_by="text",
                         timeout=None):

seleniumbase/fixtures/js_utils.py

@@ -732,6 +732,64 @@ def slow_scroll_to_element(driver, element, browser):
         time.sleep(0.162)
 
 
+def get_drag_and_drop_script():
+    script = (r"""(function( $ ) {
+        $.fn.simulateDragDrop = function(options) {
+                return this.each(function() {
+                        new $.simulateDragDrop(this, options);
+                });
+        };
+        $.simulateDragDrop = function(elem, options) {
+                this.options = options;
+                this.simulateEvent(elem, options);
+        };
+        $.extend($.simulateDragDrop.prototype, {
+                simulateEvent: function(elem, options) {
+                        /*Simulating drag start*/
+                        var type = 'dragstart';
+                        var event = this.createEvent(type);
+                        this.dispatchEvent(elem, type, event);
+
+                        /*Simulating drop*/
+                        type = 'drop';
+                        var dropEvent = this.createEvent(type, {});
+                        dropEvent.dataTransfer = event.dataTransfer;
+                        this.dispatchEvent(
+                            $(options.dropTarget)[0], type, dropEvent);
+
+                        /*Simulating drag end*/
+                        type = 'dragend';
+                        var dragEndEvent = this.createEvent(type, {});
+                        dragEndEvent.dataTransfer = event.dataTransfer;
+                        this.dispatchEvent(elem, type, dragEndEvent);
+                },
+                createEvent: function(type) {
+                        var event = document.createEvent("CustomEvent");
+                        event.initCustomEvent(type, true, true, null);
+                        event.dataTransfer = {
+                                data: {
+                                },
+                                setData: function(type, val){
+                                        this.data[type] = val;
+                                },
+                                getData: function(type){
+                                        return this.data[type];
+                                }
+                        };
+                        return event;
+                },
+                dispatchEvent: function(elem, type, event) {
+                        if(elem.dispatchEvent) {
+                                elem.dispatchEvent(event);
+                        }else if( elem.fireEvent ) {
+                                elem.fireEvent("on"+type, event);
+                        }
+                }
+        });
+        })(jQuery);""")
+    return script
+
+
 @decorators.deprecated("Use re.escape() instead, which does what you want!")
 def _jq_format(code):
     """