1
1
mirror of https://github.com/theoludwig/programming-challenges.git synced 2025-05-18 12:02:53 +02:00

refactor(cli): usage of node:test instead of tap

This commit is contained in:
2023-07-20 22:00:11 +02:00
parent c25eeaaa98
commit c53c2997ec
19 changed files with 647 additions and 4418 deletions

View File

@ -1,8 +1,9 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import { PassThrough } from 'node:stream'
import path from 'node:path'
import fs from 'node:fs'
import tap from 'tap'
import sinon from 'sinon'
import fsMock from 'mock-fs'
import chalk from 'chalk'
@ -18,7 +19,7 @@ const challenge = 'aaaa-test-jest'
const inputChallenge = `--challenge=${challenge}`
const inputGitHubUser = `--github-user=${githubUser}`
await tap.test('programming-challenges generate challenge', async (t) => {
await test('programming-challenges generate challenge', async (t) => {
t.beforeEach(() => {
fsMock(
{
@ -36,7 +37,7 @@ await tap.test('programming-challenges generate challenge', async (t) => {
sinon.restore()
})
await t.test('succeeds and generate the new challenge', async (t) => {
await t.test('succeeds and generate the new challenge', async () => {
sinon.stub(console, 'log').value(() => {})
const consoleLogSpy = sinon.spy(console, 'log')
const dateString = date.format(new Date(), 'D MMMM Y', true)
@ -50,7 +51,7 @@ await tap.test('programming-challenges generate challenge', async (t) => {
}
)
stream.end()
t.equal(exitCode, 0)
assert.strictEqual(exitCode, 0)
const challengePath = path.join(process.cwd(), 'challenges', challenge)
const readmePath = path.join(challengePath, 'README.md')
const readmeContent = await fs.promises.readFile(readmePath, {
@ -59,9 +60,9 @@ await tap.test('programming-challenges generate challenge', async (t) => {
const successMessage = `${chalk.bold.green(
'Success:'
)} created the new challenge at ${challengePath}.`
t.equal(consoleLogSpy.calledWith(successMessage), true)
t.equal(await isExistingPath(challengePath), true)
t.equal(
assert.strictEqual(consoleLogSpy.calledWith(successMessage), true)
assert.strictEqual(await isExistingPath(challengePath), true)
assert.strictEqual(
readmeContent,
`# ${challenge}
@ -78,7 +79,7 @@ See the \`test\` folder for examples of input/output.
)
})
await t.test('fails without options', async (t) => {
await t.test('fails without options', async () => {
const stream = new PassThrough()
const promise = getStream(stream)
const exitCode = await cli.run(input, {
@ -87,12 +88,12 @@ See the \`test\` folder for examples of input/output.
stderr: stream
})
stream.end()
t.equal(exitCode, 1)
assert.strictEqual(exitCode, 1)
const output = await promise
t.match(output, 'Unknown Syntax Error')
assert.match(output, /Unknown Syntax Error/)
})
await t.test('fails with already existing challenge', async (t) => {
await t.test('fails with already existing challenge', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -105,8 +106,8 @@ See the \`test\` folder for examples of input/output.
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
`${chalk.bold.red('Error:')} The challenge already exists: hello-world.`
),
@ -114,7 +115,7 @@ See the \`test\` folder for examples of input/output.
)
})
await t.test('fails with invalid challenge name', async (t) => {
await t.test('fails with invalid challenge name', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -127,8 +128,8 @@ See the \`test\` folder for examples of input/output.
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
`${chalk.bold.red('Error:')} Invalid challenge name.`
),

View File

@ -1,8 +1,9 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import { PassThrough } from 'node:stream'
import path from 'node:path'
import fs from 'node:fs'
import tap from 'tap'
import sinon from 'sinon'
import fsMock from 'mock-fs'
import chalk from 'chalk'
@ -22,7 +23,7 @@ const inputGitHubUser = `--github-user=${githubUser}`
const inputLanguage = `--language=${language}`
const inputSolution = `--solution=${solution}`
await tap.test('programming-challenges generate solution', async (t) => {
await test('programming-challenges generate solution', async (t) => {
t.beforeEach(() => {
fsMock(
{
@ -37,7 +38,7 @@ await tap.test('programming-challenges generate solution', async (t) => {
sinon.restore()
})
await t.test('succeeds and generate the new solution', async (t) => {
await t.test('succeeds and generate the new solution', async () => {
sinon.stub(console, 'log').value(() => {})
const consoleLogSpy = sinon.spy(console, 'log')
const dateString = date.format(new Date(), 'D MMMM Y', true)
@ -51,7 +52,7 @@ await tap.test('programming-challenges generate solution', async (t) => {
}
)
stream.end()
t.equal(exitCode, 0)
assert.strictEqual(exitCode, 0)
const solutionPath = path.join(
process.cwd(),
'challenges',
@ -67,9 +68,9 @@ await tap.test('programming-challenges generate solution', async (t) => {
const successMessage = `${chalk.bold.green(
'Success:'
)} created the new solution at ${solutionPath}.`
t.equal(consoleLogSpy.calledWith(successMessage), true)
t.equal(await isExistingPath(solutionPath), true)
t.equal(
assert.strictEqual(consoleLogSpy.calledWith(successMessage), true)
assert.strictEqual(await isExistingPath(solutionPath), true)
assert.strictEqual(
readmeContent,
`# ${challenge}/${language}/${solution}
@ -78,7 +79,7 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
)
})
await t.test("fails with challenges that doesn't exist", async (t) => {
await t.test("fails with challenges that doesn't exist", async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -99,8 +100,8 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` The challenge doesn't exist yet: ${invalidChallenge}.`
@ -109,7 +110,7 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
)
})
await t.test('fails with solution that already exist', async (t) => {
await t.test('fails with solution that already exist', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -130,8 +131,8 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` The solution already exists: ${invalidSolution}.`
@ -140,7 +141,7 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
)
})
await t.test('fails with invalid language', async (t) => {
await t.test('fails with invalid language', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -161,8 +162,8 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
' This programming language is not supported yet.'
@ -180,8 +181,8 @@ Created by [@${githubUser}](https://github.com/${githubUser}) on ${dateString}.
stderr: stream
})
stream.end()
t.equal(exitCode, 1)
assert.strictEqual(exitCode, 1)
const output = await promise
t.match(output, 'Unknown Syntax Error')
assert.match(output, /Unknown Syntax Error/)
})
})

View File

@ -1,7 +1,8 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import { PassThrough } from 'node:stream'
import path from 'node:path'
import tap from 'tap'
import sinon from 'sinon'
import chalk from 'chalk'
@ -24,12 +25,12 @@ const inputLanguage = `--language=${language}`
const inputSolution = `--solution=${solution}`
const inputInputPath = `--input-path=${inputPath}`
await tap.test('programming-challenges run solution', async (t) => {
await test('programming-challenges run solution', async (t) => {
t.afterEach(() => {
sinon.restore()
})
await t.test('succeeds', async (t) => {
await t.test('succeeds', async () => {
sinon.stub(console, 'log').value(() => {})
const consoleLogSpy = sinon.spy(console, 'log')
const stream = new PassThrough()
@ -49,11 +50,11 @@ await tap.test('programming-challenges run solution', async (t) => {
}
)
stream.end()
t.equal(exitCode, 0)
t.equal(consoleLogSpy.calledWith(`Hello, world!`), true)
assert.strictEqual(exitCode, 0)
assert.strictEqual(consoleLogSpy.calledWith(`Hello, world!`), true)
})
await t.test("fails with solution that doesn't exist", async (t) => {
await t.test("fails with solution that doesn't exist", async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -74,8 +75,8 @@ await tap.test('programming-challenges run solution', async (t) => {
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') + ' The solution was not found.'
),
@ -83,7 +84,7 @@ await tap.test('programming-challenges run solution', async (t) => {
)
})
await t.test('fails with invalid language', async (t) => {
await t.test('fails with invalid language', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -104,8 +105,8 @@ await tap.test('programming-challenges run solution', async (t) => {
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
' This programming language is not supported yet.'
@ -114,7 +115,7 @@ await tap.test('programming-challenges run solution', async (t) => {
)
})
await t.test('fails with invalid `input-path`', async (t) => {
await t.test('fails with invalid `input-path`', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -136,8 +137,8 @@ await tap.test('programming-challenges run solution', async (t) => {
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` The \`input-path\` doesn't exist: ${inputPath}.`

View File

@ -1,6 +1,7 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import { PassThrough } from 'node:stream'
import tap from 'tap'
import sinon from 'sinon'
import chalk from 'chalk'
@ -15,12 +16,12 @@ const inputChallenge = `--challenge=${challenge}`
const inputLanguage = `--language=${language}`
const inputSolution = `--solution=${solution}`
await tap.test('programming-challenges run test', async (t) => {
await test('programming-challenges run test', async (t) => {
t.afterEach(() => {
sinon.restore()
})
await t.test('succeeds', async (t) => {
await t.test('succeeds', async () => {
sinon.stub(console, 'log').value(() => {})
const consoleLogSpy = sinon.spy(console, 'log')
const stream = new PassThrough()
@ -33,23 +34,26 @@ await tap.test('programming-challenges run test', async (t) => {
}
)
stream.end()
t.equal(exitCode, 0)
t.equal(
assert.strictEqual(exitCode, 0)
assert.strictEqual(
consoleLogSpy.calledWith(
`${chalk.bold('Name:')} ${challenge}/${language}/${solution}\n`
),
true
)
t.equal(
assert.strictEqual(
consoleLogSpy.calledWith(
`${chalk.bold('Tests:')} ${chalk.bold.green('3 passed')}, 3 total`
),
true
)
t.equal(consoleLogSpy.calledWith(SolutionTestsResult.SUCCESS_MESSAGE), true)
assert.strictEqual(
consoleLogSpy.calledWith(SolutionTestsResult.SUCCESS_MESSAGE),
true
)
})
await t.test("fails with solution that doesn't exist", async (t) => {
await t.test("fails with solution that doesn't exist", async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -64,8 +68,8 @@ await tap.test('programming-challenges run test', async (t) => {
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') + ' The solution was not found.'
),
@ -73,7 +77,7 @@ await tap.test('programming-challenges run test', async (t) => {
)
})
await t.test('fails with invalid language', async (t) => {
await t.test('fails with invalid language', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -88,8 +92,8 @@ await tap.test('programming-challenges run test', async (t) => {
}
)
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
' This programming language is not supported yet.'
@ -98,7 +102,7 @@ await tap.test('programming-challenges run test', async (t) => {
)
})
await t.test('fails without options', async (t) => {
await t.test('fails without options', async () => {
sinon.stub(console, 'error').value(() => {})
const consoleErrorSpy = sinon.spy(console, 'error')
const stream = new PassThrough()
@ -108,8 +112,8 @@ await tap.test('programming-challenges run test', async (t) => {
stderr: stream
})
stream.end()
t.equal(exitCode, 1)
t.equal(
assert.strictEqual(exitCode, 1)
assert.strictEqual(
consoleErrorSpy.calledWith(
`${chalk.bold.red(
'Error:'

View File

@ -60,7 +60,7 @@ export class Docker {
)
try {
const { stdout, stderr } = await subprocess
if (stderr.length !== 0) {
if (stderr.length > 0) {
throw new Error(stderr)
}
return {

View File

@ -1,6 +1,7 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import crypto from 'node:crypto'
import tap from 'tap'
import sinon from 'sinon'
import { Challenge } from '../Challenge.js'
@ -10,7 +11,7 @@ import { parseCommandOutput } from '../../utils/parseCommandOutput.js'
const gitAffected = new GitAffected()
await tap.test('services/GitAffected', async (t) => {
await test('services/GitAffected', async (t) => {
t.afterEach(() => {
sinon.restore()
})
@ -22,19 +23,22 @@ await tap.test('services/GitAffected', async (t) => {
})
await t.test('parseCommandOutput', async (t) => {
await t.test('returns the right output array', async (t) => {
t.same(parseCommandOutput('1.txt\n 2.txt '), ['1.txt', '2.txt'])
await t.test('returns the right output array', async () => {
assert.deepStrictEqual(parseCommandOutput('1.txt\n 2.txt '), [
'1.txt',
'2.txt'
])
})
})
await t.test('getAffectedSolutionsFromFiles', async (t) => {
await t.test('returns the affected solutions', async (t) => {
await t.test('returns the affected solutions', async () => {
const files = [
'challenges/hello-world/solutions/javascript/function/solution.js',
'challenges/is-palindrome/solutions/c/function/input.c'
]
const solutions = await gitAffected.getAffectedSolutionsFromFiles(files)
t.same(solutions, [
assert.deepStrictEqual(solutions, [
new Solution({
challenge: new Challenge({ name: 'hello-world' }),
name: 'function',
@ -50,10 +54,10 @@ await tap.test('services/GitAffected', async (t) => {
await t.test(
'returns the affected solutions from Dockerfile changes',
async (t) => {
async () => {
const files = ['templates/docker/javascript/Dockerfile']
const solutions = await gitAffected.getAffectedSolutionsFromFiles(files)
t.same(
assert.deepStrictEqual(
solutions[0],
new Solution({
challenge: new Challenge({ name: 'camel-case' }),
@ -61,7 +65,7 @@ await tap.test('services/GitAffected', async (t) => {
programmingLanguageName: 'javascript'
})
)
t.same(
assert.deepStrictEqual(
solutions[1],
new Solution({
challenge: new Challenge({ name: 'first-non-repeating-character' }),
@ -74,10 +78,10 @@ await tap.test('services/GitAffected', async (t) => {
await t.test(
'returns the affected solutions from Docker template changes',
async (t) => {
async () => {
const files = ['templates/docker/javascript/package.json']
const solutions = await gitAffected.getAffectedSolutionsFromFiles(files)
t.same(
assert.deepStrictEqual(
solutions[0],
new Solution({
challenge: new Challenge({ name: 'camel-case' }),
@ -85,7 +89,7 @@ await tap.test('services/GitAffected', async (t) => {
programmingLanguageName: 'javascript'
})
)
t.same(
assert.deepStrictEqual(
solutions[1],
new Solution({
challenge: new Challenge({ name: 'first-non-repeating-character' }),
@ -98,10 +102,10 @@ await tap.test('services/GitAffected', async (t) => {
await t.test(
'returns the affected solutions from input/output files',
async (t) => {
async () => {
const files = ['challenges/hello-world/test/1/input.txt']
const solutions = await gitAffected.getAffectedSolutionsFromFiles(files)
t.same(
assert.deepStrictEqual(
solutions[0],
new Solution({
challenge: new Challenge({ name: 'hello-world' }),
@ -109,7 +113,7 @@ await tap.test('services/GitAffected', async (t) => {
programmingLanguageName: 'c'
})
)
t.same(
assert.deepStrictEqual(
solutions[1],
new Solution({
challenge: new Challenge({ name: 'hello-world' }),
@ -117,7 +121,7 @@ await tap.test('services/GitAffected', async (t) => {
programmingLanguageName: 'cpp'
})
)
t.same(
assert.deepStrictEqual(
solutions[2],
new Solution({
challenge: new Challenge({ name: 'hello-world' }),
@ -125,7 +129,7 @@ await tap.test('services/GitAffected', async (t) => {
programmingLanguageName: 'cs'
})
)
t.same(
assert.deepStrictEqual(
solutions[3],
new Solution({
challenge: new Challenge({ name: 'hello-world' }),

View File

@ -1,16 +1,17 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import fs from 'node:fs'
import tap from 'tap'
import fsMock from 'mock-fs'
import { copyDirectory } from '../copyDirectory.js'
await tap.test('utils/copyDirectory', async (t) => {
await test('utils/copyDirectory', async (t) => {
t.afterEach(() => {
fsMock.restore()
})
await t.test('copy the files', async (t) => {
await t.test('copy the files', async () => {
fsMock({
'/source': {
'default.png': '',
@ -21,19 +22,22 @@ await tap.test('utils/copyDirectory', async (t) => {
let destinationDirectoryContent = await fs.promises.readdir('/destination')
let sourceDirectoryContent = await fs.promises.readdir('/source')
t.equal(destinationDirectoryContent.length, 0)
t.equal(sourceDirectoryContent.length, 2)
assert.strictEqual(destinationDirectoryContent.length, 0)
assert.strictEqual(sourceDirectoryContent.length, 2)
await copyDirectory('/source', '/destination')
destinationDirectoryContent = await fs.promises.readdir('/destination')
sourceDirectoryContent = await fs.promises.readdir('/source')
t.equal(destinationDirectoryContent.length, 2)
t.equal(sourceDirectoryContent.length, 2)
t.strictSame(destinationDirectoryContent, ['default.png', 'index.ts'])
t.strictSame(sourceDirectoryContent, ['default.png', 'index.ts'])
assert.strictEqual(destinationDirectoryContent.length, 2)
assert.strictEqual(sourceDirectoryContent.length, 2)
assert.deepStrictEqual(destinationDirectoryContent, [
'default.png',
'index.ts'
])
assert.deepStrictEqual(sourceDirectoryContent, ['default.png', 'index.ts'])
})
await t.test('copy the files and folders recursively', async (t) => {
await t.test('copy the files and folders recursively', async () => {
fsMock({
'/source': {
'random-folder': {
@ -53,10 +57,10 @@ await tap.test('utils/copyDirectory', async (t) => {
let secondRandomFolderContent = await fs.promises.readdir(
'/source/random-folder/second-random-folder'
)
t.equal(randomFolderContent.length, 2)
t.equal(secondRandomFolderContent.length, 1)
t.equal(destinationDirectoryContent.length, 0)
t.equal(sourceDirectoryContent.length, 2)
assert.strictEqual(randomFolderContent.length, 2)
assert.strictEqual(secondRandomFolderContent.length, 1)
assert.strictEqual(destinationDirectoryContent.length, 0)
assert.strictEqual(sourceDirectoryContent.length, 2)
await copyDirectory('/source', '/destination')
destinationDirectoryContent = await fs.promises.readdir('/destination')
@ -67,13 +71,22 @@ await tap.test('utils/copyDirectory', async (t) => {
secondRandomFolderContent = await fs.promises.readdir(
'/destination/random-folder/second-random-folder'
)
t.equal(destinationDirectoryContent.length, 2)
t.equal(sourceDirectoryContent.length, 2)
t.strictSame(destinationDirectoryContent, ['index.ts', 'random-folder'])
t.strictSame(sourceDirectoryContent, ['index.ts', 'random-folder'])
t.equal(randomFolderContent.length, 2)
t.equal(secondRandomFolderContent.length, 1)
t.strictSame(randomFolderContent, ['default.png', 'second-random-folder'])
t.strictSame(secondRandomFolderContent, ['mycode.ts'])
assert.strictEqual(destinationDirectoryContent.length, 2)
assert.strictEqual(sourceDirectoryContent.length, 2)
assert.deepStrictEqual(destinationDirectoryContent, [
'index.ts',
'random-folder'
])
assert.deepStrictEqual(sourceDirectoryContent, [
'index.ts',
'random-folder'
])
assert.strictEqual(randomFolderContent.length, 2)
assert.strictEqual(secondRandomFolderContent.length, 1)
assert.deepStrictEqual(randomFolderContent, [
'default.png',
'second-random-folder'
])
assert.deepStrictEqual(secondRandomFolderContent, ['mycode.ts'])
})
})

View File

@ -1,9 +1,11 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import fsMock from 'mock-fs'
import tap from 'tap'
import { isExistingPath } from '../isExistingPath.js'
await tap.test('utils/isExistingPath', async (t) => {
await test('utils/isExistingPath', async (t) => {
t.afterEach(() => {
fsMock.restore()
})
@ -12,13 +14,13 @@ await tap.test('utils/isExistingPath', async (t) => {
fsMock({
'/file.txt': ''
})
t.equal(await isExistingPath('/file.txt'), true)
assert.strictEqual(await isExistingPath('/file.txt'), true)
})
await t.test("should return false if the file doesn't exists", async () => {
fsMock({
'/file.txt': ''
})
t.equal(await isExistingPath('/randomfile.txt'), false)
assert.strictEqual(await isExistingPath('/randomfile.txt'), false)
})
})