@bernierllc/github-parser 1.2.5 → 1.4.0

package/__tests__/github-parser.test.ts

@@ -1,865 +0,0 @@
-/*
-Copyright (c) 2025 Bernier LLC
-
-This file is licensed to the client under a limited-use license.
-The client may use and modify this code *only within the scope of the project it was delivered for*.
-Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
-*/
-
-import { GitHubParser } from '../src';
-
-describe('GitHubParser', () => {
-  let parser: GitHubParser;
-
-  beforeEach(() => {
-    parser = new GitHubParser();
-  });
-
-  it('should create a GitHub parser', () => {
-    expect(parser).toBeInstanceOf(GitHubParser);
-  });
-
-  it('should parse push webhook payload', () => {
-    const payload = {
-      ref: 'refs/heads/main',
-      repository: {
-        id: 123,
-        name: 'test-repo',
-        full_name: 'owner/test-repo',
-        owner: {
-          login: 'owner',
-          type: 'User'
-        },
-        default_branch: 'main',
-        html_url: 'https://github.com/owner/test-repo',
-        private: false
-      },
-      commits: [
-        {
-          id: 'abc123',
-          message: 'Test commit',
-          author: {
-            name: 'Test User',
-            email: 'test@example.com',
-            username: 'testuser'
-          },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/test-repo/commit/abc123',
-          added: ['file1.ts'],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const result = parser.parse(payload);
-
-    expect(result.type).toBe('push');
-    expect(result.repository.name).toBe('test-repo');
-    expect(result.commits).toHaveLength(1);
-    expect(result.commits?.[0].sha).toBe('abc123');
-  });
-
-  it('should extract repository information', () => {
-    const payload = {
-      repository: {
-        id: 456,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: {
-          login: 'user',
-          type: 'Organization'
-        },
-        default_branch: 'develop',
-        html_url: 'https://github.com/user/repo',
-        private: true
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-
-    expect(repo.id).toBe(456);
-    expect(repo.name).toBe('repo');
-    expect(repo.fullName).toBe('user/repo');
-    expect(repo.owner.login).toBe('user');
-    expect(repo.private).toBe(true);
-  });
-
-  it('should extract commits from push webhook', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'commit1',
-          message: 'First commit',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/commit1',
-          added: ['file1.ts'],
-          removed: ['file2.ts'],
-          modified: ['file3.ts']
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-
-    expect(commits).toHaveLength(1);
-    expect(commits[0].sha).toBe('commit1');
-    expect(commits[0].additions).toBe(1);
-    expect(commits[0].deletions).toBe(1);
-  });
-
-  it('should extract single commit', () => {
-    const payload = {
-      commit: {
-        sha: 'def456',
-        message: 'Single commit',
-        author: { name: 'Developer', email: 'dev@example.com' },
-        timestamp: '2025-01-28T12:00:00Z',
-        url: 'https://github.com/owner/repo/commit/def456',
-        additions: 10,
-        deletions: 5,
-        modified: ['file1.ts', 'file2.ts']
-      }
-    };
-
-    const commit = parser.extractCommit(payload);
-
-    expect(commit).not.toBeNull();
-    expect(commit?.sha).toBe('def456');
-    expect(commit?.message).toBe('Single commit');
-    expect(commit?.additions).toBe(10);
-    expect(commit?.deletions).toBe(5);
-  });
-
-  it('should return null when no commit exists', () => {
-    const payload = {};
-    const commit = parser.extractCommit(payload);
-    expect(commit).toBeNull();
-  });
-
-  it('should normalize pull_request event type', () => {
-    const payload = {
-      pull_request: { number: 1 },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.type).toBe('pull_request');
-  });
-
-  it('should normalize issues event type', () => {
-    const payload = {
-      issue: { number: 1 },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.type).toBe('issues');
-  });
-
-  it('should normalize release event type', () => {
-    const payload = {
-      release: { tag_name: 'v1.0.0' },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.type).toBe('release');
-  });
-
-  it('should handle explicit X-GitHub-Event header', () => {
-    const payload = {
-      'X-GitHub-Event': 'push',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('push');
-  });
-
-  it('should extract action from payload', () => {
-    const payload = {
-      action: 'opened',
-      pull_request: { number: 1 },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.action).toBe('opened');
-  });
-
-  it('should extract branch from ref', () => {
-    const payload = {
-      ref: 'refs/heads/feature-branch',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      },
-      commits: []
-    };
-
-    const result = parser.parse(payload);
-    expect(result.branch).toBe('feature-branch');
-    expect(result.ref).toBe('refs/heads/feature-branch');
-  });
-
-  it('should extract sender information', () => {
-    const payload = {
-      ref: 'refs/heads/main',
-      sender: {
-        login: 'octocat',
-        type: 'User'
-      },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      },
-      commits: []
-    };
-
-    const result = parser.parse(payload);
-    expect(result.sender).toEqual({
-      login: 'octocat',
-      type: 'User'
-    });
-  });
-
-  it('should handle commit with committer fallback', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'xyz789',
-          message: 'Commit with committer',
-          committer: { name: 'Committer', email: 'committer@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/xyz789',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].author.name).toBe('Committer');
-    expect(commits[0].author.email).toBe('committer@example.com');
-  });
-
-  it('should handle empty commits array', () => {
-    const payload = {
-      commits: []
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits).toHaveLength(0);
-  });
-
-  it('should handle missing commits field', () => {
-    const payload = {};
-
-    const commits = parser.extractCommits(payload);
-    expect(commits).toHaveLength(0);
-  });
-
-  it('should throw error when repository is missing', () => {
-    const payload = {};
-
-    expect(() => parser.extractRepository(payload)).toThrow('Repository information not found in payload');
-  });
-
-  it('should handle unknown event type', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.type).toBe('unknown');
-  });
-
-  it('should handle commit without timestamp', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'no-time',
-          message: 'No timestamp',
-          author: { name: 'Author', email: 'author@example.com' },
-          url: 'https://github.com/owner/repo/commit/no-time',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].timestamp).toBeInstanceOf(Date);
-  });
-
-  it('should parse non-push event with commit field', () => {
-    const payload = {
-      'X-GitHub-Event': 'status',
-      commit: {
-        sha: 'abc123',
-        message: 'Status update',
-        author: { name: 'Bot', email: 'bot@example.com' },
-        timestamp: '2025-01-28T00:00:00Z',
-        url: 'https://github.com/owner/repo/commit/abc123',
-        additions: 0,
-        deletions: 0,
-        modified: []
-      },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.type).toBe('status');
-    expect(result.commit).toBeDefined();
-    expect(result.commit?.sha).toBe('abc123');
-  });
-
-  it('should handle event type with action field', () => {
-    const payload = {
-      action: 'published',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('published');
-  });
-
-  it('should handle event type with type field', () => {
-    const payload = {
-      type: 'CheckSuiteEvent',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('checksuiteevent');
-  });
-
-  it('should handle ref without refs/heads prefix', () => {
-    const payload = {
-      ref: 'main',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const result = parser.parse(payload);
-    expect(result.ref).toBe('main');
-    expect(result.branch).toBe('main');
-  });
-
-  it('should handle commit with author username', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'with-username',
-          message: 'Has username',
-          author: {
-            name: 'Developer',
-            email: 'dev@example.com',
-            username: 'devuser'
-          },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/with-username',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].author.username).toBe('devuser');
-  });
-
-  it('should handle commit without author or committer', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'no-author',
-          message: 'No author',
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/no-author',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].author.name).toBe('');
-    expect(commits[0].author.email).toBe('');
-  });
-
-  it('should use sha field when id is missing', () => {
-    const payload = {
-      commits: [
-        {
-          sha: 'sha123',
-          message: 'Has SHA',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/sha123',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].sha).toBe('sha123');
-  });
-
-  it('should handle missing commit message', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'no-msg',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/no-msg',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].message).toBe('');
-  });
-
-  it('should handle missing commit url', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'no-url',
-          message: 'No URL',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].url).toBe('');
-  });
-
-  it('should handle repository with fullName field', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        fullName: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.fullName).toBe('user/repo');
-  });
-
-  it('should handle repository with defaultBranch field', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        defaultBranch: 'master',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.defaultBranch).toBe('master');
-  });
-
-  it('should handle repository with htmlUrl field', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        htmlUrl: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.url).toBe('https://github.com/user/repo');
-  });
-
-  it('should handle repository with only url field', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        url: 'https://api.github.com/repos/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.url).toBe('https://api.github.com/repos/user/repo');
-  });
-
-  it('should handle repository with missing owner type', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.owner.type).toBe('User');
-  });
-
-  it('should handle repository with missing default branch', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.defaultBranch).toBe('main');
-  });
-
-  it('should handle commit with missing modified field', () => {
-    const payload = {
-      commits: [
-        {
-          id: 'no-modified',
-          message: 'No modified',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/no-modified',
-          added: [],
-          removed: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].files).toEqual([]);
-  });
-
-  it('should handle payload without sender', () => {
-    const payload = {
-      ref: 'refs/heads/main',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      },
-      commits: []
-    };
-
-    const result = parser.parse(payload);
-    expect(result.sender).toBeUndefined();
-  });
-
-  it('should handle commit with neither sha nor id', () => {
-    const payload = {
-      commits: [
-        {
-          message: 'No SHA or ID',
-          author: { name: 'Author', email: 'author@example.com' },
-          timestamp: '2025-01-28T00:00:00Z',
-          url: 'https://github.com/owner/repo/commit/unknown',
-          added: [],
-          removed: [],
-          modified: []
-        }
-      ]
-    };
-
-    const commits = parser.extractCommits(payload);
-    expect(commits[0].sha).toBe('');
-  });
-
-  it('should handle repository with missing name', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.name).toBe('');
-  });
-
-  it('should handle repository with missing full_name and fullName', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.fullName).toBe('');
-  });
-
-  it('should handle repository owner with missing login', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { type: 'Organization' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.owner.login).toBe('');
-  });
-
-  it('should handle repository with all url fields missing', () => {
-    const payload = {
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        private: false
-      }
-    };
-
-    const repo = parser.extractRepository(payload);
-    expect(repo.url).toBe('');
-  });
-
-  it('should detect pull_request event from X-GitHub-Event header', () => {
-    const payload = {
-      'X-GitHub-Event': 'pull_request',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('pull_request');
-  });
-
-  it('should detect issues event from X-GitHub-Event header', () => {
-    const payload = {
-      'X-GitHub-Event': 'issues',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('issues');
-  });
-
-  it('should detect release event from X-GitHub-Event header', () => {
-    const payload = {
-      'X-GitHub-Event': 'release',
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      }
-    };
-
-    const eventType = parser.normalizeEventType(payload);
-    expect(eventType).toBe('release');
-  });
-
-  it('should handle sender with missing login', () => {
-    const payload = {
-      ref: 'refs/heads/main',
-      sender: {
-        type: 'Bot'
-      },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      },
-      commits: []
-    };
-
-    const result = parser.parse(payload);
-    expect(result.sender?.login).toBe('');
-  });
-
-  it('should handle sender with missing type', () => {
-    const payload = {
-      ref: 'refs/heads/main',
-      sender: {
-        login: 'bot-user'
-      },
-      repository: {
-        id: 1,
-        name: 'repo',
-        full_name: 'user/repo',
-        owner: { login: 'user', type: 'User' },
-        default_branch: 'main',
-        html_url: 'https://github.com/user/repo',
-        private: false
-      },
-      commits: []
-    };
-
-    const result = parser.parse(payload);
-    expect(result.sender?.type).toBe('User');
-  });
-});
-