From d78902fac300f32950112af4dfd9832933344248 Mon Sep 17 00:00:00 2001
From: Anders Kaseorg <anders@zulip.com>
Date: Sun, 1 Dec 2024 20:57:59 -0800
Subject: [PATCH] e2e-tests: Move test credentials to a JSON file.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
---
 .gitignore                            |  5 +----
 eslint.config.js                      |  5 +----
 tools/setup/generate-test-credentials |  5 ++---
 var/puppeteer/test_credentials.d.ts   |  6 ------
 web/e2e-tests/lib/common.ts           | 10 +++++++---
 web/e2e-tests/settings.test.ts        |  3 +--
 6 files changed, 12 insertions(+), 22 deletions(-)
 delete mode 100644 var/puppeteer/test_credentials.d.ts

diff --git a/.gitignore b/.gitignore
index 4f63471ede..648e5ced40 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,10 +31,7 @@
 package-lock.json
 
 /.vagrant
-/var/*
-!/var/puppeteer
-/var/puppeteer/*
-!/var/puppeteer/test_credentials.d.ts
+/var
 
 /.dmypy.json
 /.ruff_cache
diff --git a/eslint.config.js b/eslint.config.js
index c0be85c35b..52b7e1b548 100644
--- a/eslint.config.js
+++ b/eslint.config.js
@@ -23,10 +23,7 @@ export default [
             "docs/_build",
             "static/generated",
             "static/webpack-bundles",
-            "var/*",
-            "!var/puppeteer",
-            "var/puppeteer/*",
-            "!var/puppeteer/test_credentials.d.ts",
+            "var",
             "web/generated",
             "web/third",
             "zulip-current-venv",
diff --git a/tools/setup/generate-test-credentials b/tools/setup/generate-test-credentials
index 6a004d1155..fa5669a967 100755
--- a/tools/setup/generate-test-credentials
+++ b/tools/setup/generate-test-credentials
@@ -8,7 +8,6 @@ email=desdemona@zulip.com
 mkdir -p var/puppeteer
 
 password=$(./manage.py print_initial_password "$email" | grep -F "$email" | awk '{ print $2 }')
-cat >var/puppeteer/test_credentials.js <<EOF
-// Generated by tools/setup/generate-test-credentials
-export const test_credentials = {default_user: {username: '$email', password: '$password'}};
+cat >var/puppeteer/test_credentials.json <<EOF
+{"default_user": {"username": "$email", "password": "$password"}}
 EOF
diff --git a/var/puppeteer/test_credentials.d.ts b/var/puppeteer/test_credentials.d.ts
deleted file mode 100644
index 8373b9bd1d..0000000000
--- a/var/puppeteer/test_credentials.d.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-export const test_credentials: {
-    default_user: {
-        username: string;
-        password: string;
-    };
-};
diff --git a/web/e2e-tests/lib/common.ts b/web/e2e-tests/lib/common.ts
index 5f0d5c50b3..5bc2bb4b79 100644
--- a/web/e2e-tests/lib/common.ts
+++ b/web/e2e-tests/lib/common.ts
@@ -1,20 +1,24 @@
 import assert from "node:assert/strict";
-import "css.escape";
+import * as fs from "node:fs";
 import path from "node:path";
 import timersPromises from "node:timers/promises";
 import * as url from "node:url";
 
+import "css.escape";
 import ErrorStackParser from "error-stack-parser";
 import type {Browser, ConsoleMessage, ConsoleMessageLocation, ElementHandle, Page} from "puppeteer";
 import puppeteer from "puppeteer";
 import StackFrame from "stackframe";
 import StackTraceGPS from "stacktrace-gps";
-
-import {test_credentials} from "../../../var/puppeteer/test_credentials.js";
+import {z} from "zod";
 
 const root_dir = url.fileURLToPath(new URL("../../..", import.meta.url));
 const puppeteer_dir = path.join(root_dir, "var/puppeteer");
 
+export const test_credentials = z
+    .object({default_user: z.object({username: z.string(), password: z.string()})})
+    .parse(JSON.parse(fs.readFileSync(path.join(puppeteer_dir, "test_credentials.json"), "utf8")));
+
 type Message = Record<string, string | boolean> & {
     recipient?: string;
     content: string;
diff --git a/web/e2e-tests/settings.test.ts b/web/e2e-tests/settings.test.ts
index 4cbd7a2e31..4716aee672 100644
--- a/web/e2e-tests/settings.test.ts
+++ b/web/e2e-tests/settings.test.ts
@@ -2,9 +2,8 @@ import assert from "node:assert/strict";
 
 import type {Page} from "puppeteer";
 
-import {test_credentials} from "../../var/puppeteer/test_credentials.js";
-
 import * as common from "./lib/common.ts";
+import {test_credentials} from "./lib/common.ts";
 
 const OUTGOING_WEBHOOK_BOT_TYPE = "3";
 const GENERIC_BOT_TYPE = "1";