javascript - Fel med Typescript Pact.io-test: PopsicleError: Kan inte ansluta till

Förväntat: Att köra npm run pactTest bör generera en pact-fil (JSON).

Resultat: Jag får ett Kan inte ansluta-fel.

Pact.io JavaScript-implementeringsguide.

Pact.io Typescript testexempel.

Jag uppskattar alla tankar eller idéer om vad jag gör fel :)

Felet

MISSLYCKAS src/services/api/TotalPayout.test.pact.ts API:et getUsersTotalPayout ✕ Bör kalla getUsersTotalPayout och returnera ett objekt med total_payout (45ms)
● API › getUsersTotalPayout › Bör kalla getUsersTotalPayout och returnera ett objekt med total_utbetalning
PopsicleError: Kunde inte ansluta till "http://127.0.0.1:12345/interactions" Orsakad av: Fel: connect ECONNREFUSED 127.0.0.1:12345
 at Request.Object.<anonymous>.Request.error (node_modules/popsicle/src/request.ts:91:12)
  at ClientRequest.<anonymous> (node_modules/popsicle/src/index.ts:218:31)

package.json-skript:

"pactTest": "export NODE_ENV=pactTest && jest --testRegex \"/*(.test.pact.ts)\" --runInBand --setupFiles ./pactSetup.ts --setupTestFrameworkScriptFile ./pactTestWrapper.ts",

Min src/pactSetup.ts-fil

// @ts-ignore
import path from 'path';
import { Pact } from '@pact-foundation/pact/pact';

// @ts-ignore
global.provider = new Pact({
  port: 1234,
  log: path.resolve(process.cwd(), 'logs', 'mockserver-integration.log'),
  dir: path.resolve(process.cwd(), 'pacts'),
  spec: 2,
  cors: true,
  pactfileWriteMode: 'update',
  consumer: 'Exchange',
  provider: 'LP Service'
});

Min src/pactTestWrapper.ts

jasmine.DEFAULT_TIMEOUT_INTERVAL = 10000; // This is to give the pact mock server time to start

// @ts-ignore
beforeAll(() => provider.setup()); // Create mock provider
// @ts-ignore
afterEach(() => provider.verify()); // Ensure the mock provider verifies expected interactions for each test
// @ts-ignore
afterAll(() => provider.finalize()); // Tear down the mock and write the pact

Testet: src/services/api/TotalPayout.test.pact.ts

// @ts-ignore
import path from 'path';
import { Pact } from '@pact-foundation/pact';
import { getTotalPayout } from './apiPayout';

const port = 12345;
const endpoint = '/frontoffice/api/get-total-payout';

const EXPECTED_BODY = {
  total_payout: 100.21,
};

const userId = 'foo';

const provider = new Pact({
  port,
  log: path.resolve(process.cwd(), 'logs', 'mockserver-integration.log'),
  dir: path.resolve(process.cwd(), 'pacts'),
  spec: 2,
  consumer: 'Exchange',
  provider: 'LP Service',
  pactfileWriteMode: 'merge'
});

describe('The API', () => {
  // Copy this block once per interaction under test
  describe('getUsersTotalPayout', () => {
    beforeEach(() => {
      const interaction = {
        uponReceiving: 'a GET request with a user id',
        withRequest: {
          method: 'GET',
          path: endpoint,
          headers: {
            Accept: 'application/json',
          },
        },
        willRespondWith: {
          status: 200,
          headers: {
            'Content-Type': 'application/json'
          },
          body: EXPECTED_BODY
        },
      };

      // @ts-ignore
      return provider.addInteraction(interaction);
    });

    // add expectations
    it('Should call getUsersTotalPayout and return an object with the total_payout', done => {
      getTotalPayout(userId)
        .then((response: any) => {
          expect(response).toEqual(EXPECTED_BODY);
        })
        .then(done);
    });
  });
});

API-tjänstfilen apiPayout.ts

// @ts-ignore
import axios, * as others from 'axios';

const endpoint = '/frontoffice/api/';

export const getTotalPayout = async (userId: string) => {
  const response = await axios.get(`${endpoint}get-total-payout`, { params: userId });
  return response.data;
};

Från mockserver-integration.log

I, [2018-09-19T11:07:41.259437 #79922]  INFO -- : Verifying - interactions matched
I, [2018-09-19T11:07:41.264440 #79922]  INFO -- : Cleared interactions

Från debug-loggen

20 error code ELIFECYCLE
21 error errno 1
22 error [email  pactTest: `export NODE_ENV=pactTest && jest --testRegex "/*(.test.pact.ts)" --runInBand --setupFiles ./pactSetup.ts --setupTestFrameworkScriptFile ./pactTestWrapper.ts`
22 error Exit status 1
23 error Failed at the [email  pactTest script.

Uppdatera

Efter att ha kommenterat ut leverantörsinställningslogiken i test.pact-filen och kört npm run pactTest igen får jag följande:

console.error node_modules/@pact-foundation/pact/pact.js:110 Pact-verifiering misslyckades!
console.error node_modules/@pact-foundation/pact/pact.js:111 Faktiska interaktioner stämmer inte överens med förväntade interaktioner för mock MockService.
Saknade förfrågningar: GET /frontoffice/api/liquidity-pool/get-total-payout
Se /Users/leongaban/projects/trade.io/tradeio-front/logs/mockserver-integration.log för detaljer.

Och min uppdaterade mockserver-integration.log

I, [2018-09-19T14:12:19.128823 #82330]  INFO -- : Registered expected interaction GET /frontoffice/api/liquidity-pool/get-total-payout
D, [2018-09-19T14:12:19.129127 #82330] DEBUG -- : {
  "description": "a GET request with a user id",
  "request": {
    "method": "GET",
    "path": "/frontoffice/api/liquidity-pool/get-total-payout",
    "headers": {
      "Accept": "application/json"
    }
  },
  "response": {
    "status": 200,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "total_payout": 100.21
    }
  }
}
W, [2018-09-19T14:12:19.139198 #82330]  WARN -- : Verifying - actual interactions do not match expected interactions. 
Missing requests:
    GET /frontoffice/api/liquidity-pool/get-total-payout


W, [2018-09-19T14:12:19.139254 #82330]  WARN -- : Missing requests:
    GET /frontoffice/api/liquidity-pool/get-total-payout

Svar #1

Flera problem kan jag påpeka:

Det verkar som att du deklarerar och startar en pact-mockserver två gånger: i filen src/pactSetup.ts och även i TotalPayout.test.pact.ts, vilket jag inte är säker på att det är vad du avsåg att göra. Du vill förmodligen undvika att deklarera providern i TotalPayout-testet, och istället har du redan provider-objektet på global nivå som en del av testramverksuppsättningsfilerna.
I koden apiPayout.ts refererar du till slutpunkts-URL:en, men till vilken port skickas förfrågan? Detta API-anrop bör slutligen fångas av pact-mock-leverantören som du startar. Om du skickar anrop till en annan port än den som mock-leverantören lyssnar på kommer du aldrig nå den.
En liten detalj: /frontoffice/api/get-total-payout är inte RESTful. Du vill undvika att inkludera verb som "get" i ditt API och använda rätt HTTP-metod för det (GET).

Svar #2

Inte säker på om det var ditt problem, men jag hade ordningen för writePact och finalize fel. Jag hade:

afterAll(async () => {
  await provider.finalize()
  await provider.writePact()
})

istället för den korrekta ordningen:

afterAll(async () => {
  await provider.writePact()
  await provider.finalize()
})