Jest和TypeScript的存根不完整

时间:2019-12-06 11:50:03

标签: typescript testing jestjs sinon

我正在尝试使用Jest测试一个函数。由于我使用的是TypeScript,因此编译器困扰我确保我的存根返回所有对象字段。我不需要所有对象字段,只需其中两个。更糟糕的是,它要我返回的对象相当复杂。

我有什么

import * as sinon from "sinon";
import * as stripeHelpers from "../../src/lib/stripe";

describe("lib/authorization", () => {
    let sandbox: sinon.SinonSandbox;
    beforeAll(() => {
        sandbox = sinon.createSandbox();
    });

    afterEach(() => {
        sandbox.restore();
    });

    describe("getAuthorizationDateRange", () => {
        test("returns an authorization date range", async () => {
            const getUserSubscriptionStub = sandbox.stub(stripeHelpers, "getUserSubscription").resolves({
                current_period_end: 123123,
                current_period_start: 123123,
                object: "subscription",
                application_fee_percent: undefined,
                billing: "charge_automatically",
                collection_method: "charge_automatically",
                billing_cycle_anchor: 0,
                billing_thresholds: undefined,
                cancel_at: undefined,
                cancel_at_period_end: true,
                canceled_at: undefined,
                created: 0,
                customer: "test",
                days_until_due: undefined,
                default_payment_method: "test",
                default_source: "test",
                default_tax_rates: [],
                discount: undefined,
                ended_at: undefined,
                items,
                latest_invoice: "test",
                livemode: true,
                metadata: {},
                start: 0,
                start_date: 0,
                status: "active",
                tax_percent: undefined,
                trial_end: undefined,
                trial_start: undefined,
            });
        });
    });
});

我想做什么

import * as sinon from "sinon";
import * as stripeHelpers from "../../src/lib/stripe";

describe("lib/authorization", () => {
    let sandbox: sinon.SinonSandbox;
    beforeAll(() => {
        sandbox = sinon.createSandbox();
    });

    afterEach(() => {
        sandbox.restore();
    });

    describe("getAuthorizationDateRange", () => {
        test("returns an authorization date range", async () => {
            const getUserSubscriptionStub = sandbox.stub(stripeHelpers, "getUserSubscription").resolves({
                current_period_end: 123123,
                current_period_start: 123123,
            });
        });
    });
});

正在测试的功能

export async function getAuthorizationDateRange(user: User): Promise<DateRange> {
    const subscription: Stripe.subscriptions.ISubscription = await stripeHelpers.getUserSubscription(user);
    return {
        start: moment.unix(subscription.current_period_start).toDate(),
        end: moment.unix(subscription.current_period_end).toDate()
    };
}

该函数仅使用前两个属性,因此尝试重新创建 entire 对象感觉很浪费。 Stripe.subscriptions.ISubscription接口有很多嵌套和复杂之处,我在测试中要避免。

1 个答案:

答案 0 :(得分:0)

事实证明,您只需要将该对象强制转换为显式any

const getUserSubscriptionStub = sandbox.stub(stripeHelpers, "getUserSubscription").resolves({
    current_period_end: 123123,
    current_period_start: 123123,
} as any);