@wordpress/project-management-automation/lib/tasks/first-time-contributor-account-link/test/index.js

GitHub Action that implements various automation to assist with managing the Gutenberg GitHub repository.

/**
 * Internal dependencies
 */
import firstTimeContributorAccountLink from '../';
import hasWordPressProfile from '../../../has-wordpress-profile';

jest.mock( '../../../has-wordpress-profile', () => jest.fn() );

const botUser = {
	data: {
		name: 'Ghost',
		email: 'ghost@example.invalid',
		username: 'ghost',
		type: 'Bot',
	},
};
const humanUser = {
	data: {
		name: 'Ghost',
		email: 'ghost@example.invalid',
		username: 'ghost',
		type: 'User',
	},
};

describe( 'firstTimeContributorAccountLink', () => {
	beforeEach( () => {
		hasWordPressProfile.mockReset();
	} );

	const payload = {
		ref: 'refs/heads/trunk',
		commits: [
			{
				id: '4c535288a6a2b75ff23ee96c75f7d9877e919241',
				message: 'Add a feature from pull request (#123)',
				author: {
					name: 'Ghost',
					email: 'ghost@example.invalid',
					username: 'ghost',
				},
			},
		],
		repository: {
			owner: {
				login: 'WordPress',
			},
			name: 'gutenberg',
		},
	};

	it( 'does nothing if not a commit to trunk', async () => {
		const payloadForBranchPush = {
			...payload,
			ref: 'refs/heads/update/chicken-branch',
		};

		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn(),
				},
				users: {
					getByUsername: jest.fn( () => humanUser ),
				},
			},
		};

		await firstTimeContributorAccountLink( payloadForBranchPush, octokit );

		expect( octokit.rest.users.getByUsername ).not.toHaveBeenCalled();
		expect( octokit.rest.repos.listCommits ).not.toHaveBeenCalled();
	} );

	it( 'does nothing if commit pull request undeterminable', async () => {
		const payloadDirectToTrunk = {
			...payload,
			commits: [
				{
					message: 'Add a feature direct to trunk',
					author: {
						name: 'Ghost',
						email: 'ghost@example.invalid',
						username: 'ghost',
					},
				},
			],
		};

		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn(),
				},
				users: {
					getByUsername: jest.fn( () => humanUser ),
				},
			},
		};

		await firstTimeContributorAccountLink( payloadDirectToTrunk, octokit );

		expect( octokit.rest.users.getByUsername ).not.toHaveBeenCalled();
		expect( octokit.rest.repos.listCommits ).not.toHaveBeenCalled();
	} );

	it( 'does nothing for commits by bots', async () => {
		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn(),
				},
				users: {
					// Return a bot when `getByUsername` is called.
					getByUsername: jest.fn( () => botUser ),
				},
			},
		};

		await firstTimeContributorAccountLink( payload, octokit );

		expect( octokit.rest.users.getByUsername ).toHaveBeenCalledWith( {
			username: payload.commits[ 0 ].author.username,
		} );
		expect( octokit.rest.repos.listCommits ).not.toHaveBeenCalled();
	} );

	it( 'does nothing if the user has multiple commits', async () => {
		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn( () =>
						Promise.resolve( {
							data: [
								{
									sha: '4c535288a6a2b75ff23ee96c75f7d9877e919241',
								},
								{
									sha: '59b07cc57adff90630fc9d5cf2317269a0f4f158',
								},
							],
						} )
					),
				},
				users: {
					getByUsername: jest.fn( () => humanUser ),
				},
				issues: {
					createComment: jest.fn(),
				},
			},
		};

		await firstTimeContributorAccountLink( payload, octokit );

		expect( octokit.rest.users.getByUsername ).toHaveBeenCalledWith( {
			username: payload.commits[ 0 ].author.username,
		} );
		expect( octokit.rest.repos.listCommits ).toHaveBeenCalledWith( {
			owner: 'WordPress',
			repo: 'gutenberg',
			author: 'ghost',
		} );
		expect( octokit.rest.issues.createComment ).not.toHaveBeenCalled();
	} );

	it( 'aborts if the request to retrieve WordPress.org user profile fails', async () => {
		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn( () =>
						Promise.resolve( {
							data: [
								{
									sha: '4c535288a6a2b75ff23ee96c75f7d9877e919241',
								},
							],
						} )
					),
				},
				users: {
					getByUsername: jest.fn( () => humanUser ),
				},
				issues: {
					createComment: jest.fn(),
				},
			},
		};

		hasWordPressProfile.mockImplementation( () => {
			return Promise.reject( new Error( 'Whoops!' ) );
		} );

		await firstTimeContributorAccountLink( payload, octokit );

		expect( octokit.rest.users.getByUsername ).toHaveBeenCalledWith( {
			username: payload.commits[ 0 ].author.username,
		} );
		expect( octokit.rest.repos.listCommits ).toHaveBeenCalledWith( {
			owner: 'WordPress',
			repo: 'gutenberg',
			author: 'ghost',
		} );
		expect( octokit.rest.issues.createComment ).not.toHaveBeenCalled();
	} );

	it( 'prompts the user to link their GitHub account to their WordPress.org profile', async () => {
		const octokit = {
			rest: {
				repos: {
					listCommits: jest.fn( () =>
						Promise.resolve( {
							data: [
								{
									sha: '4c535288a6a2b75ff23ee96c75f7d9877e919241',
								},
							],
						} )
					),
				},
				users: {
					getByUsername: jest.fn( () => humanUser ),
				},
				issues: {
					createComment: jest.fn(),
				},
			},
		};

		hasWordPressProfile.mockReturnValue( Promise.resolve( false ) );

		await firstTimeContributorAccountLink( payload, octokit );

		expect( octokit.rest.users.getByUsername ).toHaveBeenCalledWith( {
			username: payload.commits[ 0 ].author.username,
		} );
		expect( octokit.rest.repos.listCommits ).toHaveBeenCalledWith( {
			owner: 'WordPress',
			repo: 'gutenberg',
			author: 'ghost',
		} );
		expect( octokit.rest.issues.createComment ).toHaveBeenCalledWith( {
			owner: 'WordPress',
			repo: 'gutenberg',
			issue_number: 123,
			body: expect.stringMatching( /^Congratulations/ ),
		} );
	} );
} );