feat(CSAF2.1): #401 add mandatory test 6.2.39.2 - move common functions to an own file

Author: rainer-exxcellent

csaf_2_1/recommendedTests/recommendedTest_6_2_39_2.js

@@ -1,6 +1,9 @@
 import Ajv from 'ajv/dist/jtd.js'
-import translations from '../../lib/language_specific_translation/translations.js'
-import bcp47 from 'bcp47'
+import {
+  containsOneNoteWithTitleAndCategory,
+  getTranslationInDocumentLang,
+  isLangSpecifiedAndNotEnglish,
+} from '../../lib/shared/languageSpecificTranslation.js'
 
 const ajv = new Ajv()
 
@@ -42,55 +45,6 @@ const inputSchema = /** @type {const} */ ({
 
 const validateSchema = ajv.compile(inputSchema)
 
-/**
- * Checks if the document language is specified and not English
- *
- * @param {string | undefined} language - The language expression to check
- * @returns {boolean} True if the language is valid, false otherwise
- */
-export function isLangSpecifiedAndNotEnglish(language) {
-  return (
-    !!language && !(bcp47.parse(language)?.langtag.language.language === 'en')
-  )
-}
-
-/**
- *  test whether exactly one item in document notes exists that has the given title.
- *  and the given category.
- * @param {({} & { category?: string | undefined; title?: string | undefined; } & Record<string, unknown>)[]} notes
- * @param {string} titleToFind
- * @param {string} category
- * @returns {boolean} True if the language is valid, false otherwise
- */
-function containsOneNoteWithTitleAndCategory(notes, titleToFind, category) {
-  return (
-    notes.filter(
-      (note) => note.category === category && note.title === titleToFind
-    ).length === 1
-  )
-}
-
-/**
- * Get the language specific translation of the given i18nKey
- * @param {{ document: { lang?: string; }; }} doc
- * @param {string} i18nKey
- * @return {string | undefined}
- */
-export function getTranslationInDocumentLang(doc, i18nKey) {
-  if (!doc.document.lang) {
-    return undefined
-  }
-  const language = bcp47.parse(doc.document.lang)?.langtag.language.language
-
-  /** @type {Record<string, Record <string,string>>}*/
-  const translationByLang = translations.translation
-  if (!language || !translationByLang[language]) {
-    return undefined
-  } else {
-    return translationByLang[language][i18nKey]
-  }
-}
-
 /**
  * If the document language is specified but not English, and the license_expression contains license
  * identifiers or exceptions that are not listed in the SPDX license list or Aboutcode's "ScanCode LicenseDB",

lib/shared/languageSpecificTranslation.js

@@ -0,0 +1,54 @@
+/**
+ * Checks if the document language is specified and not English
+ *
+ * @param {string | undefined} language - The language expression to check
+ * @returns {boolean} True if the language is valid, false otherwise
+ */
+export function isLangSpecifiedAndNotEnglish(language) {
+  return (
+    !!language && !(bcp47.parse(language)?.langtag.language.language === 'en')
+  )
+}
+import bcp47 from 'bcp47'
+import translations from '../../lib/language_specific_translation/translations.js'
+
+/**
+ *  test whether exactly one item in document notes exists that has the given title.
+ *  and the given category.
+ * @param {({} & { category?: string | undefined; title?: string | undefined; } & Record<string, unknown>)[]} notes
+ * @param {string} titleToFind
+ * @param {string} category
+ * @returns {boolean} True if the language is valid, false otherwise
+ */
+export function containsOneNoteWithTitleAndCategory(
+  notes,
+  titleToFind,
+  category
+) {
+  return (
+    notes.filter(
+      (note) => note.category === category && note.title === titleToFind
+    ).length === 1
+  )
+}
+
+/**
+ * Get the language specific translation of the given i18nKey
+ * @param {{ document: { lang?: string; }; }} doc
+ * @param {string} i18nKey
+ * @return {string | undefined}
+ */
+export function getTranslationInDocumentLang(doc, i18nKey) {
+  if (!doc.document.lang) {
+    return undefined
+  }
+  const language = bcp47.parse(doc.document.lang)?.langtag.language.language
+
+  /** @type {Record<string, Record <string,string>>}*/
+  const translationByLang = translations.translation
+  if (!language || !translationByLang[language]) {
+    return undefined
+  } else {
+    return translationByLang[language][i18nKey]
+  }
+}

tests/csaf_2_1/recommendedTest_6_2_39_2.js

@@ -1,9 +1,7 @@
-import {
-  getTranslationInDocumentLang,
-  recommendedTest_6_2_39_2,
-} from '../../csaf_2_1/recommendedTests/recommendedTest_6_2_39_2.js'
+import { recommendedTest_6_2_39_2 } from '../../csaf_2_1/recommendedTests/recommendedTest_6_2_39_2.js'
 import { expect } from 'chai'
 import assert from 'node:assert'
+import { getTranslationInDocumentLang } from '../../lib/shared/languageSpecificTranslation.js'
 
 describe('recommendedTest_6_2_39_2', function () {
   it('only runs on relevant documents', function () {