From f7f2b0a5b6fa51fefe7bb24c3f37abffc7ef6f77 Mon Sep 17 00:00:00 2001
From: Mirko Brodesser <mbrodesser@mozilla.com>
Date: Fri, 25 Feb 2022 09:35:45 +0000
Subject: [PATCH] Bug 1472338: part 1) Add Chrome tests for the async Clipboard
 API. r=NeilDeakin

Differential Revision: https://phabricator.services.mozilla.com/D138660
---
 toolkit/content/tests/chrome/chrome.ini            |   1 +
 .../tests/chrome/test_async_clipboard.xhtml        | 141 +++++++++++++++++++++
 2 files changed, 142 insertions(+)
 create mode 100644 toolkit/content/tests/chrome/test_async_clipboard.xhtml

diff --git a/toolkit/content/tests/chrome/chrome.ini b/toolkit/content/tests/chrome/chrome.ini
index ef4ce40855d5..ab0412693dbc 100644
--- a/toolkit/content/tests/chrome/chrome.ini
+++ b/toolkit/content/tests/chrome/chrome.ini
@@ -61,6 +61,7 @@ prefs =
 skip-if =
   (verify && (os == 'win')) || (debug && (os == 'win') && (bits == 32)) # Bug 1546256
   win10_2004 # Bug 1727507
+[test_async_clipboard.xhtml]
 [test_autocomplete2.xhtml]
 [test_autocomplete3.xhtml]
 [test_autocomplete4.xhtml]
diff --git a/toolkit/content/tests/chrome/test_async_clipboard.xhtml b/toolkit/content/tests/chrome/test_async_clipboard.xhtml
new file mode 100644
index 000000000000..ff01e60b82c6
--- /dev/null
+++ b/toolkit/content/tests/chrome/test_async_clipboard.xhtml
@@ -0,0 +1,141 @@
+<?xml version="1.0"?>
+<?xml-stylesheet href="chrome://global/skin" type="text/css"?>
+<?xml-stylesheet href="chrome://mochikit/content/tests/SimpleTest/test.css" type="text/css"?>
+
+<window title="Async clipboard APIs Test"
+        xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"
+        onload="runTest();">
+
+  <script type="application/javascript"
+          src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"/>
+  <script type="application/javascript"
+          src="chrome://mochikit/content/tests/SimpleTest/EventUtils.js"/>
+
+<script class="testbody" type="application/javascript">
+<![CDATA[
+
+  SimpleTest.waitForExplicitFinish();
+
+  const { Services } = SpecialPowers.Cu.import("resource://gre/modules/Services.jsm");
+  const { AppConstants } = SpecialPowers.Cu.import("resource://gre/modules/AppConstants.jsm");
+  const { PlacesUtils } = SpecialPowers.Cu.import("resource://gre/modules/PlacesUtils.jsm");
+
+  // Some of the clipboard code requires reading or writing "text/unicode" when
+  // actually "text/plain" is desired.
+  const kTextUnicodeMimeType = "text/unicode";
+
+  const kTextPlainMimeType = "text/plain";
+
+  function clearClipboard() {
+    Services.clipboard.emptyClipboard(Services.clipboard.kGlobalClipboard);
+  }
+
+  async function testRead() {
+    let expected = "x";
+    await SimpleTest.promiseClipboardChange(expected, () => {
+      SpecialPowers.clipboardCopyString(expected);
+    }, kTextUnicodeMimeType);
+    let items = await navigator.clipboard.read();
+    is(items.length, 1, "read() read exactly one item");
+    const actual = await items[0].getType(kTextPlainMimeType).then(blob => blob.text());
+    is(actual, expected, "read() read the right thing");
+  }
+
+  async function testWrite() {
+    // See bug 666254.
+    if (AppConstants.platform != "macosx") {
+      await SimpleTest.promiseClipboardChange("", () => {
+        clearClipboard();
+      });
+    }
+
+    let expected = "x";
+    // eslint-disable-next-line no-undef
+    let item = new ClipboardItem({[kTextPlainMimeType]: expected});
+    await navigator.clipboard.write([item]);
+    let actual = SpecialPowers.getClipboardData(kTextUnicodeMimeType);
+    is(actual, expected, "write() wrote the right thing");
+  }
+
+  async function testReadText() {
+    let expected = "x";
+    await SimpleTest.promiseClipboardChange(expected, () => {
+      SpecialPowers.clipboardCopyString(expected);
+    }, kTextUnicodeMimeType);
+    let actual = await navigator.clipboard.readText();
+    is(actual, expected, "readText() read the right thing");
+  }
+
+  async function testWriteText() {
+    // See bug 666254.
+    if (AppConstants.platform != "macosx") {
+      await SimpleTest.promiseClipboardChange("", () => {
+        clearClipboard();
+      });
+    }
+
+    let expected = "x";
+    await navigator.clipboard.writeText(expected);
+    let actual = SpecialPowers.getClipboardData(kTextUnicodeMimeType);
+    is(actual, expected, "writeText() wrote the right thing");
+  }
+
+  async function testNoContentsRead() {
+    await SimpleTest.promiseClipboardChange("", () => {
+      clearClipboard();
+    });
+
+    const items = await navigator.clipboard.read();
+
+    // Bug 1756955: at least on Ubuntu 20.04, clearing the clipboard leads to
+    // one item with no types.
+    if (!items.length ||
+        (items.length == 1 && !items[0].types.length)) {
+      ok(true, "read() read the right thing from empty clipboard");
+    } else {
+      ok(false, "read() read the wrong thing from empty clipboard");
+    }
+  }
+
+  async function testNoContentsReadText() {
+    await SimpleTest.promiseClipboardChange("", () => {
+      clearClipboard();
+    });
+    let actual = await navigator.clipboard.readText();
+    is(actual, "", "readText() read the right thing from empty clipboard");
+  }
+
+  function runTest() {
+    (async function() {
+      await SpecialPowers.pushPrefEnv({"set": [
+        ["dom.events.asyncClipboard", true],
+        ["dom.events.asyncClipboard.read", true],
+        ["dom.events.asyncClipboard.clipboardItem", true],
+      ]});
+      await testRead();
+      await testReadText();
+      await testWrite();
+      await testWriteText();
+
+      // See bug 666254.
+      if (AppConstants.platform != "macosx") {
+        await testNoContentsRead();
+        await testNoContentsReadText();
+      }
+
+      SimpleTest.finish();
+    })();
+  }
+  ]]>
+</script>
+
+<body xmlns="http://www.w3.org/1999/xhtml">
+<p id="display">
+</p>
+<div id="content" style="display: none">
+</div>
+<pre id="test">
+</pre>
+</body>
+
+</window>
-- 
2.11.4.GIT