Add integration tests for _NET_WM_MOVERESIZE behaviour

Author: phantamanta44

tests/_client.lua

@@ -24,16 +24,21 @@ local function open_window(class, title, options)
         default_height = options.default_height or 100,
         title          = title
     }
+    if options.resize_increment or options.custom_titlebar then
+        -- These require Gtk3, but may fail with an obscure message with Gtk2.
+        -- Produce a better error message instead.
+        assert(tonumber(require("lgi").Gtk._version) >= 3, "Gtk 3 required, but not found")
+    end
     if options.gravity then
         window:set_gravity(tonumber(options.gravity))
     end
     if options.snid and options.snid ~= "" then
         window:set_startup_id(options.snid)
     end
+    if options.custom_titlebar then
+        window:set_titlebar(Gtk.Label { label = title })
+    end
     if options.resize_increment then
-        -- This requires Gtk3, but fails with an obscure message with Gtk2.
-        -- Produce a better error message instead.
-        assert(tonumber(require("lgi").Gtk._version) >= 3, "Gtk 3 required, but not found")
         local geom = Gdk.Geometry {
             width_inc = 200,
             height_inc = 200,
@@ -194,6 +199,9 @@ local function new(_, class, title, sn_rules, callback, resize_increment, args)
     if args.minimize_after then
         options = options .. "minimize_after,"
     end
+    if args.custom_titlebar then
+        options = options .. "custom_titlebar,"
+    end
 
     if args.size then
         options = table.concat {

tests/test-ewmh-wm_moveresize.lua

@@ -0,0 +1,285 @@
+local test_client = require("_client")
+local placement = require("awful.placement")
+local unpack = unpack or table.unpack -- luacheck: globals unpack (compatibility with Lua 5.1)
+
+-- Testing utils
+local signals_of_interest = {
+    "request::mouse_move",
+    "request::mouse_resize",
+    "request::mouse_cancel"
+}
+local signal_buffer = {}
+
+local function assert_signal(sig_name, asserts)
+    local sig_data = signal_buffer[sig_name]
+    assert(sig_data ~= nil, "expected signal: " .. sig_name)
+    if asserts then
+        asserts(unpack(sig_data))
+    end
+    signal_buffer = {}
+end
+
+local function assert_geometry(c, x, y, width, height)
+    local geo = c:geometry()
+    assert(geo.x      == x,      "expected x coord " .. x ..
+        ", but it was " .. geo.x)
+    assert(geo.y      == y,      "expected y coord " .. y ..
+        ", but it was " .. geo.y)
+    assert(geo.width  == width,  "expected width "   .. width ..
+        ", but it was " .. geo.width)
+    assert(geo.height == height, "expected height "  .. height ..
+        ", but it was " .. geo.height)
+end
+
+local function drag(x, y)
+    mouse.coords {x = x, y = y}
+end
+
+local function click(x, y)
+    drag(x, y)
+    root.fake_input("button_press", 1)
+end
+
+local function unclick()
+    root.fake_input("button_release", 1)
+end
+
+local resize_corners = {
+    {corner = "right",        bx = -1, by = 0,  dx = 0, dy = 0, dw = 1,  dh = 0},
+    {corner = "bottom_right", bx = -1, by = -1, dx = 0, dy = 0, dw = 1,  dh = 1},
+    {corner = "bottom",       bx = 0,  by = -1, dx = 0, dy = 0, dw = 0,  dh = 1},
+    {corner = "bottom_left",  bx = 1,  by = -1, dx = 1, dy = 0, dw = -1, dh = 1},
+    {corner = "left",         bx = 1,  by = 0,  dx = 1, dy = 0, dw = -1, dh = 0},
+    {corner = "top_left",     bx = 1,  by = 1,  dx = 1, dy = 1, dw = -1, dh = -1},
+    {corner = "top",          bx = 0,  by = 1,  dx = 0, dy = 1, dw = 0,  dh = -1},
+    {corner = "top_right",    bx = -1, by = 1,  dx = 0, dy = 1, dw = 1,  dh = -1},
+}
+local steps = {}
+
+-- Mouse movement tests
+
+table.insert(steps, function(count)
+    if count == 1 then  -- Setup.
+        test_client("foobar", "foobar", nil, nil, nil, {
+            custom_titlebar = true
+        })
+    elseif #client.get() > 0 then
+        local c = client.get()[1]
+
+        c : geometry {
+            x      = 200,
+            y      = 200,
+            width  = 400,
+            height = 400,
+        }
+
+        -- Attach signal handlers so that we can see which signals have been fired
+        for _,sig_name in ipairs(signals_of_interest) do
+            c:connect_signal(sig_name, function(_, ...)
+                signal_buffer[sig_name] = {...}
+                local _, args = ...
+                if args and args.mouse_pos then
+                    print("got signal " .. sig_name ..
+                        " at (" .. args.mouse_pos.x .. ", " .. args.mouse_pos.y .. ")")
+                else
+                    print("got signal " .. sig_name)
+                end
+            end)
+        end
+
+        return true
+    end
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    -- GTK window may take some time to finish setting up
+    -- Just repeat until the drag works
+    if signal_buffer["request::mouse_move"] then return true end
+
+    -- Just in case there is an accidental delayed geometry callback
+    assert_geometry(c, 200, 200, 400, 400)
+
+    -- Click the title bar and drag to start a mouse movement transaction
+    -- This doesn't necessarily move the window yet!
+    unclick()
+    click(400, 220)
+    drag(420, 220)
+end)
+
+table.insert(steps, function()
+    assert_signal("request::mouse_move", function(context, args)
+        assert(context          == "ewmh")
+        assert(args.button      == 1)
+        assert(args.mouse_pos.x == 400)
+        assert(args.mouse_pos.y == 220)
+    end)
+
+    -- Actually move the window
+    drag(500, 120)
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    assert_geometry(c, 300, 100, 400, 400)
+
+    -- Release the mouse to end the movement
+    unclick()
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    if mousegrabber.isrunning() then return end
+
+    assert_geometry(c, 300, 100, 400, 400)
+
+    -- Window should no longer follow mouse
+    drag(300, 200)
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    assert_geometry(c, 300, 100, 400, 400)
+
+    -- Start another mouse movement transaction
+    click(500, 120)
+    drag(520, 120)
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    if not signal_buffer["request::mouse_move"] then return end
+
+    assert_geometry(c, 300, 100, 400, 400)
+
+    -- Move the window somewhere else
+    drag(600, 170)
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    assert_geometry(c, 400, 150, 400, 400)
+
+    -- Cancel the mouse movement with a signal
+    c:emit_signal("request::mouse_cancel", "test")
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    assert_signal("request::mouse_cancel")
+    assert_geometry(c, 400, 150, 400, 400)
+
+    -- Window should no longer follow mouse
+    drag(300, 200)
+
+    return true
+end)
+
+table.insert(steps, function()
+    local c = client.get()[1]
+
+    assert_geometry(c, 400, 150, 400, 400)
+
+    unclick()
+
+    return true
+end)
+
+-- Mouse resizing tests
+
+local exp_x = 400
+local exp_y = 150
+local exp_w = 400
+local exp_h = 400
+
+local function assert_expected_geometry(c)
+    assert_geometry(c, exp_x, exp_y, exp_w, exp_h)
+end
+
+local drag_amount = 50
+local exp_mouse_x
+local exp_mouse_y
+
+for _,rc in ipairs(resize_corners) do
+    table.insert(steps, function()
+        local c = client.get()[1]
+
+        assert_expected_geometry(c)
+
+        local corner_pos = placement[rc.corner](mouse, {parent = c, pretend = true})
+        exp_mouse_x = corner_pos.x + rc.bx * 3
+        exp_mouse_y = corner_pos.y + rc.by * 3
+
+        -- Click the edge of the window to start a mouse resizing transaction
+        click(exp_mouse_x, exp_mouse_y)
+
+        return true
+    end)
+
+    table.insert(steps, function()
+        if not signal_buffer["request::mouse_resize"] then return end
+
+        assert_signal("request::mouse_resize", function(context, args)
+            assert(context          == "ewmh")
+            assert(args.button      == 1)
+            assert(args.mouse_pos.x == exp_mouse_x)
+            assert(args.mouse_pos.y == exp_mouse_y)
+        end)
+
+        -- Resize the window
+        drag(exp_mouse_x + drag_amount, exp_mouse_y + drag_amount)
+        exp_x = exp_x + rc.dx * drag_amount
+        exp_y = exp_y + rc.dy * drag_amount
+        exp_w = exp_w + rc.dw * drag_amount
+        exp_h = exp_h + rc.dh * drag_amount
+
+        return true
+    end)
+
+    table.insert(steps, function()
+        local c = client.get()[1]
+
+        assert_expected_geometry(c)
+
+        -- Release the mouse to end the resizing
+        unclick()
+
+        return true
+    end)
+
+    table.insert(steps, function()
+        local c = client.get()[1]
+
+        if mousegrabber.isrunning() then return end
+
+        assert_expected_geometry(c)
+
+        -- Window should no longer follow mouse
+        drag(exp_mouse_x + 30, exp_mouse_y - 20)
+
+        return true
+    end)
+end
+
+require("_runner").run_steps(steps)
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80