test: fix validateXMLBoilerplate tests

Author: NGPixel

tests/xml.test.js

@@ -1,7 +1,7 @@
 import { afterAll, afterEach, beforeAll, describe, expect, test } from 'vitest'
 import { MODES } from '../lib/config/modes.mjs'
 import { toContainError, ValidationError, ValidationWarning, ValidationComment } from '../lib/helpers/error.mjs'
-import { detectDeprecatedElements, validateCodeBlocks, validateTextLikeRefs, validateIprAttribute, validatePreptimeAttribute, validateSubmissionType, validateIETFTLPBoilerplateXML, validateIPRAutogeneratedBoilerplate } from '../lib/modules/xml.mjs'
+import { detectDeprecatedElements, validateCodeBlocks, validateTextLikeRefs, validateIprAttribute, validatePreptimeAttribute, validateSubmissionType, validateIPRAutogeneratedBoilerplate, validateXMLBoilerplate } from '../lib/modules/xml.mjs'
 import { baseXMLDoc } from './fixtures/base-doc.mjs'
 import { cloneDeep, set } from 'lodash-es'
 import { setupServer } from 'msw/node'
@@ -216,19 +216,19 @@ describe('Validate IETF-TLP boilerplate for XML documents', () => {
   test('Valid IETF-TLP boilerplate and ipr attribute', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'trust200902')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toHaveLength(0)
+    await expect(validateXMLBoilerplate(doc)).resolves.toHaveLength(0)
   })
 
   test('Unnecessary boilerplate text detected', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc.front.t', 'This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toContainError('UNNECESSARY_BOILERPLATE_TEXT', ValidationWarning)
+    await expect(validateXMLBoilerplate(doc)).resolves.toContainError('UNNECESSARY_BOILERPLATE_TEXT', ValidationWarning)
   })
 
   test('Multiple boilerplate texts detected', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc.front.t', 'This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Copyright (c) 2025 IETF Trust and the persons identified as the document authors. All rights reserved.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toEqual(
+    await expect(validateXMLBoilerplate(doc)).resolves.toEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: 'UNNECESSARY_BOILERPLATE_TEXT' }),
         expect.objectContaining({ name: 'UNNECESSARY_BOILERPLATE_TEXT' })
