1

我正在为使用这样的email-templates模块的方法编写单元测试:

var EmailTemplate = require('email-templates').EmailTemplate;

module.exports = {
    sendTemplateEmail: function (emailName, data, subject, to, from) {
        var template = new EmailTemplate(__dirname + "/../emails/" + emailName);

        data.from = FROM;
        data.host = config.host;

        return template.render(data)
            .then(function (result) {
                return mailer.sendEmail(subject, to, from, result.html, result.text);
            })
            .then(function () {
                log.info(util.format("Sent %s email to %s. data=%s", emailName, to, JSON.stringify(data)));
                return Promise.resolve();
            })
            .catch(function (err) {
                return Promise.reject(new InternalError(err, "Error sending %s email to %s. data=%s", emailName, to, JSON.stringify(data)));
            });
    }
};

单元测试如下所示:

var assert = require("assert"),
    sinon = require("sinon"),
    Promise = require("bluebird"),
    proxyquire = require("proxyquire");

describe('mailer#sendTemplateEmail', function () {
    var templates,
        template;

    beforeEach(function() {
        templates = {
            EmailTemplate: function(path) {}
        };
        template = {
            render: function(data) {}
        };

        sinon.stub(templates, "EmailTemplate").returns(template);
    });

    it("should reject immediately if template.render fails", function () {
        const TO = {email: "user1@example.com", first: "User"};
        const FROM = {email: "user2@example.com", first: "User"};
        const EMAIL_NAME = "results";
        const SUBJECT = "Results are in!";
        const DATA = {
            week: 10,
            season: "2015"
        };

        var err = new Error("error");
        var mailer = proxyquire("../src/mailer", {
            "email-templates": templates
        });

        sinon.stub(template, "render").returns(Promise.reject(err));

        return mailer.sendTemplateEmail(EMAIL_NAME, DATA, SUBJECT, TO, FROM)
                .then(function () {
                    assert.fail("Expected a rejected promise.");
                })
                .catch(function (err) {
                    assert(err.message === "error");
                    assert(mailer.sendEmail.notCalled);
                });
    });
};

我遇到的问题是在sendTemplateEmail实例化一个新EmailTemplate对象的函数的第一行。被调用的EmailTemplate构造函数指向在 中定义的非存根EmailTemplate函数beforeEach,而不是在最后一行创建的 sinon 存根beforeEach。但是,如果我评估该require('email-templates').EmailTemplate语句,它会正确地指向 sinon 存根。我宁愿不必更改我的代码来调用内联的 require 语句,例如:

var template = new require('email-templates').EmailTemplate(__dirname + "/../emails/" + emailName);

有没有办法按照我的意图完成存根?

4

1 回答 1

1

您可以在构建邮件程序时注入您的依赖项 - exp:

function mailer(options) {
  options = options || {};
  this.email_template = options.email_template;
}

然后在 sendTemplateEmail 函数中 - 使用 email_template 成员。

另外 - 不确定你的邮件代码 - 但是如果你需要你的邮件在你的代码中充当一个单例(并且它还没有) - 你可以将它添加到你的邮件中:

module.exports = {
    getInstance: function(emailTemplate) {
        if(this.instance === null){
            this.instance = new mailer(emailTemplate);
        }
        return this.instance;
    }
}

然后,当您需要您的邮件时,您可以使用以下语法:

var template = new require('email-templates').EmailTemplate(__dirname + "/../emails/" + emailName);
var mail = mailer.getInstance(template);

这样,您的应用程序(单元测试框架或您的实际/真实世界的应用程序)将确定将在流程生命周期内使用的邮件程序的类型。

于 2015-12-24T19:53:51.843 回答