From 5076359ba6551589ca49bab858b63f8a2325e0a3 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Mon, 17 Apr 2023 04:42:21 +0200 Subject: [PATCH] fix tests implementation Signed-off-by: CrazyMax --- __mocks__/@actions/github.ts | 207 +++++++++++++++++++++++++++++++++++ __tests__/context.test.ts | 57 +++++----- __tests__/image.test.ts | 2 +- __tests__/meta.test.ts | 38 +++---- tsconfig.json | 1 + 5 files changed, 255 insertions(+), 50 deletions(-) create mode 100644 __mocks__/@actions/github.ts diff --git a/__mocks__/@actions/github.ts b/__mocks__/@actions/github.ts new file mode 100644 index 0000000..578a3de --- /dev/null +++ b/__mocks__/@actions/github.ts @@ -0,0 +1,207 @@ +import {jest} from '@jest/globals'; + +export const context = { + repo: { + owner: 'docker', + repo: 'actions-toolkit' + }, + ref: 'refs/heads/master', + runId: 123, + payload: { + after: '860c1904a1ce19322e91ac35af1ab07466440c37', + base_ref: null, + before: '5f3331d7f7044c18ca9f12c77d961c4d7cf3276a', + commits: [ + { + author: { + email: 'crazy-max@users.noreply.github.com', + name: 'CrazyMax', + username: 'crazy-max' + }, + committer: { + email: 'crazy-max@users.noreply.github.com', + name: 'CrazyMax', + username: 'crazy-max' + }, + distinct: true, + id: '860c1904a1ce19322e91ac35af1ab07466440c37', + message: 'hello dev', + timestamp: '2022-04-19T11:27:24+02:00', + tree_id: 'd2c60af597e863787d2d27f569e30495b0b92820', + url: 'https://github.com/docker/test-docker-action/commit/860c1904a1ce19322e91ac35af1ab07466440c37' + } + ], + compare: 'https://github.com/docker/test-docker-action/compare/5f3331d7f704...860c1904a1ce', + created: false, + deleted: false, + forced: false, + head_commit: { + author: { + email: 'crazy-max@users.noreply.github.com', + name: 'CrazyMax', + username: 'crazy-max' + }, + committer: { + email: 'crazy-max@users.noreply.github.com', + name: 'CrazyMax', + username: 'crazy-max' + }, + distinct: true, + id: '860c1904a1ce19322e91ac35af1ab07466440c37', + message: 'hello dev', + timestamp: '2022-04-19T11:27:24+02:00', + tree_id: 'd2c60af597e863787d2d27f569e30495b0b92820', + url: 'https://github.com/docker/test-docker-action/commit/860c1904a1ce19322e91ac35af1ab07466440c37' + }, + organization: { + avatar_url: 'https://avatars.githubusercontent.com/u/5429470?v=4', + description: 'Docker helps developers bring their ideas to life by conquering the complexity of app development.', + events_url: 'https://api.github.com/orgs/docker/events', + hooks_url: 'https://api.github.com/orgs/docker/hooks', + id: 5429470, + issues_url: 'https://api.github.com/orgs/docker/issues', + login: 'docker', + members_url: 'https://api.github.com/orgs/docker/members{/member}', + node_id: 'MDEyOk9yZ2FuaXphdGlvbjU0Mjk0NzA=', + public_members_url: 'https://api.github.com/orgs/docker/public_members{/member}', + repos_url: 'https://api.github.com/orgs/docker/repos', + url: 'https://api.github.com/orgs/docker' + }, + pusher: { + email: 'github@crazymax.dev', + name: 'crazy-max' + }, + ref: 'refs/heads/dev', + repository: { + allow_forking: true, + archive_url: 'https://api.github.com/repos/docker/test-docker-action/{archive_format}{/ref}', + archived: false, + assignees_url: 'https://api.github.com/repos/docker/test-docker-action/assignees{/user}', + blobs_url: 'https://api.github.com/repos/docker/test-docker-action/git/blobs{/sha}', + branches_url: 'https://api.github.com/repos/docker/test-docker-action/branches{/branch}', + clone_url: 'https://github.com/docker/test-docker-action.git', + collaborators_url: 'https://api.github.com/repos/docker/test-docker-action/collaborators{/collaborator}', + comments_url: 'https://api.github.com/repos/docker/test-docker-action/comments{/number}', + commits_url: 'https://api.github.com/repos/docker/test-docker-action/commits{/sha}', + compare_url: 'https://api.github.com/repos/docker/test-docker-action/compare/{base}...{head}', + contents_url: 'https://api.github.com/repos/docker/test-docker-action/contents/{+path}', + contributors_url: 'https://api.github.com/repos/docker/test-docker-action/contributors', + created_at: 1596792180, + default_branch: 'master', + deployments_url: 'https://api.github.com/repos/docker/test-docker-action/deployments', + description: 'Test "Docker" Actions', + disabled: false, + downloads_url: 'https://api.github.com/repos/docker/test-docker-action/downloads', + events_url: 'https://api.github.com/repos/docker/test-docker-action/events', + fork: false, + forks: 1, + forks_count: 1, + forks_url: 'https://api.github.com/repos/docker/test-docker-action/forks', + full_name: 'docker/test-docker-action', + git_commits_url: 'https://api.github.com/repos/docker/test-docker-action/git/commits{/sha}', + git_refs_url: 'https://api.github.com/repos/docker/test-docker-action/git/refs{/sha}', + git_tags_url: 'https://api.github.com/repos/docker/test-docker-action/git/tags{/sha}', + git_url: 'git://github.com/docker/test-docker-action.git', + has_downloads: true, + has_issues: true, + has_pages: false, + has_projects: true, + has_wiki: true, + homepage: '', + hooks_url: 'https://api.github.com/repos/docker/test-docker-action/hooks', + html_url: 'https://github.com/docker/test-docker-action', + id: 285789493, + is_template: false, + issue_comment_url: 'https://api.github.com/repos/docker/test-docker-action/issues/comments{/number}', + issue_events_url: 'https://api.github.com/repos/docker/test-docker-action/issues/events{/number}', + issues_url: 'https://api.github.com/repos/docker/test-docker-action/issues{/number}', + keys_url: 'https://api.github.com/repos/docker/test-docker-action/keys{/key_id}', + labels_url: 'https://api.github.com/repos/docker/test-docker-action/labels{/name}', + language: 'JavaScript', + languages_url: 'https://api.github.com/repos/docker/test-docker-action/languages', + license: { + key: 'mit', + name: 'MIT License', + node_id: 'MDc6TGljZW5zZTEz', + spdx_id: 'MIT', + url: 'https://api.github.com/licenses/mit' + }, + master_branch: 'master', + merges_url: 'https://api.github.com/repos/docker/test-docker-action/merges', + milestones_url: 'https://api.github.com/repos/docker/test-docker-action/milestones{/number}', + mirror_url: null, + name: 'test-docker-action', + node_id: 'MDEwOlJlcG9zaXRvcnkyODU3ODk0OTM=', + notifications_url: 'https://api.github.com/repos/docker/test-docker-action/notifications{?since,all,participating}', + open_issues: 6, + open_issues_count: 6, + organization: 'docker', + owner: { + avatar_url: 'https://avatars.githubusercontent.com/u/5429470?v=4', + email: 'info@docker.com', + events_url: 'https://api.github.com/users/docker/events{/privacy}', + followers_url: 'https://api.github.com/users/docker/followers', + following_url: 'https://api.github.com/users/docker/following{/other_user}', + gists_url: 'https://api.github.com/users/docker/gists{/gist_id}', + gravatar_id: '', + html_url: 'https://github.com/docker', + id: 5429470, + login: 'docker', + name: 'docker', + node_id: 'MDEyOk9yZ2FuaXphdGlvbjU0Mjk0NzA=', + organizations_url: 'https://api.github.com/users/docker/orgs', + received_events_url: 'https://api.github.com/users/docker/received_events', + repos_url: 'https://api.github.com/users/docker/repos', + site_admin: false, + starred_url: 'https://api.github.com/users/docker/starred{/owner}{/repo}', + subscriptions_url: 'https://api.github.com/users/docker/subscriptions', + type: 'Organization', + url: 'https://api.github.com/users/docker' + }, + private: true, + pulls_url: 'https://api.github.com/repos/docker/test-docker-action/pulls{/number}', + pushed_at: 1650360446, + releases_url: 'https://api.github.com/repos/docker/test-docker-action/releases{/id}', + size: 796, + ssh_url: 'git@github.com:docker/test-docker-action.git', + stargazers: 0, + stargazers_count: 0, + stargazers_url: 'https://api.github.com/repos/docker/test-docker-action/stargazers', + statuses_url: 'https://api.github.com/repos/docker/test-docker-action/statuses/{sha}', + subscribers_url: 'https://api.github.com/repos/docker/test-docker-action/subscribers', + subscription_url: 'https://api.github.com/repos/docker/test-docker-action/subscription', + svn_url: 'https://github.com/docker/test-docker-action', + tags_url: 'https://api.github.com/repos/docker/test-docker-action/tags', + teams_url: 'https://api.github.com/repos/docker/test-docker-action/teams', + topics: [], + trees_url: 'https://api.github.com/repos/docker/test-docker-action/git/trees{/sha}', + updated_at: '2022-04-19T09:05:09Z', + url: 'https://github.com/docker/test-docker-action', + visibility: 'private', + watchers: 0, + watchers_count: 0 + }, + sender: { + avatar_url: 'https://avatars.githubusercontent.com/u/1951866?v=4', + events_url: 'https://api.github.com/users/crazy-max/events{/privacy}', + followers_url: 'https://api.github.com/users/crazy-max/followers', + following_url: 'https://api.github.com/users/crazy-max/following{/other_user}', + gists_url: 'https://api.github.com/users/crazy-max/gists{/gist_id}', + gravatar_id: '', + html_url: 'https://github.com/crazy-max', + id: 1951866, + login: 'crazy-max', + node_id: 'MDQ6VXNlcjE5NTE4NjY=', + organizations_url: 'https://api.github.com/users/crazy-max/orgs', + received_events_url: 'https://api.github.com/users/crazy-max/received_events', + repos_url: 'https://api.github.com/users/crazy-max/repos', + site_admin: false, + starred_url: 'https://api.github.com/users/crazy-max/starred{/owner}{/repo}', + subscriptions_url: 'https://api.github.com/users/crazy-max/subscriptions', + type: 'User', + url: 'https://api.github.com/users/crazy-max' + } + } +}; + +export const getOctokit = jest.fn(); diff --git a/__tests__/context.test.ts b/__tests__/context.test.ts index e5691e8..945345e 100644 --- a/__tests__/context.test.ts +++ b/__tests__/context.test.ts @@ -1,9 +1,19 @@ -import {Context} from '@actions/github/lib/context'; -import {beforeEach, describe, expect, test, it, jest} from '@jest/globals'; +import {afterEach, beforeEach, describe, expect, test, it, jest} from '@jest/globals'; import * as dotenv from 'dotenv'; import * as fs from 'fs'; import * as path from 'path'; -import {ContextSource, getInputs, Inputs} from '../src/context'; +import {Context} from '@actions/github/lib/context'; +import {Git} from '@docker/actions-toolkit/lib/git'; +import {GitHub} from '@docker/actions-toolkit/lib/github'; + +import {ContextSource, getContext, getInputs, Inputs} from '../src/context'; + +beforeEach(() => { + jest.clearAllMocks(); + jest.spyOn(GitHub, 'context', 'get').mockImplementation((): Context => { + return new Context(); + }); +}); describe('getInputs', () => { beforeEach(() => { @@ -66,37 +76,34 @@ describe('getInputs', () => { }); describe('getContext', () => { - it('get context with workflow', async () => { - process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures/event_create_branch.env'))); - + const originalEnv = process.env; + beforeEach(() => { jest.resetModules(); - // eslint-disable-next-line @typescript-eslint/no-var-requires - const {getContext} = require('../src/context'); - const contextResult = await getContext(ContextSource.workflow); - - expect(contextResult.ref).toEqual('refs/heads/dev'); - expect(contextResult.sha).toEqual('5f3331d7f7044c18ca9f12c77d961c4d7cf3276a'); + process.env = { + ...originalEnv, + ...dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures/event_create_branch.env'))) + }; + }); + afterEach(() => { + process.env = originalEnv; }); - it('get context with git', async () => { - jest.resetModules(); + it('workflow', async () => { + const context = await getContext(ContextSource.workflow); + expect(context.ref).toEqual('refs/heads/dev'); + expect(context.sha).toEqual('5f3331d7f7044c18ca9f12c77d961c4d7cf3276a'); + }); - // eslint-disable-next-line @typescript-eslint/no-var-requires - const git = require('@docker/actions-toolkit/lib/git'); - jest.spyOn(git.Git, 'context').mockImplementation((): Promise => { + it('git', async () => { + jest.spyOn(Git, 'context').mockImplementation((): Promise => { return Promise.resolve({ ref: 'refs/heads/git-test', sha: 'git-test-sha' } as Context); }); - - // eslint-disable-next-line @typescript-eslint/no-var-requires - const {getContext} = require('../src/context'); - - const contextResult = await getContext(ContextSource.git); - - expect(contextResult.ref).toEqual('refs/heads/git-test'); - expect(contextResult.sha).toEqual('git-test-sha'); + const context = await getContext(ContextSource.git); + expect(context.ref).toEqual('refs/heads/git-test'); + expect(context.sha).toEqual('git-test-sha'); }); }); diff --git a/__tests__/image.test.ts b/__tests__/image.test.ts index 0e82d81..29a926f 100644 --- a/__tests__/image.test.ts +++ b/__tests__/image.test.ts @@ -87,7 +87,7 @@ describe('transform', () => { [ [`name/foo,name=name/bar,enable=true`], undefined, true ] - ])('given %p', async (l: string[], expected: Image[], invalid: boolean) => { + ])('given %p', async (l: string[], expected: Image[] | undefined, invalid: boolean) => { try { const images = Transform(l); expect(images).toEqual(expected); diff --git a/__tests__/meta.test.ts b/__tests__/meta.test.ts index 9ee0051..6f1cac9 100644 --- a/__tests__/meta.test.ts +++ b/__tests__/meta.test.ts @@ -5,10 +5,13 @@ import * as dotenv from 'dotenv'; import {GitHub} from '@docker/actions-toolkit/lib/github'; import {Toolkit} from '@docker/actions-toolkit/lib/toolkit'; import {GitHubRepo} from '@docker/actions-toolkit/lib/types/github'; -import {ContextSource, getInputs, Inputs} from '../src/context'; +import {Context} from '@actions/github/lib/context'; + +import {ContextSource, getContext, getInputs, Inputs} from '../src/context'; import {Meta, Version} from '../src/meta'; import repoFixture from './fixtures/repo.json'; + jest.spyOn(GitHub.prototype, 'repoData').mockImplementation((): Promise => { return >(repoFixture as unknown); }); @@ -21,17 +24,6 @@ jest.mock('moment-timezone', () => { return () => (jest.requireActual('moment-timezone') as typeof import('moment-timezone'))('2020-01-10T00:30:00.000Z'); }); -/** - * Get a workflow context based on the current environment variables. - */ -const getFreshWorkflowContext = async () => { - jest.resetModules(); - // eslint-disable-next-line @typescript-eslint/no-var-requires - const {getContext} = require('../src/context'); - const context = await getContext(ContextSource.workflow); - return context; -}; - beforeEach(() => { jest.clearAllMocks(); Object.keys(process.env).forEach(function (key) { @@ -39,6 +31,9 @@ beforeEach(() => { delete process.env[key]; } }); + jest.spyOn(GitHub, 'context', 'get').mockImplementation((): Context => { + return new Context(); + }); }); describe('isRawStatement', () => { @@ -58,8 +53,7 @@ const tagsLabelsTest = async (name: string, envFile: string, inputs: Inputs, exV process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile))); const toolkit = new Toolkit(); const repo = await toolkit.github.repoData(); - const context = await getFreshWorkflowContext(); - const meta = new Meta({...getInputs(), ...inputs}, context, repo); + const meta = new Meta({...getInputs(), ...inputs}, await getContext(ContextSource.workflow), repo); const version = meta.version; expect(version).toEqual(exVersion); @@ -2776,8 +2770,7 @@ describe('pr-head-sha', () => { const toolkit = new Toolkit(); const repo = await toolkit.github.repoData(); - const context = await getFreshWorkflowContext(); - const meta = new Meta({...getInputs(), ...inputs}, context, repo); + const meta = new Meta({...getInputs(), ...inputs}, await getContext(ContextSource.workflow), repo); const version = meta.version; expect(version).toEqual(exVersion); @@ -3719,8 +3712,7 @@ describe('json', () => { const toolkit = new Toolkit(); const repo = await toolkit.github.repoData(); - const context = await getFreshWorkflowContext(); - const meta = new Meta({...getInputs(), ...inputs}, context, repo); + const meta = new Meta({...getInputs(), ...inputs}, await getContext(ContextSource.workflow), repo); const jsonOutput = meta.getJSON(); expect(jsonOutput).toEqual(exJSON); @@ -4026,8 +4018,7 @@ describe('bake', () => { const toolkit = new Toolkit(); const repo = await toolkit.github.repoData(); - const context = await getFreshWorkflowContext(); - const meta = new Meta({...getInputs(), ...inputs}, context, repo); + const meta = new Meta({...getInputs(), ...inputs}, await getContext(ContextSource.workflow), repo); const bakeFile = meta.getBakeFile(); expect(JSON.parse(fs.readFileSync(bakeFile, 'utf8'))).toEqual(exBakeDefinition); @@ -4069,13 +4060,12 @@ describe('sepTags', () => { "user/app:dev,user/app:my,user/app:custom,user/app:tags" ] ])('given %p with %p event', async (name: string, envFile: string, inputs: Inputs, expTags: string) => { - + process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile))); - + const toolkit = new Toolkit(); const repo = await toolkit.github.repoData(); - const context = await getFreshWorkflowContext(); - const meta = new Meta({...getInputs(), ...inputs}, context, repo); + const meta = new Meta({...getInputs(), ...inputs}, await getContext(ContextSource.workflow), repo); expect(meta.getTags().join(inputs.sepTags)).toEqual(expTags); }); diff --git a/tsconfig.json b/tsconfig.json index 04c6783..9720dc0 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,6 +13,7 @@ "useUnknownInCatchVariables": false, }, "exclude": [ + "./__mocks__/**/*", "./__tests__/**/*", "./lib/**/*", "node_modules",