Add tests: validate, request-builder

Author: saffi-codefresh

package.json

@@ -26,6 +26,7 @@
     "eventsource": "^2.0.1"
   },
   "devDependencies": {
+    "@types/jest": "^27.5.1",
     "@types/node": "^17.0.31",
     "@typescript-eslint/eslint-plugin": "^5.23.0",
     "@typescript-eslint/parser": "^5.23.0",
@@ -35,10 +36,25 @@
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-unicorn": "^42.0.0",
     "eslint-plugin-unused-imports": "^1.1.2",
+    "jest": "^28.1.0",
     "nodemon": "^2.0.16",
     "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.2",
     "ts-node": "^10.7.0",
     "tsconfig-paths": "^4.0.0",
     "typescript": "^4.6.4"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "testEnvironment": "node"
   }
 }

src/__tests__/request-builder.spec.ts

@@ -0,0 +1,16 @@
+import { buildUrlHeaders } from '../request-builder'
+
+
+describe('request builder test', () => {
+    it('clean CF_', async () => {
+        const
+            { url, headers } = buildUrlHeaders({
+                'CF_API_KEY': 'the-token',
+                'CF_HOST': 'g.codefresh.io',
+                'CF_IMAGE': 'testImage'
+            })
+        expect(url).toEqual('g.codefresh.io/api/image-report?IMAGE=testImage')
+        expect(headers).toEqual({ 'authorization': 'the-token' })
+    })
+
+})

src/__tests__/validate.spec.ts

@@ -0,0 +1,40 @@
+import { validate } from '../validate'
+
+
+describe('client report-image validation', () => {
+    it('Must have', async () => {
+        try {
+            validate({ ENV1: '1', someVal: 'ignored' })
+        } catch (error) {
+            expect(error.message).toBe(`Validation Error: ["CF_API_KEY must be provided as environment variable.","CF_IMAGE must be provided as environment variable."]`)
+            return
+        }
+        fail(`should have thrown Validation Error`)
+    })
+    it('All OK', async () => {
+        let res
+        try {
+            res = validate({ CF_API_KEY: '1', alsoIgnored: 'ignored', IGNORED: 'ignored too', CF_IMAGE: 'testImage', CF_HOST: `host.io` })
+        } catch (error) {
+            fail(`should have not thrown an error ${JSON.stringify(error)}`)
+        }
+        expect(res).toEqual({
+            'CF_API_KEY': '1',
+            'CF_HOST': 'host.io',
+            'CF_IMAGE': 'testImage'
+        })
+    })
+    it('default CF_HOST', async () => {
+        let res
+        try {
+            res = validate({ CF_API_KEY: '1', alsoIgnored: 'ignored', IGNORED: 'ignored too', CF_IMAGE: 'testImage' })
+        } catch (error) {
+            fail(`should have not thrown an error ${JSON.stringify(error)}`)
+        }
+        expect(res).toEqual({
+            'CF_API_KEY': '1',
+            'CF_HOST': 'g.codefresh.io',
+            'CF_IMAGE': 'testImage'
+        })
+    })
+})

src/index.ts

@@ -12,7 +12,7 @@ async function main(): Promise<void> {
         console.debug('Running with verbose log')
     }
     const payload = validate(process.env)
-    const { url, headers } = buildUrlHeaders(payload, encodeURIComponent)
+    const { url, headers } = buildUrlHeaders(payload)
     if (verbose) {
         console.debug(`Payload: ${JSON.stringify(payload, null, 2)}`)
         console.debug(`Sending request: ${url}, headers: ${JSON.stringify(headers)}`)

src/request-builder.ts

@@ -16,7 +16,8 @@ function cleanThePrefixCF(env: Record<string, string|undefined>): Record<string,
  * @param payload
  * @param esc
  */
-export function buildUrlHeaders(payload: Record<string, string | undefined>, esc: (uriComponent: (string | number | boolean)) => string) {
+export function buildUrlHeaders(payload: Record<string, string | undefined>) {
+    const esc = encodeURIComponent
     const parameters = cleanThePrefixCF(payload)
     const headers = { 'authorization': parameters['API_KEY'] }
     const host = parameters['HOST']

src/validate.ts

@@ -11,7 +11,6 @@ export function validate(payload: Record<string, string|undefined>): Record<stri
         messages.push(`CF_IMAGE must be provided as environment variable.`)
     }
     if (messages.length>0) {
-        console.error()
         throw new Error(`Validation Error: ${JSON.stringify(messages)}`)
     }
     filtered['CF_HOST'] = filtered['CF_HOST'] || 'g.codefresh.io'