jjzjj

javascript - JavaScript/Mocha-如何测试是否已等待函数调用

coder 2024-07-26 原文

我想编写一个测试,检查我的函数是否使用await关键字调用其他函数。

我希望我的测试失败:

async methodA() {
   this.methodB();
   return true; 
},

我希望我的测试能够成功:
async methodA() {
   await this.methodB();
   return true;
},

我也想让成功地使成为我的测试:
methodA() {
   return this.methodB()
       .then(() => true);
},

我有一个解决方案,方法是使用process.nextTick对该方法进行 stub 并强制其在其中返回假 promise ,但这似乎很丑陋,我不想在测试中使用process.nextTicksetTimeout等。

ugly-async-test.js
const { stub } = require('sinon');
const { expect } = require('chai');

const testObject = {
    async methodA() {
        await this.methodB();
    },
    async methodB() {
        // some async code
    },
};

describe('methodA', () => {
    let asyncCheckMethodB;

    beforeEach(() => {
        asyncCheckMethodB = stub();
        stub(testObject, 'methodB').returns(new Promise(resolve => process.nextTick(resolve)).then(asyncCheckMethodB));
    });

    afterEach(() => {
        testObject.methodB.restore();
    });

    it('should await methodB', async () => {
        await testObject.methodA();
        expect(asyncCheckMethodB.callCount).to.be.equal(1);
    });
});

测试函数调用中是否使用了await的聪明方法是什么?

最佳答案

TLDR

如果methodA调用await上的methodB,则Promise返回的methodA将无法解析,直到Promise返回的methodB解析为止。

另一方面,如果methodA未在await上调用methodB,则Promise返回的methodA将立即解析Promise返回的methodB是否已解决。

因此,测试methodA是否在await上调用methodB仅仅是测试Promise返回的methodA是否等待Promise返回的methodB解析之后再解决:

const { stub } = require('sinon');
const { expect } = require('chai');

const testObject = {
  async methodA() {
    await this.methodB();
  },
  async methodB() { }
};

describe('methodA', () => {
  const order = [];
  let promiseB;
  let savedResolve;

  beforeEach(() => {
    promiseB = new Promise(resolve => {
      savedResolve = resolve;  // save resolve so we can call it later
    }).then(() => { order.push('B') })
    stub(testObject, 'methodB').returns(promiseB);
  });

  afterEach(() => {
    testObject.methodB.restore();
  });

  it('should await methodB', async () => {
    const promiseA = testObject.methodA().then(() => order.push('A'));
    savedResolve();  // now resolve promiseB
    await Promise.all([promiseA, promiseB]);  // wait for the callbacks in PromiseJobs to complete
    expect(order).to.eql(['B', 'A']);  // SUCCESS: 'B' is first ONLY if promiseA waits for promiseB
  });
});



细节

在您的所有三个代码示例中,methodAmethodB都返回Promise

我将Promise返回的methodA称为promiseA,将Promise返回的methodB称为promiseB

您要测试的是promiseA是否等待解析直到promiseB解析。

首先,让我们看一下如何测试promiseA不等待promiseB

测试promiseA是否不等待promiseB

测试否定情况(promiseA不等待promiseB)的一种简单方法是模拟methodB以返回从未解决Promise:

describe('methodA', () => {

  beforeEach(() => {
    // stub methodB to return a Promise that never resolves
    stub(testObject, 'methodB').returns(new Promise(() => {}));
  });

  afterEach(() => {
    testObject.methodB.restore();
  });

  it('should NOT await methodB', async () => {
    // passes if promiseA did NOT wait for promiseB
    // times out and fails if promiseA waits for promiseB
    await testObject.methodA();
  });

});

这是一个非常干净,简单和直接的测试。

如果我们可以返回相反的结果,那就太棒了……如果此测试会使失败,则返回 true

不幸的是,这不是一个合理的方法,因为如果promiseA确实是await promiseB,则此测试会使超时。

我们将需要一种不同的方法。

