Merge pull request #303 from secvisogram/feat/286-rename-optional-2-recommended-tests

rainer-exxcellent · web-flow · commit ee6005f1362a · 2025-06-05T15:31:28.000+02:00
Feat/286 rename optional 2 recommended tests
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@
     - CSAF 2.1
       - [Module `csaf_2_1/schemaTests.js`](#module-csaf_2_1schematestsjs)
       - [Module `csaf_2_1/mandatoryTests.js`](#module-csaf_2_1mandatorytestsjs)
-      - [Module `csaf_2_1/optionalTests.js`](#module-csaf_2_1optionaltestsjs)
+      - [Module `csaf_2_1/recommendedTests.js`](#module-csaf_2_1recommendedtestsjs)
       - [Module `csaf_2_1/informativeTests.js`](#module-csaf_2_1informativetestsjs)
       - [Module `csaf_2_1/basic.js`](#module-csaf_2_1basicjs)
       - [Module `csaf_2_1/extended.js`](#module-csaf_2_1extendedjs)
@@ -357,29 +357,29 @@ export const mandatoryTest_6_1_33: DocumentTest
 
 [(back to top)](#bsi-csaf-validator-lib)
 
-#### Module `csaf_2_1/optionalTests.js`
+#### Module `csaf_2_1/recommendedTests.js`
 
 ```typescript
-export const optionalTest_6_2_1: DocumentTest
-export const optionalTest_6_2_2: DocumentTest
-export const optionalTest_6_2_3: DocumentTest
-export const optionalTest_6_2_4: DocumentTest
-export const optionalTest_6_2_5: DocumentTest
-export const optionalTest_6_2_6: DocumentTest
-export const optionalTest_6_2_7: DocumentTest
-export const optionalTest_6_2_8: DocumentTest
-export const optionalTest_6_2_9: DocumentTest
-export const optionalTest_6_2_10: DocumentTest
-export const optionalTest_6_2_11: DocumentTest
-export const optionalTest_6_2_12: DocumentTest
-export const optionalTest_6_2_13: DocumentTest
-export const optionalTest_6_2_14: DocumentTest
-export const optionalTest_6_2_15: DocumentTest
-export const optionalTest_6_2_16: DocumentTest
-export const optionalTest_6_2_17: DocumentTest
-export const optionalTest_6_2_18: DocumentTest
-export const optionalTest_6_2_19: DocumentTest
-export const optionalTest_6_2_20: DocumentTest
+export const recommendedTest_6_2_1: DocumentTest
+export const recommendedTest_6_2_2: DocumentTest
+export const recommendedTest_6_2_3: DocumentTest
+export const recommendedTest_6_2_4: DocumentTest
+export const recommendedTest_6_2_5: DocumentTest
+export const recommendedTest_6_2_6: DocumentTest
+export const recommendedTest_6_2_7: DocumentTest
+export const recommendedTest_6_2_8: DocumentTest
+export const recommendedTest_6_2_9: DocumentTest
+export const recommendedTest_6_2_10: DocumentTest
+export const recommendedTest_6_2_11: DocumentTest
+export const recommendedTest_6_2_12: DocumentTest
+export const recommendedTest_6_2_13: DocumentTest
+export const recommendedTest_6_2_14: DocumentTest
+export const recommendedTest_6_2_15: DocumentTest
+export const recommendedTest_6_2_16: DocumentTest
+export const recommendedTest_6_2_17: DocumentTest
+export const recommendedTest_6_2_18: DocumentTest
+export const recommendedTest_6_2_19: DocumentTest
+export const recommendedTest_6_2_20: DocumentTest
 ```
 
 [(back to top)](#bsi-csaf-validator-lib)
diff --git a/csaf_2_1/extended.js b/csaf_2_1/extended.js
@@ -1,2 +1,2 @@
 export * from './basic.js'
-export * from './optionalTests.js'
+export * from './recommendedTests.js'
diff --git a/csaf_2_1/optionalTests.js b/csaf_2_1/optionalTests.js
diff --git a/csaf_2_1/recommendedTests.js b/csaf_2_1/recommendedTests.js
@@ -0,0 +1,29 @@
+/**
+ * @file Bundles all recommended tests.
+ *
+ * Old optional tests are wrapped. This is necessary to adapt the function name
+ * which is used as the test name. The test name is used in the validator service
+ * for example.
+ */
+
+export { recommendedTest_6_2_1 } from './recommendedTests/recommendedTest_6_2_1.js'
+export { recommendedTest_6_2_10 } from './recommendedTests/recommendedTest_6_2_10.js'
+export { recommendedTest_6_2_11 } from './recommendedTests/recommendedTest_6_2_11.js'
+export { recommendedTest_6_2_12 } from './recommendedTests/recommendedTest_6_2_12.js'
+export { recommendedTest_6_2_13 } from './recommendedTests/recommendedTest_6_2_13.js'
+export { recommendedTest_6_2_14 } from './recommendedTests/recommendedTest_6_2_14.js'
+export { recommendedTest_6_2_15 } from './recommendedTests/recommendedTest_6_2_15.js'
+export { recommendedTest_6_2_16 } from './recommendedTests/recommendedTest_6_2_16.js'
+export { recommendedTest_6_2_17 } from './recommendedTests/recommendedTest_6_2_17.js'
+export { recommendedTest_6_2_18 } from './recommendedTests/recommendedTest_6_2_18.js'
+export { recommendedTest_6_2_19 } from './recommendedTests/recommendedTest_6_2_19.js'
+export { recommendedTest_6_2_2 } from './recommendedTests/recommendedTest_6_2_2.js'
+export { recommendedTest_6_2_20 } from './recommendedTests/recommendedTest_6_2_20.js'
+export { recommendedTest_6_2_4 } from './recommendedTests/recommendedTest_6_2_4.js'
+export { recommendedTest_6_2_5 } from './recommendedTests/recommendedTest_6_2_5.js'
+export { recommendedTest_6_2_6 } from './recommendedTests/recommendedTest_6_2_6.js'
+export { recommendedTest_6_2_7 } from './recommendedTests/recommendedTest_6_2_7.js'
+export { recommendedTest_6_2_8 } from './recommendedTests/recommendedTest_6_2_8.js'
+export { recommendedTest_6_2_9 } from './recommendedTests/recommendedTest_6_2_9.js'
+export { recommendedTest_6_2_3 } from './recommendedTests/recommendedTest_6_2_3.js'
+export { recommendedTest_6_2_22 } from './recommendedTests/recommendedTest_6_2_22.js'
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_1.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_1.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_1 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_1(doc) {
+  return optionalTest_6_2_1(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_10.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_10.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_10 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_10(doc) {
+  return optionalTest_6_2_10(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_11.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_11.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_11 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_11(doc) {
+  return optionalTest_6_2_11(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_12.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_12.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_12 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_12(doc) {
+  return optionalTest_6_2_12(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_13.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_13.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_13 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_13(doc) {
+  return optionalTest_6_2_13(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_14.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_14.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_14 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_14(doc) {
+  return optionalTest_6_2_14(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_15.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_15.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_15 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_15(doc) {
+  return optionalTest_6_2_15(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_16.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_16.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_16 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_16(doc) {
+  return optionalTest_6_2_16(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_17.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_17.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_17 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_17(doc) {
+  return optionalTest_6_2_17(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_18.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_18.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_18 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_18(doc) {
+  return optionalTest_6_2_18(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_19.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_19.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_19 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_19(doc) {
+  return optionalTest_6_2_19(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_2.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_2.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_2 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_2(doc) {
+  return optionalTest_6_2_2(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_20.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_20.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_20 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_20(doc) {
+  return optionalTest_6_2_20(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_22.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_22.js
@@ -25,7 +25,7 @@ const validate = ajv.compile(inputSchema)
 /**
  * @param {any} doc
  */
-export function optionalTest_6_2_22(doc) {
+export function recommendedTest_6_2_22(doc) {
   /** @type {Array<{ message: string; instancePath: string }>} */
   const warnings = []
   const context = { warnings }
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_3.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_3.js
@@ -41,7 +41,7 @@ const validate = ajv.compile(inputSchema)
 /**
  * @param {any} doc
  */
-export function optionalTest_6_2_3(doc) {
+export function recommendedTest_6_2_3(doc) {
   /** @type {Array<{ message: string; instancePath: string }>} */
   const warnings = []
   const context = { warnings }
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_4.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_4.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_4 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_4(doc) {
+  return optionalTest_6_2_4(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_5.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_5.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_5 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_5(doc) {
+  return optionalTest_6_2_5(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_6.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_6.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_6 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_6(doc) {
+  return optionalTest_6_2_6(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_7.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_7.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_7 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_7(doc) {
+  return optionalTest_6_2_7(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_8.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_8.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_8 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_8(doc) {
+  return optionalTest_6_2_8(doc)
+}
diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_9.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_9.js
@@ -0,0 +1,8 @@
+import { optionalTest_6_2_9 } from '../../optionalTests.js'
+
+/**
+ * @param {unknown} doc
+ */
+export function recommendedTest_6_2_9(doc) {
+  return optionalTest_6_2_9(doc)
+}
diff --git a/scripts/runTest.js b/scripts/runTest.js
@@ -14,9 +14,9 @@
  *      can insert any test name from `mandatoryTests.js`, `optionalTests.js`,
  *      `informativeTests.js` and `schemaTests.js`.
  *      If you use 2.1 here you can insert any test name from `csaf_2_1/mandatoryTests.js`,
- *      `csaf_2_1/optionalTests.js`, `csaf_2_1/informativeTests.js` and `csaf_2_1/schemaTests.js`.
- *      Some presets are also allowed such as `mandatory`, `optional`, `informative`,
- *      `schema` and `base`.
+ *      `csaf_2_1/recommendedTests.js`, `csaf_2_1/informativeTests.js` and `csaf_2_1/schemaTests.js`.
+ *      Some presets are also allowed such as `mandatory`, `optional` (only CSAF 2.0), recommended (only CSAF 2.1),
+ *      `informative`, `schema` and `base`.
  *
  *    -c <csaf-version> (default: 2.0)
  *      Specifies the csaf version to use. The currently allowed versions are `2.0` (the default)
@@ -43,13 +43,20 @@ import assert from 'node:assert'
  * @param {DocumentTestLoader} ctx.schemaTests
  * @param {DocumentTestLoader} ctx.mandatoryTests
  * @param {DocumentTestLoader} ctx.optionalTests
+ * @param {DocumentTestLoader} ctx.recommendedTests
  * @param {DocumentTestLoader} ctx.informativeTests
  * @param {object} params
  * @param {string} params.testName
  * @param {string} params.filePath
  */
 const main = async (
-  { informativeTests, mandatoryTests, optionalTests, schemaTests },
+  {
+    informativeTests,
+    mandatoryTests,
+    optionalTests,
+    recommendedTests,
+    schemaTests,
+  },
   { testName, filePath }
 ) => {
   const json = JSON.parse(await readFile(filePath, { encoding: 'utf-8' }))
@@ -59,6 +66,8 @@ const main = async (
       ? Object.values(await mandatoryTests())
       : testName === 'optional'
       ? Object.values(await optionalTests())
+      : testName === 'recommended'
+      ? Object.values(await recommendedTests())
       : testName === 'informative'
       ? Object.values(await informativeTests())
       : testName === 'schema'
@@ -69,6 +78,7 @@ const main = async (
         )
       : Object.values(await mandatoryTests())
           .concat(Object.values(await optionalTests()))
+          .concat(Object.values(await recommendedTests()))
           .concat(Object.values(await informativeTests()))
           .concat(Object.values(await schemaTests()))
           .filter((t) => t.name === testName)
@@ -109,6 +119,7 @@ if (cliOptions['csaf-version'] === '2.0') {
       mandatoryTests: () => import('../mandatoryTests.js'),
       informativeTests: () => import('../informativeTests.js'),
       optionalTests: () => import('../optionalTests.js'),
+      recommendedTests: async () => ({}),
       schemaTests: () => import('../schemaTests.js'),
     },
     { filePath, testName }
@@ -118,7 +129,8 @@ if (cliOptions['csaf-version'] === '2.0') {
     {
       mandatoryTests: () => import('../csaf_2_1/mandatoryTests.js'),
       informativeTests: () => import('../csaf_2_1/informativeTests.js'),
-      optionalTests: () => import('../csaf_2_1/optionalTests.js'),
+      optionalTests: async () => ({}),
+      recommendedTests: () => import('../csaf_2_1/recommendedTests.js'),
       schemaTests: () => import('../csaf_2_1/schemaTests.js'),
     },
     { filePath, testName }
diff --git a/tests/csaf_2_1/oasis.js b/tests/csaf_2_1/oasis.js
diff --git a/tests/csaf_2_1/optionalTest_6_2_22.js b/tests/csaf_2_1/optionalTest_6_2_22.js
diff --git a/tests/csaf_2_1/optionalTest_6_2_3.js b/tests/csaf_2_1/optionalTest_6_2_3.js
diff --git a/tests/csaf_2_1/recommendedTest_6_2_22.js b/tests/csaf_2_1/recommendedTest_6_2_22.js
diff --git a/tests/csaf_2_1/recommendedTest_6_2_3.js b/tests/csaf_2_1/recommendedTest_6_2_3.js

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`export * from './basic.js'`
`2`		`-export * from './optionalTests.js'`
	`2`	`+export * from './recommendedTests.js'`