Jasmine 测试异步 Mock 函数多次调用失败问题排查与解决

本文旨在解决 Jasmine 测试中，异步 Mock 函数在同一个测试函数内被多次调用时，后续调用无法正确执行的问题。通过分析问题原因，提供有效的解决方案，并给出完整的代码示例，帮助开发者避免类似错误，确保测试的准确性和可靠性。

在 Jasmine 中测试异步代码时，经常会用到 jasmine.createSpy 来 Mock 函数，并使用 and.returnValue 或 and.returnValues 来指定返回值。 然而，当同一个异步 Mock 函数在同一个测试函数中被多次调用时，可能会遇到后续调用无法正确执行，导致测试失败的问题。

问题分析

问题的根源在于异步函数的执行特性以及 Jasmine 对异步 Mock 函数的处理方式。当一个函数被 Mock 并且返回一个 Promise 时，如果没有正确处理 Promise 的 resolve 或 reject， Jasmine 可能无法正确地追踪函数的调用次数和返回值。

解决方案

解决此问题的关键在于确保异步函数被正确地 await，并且 Mock 函数返回的 Promise 被正确地 resolve。以下是一些常见的解决方案：

1. 确保 await 关键字的使用

   在调用异步函数时，务必使用 await 关键字，以便等待 Promise resolve 后再继续执行后续代码。如果缺少 await，函数将立即返回 Promise 对象，而不会等待 Promise 的结果，导致后续的断言失败。

   // 错误示例
   deleteProject = getDialogAnswer(title, optiontext, choices, defaultvalue);
   
   // 正确示例
   deleteProject = await getDialogAnswer(title, optiontext, choices, defaultvalue);

   登录后复制

2. 在 Mock 函数中返回 resolved 的 Promise

   使用 jasmine.createSpy 创建 Mock 函数时，确保使用 Promise.resolve() 返回一个 resolved 的 Promise。这可以确保 Jasmine 正确地追踪函数的调用和返回值。

   const getDialogAnswer = jasmine.createSpy('Mock_getDialogAnswer').and.returnValues(
       Promise.resolve('yes'),
       Promise.resolve('yes')
   );

   登录后复制

   或者，可以使用 and.returnValue 简化单个返回值的情况：

   const getDialogAnswer = jasmine.createSpy('Mock_getDialogAnswer').and.returnValue(Promise.resolve('yes'));

   登录后复制

3. 确保测试函数是异步的

   测试函数本身也需要声明为 async 函数，以便能够使用 await 关键字。

   it("should delete on yes + yes", async () => {
       // 测试代码
   });

   登录后复制

4. 检查应用程序代码中是否缺少 async 或 await

   有时候问题可能不在测试代码中，而是在应用程序代码中缺少 async 或 await 关键字。 确保所有需要等待 Promise resolve 的地方都使用了 await。

   this.objmethod1 = async function () {
       const async_objmethod = async function(){
           let deleteProject = await getDialogAnswer()
           deleteProject = await getDialogAnswer()
           this.objmethod2();
           this.objmethod3()
           this.objmethod4();
           unsaved_changes = true;
           method5(this.name);
       }
       await async_objmethod.bind(this)();
   };

   登录后复制

完整示例

以下是一个完整的示例，演示了如何正确地测试异步 Mock 函数的多次调用：

maincode.js

function main_obj() {
    this.objmethod1 = async function () {
        const async_objmethod = async function(){
            let deleteProject = await getDialogAnswer()
            deleteProject = await getDialogAnswer()
            this.objmethod2();
            this.objmethod3()
            this.objmethod4();
            unsaved_changes = true;
            method5(this.name);
        }
        await async_objmethod.bind(this)();
    };
    this.objmethod2 = function () {};
    this.objmethod3 = function () {};
    this.objmethod4 = function () {};
}

test_spec.js

const getDialogAnswer = jasmine.createSpy('Mock_getDialogAnswer').and.returnValue(
    Promise.resolve('yes')
);
const method5 = jasmine.createSpy('Mock_method5')
let unsaved_changes;

// var for main_inst instance set in 'before-funcs'
let main_inst
beforeEach(function() {
    main_inst = new main_obj();
    unsaved_changes = null
    spyOn(main_inst, 'objmethod2')
    spyOn(main_inst, 'objmethod3')
    spyOn(main_inst, 'objmethod4')
});

describe("Test makemain_inst.js", () => {
    describe("Test new jquery ui dialog functions", () => {
        describe("test dialog uses", () => {
            describe("test this.objmethod1()", () => {
                describe("test yes no", () => {
                    it("should delete on yes + yes", async () => {
                        // ------------ setup -------------
                        // --------   Call ----------------
                        const x = await main_inst.objmethod1()
                        // ------------- verify ------------
                        expect(getDialogAnswer).toHaveBeenCalledTimes(2)

                        expect(main_inst.objmethod2).toHaveBeenCalledTimes(1)
                        expect(main_inst.objmethod3).toHaveBeenCalledTimes(1)
                        expect(main_inst.objmethod4).toHaveBeenCalledTimes(1)
                        expect(method5).toHaveBeenCalledTimes(1)
                        expect(unsaved_changes).toBe(true);
                    });
                });
            });
        });
    });
});

总结

在 Jasmine 中测试异步 Mock 函数的多次调用时，需要特别注意 async、await 和 Promise 的正确使用。 确保 Mock 函数返回 resolved 的 Promise，并在调用异步函数时使用 await 关键字。 通过仔细检查代码，可以避免类似问题，并确保测试的准确性和可靠性。

以上就是Jasmine 测试异步 Mock 函数多次调用失败问题排查与解决的详细内容，更多请关注php中文网其它相关文章！