背景信息

在继续之前,这里有一些有用的背景信息:

JavaScript使用message queue。下一条开始之前的当前消息runs to completion。运行测试时,测试是当前消息。

ES6引入了PromiseJobs queue来处理“响应 promise 的解决方案”的工作。 PromiseJobs队列中的所有作业都在当前消息完成之后且下一条消息开始之前运行。

因此,当Promise解析后,其then回调将添加到PromiseJobs队列中,并且当当前消息完成时,PromiseJobs中的所有作业将按顺序运行,直到队列为空。
asyncawait只是syntactic sugar over promises and generators。在await上调用Promise本质上将其余函数包装在PromiseJobs中计划的回调中,等待的Promise解析后再进行调度。

我们需要的是一个测试,该测试将告诉我们promiseA DID是否等待promiseB而不超时。

由于我们不希望测试超时,因此promiseApromiseB 都必须解析。

因此,目标是找出一种方法来判断promiseA是否正在等待promiseB,因为它们都在解析。

答案是利用PromiseJobs队列。

考虑一下这个测试:

it('should result in [1, 2]', async () => {
  const order = [];
  const promise1 = Promise.resolve().then(() => order.push('1'));
  const promise2 = Promise.resolve().then(() => order.push('2'));
  expect(order).to.eql([]);  // SUCCESS: callbacks are still queued in PromiseJobs
  await Promise.all([promise1, promise2]);  // let the callbacks run
  expect(order).to.eql(['1', '2']);  // SUCCESS
});
Promise.resolve()返回已解析的Promise,因此这两个回调将立即添加到PromiseJobs队列中。暂停当前​​消息(测试)以等待PromiseJobs中的作业后,它们将按照添加到PromiseJobs队列中的顺序运行,并且当测试在await Promise.all之后继续运行时,order数组将按预期包含['1', '2']

现在考虑这个测试:

it('should result in [2, 1]', async () => {
  const order = [];
  let savedResolve;
  const promise1 = new Promise((resolve) => {
    savedResolve = resolve;  // save resolve so we can call it later
  }).then(() => order.push('1'));
  const promise2 = Promise.resolve().then(() => order.push('2'));
  expect(order).to.eql([]);  // SUCCESS
  savedResolve();  // NOW resolve the first Promise
  await Promise.all([promise1, promise2]);  // let the callbacks run
  expect(order).to.eql(['2', '1']);  // SUCCESS
});

在这种情况下,我们从第一个resolve中保存Promise,以便稍后使用。由于第一个Promise尚未解析,因此then回调不会立即添加到PromiseJobs队列中。另一方面,第二个Promise已经解决,因此其then回调已添加到PromiseJobs队列中。一旦发生这种情况,我们将调用保存的resolve,以便解析第一个Promise,这会将其then回调添加到PromiseJobs队列的末尾。一旦当前消息(测试)暂停以等待PromiseJobs中的作业,order数组将按预期包含['2', '1']

What is the smart way to test if await was used in the function call?



测试函数调用中是否使用了await的明智方法是向thenpromiseA都添加promiseB回调,然后延迟解析promiseB 。如果promiseA等待promiseB,则其回调将始终是PromiseJobs队列中的最后。另一方面,如果promiseA不等待promiseB,则其回调将在PromiseJobs中首先在队列中排队。

最终解决方案在 TLDR 部分中。

