Add a test for awful.placement.no_overlap+awful.placement.no_offscreen

Test that the placement function used in the default configuration
behaves as intended.  This test was failing before the no_overlap and
no_offscreen fixes in two previous commits.

Signed-off-by: Sergey Vlasov <sigprof@gmail.com>

tests/test-awful-placement.lua

@@ -0,0 +1,170 @@
+local awful = require("awful")
+local gears = require("gears")
+local beautiful = require("beautiful")
+local test_client = require("_client")
+local runner = require("_runner")
+
+-- This test makes some assumptions about the no_overlap behavior which may not
+-- be correct if the screen is in the portrait orientation.
+if mouse.screen.workarea.height >= mouse.screen.workarea.width then
+    print("This test does not work with the portrait screen orientation.")
+    runner.run_steps { function() return true end }
+    return
+end
+
+local tests = {}
+
+local tb_height = gears.math.round(beautiful.get_font_height() * 1.5)
+local border_width = beautiful.border_width
+
+local class = "test-awful-placement"
+local rule = {
+    rule = {
+        class = class
+    },
+    properties = {
+        floating = true,
+        placement = awful.placement.no_overlap + awful.placement.no_offscreen
+    }
+}
+table.insert(awful.rules.rules, rule)
+
+local function check_geometry(c, x, y, width, height)
+    local g = c:geometry()
+    if g.x ~= x or g.y ~= y or g.width ~= width or g.height ~= height then
+        assert(false, string.format("(%d, %d, %d, %d) ~= (%d, %d, %d, %d)",
+            g.x, g.y, g.width, g.height, x, y, width, height))
+    end
+end
+
+local function default_test(c, geometry)
+    check_geometry(c, geometry.expected_x, geometry.expected_y,
+        geometry.expected_width  or geometry.width,
+        geometry.expected_height or (geometry.height + tb_height))
+    return true
+end
+
+local client_count = 0
+local client_data = {}
+local function add_client(args)
+    client_count = client_count + 1
+    local client_index = client_count
+    table.insert(tests, function(count)
+        local name = string.format("client%010d", client_index)
+        if count <= 1 then
+            local geometry = args.geometry(mouse.screen.workarea)
+            test_client(class, name, nil, nil, nil, {
+                size = {
+                    width = geometry.width,
+                    height = geometry.height
+                }
+            })
+            client_data[client_index] = { geometry = geometry }
+            return nil
+        elseif #client.get() >= client_index then
+            local data = client_data[client_index]
+            local c = data.c
+            if not c then
+                c = client.get()[1]
+                assert(c.name == name)
+                data.c = c
+            end
+            local test = args.test or default_test
+            return test(c, data.geometry)
+        end
+    end)
+end
+
+-- The first 100x100 window should be placed at the top left corner.
+add_client {
+    geometry = function(wa)
+        return {
+            width       = 100,
+            height      = 100,
+            expected_x  = wa.x,
+            expected_y  = wa.y
+        }
+    end
+}
+
+-- The second 100x100 window should be placed to the right of the first window.
+-- Note that this assumption fails if the screen is in the portrait orientation
+-- (e.g., the test succeeds with a 600x703 screen and fails with 600x704).
+add_client {
+    geometry = function(wa)
+        return {
+            width       = 100,
+            height      = 100,
+            expected_x  = wa.x + 100 + 2*border_width,
+            expected_y  = wa.y
+        }
+    end
+}
+
+-- The wide window should be placed below the two 100x100 windows.
+add_client {
+    geometry = function(wa)
+        return {
+            width       = wa.width - 50,
+            height      = 100,
+            expected_x  = wa.x,
+            expected_y  = wa.y + tb_height + 2*border_width + 100
+        }
+    end
+}
+
+-- The first large window which does not completely fit in any free area should
+-- be placed at the bottom left corner (no_overlap should place it below the
+-- wide window, and then no_offscreen should shift it up so that it would be
+-- completely inside the workarea).
+add_client {
+    geometry = function(wa)
+        return {
+            width       = wa.width - 10,
+            height      = wa.height - 50,
+            expected_x  = wa.x,
+            expected_y  = wa.y + 50 - 2*border_width - tb_height
+        }
+    end
+}
+
+-- The second large window should be placed at the top right corner.
+add_client {
+    geometry = function(wa)
+        return {
+            width       = wa.width - 10,
+            height      = wa.height - 50,
+            expected_x  = wa.x + 10 - 2*border_width,
+            expected_y  = wa.y
+        }
+    end
+}
+
+-- The third large window should be placed at the bottom right corner.
+add_client {
+    geometry = function(wa)
+        return {
+            width       = wa.width - 10,
+            height      = wa.height - 50,
+            expected_x  = wa.x + 10 - 2*border_width,
+            expected_y  = wa.y + 50 - 2*border_width - tb_height
+        }
+    end
+}
+
+-- The fourth large window should be placed at the top left corner (the whole
+-- workarea is occupied now).
+add_client {
+    geometry = function(wa)
+        return {
+            width       = wa.width - 50,
+            height      = wa.height - 50,
+            expected_x  = wa.x,
+            expected_y  = wa.y
+        }
+    end
+}
+
+runner.run_steps(tests)
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80