test: add clipboard tests

lua/img-clip/clipboard.lua

@@ -68,6 +68,7 @@ M.check_if_content_is_image = function(cmd)
     return exit_code == 0
 
     -- MacOS (osascript) as a fallback
+    -- TOOD: Add correct quotes aroudn class PNGf
   elseif cmd == "osascript" then
     local output = util.execute("osascript -e 'clipboard info'")
     return output ~= nil and output:find("class PNGf") ~= nil

tests/clipboard_spec.lua

@@ -0,0 +1,232 @@
+local clipboard = require("img-clip.clipboard")
+local util = require("img-clip.util")
+
+describe("clipboard", function()
+  describe("x11", function()
+    before_each(function()
+      os.getenv = function(env)
+        return env == "DISPLAY"
+      end
+      util.has = function()
+        return false
+      end
+      util.executable = function(cmd)
+        return cmd == "xclip"
+      end
+    end)
+
+    it("returns 'xclip' as the clipboard command", function()
+      assert.equals("xclip", clipboard.get_clip_cmd())
+    end)
+
+    it("returns true if clipboard content is an image", function()
+      util.execute = function(command)
+        assert(command:match("xclip"))
+        return [[TARGETS\nimage/png]], 0 -- output of xclip
+      end
+
+      assert.is_true(clipboard.check_if_content_is_image("xclip"))
+    end)
+
+    it("returns false if clipboard content is not an image", function()
+      util.execute = function(command)
+        assert(command:match("xclip"))
+        return [[TARGETS\nUTF8_STRING]], 0 -- output of xclip
+      end
+
+      assert.is_false(clipboard.check_if_content_is_image("xclip"))
+    end)
+
+    it("successfully saves an image", function()
+      util.execute = function(command)
+        assert(command:match("xclip"))
+        return nil, 0 -- simulate successful execution
+      end
+
+      assert.is_true(clipboard.save_clipboard_image("xclip", "/path/to/image.png"))
+    end)
+  end)
+
+  describe("wayland", function()
+    before_each(function()
+      os.getenv = function(env)
+        return env == "WAYLAND_DISPLAY"
+      end
+      util.has = function()
+        return false
+      end
+      util.executable = function(cmd)
+        return cmd == "wl-paste" or cmd == "wl-clipboard"
+      end
+    end)
+
+    it("returns 'wl-paste' as the clipboard command", function()
+      assert.equals("wl-paste", clipboard.get_clip_cmd())
+    end)
+
+    it("returns true if clipboard content is an image", function()
+      util.execute = function(command)
+        assert(command:match("wl%-paste"))
+        return [[TARGETS\nimage/png]], 0 -- output of wl-paste
+      end
+
+      assert.is_true(clipboard.check_if_content_is_image("wl-paste"))
+    end)
+
+    it("returns false if clipboard content is not an image", function()
+      util.execute = function(command)
+        assert(command:match("wl%-paste"))
+        return [[TARGETS\nUTF8_STRING]], 0 -- output of wl-paste
+      end
+
+      assert.is_false(clipboard.check_if_content_is_image("wl-paste"))
+    end)
+
+    it("successfully saves an image", function()
+      util.execute = function(command)
+        assert(command:match("wl%-paste"))
+        return nil, 0 -- simulate successful execution
+      end
+
+      assert.is_true(clipboard.save_clipboard_image("wl-paste", "/path/to/image.png"))
+    end)
+  end)
+
+  describe("macos", function()
+    describe("pngpaste", function()
+      before_each(function()
+        util.has = function(feature)
+          return feature == "mac"
+        end
+        os.getenv = function()
+          return nil
+        end
+        util.executable = function(cmd)
+          return cmd == "pngpaste" or cmd == "osascript"
+        end
+      end)
+
+      it("returns 'pngpaste' as the clipboard command", function()
+        assert.equals("pngpaste", clipboard.get_clip_cmd())
+      end)
+
+      it("returns true if clipboard content is an image", function()
+        util.execute = function(command)
+          assert(command:match("pngpaste"))
+          return nil, 0 -- output of pngpaste
+        end
+
+        assert.is_true(clipboard.check_if_content_is_image("pngpaste"))
+      end)
+
+      it("returns false if clipboard content is not an image", function()
+        util.execute = function(command)
+          assert(command:match("pngpaste"))
+          return nil, 1 -- output of pngpaste
+        end
+
+        assert.is_false(clipboard.check_if_content_is_image("pngpaste"))
+      end)
+
+      it("successfully saves an image", function()
+        util.execute = function(command)
+          assert(command:match("pngpaste"))
+          return nil, 0 -- simulate successful execution
+        end
+
+        assert.is_true(clipboard.save_clipboard_image("pngpaste", "/path/to/image.png"))
+      end)
+    end)
+
+    describe("osascript", function()
+      before_each(function()
+        util.has = function(feature)
+          return feature == "mac"
+        end
+        os.getenv = function()
+          return nil
+        end
+        util.executable = function(cmd)
+          return cmd == "osascript"
+        end
+      end)
+
+      it("returns 'osascript' as the clipboard command", function()
+        assert.equals("osascript", clipboard.get_clip_cmd())
+      end)
+
+      -- TODO: Get correct output of osascript
+      it("returns true if clipboard content is an image", function()
+        util.execute = function(command)
+          assert(command:match("osascript"))
+          return "class PNGf", 0 -- output of osascript
+        end
+
+        assert.is_true(clipboard.check_if_content_is_image("osascript"))
+      end)
+
+      -- TODO: Get correct output of osascript
+      it("returns false if clipboard content is not an image", function()
+        util.execute = function(command)
+          assert(command:match("osascript"))
+          return "Text", 1 -- output of osascript
+        end
+
+        assert.is_false(clipboard.check_if_content_is_image("osascript"))
+      end)
+
+      it("successfully saves an image", function()
+        util.execute = function(command)
+          assert(command:match("osascript"))
+          return nil, 0 -- simulate successful execution
+        end
+
+        assert.is_true(clipboard.save_clipboard_image("osascript", "/path/to/image.png"))
+      end)
+    end)
+  end)
+
+  describe("windows", function()
+    before_each(function()
+      util.has = function(feature)
+        return feature == "win32" or feature == "wsl"
+      end
+      util.executable = function(cmd)
+        return cmd == "powershell.exe"
+      end
+    end)
+
+    it("returns 'powershell.exe' as the clipboard command", function()
+      assert.equals("powershell.exe", clipboard.get_clip_cmd())
+    end)
+
+    -- TODO: Get correct output of powershell
+    it("returns true if clipboard content is an image", function()
+      util.execute = function(command)
+        assert(command:match("powershell.exe"))
+        return "ImageFormat", 0 -- output of powershell
+      end
+
+      assert.is_true(clipboard.check_if_content_is_image("powershell.exe"))
+    end)
+
+    -- TODO: Get correct output of powershell
+    it("returns false if clipboard content is not an image", function()
+      util.execute = function(command)
+        assert(command:match("powershell.exe"))
+        return "", 0 -- output of powershell
+      end
+
+      assert.is_false(clipboard.check_if_content_is_image("powershell.exe"))
+    end)
+
+    it("successfully saves an image", function()
+      util.execute = function(command)
+        assert(command:match("powershell.exe"))
+        return nil, 0 -- simulate successful execution
+      end
+
+      assert.is_true(clipboard.save_clipboard_image("powershell.exe", "C:\\path\\to\\image.png"))
+    end)
+  end)
+end)