Tests for playground are using a mock response (#2611)

The official playground quite often provides a timeout error as in https://github.com/google/comprehensive-rust/issues/2549 This is mocking/overriding the response from the playground for success and failure messages to avoid the server provided timeouts. As far as I see most responses from the playground are delivered below 10 seconds (but varies a lot...) There still might be timeouts and I know of the following knobs that can be tuned - wdio waits for 10 seconds until it aborts the current attemp (e.g. to wait for the text to be as expected) 347de61d13/tests/wdio.conf.ts (L98) - another timeout is the 15 second timeout for fetching the result from the playground - this is not overriden by the mock (currently, pending https://github.com/webdriverio/webdriverio/issues/14090 which would allow for an immediate mock response without waiting for the remote endpoint) 347de61d13/theme/book.js (L31)
2025-06-28 11:31:32 +02:00 · 2025-02-06 12:33:33 +01:00
parent 553e3c5b10
commit 4ec257942e
2 changed files with 155 additions and 0 deletions
--- a/tests/src/objects/playground.ts
+++ b/tests/src/objects/playground.ts
@ -0,0 +1,106 @@
+import { $, browser } from "@wdio/globals";
+
+export default class Playground {
+  /**
+   * stores a playground mock
+   */
+  mock: WebdriverIO.Mock;
+
+  get area() {
+    return $(".ace_content");
+  }
+  get start_button() {
+    return $("button.play-button");
+  }
+  get stderr() {
+    return $("code.result.stderr");
+  }
+  get stdout() {
+    return $("code.result.stdout");
+  }
+
+  /**
+   * activate the playground by clicking into it
+   */
+  async activate() {
+    // clicking into the content is necessary for the button to be displayed
+    await this.area.waitForClickable();
+    await this.area.click();
+  }
+
+  /**
+   *  run the code in the playground editor
+   */
+  async run() {
+    // clicking the button triggers action
+    await this.start_button.waitForClickable();
+    // await browser.debug();
+    await this.start_button.click();
+  }
+
+  /**
+   * generate a new mock for the playground that overrides playground requests
+   */
+  async mock_new() {
+    return browser.mock("https://play.rust-lang.org/execute", {
+      method: "post",
+    });
+  }
+
+  /**
+   * reset the mock object
+   */
+  async mock_reset() {
+    this.mock.clear();
+  }
+
+  /**
+   * mock a successful playground run
+   * @param stdout a string that is expected to be in stdout
+   */
+  async mock_success(stdout: string) {
+    this.mock = await this.mock_new();
+
+    // be aware that there is a still a preflight OPTIONS request
+    this.mock.respond(
+      {
+        success: true,
+        exitDetail: "Exited with status 0",
+        stdout: stdout,
+        stderr:
+          "   Compiling playground v0.0.1 (/playground)\n    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.62s\n     Running `target/debug/playground`\n",
+      },
+      {
+        headers: {
+          "Access-Control-Allow-Origin": "*",
+        },
+        fetchResponse: false,
+      }
+    );
+  }
+
+  /**
+   * mock a failed run that would be caused if a `fn fail()` is added without any function body
+   */
+  async mock_fail() {
+    // mock the response so this test does not rely on the playground backend to be working
+    this.mock = await this.mock_new();
+
+    // be aware that there is a still a preflight OPTIONS request
+    this.mock.respond(
+      {
+        success: false,
+        exitDetail: "Exited with status 101",
+        stdout: "",
+        stderr:
+          '   Compiling playground v0.0.1 (/playground)\nerror: expected one of `->`, `where`, or `{`, found `}`\n --> src/main.rs:5:1\n  |\n4 |     fn fail()\n  |        ----  - expected one of `->`, `where`, or `{`\n  |        |\n  |        while parsing this `fn`\n5 | }\n  | ^ unexpected token\n\nerror: free function without a body\n --> src/main.rs:4:5\n  |\n4 |     fn fail()\n  |     ^^^^^^^^^- help: provide a definition for the function: `{ <body> }`\n\nerror: could not compile `playground` (bin "playground") due to 2 previous errors\n',
+      },
+      {
+        headers: {
+          "Access-Control-Allow-Origin": "*",
+        },
+        fetchResponse: false,
+      }
+    );
+  }
+}