@eventcatalog/notifier/tests/notifications/ConsumerAddedEvent.spec.ts

CLI tool to detect EventCatalog changes and send notifications

import { describe, it, expect } from 'vitest';
import { ConsumerAddedEvent } from '../../src/notifications/ConsumerAddedEvent';
import { vi } from 'vitest';
import path from 'path';
import fs from 'fs';
const GIT_DIFF_EXAMPLES_PATH = path.join(__dirname, '../git-diff-examples');

// Need to mock execSync for git show, returning different content for each file
vi.mock('child_process', () => ({
  execSync: vi.fn().mockImplementation((command) => {
    if (command.includes('git show HEAD~1')) {
      return 'This is the content of the file at the commit before';
    } else if (command.includes('git show HEAD')) {
      return 'This is the content of the file at the commit after';
    }
    return '';
  }),
}));

describe('ConsumerAddedEvent', () => {
  it('when a new consumer has been added for an event, it will return a notification', async () => {
    vi.mock('child_process', () => ({
      execSync: vi.fn().mockImplementation((command) => {
        return command.includes('git show HEAD~1')
          ? fs.readFileSync(path.join(GIT_DIFF_EXAMPLES_PATH, 'ConsumerAddedEvent/before.md'), 'utf8')
          : fs.readFileSync(path.join(GIT_DIFF_EXAMPLES_PATH, 'ConsumerAddedEvent/after.md'), 'utf8');
      }),
    }));

    const changedFiles = ['tests/catalog/services/PaymentGatewayService/index.mdx'];

    const event = new ConsumerAddedEvent({
      catalogPath: 'tests/catalog',
      changedFiles,
      options: {
        dryRun: false,
        lifecycle: 'active',
        actionUrl: 'https://example.com',
        config: 'notifier.yml',
        catalog: 'tests/catalog',
        commitRange: 'HEAD~1..HEAD',
        verbose: false,
      },
    });
    const result = await event.process();

    expect(result).toEqual([
      {
        id: 'consumer-added',
        version: '1.0.0',
        resource: {
          id: 'GetInventoryList',
          name: 'List inventory list',
          version: '0.0.1',
          type: 'event',
          owners: [
            {
              id: 'dboyne',
              name: 'David Boyne',
              avatarUrl: expect.any(String),
              role: 'Lead developer',
              email: 'test@test.com',
              slackDirectMessageUrl: 'https://yourteam.slack.com/channels/boyney123',
              msTeamsDirectMessageUrl: 'https://teams.microsoft.com/l/chat/0/0?users=test@test.com',
              markdown: expect.any(String),
            },
          ],
        },
        consumer: {
          id: 'InventoryService',
          name: 'Inventory Service',
          version: '0.0.2',
          type: 'service',
          owners: [],
        },
        metadata: {
          timestamp: expect.any(String),
          catalog_path: 'tests/catalog',
        },
      },
    ]);
  });

  it('when no consumers have been added, to a service, it should return an empty array', async () => {
    const changedFiles = ['tests/catalog/services/RandomServiceThatDoesntExist/index.mdx'];
    const event = new ConsumerAddedEvent({
      catalogPath: 'tests/catalog',
      changedFiles,
      options: {
        dryRun: false,
        lifecycle: 'active',
        actionUrl: 'https://example.com',
        config: 'notifier.yml',
        catalog: 'tests/catalog',
        commitRange: 'HEAD~1..HEAD',
        verbose: false,
      },
    });
    const result = await event.process();
    expect(result).toEqual([]);
  });

  describe('getSlackMessage', () => {
    const mockConfig = {
      version: '1.0.0',
      eventcatalog_url: 'https://example.eventcatalog.dev',
      owners: {},
    };

    const mockNotification = {
      id: 'consumer-added',
      version: '1.0.0',
      resource: {
        id: 'TestEvent',
        name: 'Test Event',
        version: '1.0.0',
        type: 'event' as const,
        owners: [{ id: 'team1', name: 'Team 1' }],
      },
      consumer: {
        id: 'TestService',
        name: 'Test Service',
        version: '1.0.0',
        type: 'service',
        owners: [{ id: 'team2', name: 'Team 2' }],
      },
      metadata: {
        timestamp: '2023-01-01T00:00:00.000Z',
        catalog_path: '/test/catalog',
      },
    };

    it('should return active stage message when stage is active', () => {
      const result = ConsumerAddedEvent.getSlackMessage(mockConfig, mockNotification, 'active');

      expect(result.text).toBe('🆕 EventCatalog - ✉️ New Event Consumer Added');
      expect(result.attachments[0].pretext).toBe('A new service has started consuming an event in your architecture');
    });

    it('should return draft stage message when stage is draft', () => {
      const result = ConsumerAddedEvent.getSlackMessage(mockConfig, mockNotification, 'draft');

      expect(result.text).toBe('🔄 EventCatalog - ✉️ Request to Add Event Consumer');
      expect(result.attachments[0].pretext).toBe('A request has been made to consume an event in your architecture');
    });

    it('should contain all required fields for both stages', () => {
      const activeResult = ConsumerAddedEvent.getSlackMessage(mockConfig, mockNotification, 'active');
      const draftResult = ConsumerAddedEvent.getSlackMessage(mockConfig, mockNotification, 'draft');

      [activeResult, draftResult].forEach((result) => {
        expect(result.attachments[0].fields).toHaveLength(6);
        expect(result.attachments[0].fields.find((f) => f.title === '📡 Event Being Consumed')).toBeDefined();
        expect(result.attachments[0].fields.find((f) => f.title === '⚙️ New Consumer Service')).toBeDefined();
        expect(result.attachments[0].fields.find((f) => f.title === '👥 Event Owners (Need to Know)')).toBeDefined();
        expect(result.attachments[0].fields.find((f) => f.title === '👥 Consumer Team')).toBeDefined();
        expect(result.attachments[0].fields.find((f) => f.title === '📅 When')).toBeDefined();
        expect(result.attachments[0].fields.find((f) => f.title === '💼 Impact')).toBeDefined();
      });
    });
  });
});