Merge pull request #1472 from mikepenz/feature/vitest

Replace Jest with Vitest

Author: mikepenz

__tests__/configuration.test.ts

@@ -1,11 +1,10 @@
 import {mergeConfiguration, parseConfiguration, resolveConfiguration} from '../src/utils.js'
 import {clear} from '../src/transform.js'
-import {jest} from '@jest/globals'
+import {expect, test} from 'vitest'
 
-jest.setTimeout(180000)
 clear()
 
-it('Configurations are merged correctly', async () => {
+test('Configurations are merged correctly', async () => {
   const configurationJson = parseConfiguration(`{
     "sort": "DESC",
     "empty_template": "- no magic changes",

__tests__/demo/demo.test.ts

@@ -1,15 +1,14 @@
 import {mergeConfiguration, resolveConfiguration} from '../../src/utils.js'
 import {ReleaseNotesBuilder} from '../../src/releaseNotesBuilder.js'
 import {GithubRepository} from '../../src/repositories/GithubRepository.js'
-import {jest} from '@jest/globals'
+import { expect, test } from 'vitest'
 
-jest.setTimeout(180000)
 
 // Define the token to use. Either retrieved from the environment.
 // Alternatively provide it as a string right here.
 const token = process.env.GITHUB_TOKEN || ''
 const githubRepository = new GithubRepository(token, undefined, '.')
-it('Test custom changelog builder', async () => {
+test('Test custom changelog builder', async () => {
   // define the configuration file to use.
   // By default, it retrieves a configuration from a json file
   // You can also quickly modify in code.

__tests__/gitea/releaseNotesBuilderGitea.test.ts

@@ -2,9 +2,8 @@ import {mergeConfiguration, resolveConfiguration} from '../../src/utils.js'
 import {ReleaseNotesBuilder} from '../../src/releaseNotesBuilder.js'
 import {GiteaRepository} from '../../src/repositories/GiteaRepository.js'
 import {clear} from '../../src/transform.js'
-import {jest} from '@jest/globals'
+import { expect, test } from 'vitest'
 
-jest.setTimeout(180000)
 clear()
 
 /**
@@ -20,7 +19,7 @@ const owner = 'jolheiser'
 const repo = 'sip'
 const configurationFile = 'configs/configuration_gitea.json'
 
-it('[Gitea] Verify reviewers who approved are fetched and also release information', async () => {
+test('[Gitea] Verify reviewers who approved are fetched and also release information', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_approvers.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -60,7 +59,7 @@ it('[Gitea] Verify reviewers who approved are fetched and also release informati
   )
 })
 
-it('[Gitea] Should match generated changelog (unspecified fromTag)', async () => {
+test('[Gitea] Should match generated changelog (unspecified fromTag)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -97,7 +96,7 @@ it('[Gitea] Should match generated changelog (unspecified fromTag)', async () =>
 })
 
 //
-it('[Gitea] Should match generated changelog (unspecified tags)', async () => {
+test('[Gitea] Should match generated changelog (unspecified tags)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -133,7 +132,7 @@ it('[Gitea] Should match generated changelog (unspecified tags)', async () => {
 `)
 })
 
-it('[Gitea] Should use empty placeholder', async () => {
+test('[Gitea] Should use empty placeholder', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -184,7 +183,7 @@ it('[Gitea] Should use empty placeholder', async () => {
 `)
 })
 
-it('[Gitea] Should fill empty placeholders', async () => {
+test('[Gitea] Should fill empty placeholders', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_empty_all_placeholders.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -292,7 +291,7 @@ https://gitea.com/jolheiser/sip/compare/v0.1.0...v0.4.0
   )
 })
 
-it('[Gitea] Should fill `template` placeholders', async () => {
+test('[Gitea] Should fill `template` placeholders', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_empty_all_placeholders.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -400,7 +399,7 @@ https://gitea.com/jolheiser/sip/compare/v0.1.0...v0.4.0
   )
 })
 
-it('[Gitea] Should fill `template` placeholders, ignore', async () => {
+test('[Gitea] Should fill `template` placeholders, ignore', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_empty_all_placeholders.json'))
   configuration.categories.pop() // drop `uncategorized` category
 
@@ -466,7 +465,7 @@ https://gitea.com/jolheiser/sip/compare/v0.3.0...v0.5.0
   )
 })
 
-it('[Gitea] Uncategorized category', async () => {
+test('[Gitea] Uncategorized category', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_uncategorized_category.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -540,7 +539,7 @@ Ignored:
   )
 })
 
-it('[Gitea] Verify commit based changelog', async () => {
+test('[Gitea] Verify commit based changelog', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_commits.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -617,7 +616,7 @@ Ignored:
   )
 })
 
-it('[Gitea] Verify commit based changelog', async () => {
+test('[Gitea] Verify commit based changelog', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -655,7 +654,7 @@ it('[Gitea] Verify commit based changelog', async () => {
   )
 })
 // no open prs
-it('[Gitea] Verify default inclusion of open PRs', async () => {
+test('[Gitea] Verify default inclusion of open PRs', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_including_open.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -696,7 +695,7 @@ Open
 `)
 })
 
-it('[Gitea] Verify custom categorisation of open PRs', async () => {
+test('[Gitea] Verify custom categorisation of open PRs', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_excluding_open.json'))
 
   const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
@@ -727,7 +726,7 @@ it('[Gitea] Verify custom categorisation of open PRs', async () => {
   expect(changeLog).toStrictEqual(``)
 })
 
-it('[Gitea] Fetch release information', async () => {
+test('[Gitea] Fetch release information', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_approvers.json'))
   configuration.template = '#{{FROM_TAG}}-#{{FROM_TAG_DATE}}\n#{{TO_TAG}}-#{{TO_TAG_DATE}}\n#{{DAYS_SINCE}}'
 
@@ -761,7 +760,7 @@ master-2020-09-21T19:30:21.000Z
 4`)
 })
 
-it('[Gitea] Fetch release information for non existing tag / release', async () => {
+test('[Gitea] Fetch release information for non existing tag / release', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_approvers.json'))
   configuration.template = '#{{FROM_TAG}}-#{{FROM_TAG_DATE}}\n#{{TO_TAG}}-#{{TO_TAG_DATE}}\n#{{DAYS_SINCE}}'
 

__tests__/gitea/releaseNotesBuilderPullGitea.test.ts

@@ -4,9 +4,8 @@ import {Options, pullData} from '../../src/pr-collector/prCollector.js'
 import {GiteaRepository} from '../../src/repositories/GiteaRepository.js'
 import {clear} from '../../src/transform.js'
 import {ReleaseNotesOptions} from '../../src/releaseNotesBuilder.js'
-import {jest} from '@jest/globals'
+import { expect, test } from 'vitest'
 
-jest.setTimeout(180000)
 clear()
 
 // load octokit instance
@@ -35,7 +34,7 @@ const owner = 'jolheiser'
 const repo = 'sip'
 const giteaRepository = new GiteaRepository(token, undefined, workingDirectory)
 const configurationFile = 'configs/configuration_gitea.json'
-it('[Gitea] Should have  changelog (tags)', async () => {
+test('[Gitea] Should have  changelog (tags)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
 
   const options = {
@@ -74,7 +73,7 @@ it('[Gitea] Should have  changelog (tags)', async () => {
 `)
 })
 
-it('[Gitea] Should match generated changelog (tags)', async () => {
+test('[Gitea] Should match generated changelog (tags)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
   const options = {
     owner: owner,
@@ -112,7 +111,7 @@ it('[Gitea] Should match generated changelog (tags)', async () => {
 `)
 })
 
-it('[Gitea] Should match generated changelog (refs)', async () => {
+test('[Gitea] Should match generated changelog (refs)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_all_placeholders.json'))
 
   const options = {
@@ -170,7 +169,7 @@ It also scans CLI flags into variables for fewer footguns.
 `)
 })
 
-it('[Gitea] Should match generated changelog and replace all occurrences (refs)', async () => {
+test('[Gitea] Should match generated changelog and replace all occurrences (refs)', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_replace_all_placeholders.json'))
   const options = {
     owner: owner,
@@ -231,7 +230,7 @@ It also scans CLI flags into variables for fewer footguns.
 `)
 })
 
-it('[Gitea] Should match ordered ASC', async () => {
+test('[Gitea] Should match ordered ASC', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', configurationFile))
   configuration.categories.pop() // drop `uncategorized` category
   const options = {
@@ -288,7 +287,7 @@ it('[Gitea] Should match ordered ASC', async () => {
 `)
 })
 
-it('[Gitea] Should match ordered DESC', async () => {
+test('[Gitea] Should match ordered DESC', async () => {
   const configuration = mergeConfiguration(undefined, resolveConfiguration('', 'configs_test/configuration_gitea_desc.json'))
   configuration.categories.pop() // drop `uncategorized` category
   const options = {

__tests__/main.test.ts

@@ -3,14 +3,13 @@ import * as process from 'process'
 import * as cp from 'child_process'
 import * as fs from 'fs'
 import {clear} from '../src/transform.js'
-import {jest} from '@jest/globals'
-import { fileURLToPath } from 'url';
+import {fileURLToPath} from 'url'
+import {expect, test} from 'vitest'
 
-jest.setTimeout(180000)
 clear()
 
-const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
-const __dirname = path.dirname(__filename); // get the name of the directory
+const __filename = fileURLToPath(import.meta.url) // get the resolved path to the file
+const __dirname = path.dirname(__filename) // get the name of the directory
 
 function resetEnv(): void {
   process.env['INPUT_CONFIGURATION'] = ''
@@ -113,7 +112,7 @@ test('offline mode should work with commit mode', () => {
   const readOutput = fs.readFileSync('test.md')
   fs.unlinkSync('test.md')
 
-  expect(readOutput.toString()).not.toBe("- no changes")
+  expect(readOutput.toString()).not.toBe('- no changes')
   expect(readOutput.toString()).not.toBe('')
 
   console.log('Offline mode test succeeded')

__tests__/offline/offlineMode.test.ts

@@ -16,9 +16,7 @@
 import {mergeConfiguration, resolveConfiguration} from '../../src/utils.js'
 import {ReleaseNotesBuilder} from '../../src/releaseNotesBuilder.js'
 import {OfflineRepository} from '../../src/repositories/OfflineRepository.js'
-import {jest} from '@jest/globals'
-
-jest.setTimeout(180000)
+import { expect, test } from 'vitest'
 
 // This test validates the behavior of the new offline mode
 test('Test offline mode functionality', async () => {

__tests__/regexUtils.test.ts

@@ -1,12 +1,11 @@
 import {transformStringToValue, validateRegex} from '../src/pr-collector/regexUtils.js'
 import {Regex} from '../src/pr-collector/types.js'
 import {clear} from '../src/transform.js'
-import {jest} from '@jest/globals'
+import {expect, test} from 'vitest'
 
-jest.setTimeout(180000)
 clear()
 
-it('Replace into target', async () => {
+test('Replace into target', async () => {
   const regex: Regex = {
     pattern: '.*(\\[Feature\\]|\\[Issue\\]).*',
     target: '$1'
@@ -16,7 +15,7 @@ it('Replace into target', async () => {
   expect(transformStringToValue('[Feature] TEST', validatedRegex!!)).toStrictEqual(`[Feature]`)
 })
 
-it('Replace all into target', async () => {
+test('Replace all into target', async () => {
   const regex: Regex = {
     pattern: '.*(\\[Feature\\]|\\[Issue\\]).*',
     method: 'replaceAll',
@@ -27,7 +26,7 @@ it('Replace all into target', async () => {
   expect(transformStringToValue('[Feature] TEST', validatedRegex!!)).toStrictEqual(`[Feature]`)
 })
 
-it('Match without target', async () => {
+test('Match without target', async () => {
   const regex: Regex = {
     pattern: '\\[Feature\\]|\\[Issue\\]',
     method: 'match'
@@ -37,7 +36,7 @@ it('Match without target', async () => {
   expect(transformStringToValue('[Feature] TEST', validatedRegex!!)).toStrictEqual(`[Feature]`)
 })
 
-it('Match into target', async () => {
+test('Match into target', async () => {
   const regex: Regex = {
     pattern: '(?<label>\\[Feature\\]|\\[Issue\\])',
     method: 'match',
@@ -48,7 +47,7 @@ it('Match into target', async () => {
   expect(transformStringToValue('[Feature] TEST', validatedRegex!!)).toStrictEqual(`[Feature]`)
 })
 
-it('Match into named group', async () => {
+test('Match into named group', async () => {
   const regex: Regex = {
     pattern: '(?<label>\\[Feature\\]|\\[Issue\\])',
     method: 'match',