@red-hat-developer-hub/e2e-test-utils 2.1.15 → 2.1.16

package/dist/secrets/tests/bitwarden.test.js

@@ -141,6 +141,46 @@ test("syncs and reads only exact-prefix items from the selected collection", asy
     assert.equal(calls[0]?.args[0], "--version");
     assert.equal(calls.every((call) => call.env?.BW_SESSION === "synthetic-session"), true);
 });
+test("reads complete list results without fetching each note again", async () => {
+    const calls = [];
+    const runner = async (_command, args) => {
+        calls.push([...args]);
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[1] === "items") {
+            return result(JSON.stringify([
+                {
+                    id: "item-id",
+                    name: "global/VAULT_TOKEN",
+                    notes: "synthetic",
+                    type: 2,
+                    collectionIds: ["collection-id"],
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const secrets = await new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    }).read("rhdh-qe", [selectors[0]]);
+    assert.equal(secrets[0]?.value, "synthetic");
+    assert.equal(calls.some((args) => args[0] === "get" && args[1] === "item"), false);
+});
 test("rejects duplicate exact item names before returning secrets", async () => {
     const runner = async (_command, args) => {
         if (args[0] === "--version")
@@ -416,3 +456,603 @@ test("does not expose attachment command output when the command fails", async (
         return true;
     });
 });
+test("reads an exact rotation item with revision metadata", async () => {
+    const runner = async (_command, args) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items") {
+            assert.deepEqual(args.slice(0, 4), [
+                "list",
+                "items",
+                "--collectionid",
+                "collection-id",
+            ]);
+            return result(JSON.stringify([{ id: "item-id" }]));
+        }
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: "old-value",
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: "2026-09-10T10:00:00.000Z",
+            }));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const item = await new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    }).readItem("rhdh-qe", "rhdh/test");
+    assert.equal(item.value, "old-value");
+    assert.equal(item.storage, "note");
+    assert.equal(item.revisionDate, "2026-09-10T10:00:00.000Z");
+});
+test("does not treat deletion read errors as a missing item", async () => {
+    let deleted = false;
+    const runner = async (_command, args) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items")
+            return result(JSON.stringify([{ id: "item-id" }]));
+        if (args[0] === "get" && args[1] === "item") {
+            if (deleted)
+                throw new Error("Bitwarden read failed after deletion");
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: "old-value",
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: "revision-1",
+            }));
+        }
+        if (args[0] === "delete" && args[1] === "item") {
+            deleted = true;
+            return result();
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const item = await client.readItem("rhdh-qe", "rhdh/test");
+    await assert.rejects(() => client.deleteItem(item), /item read failed/i);
+});
+test("filters fuzzy search results before reading the exact item", async () => {
+    const calls = [];
+    const runner = async (_command, args) => {
+        calls.push([...args]);
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[1] === "items") {
+            return result(JSON.stringify([
+                { id: "login-id", name: "rhdh/test-login", type: 1 },
+                { id: "item-id", name: "rhdh/test" },
+            ]));
+        }
+        if (args[0] === "get" && args[2] === "item-id") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: "old-value",
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: "revision-1",
+            }));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const item = await new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    }).readItem("rhdh-qe", "rhdh/test");
+    assert.equal(item.id, "item-id");
+    assert.equal(calls.some((args) => args.includes("login-id")), false);
+});
+test("updates and verifies a note-backed rotation item without changing its metadata", async () => {
+    let value = "old-value";
+    let revision = "2026-09-10T10:00:00.000Z";
+    const editInputs = [];
+    const commands = [];
+    const runner = async (_command, args, options) => {
+        commands.push(args[0]);
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items")
+            return result(JSON.stringify([{ id: "item-id" }]));
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: value,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: revision,
+            }));
+        }
+        if (args[0] === "edit") {
+            assert.equal(args[1], "item");
+            assert.equal(args[2], "item-id");
+            const payload = JSON.parse(Buffer.from(options?.input ?? "", "base64").toString("utf8"));
+            assert.equal(payload.notes, "new-value");
+            assert.deepEqual(payload.collectionIds, ["collection-id"]);
+            assert.equal(commands.includes("encode"), false);
+            editInputs.push(options?.input ?? "");
+            value = "new-value";
+            revision = "2026-09-10T11:00:00.000Z";
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: value,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: revision,
+            }));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const item = await client.readItem("rhdh-qe", "rhdh/test");
+    const updated = await client.updateItem(item, "new-value");
+    assert.equal(editInputs.length, 1);
+    assert.equal(updated.value, "new-value");
+    assert.equal(updated.revisionDate, "2026-09-10T11:00:00.000Z");
+});
+test("rejects a note update whose mutation response contains the old value", async () => {
+    let reads = 0;
+    const runner = async (_command, args) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[1] === "items")
+            return result(JSON.stringify([{ id: "item-id" }]));
+        if (args[0] === "get") {
+            reads++;
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: reads > 2 ? "new-value" : "old-value",
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: reads > 2 ? "revision-3" : "revision-1",
+            }));
+        }
+        if (args[0] === "encode")
+            return result("encoded");
+        if (args[0] === "edit") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: "old-value",
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: "revision-3",
+            }));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const existing = await client.readItem("rhdh-qe", "rhdh/test");
+    await assert.rejects(() => client.updateItem(existing, "new-value"), /read-back verification failed/i);
+});
+test("updates and verifies an attachment-backed rotation item", async () => {
+    let attachmentPresent = true;
+    let attachmentValue = "old-certificate";
+    let revision = "2026-09-10T10:00:00.000Z";
+    const runner = async (_command, args) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items") {
+            return result(JSON.stringify([{ id: "item-id" }]));
+        }
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/certificate.pem",
+                notes: null,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: revision,
+                attachments: attachmentPresent
+                    ? [{ id: "attachment-id", fileName: "certificate.pem" }]
+                    : [],
+            }));
+        }
+        if (args[0] === "get" && args[1] === "attachment") {
+            return result(attachmentValue);
+        }
+        if (args[0] === "delete" && args[1] === "attachment") {
+            attachmentPresent = false;
+            return result();
+        }
+        if (args[0] === "create" && args[1] === "attachment") {
+            attachmentPresent = true;
+            attachmentValue = "new-certificate";
+            revision = "2026-09-10T11:00:00.000Z";
+            return result();
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const item = await client.readItem("rhdh-qe", "rhdh/certificate.pem");
+    const updated = await client.updateItem(item, "new-certificate");
+    assert.equal(updated.storage, "attachment");
+    assert.equal(updated.value, "new-certificate");
+});
+test("creates a note-backed item and verifies it without putting the value in arguments", async () => {
+    const storedValue = "new-value";
+    const calls = [];
+    const runner = async (_command, args, options) => {
+        calls.push({ args, input: options?.input });
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "create" && args[1] === "item") {
+            const payload = JSON.parse(Buffer.from(options?.input ?? "", "base64").toString("utf8"));
+            assert.equal(payload.notes, storedValue);
+            return result(JSON.stringify({
+                ...payload,
+                id: "created-item-id",
+                revisionDate: "revision-1",
+            }));
+        }
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "created-item-id",
+                name: "rhdh/test",
+                notes: storedValue,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: "revision-1",
+            }));
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const created = await new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    }).createItem("rhdh-qe", "rhdh/test", storedValue, "note");
+    assert.equal(created.value, storedValue);
+    assert.equal(created.storage, "note");
+    assert.equal(calls.every(({ args }) => !args.includes(storedValue)), true);
+    assert.equal(calls.some(({ args, input }) => args[0] === "create" && input !== undefined), true);
+});
+test("does not hide attachment cleanup failure after a provider write", async () => {
+    const runner = async (_command, args, options) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "create" && args[1] === "item") {
+            assert.match(options?.input ?? "", /^[A-Za-z0-9+/]+=*$/);
+            return result(JSON.stringify({ id: "created-item-id" }));
+        }
+        if (args[0] === "create" && args[1] === "attachment")
+            return result();
+        if (args[0] === "delete" && args[1] === "item")
+            return result();
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    await assert.rejects(() => new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+        removeTemporaryDirectory: async () => {
+            throw new Error("temporary cleanup failed");
+        },
+    }).createItem("rhdh-qe", "rhdh/cert.pem", "certificate", "attachment"), /temporary cleanup failed/i);
+});
+test("converts a note-backed item to an attachment-backed item", async () => {
+    let storage = "note";
+    let value = "old-value";
+    const runner = async (_command, args, options) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items") {
+            return result(JSON.stringify([{ id: "item-id" }]));
+        }
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: storage === "note" ? value : null,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: storage === "note" ? "revision-1" : "revision-2",
+                ...(storage === "attachment"
+                    ? { attachments: [{ id: "attachment-id", fileName: "test" }] }
+                    : {}),
+            }));
+        }
+        if (args[0] === "edit" && args[1] === "item") {
+            const payload = JSON.parse(Buffer.from(options?.input ?? "", "base64").toString("utf8"));
+            assert.equal(payload.notes, null);
+            return result();
+        }
+        if (args[0] === "create" && args[1] === "attachment") {
+            storage = "attachment";
+            value = "new-value";
+            return result();
+        }
+        if (args[0] === "get" && args[1] === "attachment") {
+            return result(value);
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const existing = await client.readItem("rhdh-qe", "rhdh/test");
+    const updated = await client.updateItem(existing, "new-value", "attachment");
+    assert.equal(updated.storage, "attachment");
+    assert.equal(updated.value, "new-value");
+});
+test("restores a note when note-to-attachment edit loses its response", async () => {
+    let storage = "note";
+    let value = "old-value";
+    let edits = 0;
+    const runner = async (_command, args, options) => {
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items")
+            return result(JSON.stringify([{ id: "item-id" }]));
+        if (args[0] === "get" && args[1] === "item") {
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: storage === "note" ? value : null,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: storage === "note" ? "revision-1" : "revision-2",
+                ...(storage === "attachment"
+                    ? { attachments: [{ id: "attachment-id", fileName: "test" }] }
+                    : {}),
+            }));
+        }
+        if (args[0] === "edit" && args[1] === "item") {
+            edits++;
+            const payload = JSON.parse(Buffer.from(options?.input ?? "", "base64").toString("utf8"));
+            storage = payload.notes === null ? "attachment" : "note";
+            value = typeof payload.notes === "string" ? payload.notes : value;
+            if (edits === 1)
+                throw new Error("response lost after edit");
+            return result();
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const existing = await client.readItem("rhdh-qe", "rhdh/test");
+    await assert.rejects(() => client.updateItem(existing, "new-value", "attachment"), /update failed/i);
+    assert.equal(edits, 2);
+    assert.equal(storage, "note");
+    assert.equal(value, "old-value");
+});
+test("deletes an uploaded attachment before restoring a note after read-back failure", async () => {
+    let storage = "note";
+    let value = "old-value";
+    let uploaded = false;
+    let verificationReadFailed = false;
+    const commands = [];
+    const runner = async (_command, args, options) => {
+        commands.push(args.join(" "));
+        if (args[0] === "--version")
+            return result("2026.5.0");
+        if (args[0] === "status")
+            return result(JSON.stringify({ status: "unlocked" }));
+        if (args[0] === "sync")
+            return result();
+        if (args[0] === "list" && args[1] === "collections") {
+            return result(JSON.stringify([
+                {
+                    id: "collection-id",
+                    name: "Rhdh Qe Ci Secrets",
+                    organizationId: "org-id",
+                },
+            ]));
+        }
+        if (args[0] === "list" && args[1] === "items")
+            return result(JSON.stringify([{ id: "item-id" }]));
+        if (args[0] === "get" && args[1] === "item") {
+            if (uploaded && !verificationReadFailed) {
+                verificationReadFailed = true;
+                throw new Error("post-upload read failed");
+            }
+            return result(JSON.stringify({
+                id: "item-id",
+                name: "rhdh/test",
+                notes: storage === "note" ? value : null,
+                type: 2,
+                collectionIds: ["collection-id"],
+                organizationId: "org-id",
+                revisionDate: storage === "note" ? "revision-1" : "revision-2",
+                ...(uploaded
+                    ? {
+                        attachments: [
+                            { id: "uploaded-attachment-id", fileName: "test" },
+                        ],
+                    }
+                    : {}),
+            }));
+        }
+        if (args[0] === "edit" && args[1] === "item") {
+            const payload = JSON.parse(Buffer.from(options?.input ?? "", "base64").toString("utf8"));
+            storage = payload.notes === null ? "attachment" : "note";
+            value = typeof payload.notes === "string" ? payload.notes : value;
+            return result();
+        }
+        if (args[0] === "create" && args[1] === "attachment") {
+            uploaded = true;
+            return result();
+        }
+        if (args[0] === "delete" && args[1] === "attachment") {
+            assert.equal(args[2], "uploaded-attachment-id");
+            uploaded = false;
+            return result();
+        }
+        throw new Error(`Unexpected command: ${args.join(" ")}`);
+    };
+    const client = new BitwardenClient({
+        env: { BW_SESSION: "synthetic-session" },
+        runner,
+    });
+    const existing = await client.readItem("rhdh-qe", "rhdh/test");
+    await assert.rejects(() => client.updateItem(existing, "new-value", "attachment"), /item read failed/i);
+    assert.equal(storage, "note");
+    assert.equal(value, "old-value");
+    assert.equal(uploaded, false);
+    assert.ok(commands.indexOf("delete attachment uploaded-attachment-id") > -1);
+    assert.ok(commands.indexOf("delete attachment uploaded-attachment-id") <
+        commands.lastIndexOf("edit item item-id"));
+});