- refactor action and move different functionalities in better classes

- merge releaseNotes and releaseNotesBuilder - update testcases to cover new structure
2023-05-26 12:09:48 +00:00
parent 061b8ff198
commit 66470e5f14
8 changed files with 473 additions and 494 deletions
@@ -0,0 +1,259 @@
+import {mergeConfiguration, resolveConfiguration} from '../src/utils'
+import {pullData} from '../src/releaseNotesBuilder'
+import {Octokit} from '@octokit/rest'
+import { buildChangelog } from '../src/transform'
+
+jest.setTimeout(180000)
+
+// load octokit instance
+const octokit = new Octokit({
+  auth: `token ${process.env.GITHUB_TOKEN}`
+})
+
+it('Should have empty changelog (tags)', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs/configuration.json'))
+
+  const data = await pullData(octokit,  {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.0.1'},
+    toTag: {name: 'v0.0.2'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual('- no changes')
+})
+
+it('Should match generated changelog (tags)', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs/configuration.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.0.1'},
+    toTag: {name: 'v0.0.3'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🧪 Tests
+
+- [CI] Specify Test Case
+   - PR: #10
+
+`)
+})
+
+it('Should match generated changelog (refs)', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_all_placeholders.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: '5ec7a2d86fe9f43fdd38d5e254a1117c8a51b4c3'},
+    toTag: {name: 'fa3788c8c4b3373ef8424ce3eb008a5cd07cc5aa'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🧪 Tests
+
+[CI] Specify Test Case
+10
+https://github.com/mikepenz/release-changelog-builder-action/pull/10
+2020-10-16T13:59:36.000Z
+mikepenz
+test
+1.0.0
+- specify test case
+mikepenz, nhoelzl
+nhoelzl
+
+`)
+})
+
+it('Should match generated changelog and replace all occurrences (refs)', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_replace_all_placeholders.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: '5ec7a2d86fe9f43fdd38d5e254a1117c8a51b4c3'},
+    toTag: {name: 'fa3788c8c4b3373ef8424ce3eb008a5cd07cc5aa'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🧪 Tests
+
+[CI] Specify Test Case
+[CI] Specify Test Case
+10
+https://github.com/mikepenz/release-changelog-builder-action/pull/10
+2020-10-16T13:59:36.000Z
+mikepenz
+mikepenz
+test
+1.0.0
+- specify test case
+mikepenz, nhoelzl
+nhoelzl
+
+`)
+})
+
+it('Should match ordered ASC', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_asc.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.3.0'},
+    toTag: {name: 'v0.5.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🚀 Features\n\n22\n24\n25\n26\n28\n\n## 🐛 Fixes\n\n23\n\n`)
+})
+
+it('Should match ordered DESC', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_desc.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.3.0'},
+    toTag: {name: 'v0.5.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`## 🚀 Features\n\n28\n26\n25\n24\n22\n\n## 🐛 Fixes\n\n23\n\n`)
+})
+
+it('Should match ordered by title ASC', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_sort_title_asc.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.3.0'},
+    toTag: {name: 'v0.5.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(
+    `## 🚀 Features\n\nEnhanced action logs\nImprove README\nImproved configuration failure handling\nImproved defaults if no configuration is provided\nIntroduce additional placeholders [milestone, labels, assignees, reviewers]\n\n## 🐛 Fixes\n\nImproved handling for non existing tags\n\n`
+  )
+})
+
+it('Should match ordered by title DESC', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_sort_title_desc.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v0.3.0'},
+    toTag: {name: 'v0.5.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(
+    `## 🚀 Features\n\nIntroduce additional placeholders [milestone, labels, assignees, reviewers]\nImproved defaults if no configuration is provided\nImproved configuration failure handling\nImprove README\nEnhanced action logs\n\n## 🐛 Fixes\n\nImproved handling for non existing tags\n\n`
+  )
+})
+
+it('Should ignore PRs not merged into develop branch', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_base_branches_develop.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v1.3.1'},
+    toTag: {name: 'v1.4.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`150\n\n`)
+})
+
+it('Should ignore PRs not merged into main branch', async () => {
+  const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_base_branches_main.json'))
+  const data = await pullData(octokit, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: {name: 'v1.3.1'},
+    toTag: {name: 'v1.4.0'},
+    includeOpen: false,
+    failOnError: false,
+    fetchReviewers: false,
+    fetchReleaseInformation: false,
+    fetchReviews: false,
+    commitMode: false,
+    configuration
+  })
+
+  const changeLog = buildChangelog(data.diffInfo, data.mergedPullRequests, data.options)
+  console.log(changeLog)
+  expect(changeLog).toStrictEqual(`153\n\n`)
+})