tests: test internal helpers (#454)

Signed-off-by: Jan Kowalleck <[email protected]>

Author: jkowalleck

.mocharc.js

@@ -24,6 +24,7 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
  * @type {import('@types/mocha').Mocha.MochaOptions}
  */
 module.exports = {
+  timeout: 5000,
   spec: [
     'tests',
     'libs'

HISTORY.md

@@ -6,9 +6,12 @@ All notable changes to this project will be documented in this file.
 
 * Docs
   * Use [TSDoc](https://tsdoc.org/) syntax in TypeScript files, instead of [JSDoc](https://jsdoc.app/) (via [#318], [#453])
+* Misc
+  * Added tests for internal helpers (via [#454])
 
 [#318]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/318
 [#453]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/453
+[#454]: https://github.com/CycloneDX/cyclonedx-javascript-library/pull/454
 
 ## 1.10.0 - 2023-01-28
 

tests/_data/specLoader.js

@@ -25,6 +25,7 @@ const resPath = path.resolve(__dirname, '..', '..', 'res')
 /**
  * @param {string} resourceFile
  * @returns {*}
+ * @throws {Error} if parsing the `resourceFile` failed somehow
  */
 function loadSpec (resourceFile) {
   return JSON.parse(
@@ -38,11 +39,16 @@ function loadSpec (resourceFile) {
  * @param {string} resourceFile
  * @param {string} path
  * @returns {*}
+ * @throws {TypeError} if resolving the `path` failed
+ * @throws {Error} if parsing the `resourceFile` failed somehow
  */
 function getSpecElement (resourceFile, ...path) {
   let element = loadSpec(resourceFile)
   for (const segment of path) {
     element = element[segment]
+    if (undefined === element) {
+      throw TypeError(`undefined element: ${resourceFile}#${path.join('.')}`)
+    }
   }
   return element
 }
@@ -51,9 +57,18 @@ function getSpecElement (resourceFile, ...path) {
  * @param {string} resourceFile
  * @param {string} path
  * @returns {Array<number|string>}
+ * @throws {TypeError} if resolved `path` is not non-empty-list
+ * @throws {TypeError} if resolving the `path` failed
+ * @throws {Error} if parsing the `resourceFile` failed somehow
  */
 function getSpecEnum (resourceFile, ...path) {
-  return getSpecElement(resourceFile, 'definitions', ...path, 'enum')
+  const element = getSpecElement(
+    resourceFile,
+    'definitions', ...path, 'enum')
+  if (!Array.isArray(element) || element.length === 0) {
+    throw TypeError(`did not resolve non-empty-list for: ${resourceFile}#${path.join('.')}`)
+  }
+  return element
 }
 
 module.exports = {

tests/_data/specLoader.spec.js

@@ -0,0 +1,80 @@
+/*!
+This file is part of CycloneDX JavaScript Library.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+SPDX-License-Identifier: Apache-2.0
+Copyright (c) OWASP Foundation. All Rights Reserved.
+*/
+
+const assert = require('assert')
+const { suite, test } = require('mocha')
+
+const { loadSpec, getSpecElement, getSpecEnum } = require('./specLoader')
+
+suite('test helpers: specLoader', () => {
+  /* eslint-disable-next-line camelcase -- for better readability, JSON-path replaced `.` with `_` */
+  const expected_definitions_affectedStatus_enum = [
+    'affected',
+    'unaffected',
+    'unknown'
+  ]
+
+  suite('loadSpec()', () => {
+    test('unknown file', () => {
+      assert.throws(
+        () => {
+          loadSpec('DOES-NOT-EXIST.schema.json')
+        },
+        Error,
+        'missing expected error'
+      )
+    })
+    test('happy path', () => {
+      const loaded = loadSpec('bom-1.4.SNAPSHOT.schema.json')
+      // dummy test to see if loading worked somehow ...
+      assert.deepEqual(loaded.definitions.affectedStatus.enum, expected_definitions_affectedStatus_enum)
+    })
+  })
+
+  suite('getSpecElement()', () => {
+    test('unknown path', () => {
+      assert.throws(
+        () => {
+          getSpecElement(
+            'bom-1.4.SNAPSHOT.schema.json',
+            'properties', 'UNKNOWN_PROP')
+        },
+        TypeError('undefined element: bom-1.4.SNAPSHOT.schema.json#properties.UNKNOWN_PROP'),
+        'missing expected error'
+      )
+    })
+    test('happy path', () => {
+      const loaded = getSpecElement(
+        'bom-1.4.SNAPSHOT.schema.json',
+        'definitions', 'affectedStatus', 'enum')
+      // dummy test to see if loading worked somehow ...
+      assert.deepEqual(loaded, expected_definitions_affectedStatus_enum)
+    })
+  })
+
+  suite('getSpecEnum()', () => {
+    test('happy path', () => {
+      const loaded = getSpecEnum(
+        'bom-1.4.SNAPSHOT.schema.json',
+        'affectedStatus')
+      // dummy test to see if loading worked somehow ...
+      assert.deepEqual(loaded, expected_definitions_affectedStatus_enum)
+    })
+  })
+})

tests/_helpers/stringFunctions.spec.js

@@ -22,7 +22,7 @@ const { suite, test } = require('mocha')
 
 const stringFunctions = require('./stringFunctions')
 
-suite('helpers: stringFunctions', () => {
+suite('test helpers: stringFunctions', () => {
   suite('capitaliseFirstLetter()', () => {
     [
       ['foo', 'Foo'],

tests/unit/Models.Bom.spec.js

@@ -79,10 +79,12 @@ suite('Models.Bom', () => {
       test(`for: ${newVersion}`, () => {
         const bom = new Bom()
         assert.notStrictEqual(bom.version, newVersion)
-
-        assert.throws(() => {
-          bom.version = newVersion
-        }, /not PositiveInteger/i)
+        assert.throws(
+          () => {
+            bom.version = newVersion
+          },
+          /not PositiveInteger/i
+        )
       })
     )
   )