halfassed testing suite

Author: elliotberry

.github/workflows/nodejs-tests.yml

@@ -0,0 +1,26 @@
+name: Node.js Test Workflow
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v2
+      with:
+        node-version: '18' # or the version you need
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm test

lib/file-path-info.js

@@ -2,8 +2,6 @@ import path from 'path';
 import {slugify} from './slugify.js';
 import chalk from 'chalk';
 
-
-
 // Takes a file path and an optional boolean flag as input.
 // Extracts information about the file, such as the directory, file name, and file extension.
 // Creates a new file name that is a URL-friendly version of the original file name and returns an object that contains the old file path and the new file path if the new file name is different from the original file name. Otherwise, it returns null.

lib/ignore.js

@@ -1,4 +1,4 @@
-import path from 'path'
+
 import config from './rc.js'
 let ignoreFn
 

lib/log-changes.js

@@ -3,7 +3,7 @@ import path from 'path';
 import os from 'os';
 import chalk from 'chalk';
 
-var silent = global.silent
+
 
 const logDir = path.join(os.homedir(), '.config');
 

lib/path-validation.js

@@ -1,7 +1,6 @@
 import path from 'path'
 import fs from 'fs'
-
-
+import chalk from 'chalk'
 export const truncatePathIfPossible = (str, parentDir) => {
     if (parentDir) {
         let truncated = str.split(parentDir)[1]
@@ -84,9 +83,9 @@ export const validateAndFormatInput = async(inputStr) => {
         } else if (type === 'glob') {
             return { path: inputStr, type: 'glob' }
         } else {
-            throw new Error(`invalid input: ${inputStr}`)
+            throw new Error(chalk.red(`invalid input: ${inputStr}`))
         }
     } catch (e) {
-        throw new Error(`invalid input: ${inputStr}`)
+        throw new Error(chalk.red(`invalid input: ${inputStr}`))
     }
 }

lib/process-one-file.js

@@ -1,32 +1,32 @@
 import fs from 'fs'
 import fsp from 'node:fs/promises'
 import path from 'path'
-
-const processOneFile = async (f, rename=true, fixTildes=false) => {
+import chalk from 'chalk'
+const processOneFile = async (fileObj, rename=true, fixTildes=false) => {
     try {
 
-        !global.silent && console.log(`${f.old} -> ${f.new}`)
+        !global.silent && console.log(`${fileObj.old} -> ${fileObj.new}`)
 
-        if (fs.existsSync(f.new)) {
+        if (fs.existsSync(fileObj.new)) {
             if (rename === true) {
-                //ambiguous !global.silent && console.log(`file will be renamed: ${f.new}`)
+                //ambiguous !global.silent && console.log(`file will be renamed: ${fileObj.new}`)
                 let i = 1
-                let parsed = path.parse(f.new)
+                let parsed = path.parse(fileObj.new)
                 let newName = `${parsed.name}-${i}${parsed.ext}`
                 while (fs.existsSync(path.join(parsed.dir, newName))) {
                     i++
                     newName = `${parsed.name}-${i}${parsed.ext}`
                 }
-                f.new = path.resolve(path.join(parsed.dir, newName))
-                await fsp.rename(f.old, f.new)
+                fileObj.new = path.resolve(path.join(parsed.dir, newName))
+                await fsp.rename(fileObj.old, fileObj.new)
             } else {
-                throw new Error(`file already exists, doing nothing: ${f.new}`)
+                throw new Error(chalk.red(`file already exists, doing nothing: ${fileObj.new}`))
             }
         } else {
-            await fsp.rename(f.old, f.new)
+            await fsp.rename(fileObj.old, fileObj.new)
         }
     } catch (e) {
-        console.log(`error processing ${f.old}: ${e}`)
+        console.log(chalk.orange(`error processing ${fileObj.old}: ${e}`))
     }
 }
 

package.json

@@ -69,8 +69,10 @@
         "singleQuote": true
     },
     "devDependencies": {
+        "chai": "^4.3.10",
         "eslint": "^8.50.0",
         "eslint-config-prettier": "^9.0.0",
+        "mocha": "^10.2.0",
         "prettier": "^3.0.3",
         "release-it": "^16.2.1"
     },

test.js

@@ -4,9 +4,11 @@ import detawks from './index.js'
 import chalk from 'chalk'
 import { slugify } from './lib/slugify.js'
 import { exec } from 'child_process'
-
+import assert from 'assert'
 import { fileURLToPath } from 'url'
-
+import { expect } from 'chai'
+import { describe, it } from 'mocha'
+import test from 'node:test'
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 //this part is important for the tests to run
 var coolText = chalk.bgBlue.black
@@ -33,7 +35,7 @@ const names = [
     '✨🌀🌈🐱‍👤🐱‍🚀🐱‍🐉🐱‍💻👾🎃🕺💃🎉🎲🎸🚀🌠🌌🔮💎🎭🎨🖖🌀✨',
 ]
 
-const testSlugify = async () => {
+test('test strings', async(t) => {
     const testCases = [
         {
             input: 'Hello World',
@@ -48,16 +50,13 @@ const testSlugify = async () => {
             expected: 'hello-world',
         },
     ]
+    
     for await (let testCase of testCases) {
         const { input, expected } = testCase
         const actual = slugify(input)
-        if (actual !== expected) {
-            console.log(`expected ${expected} but got ${actual}`)
-        } else {
-            console.log(`passed test: ${input} -> ${actual}`)
-        }
+        assert.strictEqual(expected, actual)
     }
-}
+});
 
 async function deleteDirectoryAndFiles() {
     try {
@@ -121,7 +120,9 @@ const withAPI = async () => {
     console.log(coolText('Tests finished!'))
 }
 
-const withCommandLine = async () => {
+test('test command line usage for extreme error', async(t) => {
+    var failed = false
+    try {
     console.log(coolText('Running tests with command line...'))
     console.log(coolText('Creating directory with files...'))
     let oneFilePath = await createDirectoryWithFiles()
@@ -179,11 +180,9 @@ const withCommandLine = async () => {
     console.log(coolText('Deleting directory and files...'))
 
     console.log(coolText('Tests finished!'))
-}
-
-const main = async () => {
-    await testSlugify()
-    await withAPI()
-    await withCommandLine()
-}
-main()
+    } catch (e) {
+        console.error(e)
+        failed = true
+    }
+    assert.strictEqual(failed, false)
+});