请注意,当methodA是调用async上的awaitmethodB函数时,以及当methodA是返回链接到async返回的PromisePromise的普通(非methodB)函数时,这种方法都有效(这是期望的,因为同样,async / await只是Promises和生成器上的语法糖。

关于javascript - JavaScript/Mocha-如何测试是否已等待函数调用,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/54998608/

有关javascript - JavaScript/Mocha-如何测试是否已等待函数调用的更多相关文章

  1. ruby - 如何使用 Nokogiri 的 xpath 和 at_xpath 方法 - 2

    我正在学习如何使用Nokogiri,根据这段代码我遇到了一些问题:require'rubygems'require'mechanize'post_agent=WWW::Mechanize.newpost_page=post_agent.get('http://www.vbulletin.org/forum/showthread.php?t=230708')puts"\nabsolutepathwithtbodygivesnil"putspost_page.parser.xpath('/html/body/div/div/div/div/div/table/tbody/tr/td/div

  2. ruby - 如何从 ruby​​ 中的字符串运行任意对象方法? - 2

    总的来说,我对ruby​​还比较陌生,我正在为我正在创建的对象编写一些rspec测试用例。许多测试用例都非常基础,我只是想确保正确填充和返回值。我想知道是否有办法使用循环结构来执行此操作。不必为我要测试的每个方法都设置一个assertEquals。例如:describeitem,"TestingtheItem"doit"willhaveanullvaluetostart"doitem=Item.new#HereIcoulddotheitem.name.shouldbe_nil#thenIcoulddoitem.category.shouldbe_nilendend但我想要一些方法来使用

  3. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  4. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  5. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  6. ruby-on-rails - 'compass watch' 是如何工作的/它是如何与 rails 一起使用的 - 2

    我在我的项目目录中完成了compasscreate.和compassinitrails。几个问题:我已将我的.sass文件放在public/stylesheets中。这是放置它们的正确位置吗?当我运行compasswatch时,它不会自动编译这些.sass文件。我必须手动指定文件:compasswatchpublic/stylesheets/myfile.sass等。如何让它自动运行?文件ie.css、print.css和screen.css已放在stylesheets/compiled。如何在编译后不让它们重新出现的情况下删除它们?我自己编译的.sass文件编译成compiled/t

  7. ruby - 如何将脚本文件的末尾读取为数据文件(Perl 或任何其他语言) - 2

    我正在寻找执行以下操作的正确语法(在Perl、Shell或Ruby中):#variabletoaccessthedatalinesappendedasafileEND_OF_SCRIPT_MARKERrawdatastartshereanditcontinues. 最佳答案 Perl用__DATA__做这个:#!/usr/bin/perlusestrict;usewarnings;while(){print;}__DATA__Texttoprintgoeshere 关于ruby-如何将脚

  8. ruby - 如何指定 Rack 处理程序 - 2

    Rackup通过Rack的默认处理程序成功运行任何Rack应用程序。例如:classRackAppdefcall(environment)['200',{'Content-Type'=>'text/html'},["Helloworld"]]endendrunRackApp.new但是当最后一行更改为使用Rack的内置CGI处理程序时,rackup给出“NoMethodErrorat/undefinedmethod`call'fornil:NilClass”:Rack::Handler::CGI.runRackApp.newRack的其他内置处理程序也提出了同样的反对意见。例如Rack

  9. ruby - 如何每月在 Heroku 运行一次 Scheduler 插件? - 2

    在选择我想要运行操作的频率时,唯一的选项是“每天”、“每小时”和“每10分钟”。谢谢!我想为我的Rails3.1应用程序运行调度程序。 最佳答案 这不是一个优雅的解决方案,但您可以安排它每天运行,并在实际开始工作之前检查日期是否为当月的第一天。 关于ruby-如何每月在Heroku运行一次Scheduler插件?,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questions/8692687/

  10. ruby-on-rails - 如何从 format.xml 中删除 <hash></hash> - 2

    我有一个对象has_many应呈现为xml的子对象。这不是问题。我的问题是我创建了一个Hash包含此数据,就像解析器需要它一样。但是rails自动将整个文件包含在.........我需要摆脱type="array"和我该如何处理?我没有在文档中找到任何内容。 最佳答案 我遇到了同样的问题;这是我的XML:我在用这个:entries.to_xml将散列数据转换为XML,但这会将条目的数据包装到中所以我修改了:entries.to_xml(root:"Contacts")但这仍然将转换后的XML包装在“联系人”中,将我的XML代码修改为

随机推荐