integration.test.js

/* eslint-disable sonarjs/no-duplicate-string */
const path = require('path');
const Generator = require('@asyncapi/generator');
const { readFile } = require('fs').promises;

const MAIN_TEST_RESULT_PATH = path.join('test', 'temp', 'integrationTestResult');

const generateFolderName = () => {
  // you always want to generate to new directory to make sure test runs in clear environment
  return path.resolve(MAIN_TEST_RESULT_PATH, Date.now().toString());
};

describe('template integration tests for generated files using the generator and mqtt example - v2 spec', () => {
  jest.setTimeout(30000);

  it.each`
    server                  | description
    ${'production'}         | ${'should generate proper handlers and routes files'}
    ${'production-mqtts'}   | ${'should use mqtt logic for mqtts protocol'}
  `(
    '$description',
    async ({ server}) => {
      const outputDir = generateFolderName();
      const params = {
        server
      };
      const mqttExamplePath = './mocks/mqtt/asyncapi.yml';

      const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
      await generator.generateFromFile(path.resolve('test', mqttExamplePath));

      const expectedFiles = [
        '/src/api/handlers/smartylighting-streetlights-1-0-action-{streetlightId}-dim.js',
        '/src/api/handlers/smartylighting-streetlights-1-0-action-{streetlightId}-turn-off.js',
        '/src/api/handlers/smartylighting-streetlights-1-0-action-{streetlightId}-turn-on.js',
        '/src/api/handlers/smartylighting-streetlights-1-0-event-{streetlightId}-lighting-measured.js',
        '/src/api/routes/smartylighting-streetlights-1-0-action-{streetlightId}-dim.js',
        '/src/api/routes/smartylighting-streetlights-1-0-action-{streetlightId}-turn-off.js',
        '/src/api/routes/smartylighting-streetlights-1-0-action-{streetlightId}-turn-on.js',
        '/src/api/routes/smartylighting-streetlights-1-0-event-{streetlightId}-lighting-measured.js',
        '/src/api/index.js',
        '/config/common.yml',
        '/package.json'
      ];
      for (const index in expectedFiles) {
        const file = await readFile(path.join(outputDir, expectedFiles[index]), 'utf8');
        expect(file).toMatchSnapshot();
      }
    }
  );
});

describe('template integration tests for generated files using the generator and kafka example - v2 spec', () => {
  jest.setTimeout(30000);

  const outputDir = generateFolderName();
  const params = {
    server: 'test',
    securityScheme: 'certs',
    certFilesDir: './mocks/kafka/dummyCerts'
  };
  const kafkaExamplePath = './mocks/kafka/asyncapi.yml';

  it('should generate proper config for X509 security', async() => {
    const expectedSecuritySetting = 'rejectUnauthorized: true';
    const expectedConfigFile = '/config/common.yml';

    const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
    await generator.generateFromFile(path.resolve('test', kafkaExamplePath));

    const file = await readFile(path.join(outputDir, expectedConfigFile), 'utf8');
    expect(file.includes(expectedSecuritySetting)).toBeTruthy();
  });

  it('should generate proper variable that points to custom cert files location', async() => {
    const expectedVariable = 'const certFilesDir = \'./mocks/kafka/dummyCerts\';';
    const expectedFile = '/src/api/index.js';

    const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
    await generator.generateFromFile(path.resolve('test', kafkaExamplePath));

    const file = await readFile(path.join(outputDir, expectedFile), 'utf8');
    expect(file.includes(expectedVariable)).toBeTruthy();
  });
});

describe('template integration tests for generated files using the generator and mqtt example - v3 spec', () => {
  jest.setTimeout(30000);

  it.each`
    server                  | description
    ${'production'}         | ${'should generate proper handlers and routes files'}
  `(
    '$description',
    async ({ server}) => {
      const outputDir = generateFolderName();
      const params = {
        server
      };
      const mqttExamplePath = './mocks/mqtt/asyncapi-v3.yml';

      const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
      await generator.generateFromFile(path.resolve('test', mqttExamplePath));

      const expectedFiles = [
        '/src/api/handlers/lightTurnOff.js',
        '/src/api/handlers/lightingMeasured.js',
        '/src/api/handlers/lightTurnOn.js',
        '/src/api/handlers/lightsDim.js',
        '/src/api/routes/lightTurnOff.js',
        '/src/api/routes/lightingMeasured.js',
        '/src/api/routes/lightTurnOn.js',
        '/src/api/routes/lightsDim.js',
        '/src/api/index.js',
        '/config/common.yml',
        '/package.json'
      ];
      for (const index in expectedFiles) {
        const file = await readFile(path.join(outputDir, expectedFiles[index]), 'utf8');
        expect(file).toMatchSnapshot();
      }
    }
  );
});

describe('template integration tests for generated files using the generator and kafka example - v3 spec', () => {
  jest.setTimeout(30000);

  const outputDir = generateFolderName();
  const kafkaExamplePath = './mocks/kafka/asyncapi-v3.yml';

  it.each`
    server                  | description
    ${'scram-connections'}         | ${'should generate proper handlers and routes files'}
  `(
    '$description',
    async ({ server}) => {
      const params = {
        server
      };

      const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
      await generator.generateFromFile(path.resolve('test', kafkaExamplePath));

      const expectedFiles = [
        '/src/api/handlers/lightTurnOff.js',
        '/src/api/handlers/lightingMeasured.js',
        '/src/api/handlers/lightTurnOn.js',
        '/src/api/handlers/lightsDim.js',
        '/src/api/routes/lightTurnOff.js',
        '/src/api/routes/lightingMeasured.js',
        '/src/api/routes/lightTurnOn.js',
        '/src/api/routes/lightsDim.js',
        '/src/api/index.js',
        '/config/common.yml',
        '/package.json'
      ];
      for (const index in expectedFiles) {
        const file = await readFile(path.join(outputDir, expectedFiles[index]), 'utf8');
        expect(file).toMatchSnapshot();
      }
    }
  );
  
  it('should generate proper config for X509 security', async() => {
    const params = {
      server: 'scram-connections',
      securityScheme: 'certs',
      certFilesDir: './mocks/kafka/dummyCerts'
    };
    const expectedSecuritySetting = 'rejectUnauthorized: true';
    const expectedConfigFile = '/config/common.yml';

    const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
    await generator.generateFromFile(path.resolve('test', kafkaExamplePath));

    const file = await readFile(path.join(outputDir, expectedConfigFile), 'utf8');
    expect(file.includes(expectedSecuritySetting)).toBeTruthy();
  });

  it('should generate proper variable that points to custom cert files location', async() => {
    const params = {
      server: 'scram-connections',
      securityScheme: 'certs',
      certFilesDir: './mocks/kafka/dummyCerts'
    };
    const expectedVariable = 'const certFilesDir = \'./mocks/kafka/dummyCerts\';';
    const expectedFile = '/src/api/index.js';

    const generator = new Generator(path.normalize('./'), outputDir, { forceWrite: true, templateParams: params });
    await generator.generateFromFile(path.resolve('test', kafkaExamplePath));

    const file = await readFile(path.join(outputDir, expectedFile), 'utf8');
    expect(file.includes(expectedVariable)).toBeTruthy();
  });
});