@@ -240,14 +240,14 @@ describe('Validate IETF-TLP boilerplate for XML documents', () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'trust200902')
     set(doc, 'data.rfc.front.t', 'This is a clean document without boilerplate.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toHaveLength(0)
+    await expect(validateXMLBoilerplate(doc)).resolves.toHaveLength(0)
   })
 })
 
 describe('Test ipr and ipr autogenerated boilerplate', () => {
   test('should report error if ipr attribute is missing', async () => {
     const doc = cloneDeep(baseXMLDoc)
-    const result = await validateIPRAutogeneratedBoilerplate(doc)
+    const result = await validateXMLBoilerplate(doc)
     expect(result).toContainEqual(
       expect.objectContaining({
         name: 'MISSING_IPR_ATTRIBUTE',
@@ -259,7 +259,7 @@ describe('Test ipr and ipr autogenerated boilerplate', () => {
   test('should warn if ipr attribute is invalid', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'somethingInvalid')
-    const result = await validateIPRAutogeneratedBoilerplate(doc)
+    const result = await validateXMLBoilerplate(doc)
     expect(result).toContainEqual(
       expect.objectContaining({
         name: 'INVALID_IPR_VALUE'
@@ -278,19 +278,6 @@ describe('Test ipr and ipr autogenerated boilerplate', () => {
     expect(result).toHaveLength(0)
   })
 
-  test('trust200902 - missing required text', async () => {
-    const doc = cloneDeep(baseXMLDoc)
-    set(doc, 'data.rfc._attr.ipr', 'trust200902')
-    set(doc, 'data.rfc.boilerplate', 'Some incomplete or random text')
-
-    const result = await validateIPRAutogeneratedBoilerplate(doc)
-    expect(result).toContainEqual(
-      expect.objectContaining({
-        name: 'MISSING_EXPECTED_BOILERPLATE'
-      })
-    )
-  })
-
   test('trust200902 - has unexpected "noModification"', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'trust200902')
@@ -319,21 +306,6 @@ describe('Test ipr and ipr autogenerated boilerplate', () => {
     expect(result).toHaveLength(0)
   })
 
-  test('noModificationTrust200902 - missing noModification', async () => {
-    const doc = cloneDeep(baseXMLDoc)
-    set(doc, 'data.rfc._attr.ipr', 'noModificationTrust200902')
-    set(doc, 'data.rfc.boilerplate',
-      'This Internet-Draft is submitted in full conformance ' +
-      'with the provisions of BCP 78 and BCP 79.'
-    )
-    const result = await validateIPRAutogeneratedBoilerplate(doc)
-    expect(result).toContainEqual(
-      expect.objectContaining({
-        name: 'MISSING_EXPECTED_BOILERPLATE'
-      })
-    )
-  })
-
   test('noDerivativesTrust200902 - has correct texts', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'noDerivativesTrust200902')
@@ -368,53 +340,38 @@ describe('Test ipr and ipr autogenerated boilerplate', () => {
     const result = await validateIPRAutogeneratedBoilerplate(doc)
     expect(result).toHaveLength(0)
   })
-
-  test('pre5378Trust200902 - missing the pre5378 text', async () => {
-    const doc = cloneDeep(baseXMLDoc)
-    set(doc, 'data.rfc._attr.ipr', 'pre5378Trust200902')
-    set(doc, 'data.rfc.boilerplate',
-      'This Internet-Draft is submitted in full conformance ' +
-      'with the provisions of BCP 78 and BCP 79.'
-    )
-    const result = await validateIPRAutogeneratedBoilerplate(doc)
-    expect(result).toContainEqual(
-      expect.objectContaining({
-        name: 'MISSING_EXPECTED_BOILERPLATE'
-      })
-    )
-  })
 })
 
 describe('Validate IETF-TLP boilerplate for XML documents', () => {
   test('Valid IETF-TLP boilerplate and ipr attribute', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'trust200902')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toHaveLength(0)
+    await expect(validateXMLBoilerplate(doc)).resolves.toHaveLength(0)
   })
 
   test('Missing ipr attribute', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr', {})
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toContainError('MISSING_IPR_ATTRIBUTE', ValidationError)
+    await expect(validateXMLBoilerplate(doc)).resolves.toContainError('MISSING_IPR_ATTRIBUTE', ValidationError)
   })
 
   test('Invalid ipr attribute value', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'invalidValue')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toContainError('INVALID_IPR_VALUE', ValidationWarning)
+    await expect(validateXMLBoilerplate(doc)).resolves.toContainError('INVALID_IPR_VALUE', ValidationWarning)
   })
 
   test('Unnecessary boilerplate text detected', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc.front.t', 'This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toContainError('UNNECESSARY_BOILERPLATE_TEXT', ValidationWarning)
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toContainError('MISSING_IPR_ATTRIBUTE', ValidationError)
+    await expect(validateXMLBoilerplate(doc)).resolves.toContainError('UNNECESSARY_BOILERPLATE_TEXT', ValidationWarning)
+    await expect(validateXMLBoilerplate(doc)).resolves.toContainError('MISSING_IPR_ATTRIBUTE', ValidationError)
   })
 
   test('Multiple boilerplate texts detected', async () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc.front.t', 'This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Copyright (c) 2025 IETF Trust and the persons identified as the document authors. All rights reserved.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toEqual(
+    await expect(validateXMLBoilerplate(doc)).resolves.toEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: 'UNNECESSARY_BOILERPLATE_TEXT' }),
         expect.objectContaining({ name: 'UNNECESSARY_BOILERPLATE_TEXT' })
@@ -426,6 +383,6 @@ describe('Validate IETF-TLP boilerplate for XML documents', () => {
     const doc = cloneDeep(baseXMLDoc)
     set(doc, 'data.rfc._attr.ipr', 'trust200902')
     set(doc, 'data.rfc.front.t', 'This is a clean document without boilerplate.')
-    await expect(validateIETFTLPBoilerplateXML(doc)).resolves.toHaveLength(0)
+    await expect(validateXMLBoilerplate(doc)).resolves.toHaveLength(0)
   })
 })