@dxdeveloperexperience/hygie/src/rules/issueTitle.rule.spec.ts

Hygie is an easy-to-use Open-Source REST API allowing you to interact with GIT events. This NestJS API expose a set of customizable rules to automate your project's life cycle.

import { Test, TestingModule } from '@nestjs/testing';
import { GithubService } from '../github/github.service';
import { GitlabService } from '../gitlab/gitlab.service';
import { Webhook } from '../webhook/webhook';
import { RuleResult } from '../rules/ruleResult';
import { HttpService } from '@nestjs/common';
import {
  MockHttpService,
  MockGitlabService,
  MockGithubService,
  MockAnalytics,
} from '../__mocks__/mocks';
import { GitTypeEnum } from '../webhook/utils.enum';
import { IssueTitleRule } from './issueTitle.rule';

describe('RulesService', () => {
  let app: TestingModule;
  let githubService: GithubService;
  let gitlabService: GitlabService;
  let webhook: Webhook;

  beforeAll(async () => {
    app = await Test.createTestingModule({
      providers: [
        { provide: HttpService, useClass: MockHttpService },
        { provide: GitlabService, useClass: MockGitlabService },
        { provide: GithubService, useClass: MockGithubService },
      ],
    }).compile();

    githubService = app.get(GithubService);
    gitlabService = app.get(GitlabService);

    webhook = new Webhook(gitlabService, githubService);
    webhook.gitType = GitTypeEnum.Github;
    webhook.issue = {
      number: 22,
      title: 'add rules documentation',
      description: 'please consider adding a Rules section',
    };
    webhook.repository = {
      fullName: 'bastienterrier/test_webhook',
      name: 'test_webhook',
      description: 'amazing project',
      cloneURL: 'https://github.com/bastienterrier/test-webhook.git',
      defaultBranchName: 'master',
    };
  });

  beforeEach(() => {
    jest.clearAllMocks();
  });

  // IssueTitle Rule
  describe('issueTitle Rule', () => {
    it('should return true + an object with issue infos and gitApiInfos', async () => {
      const issueTitle = new IssueTitleRule(MockAnalytics);
      issueTitle.options = {
        regexp: '(add|fix)\\s.*',
      };

      jest.spyOn(issueTitle, 'validate');

      const result: RuleResult = await issueTitle.validate(webhook, issueTitle);
      const expectedResult = {
        issue: {
          matches: ['add rules documentation', 'add'],
          number: 22,
          title: 'add rules documentation',
          description: 'please consider adding a Rules section',
        },
      };
      expect(result.validated).toBe(true);
      expect(JSON.parse(JSON.stringify(result.data))).toEqual(expectedResult);
      expect(result.gitApiInfos).toEqual({
        git: 'Github',
        repositoryFullName: 'bastienterrier/test_webhook',
      });
    });
  });
  describe('issueTitle Rule', () => {
    it('should return false + an object with issue infos and gitApiInfos', async () => {
      webhook.gitType = GitTypeEnum.Gitlab;
      webhook.issue.title = 'update rules documentation';
      webhook.projectId = 7657;

      const issueTitle = new IssueTitleRule(MockAnalytics);
      issueTitle.options = {
        regexp: '(add|fix)\\s.*',
      };

      jest.spyOn(issueTitle, 'validate');

      const result: RuleResult = await issueTitle.validate(webhook, issueTitle);
      const expectedResult = {
        issue: {
          description: 'please consider adding a Rules section',
          matches: null,
          number: 22,
          title: 'update rules documentation',
        },
      };
      expect(result.validated).toBe(false);
      expect(result.data).toEqual(expectedResult);
      expect(result.gitApiInfos).toEqual({
        git: 'Gitlab',
        projectId: '7657',
      });
    });
  });
});