test: write tests for WalkthroughSkipConditions

Author: meness

tests/utils/walkthrough-skip-conditions.util.test.ts

@@ -0,0 +1,212 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Context } from 'probot';
+import { DeepPartial } from 'ts-essentials';
+import { describe, it, vi } from 'vitest';
+import { Config } from '../../src/common/types';
+import { CacheService } from '../../src/services';
+import { WalkthroughSkipConditions } from '../../src/utils';
+
+describe('WalkthroughSkipConditions', () => {
+  // shouldSkip returns true if any skip condition is met
+  it('should return true when any skip condition is met', async () => {
+    const context: DeepPartial<Context<'pull_request'>> = {
+      payload: { sender: { login: 'lorem' }, pull_request: { head: { ref: 'branchName' }, state: 'closed' } }
+    };
+    const config = {
+      walkthrough: {
+        ignore: {
+          'pull-requests': {
+            labels: [],
+            titles: [],
+            branches: []
+          }
+        },
+        enabled: true,
+        'stop-on': { 'pull-requests': { closed: true } },
+        allow: {
+          'pull-requests': {
+            always: [],
+            never: [],
+            'contributors-only': false,
+            'authors-only': false
+          }
+        }
+      }
+    } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context as any, config, cacheService, apiKey);
+
+    const result = await walkthrough.shouldSkip();
+
+    expect(result).toBe(true);
+  });
+
+  // shouldSkip returns false if no skip condition is met
+  it('should return false when no skip condition is met', async () => {
+    const context = {
+      payload: { sender: { login: 'lorem' }, pull_request: { head: { ref: 'branchName' }, state: 'open' } }
+    } as Context<'pull_request'>;
+    const config = {
+      walkthrough: {
+        ignore: {
+          'pull-requests': {
+            labels: [],
+            titles: [],
+            branches: []
+          }
+        },
+        enabled: true,
+        'stop-on': { 'pull-requests': { closed: false } },
+        allow: {
+          'pull-requests': {
+            always: [],
+            never: [],
+            'contributors-only': false,
+            'authors-only': false
+          }
+        }
+      }
+    } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = await walkthrough.shouldSkip();
+
+    expect(result).toBe(false);
+  });
+
+  // isContributorOnly returns true if sender is not a contributor
+  it('should return true when sender is not a contributor', async () => {
+    const context = { payload: { sender: { login: 'nonContributor' } } } as Context<'pull_request'>;
+    const config = { walkthrough: { allow: { 'pull-requests': { 'contributors-only': true, always: [] } } } } as Config;
+    const cacheService = {
+      get: vi.fn().mockResolvedValue([{ login: 'contributor' }])
+    } as unknown as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = await walkthrough['isContributorOnly']();
+
+    expect(result).toBe(true);
+  });
+
+  // isAuthorOnly returns true if sender is not the author
+  it('should return true when sender is not the author', () => {
+    const context = {
+      payload: {
+        pull_request: { user: { login: 'author' } },
+        sender: { login: 'notAuthor' }
+      }
+    } as Context<'pull_request'>;
+    const config = { walkthrough: { allow: { 'pull-requests': { 'authors-only': true, always: [] } } } } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = walkthrough['isAuthorOnly']();
+
+    expect(result).toBe(true);
+  });
+
+  // isDisabled returns true if walkthrough is disabled in config
+  it('should return true when walkthrough is disabled in config', () => {
+    const context = {} as Context<'pull_request'>;
+    const config = { walkthrough: { enabled: false } } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = walkthrough['isDisabled']();
+
+    expect(result).toBe(true);
+  });
+
+  // isContributorOnly handles missing contributors in cache
+  it('should handle missing contributors in cache', async () => {
+    const context = { payload: { sender: { login: 'user' } } } as Context<'pull_request'>;
+    const config = { walkthrough: { allow: { 'pull-requests': { 'contributors-only': true, always: [] } } } } as Config;
+    const cacheService = {
+      get: vi.fn().mockResolvedValue(null)
+    } as unknown as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = await walkthrough['isContributorOnly']();
+
+    expect(result).toBe(true);
+  });
+
+  // isAuthorOnly handles case sensitivity in author comparison
+  it('should handle case sensitivity in author comparison', () => {
+    const context = {
+      payload: {
+        pull_request: { user: { login: 'Author' } },
+        sender: { login: 'author' }
+      }
+    } as Context<'pull_request'>;
+    const config = { walkthrough: { allow: { 'pull-requests': { 'authors-only': true, always: [] } } } } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = walkthrough['isAuthorOnly']();
+
+    expect(result).toBe(false);
+  });
+
+  // isLabelIgnored handles case sensitivity in label comparison
+  it('should handle case sensitivity in label comparison', () => {
+    const context = {
+      payload: {
+        pull_request: {
+          labels: [{ name: 'bug' }]
+        }
+      }
+    } as Context<'pull_request'>;
+    const config = {
+      walkthrough: {
+        ignore: {
+          'pull-requests': {
+            labels: ['BUG']
+          }
+        }
+      }
+    } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = walkthrough['isLabelIgnored']();
+
+    expect(result).toBe(true);
+  });
+
+  // isTitleIgnored handles case sensitivity in title comparison
+  it('should handle case sensitivity in title comparison', () => {
+    const context = {
+      payload: {
+        pull_request: {
+          title: 'Fix Bug'
+        }
+      }
+    } as Context<'pull_request'>;
+    const config = {
+      walkthrough: {
+        ignore: {
+          'pull-requests': {
+            titles: ['fix bug']
+          }
+        }
+      }
+    } as Config;
+    const cacheService = {} as CacheService;
+    const apiKey = 'testApiKey';
+    const walkthrough = new WalkthroughSkipConditions(context, config, cacheService, apiKey);
+
+    const result = walkthrough['isTitleIgnored']();
+
+    expect(result).toBe(true);
+  });
+});