使用 Pact 和 Angular 进行 API 合约测试

Question

我有这个功能：

saveApplication(details: Application): Observable<any> {
return this.http.post(`http://localhost:5000/Apply`, details);
}

我正在为它编写一个 Pact 测试（API 合同测试），下面是测试：

describe('ApplicationService contract testing', () => {

let provider: PactWeb;
let applicationService: ApplicationService;

beforeAll(function (done) {

    provider = new PactWeb({
        cors: true, host: '127.0.0.1', port: 9776, logLevel: 'error'
    });
    setTimeout(done, 2000);

    provider.removeInteractions();
});

afterAll(function (done) {
    provider.finalize().then(function () {
        done();
    }, function (err) { done.fail(err); });
});
beforeEach(() => {

    TestBed.configureTestingModule({
        providers: [ApplicationService],
        imports: [HttpClientTestingModule]
    });

    applicationService = getTestBed().get(ApplicationService);
});

afterEach((done) => {
    provider.verify().then(done, e => done.fail(e));
});
describe('Save', () => {

    const _details: Application = {
        title: 'Mr', firstName: 'Application', lastName: 'applicant',
        dob: new Date(1977, 10, 10).toString(), gender: 'M'
    };
    beforeAll((done) => {

        provider.addInteraction({
            state: ' a task to save the dashboard application to mongo',
            uponReceiving: ' a request to post',
            withRequest: {
                method: 'POST',
                headers: { 'Content-Type': 'application/json' },
                path: '/Apply', body: _details
            }, willRespondWith:
            {
                status: 201,
                headers: {
                    'Content-Type': 'application/json'
                }
            }
        }).then(done, e => done.fail(e));
        it('should call the API to Post the application Content', (done) => {

            const _response: any = {};
            applicationService.saveApplication(_details).subscribe(res => {
                expect(res).toEqual(_response);
                done();
            }, error => { done.fail(error); }
            );
        });
    });

});
});

当 id npm run test 或 ng test 时，测试没有运行，ut 正在创建 pacts 目录。我不知道我的配置中缺少什么

这就是我在 Karma 中所拥有的：

 frameworks: ['jasmine', '@angular-devkit/build-angular','pact'],
 plugins: [....,
  require('@pact-foundation/karma-pact')],
 pact: [{
  cors: true,
  port: 9776,
  consumer: "ui",
  provider: "Apply",
  dir: "pacts/",
  spec: 2
}],
proxies: {
  '/api/applications/v1/': 'http://localhost:9776/Apply/'
},

不知道我错过了什么。有什么帮助吗？

Answer 1

如果您的测试根本没有运行，但正在生成 pact 文件夹，这意味着：

1. karma-pact 插件正在启动并启动
2. 有一些问题导致测试完全无法运行

我会先从你的测试中删除所有的协议内容，直到你可以进行绿色测试（这不会做任何事情），然后一个接一个地添加。

我不太清楚代理发生了什么，但它似乎与您的代码实际执行的操作不一致（代理路径是 /api/applications/v1，它似乎将它发送到端口 9776 上的 Pact，但是您的代码直接命中路径/Apply）。

我不是角度专家，所以以防万一不清楚，您需要确保您的 saveApplication 函数在测试中调用实际的 pact 模拟服务。

旁注：done 的使用已经很老了，在大多数情况下你应该可以翻译：

afterAll(function (done) {
    provider.finalize().then(function () {
        done();
    }, function (err) { done.fail(err); });
});

到：

afterAll(() => provider.finalize())