Add test for BOM metadata's licenses and properties fields. #1019

Signed-off-by: Augustus Kling <[email protected]>

Author: AugustusKling

src/serialize/json/normalize.ts

@@ -224,12 +224,12 @@ export class MetadataNormalizer extends BaseJsonNormalizer<Models.Metadata> {
       supplier: data.supplier === undefined
         ? undefined
         : orgEntityNormalizer.normalize(data.supplier, options),
-      licenses: data.licenses.size > 0
+      licenses: this._factory.spec.supportsMetadataLicenses && data.licenses.size > 0
         ? this._factory.makeForLicense().normalizeIterable(data.licenses, options)
         : undefined,
-      properties: this._factory.spec.supportsProperties(data) && data.properties.size > 0
+      properties: this._factory.spec.supportsMetadataProperties && data.properties.size > 0
         ? this._factory.makeForProperty().normalizeIterable(data.properties, options)
-        : undefined,
+        : undefined
     }
   }
 }

src/serialize/xml/normalize.ts

@@ -246,14 +246,14 @@ export class MetadataNormalizer extends BaseXmlNormalizer<Models.Metadata> {
           children: this._factory.makeForOrganizationalContact().normalizeIterable(data.authors, options, 'author')
         }
       : undefined
-    const licenses: SimpleXml.Element | undefined = data.licenses.size > 0
+    const licenses: SimpleXml.Element | undefined = this._factory.spec.supportsMetadataLicenses && data.licenses.size > 0
       ? {
           type: 'element',
           name: 'licenses',
           children: this._factory.makeForLicense().normalizeIterable(data.licenses, options)
         }
       : undefined
-    const properties: SimpleXml.Element | undefined = this._factory.spec.supportsProperties(data) && data.properties.size > 0
+    const properties: SimpleXml.Element | undefined = this._factory.spec.supportsMetadataProperties && data.properties.size > 0
       ? {
           type: 'element',
           name: 'properties',

src/spec/_protocol.ts

@@ -43,6 +43,8 @@ export interface _SpecProtocol {
   supportsVulnerabilityRatingMethod: (rm: Vulnerability.RatingMethod | any) => boolean
   supportsComponentEvidence: boolean
   supportsMetadataLifecycles: boolean
+  supportsMetadataLicenses: boolean
+  supportsMetadataProperties: boolean
   supportsExternalReferenceHashes: boolean
 }
 
@@ -68,6 +70,8 @@ export class _Spec implements _SpecProtocol {
   readonly #supportsVulnerabilities: boolean
   readonly #supportsComponentEvidence: boolean
   readonly #supportsMetadataLifecycles: boolean
+  readonly #supportsMetadataLicenses: boolean
+  readonly #supportsMetadataProperties: boolean
   readonly #supportsExternalReferenceHashes: boolean
 
   constructor (
@@ -85,6 +89,8 @@ export class _Spec implements _SpecProtocol {
     vulnerabilityRatingMethods: Iterable<Vulnerability.RatingMethod>,
     supportsComponentEvidence: boolean,
     supportsMetadataLifecycles: boolean,
+    supportsMetadataLicenses: boolean,
+    supportsMetadataProperties: boolean,
     supportsExternalReferenceHashes: boolean
   ) {
     this.#version = version
@@ -101,6 +107,8 @@ export class _Spec implements _SpecProtocol {
     this.#vulnerabilityRatingMethods = new Set(vulnerabilityRatingMethods)
     this.#supportsComponentEvidence = supportsComponentEvidence
     this.#supportsMetadataLifecycles = supportsMetadataLifecycles
+    this.#supportsMetadataLicenses = supportsMetadataLicenses
+    this.#supportsMetadataProperties = supportsMetadataProperties
     this.#supportsExternalReferenceHashes = supportsExternalReferenceHashes
   }
 
@@ -167,6 +175,14 @@ export class _Spec implements _SpecProtocol {
     return this.#supportsMetadataLifecycles
   }
 
+  get supportsMetadataLicenses (): boolean {
+    return this.#supportsMetadataLicenses
+  }
+
+  get supportsMetadataProperties (): boolean {
+    return this.#supportsMetadataProperties
+  }
+
   get supportsExternalReferenceHashes (): boolean {
     return this.#supportsExternalReferenceHashes
   }

src/spec/consts.ts

@@ -79,6 +79,8 @@ export const Spec1dot2: Readonly<_SpecProtocol> = Object.freeze(new _Spec(
   [],
   false,
   false,
+  false,
+  false,
   false
 ))
 
@@ -139,6 +141,8 @@ export const Spec1dot3: Readonly<_SpecProtocol> = Object.freeze(new _Spec(
   [],
   true,
   false,
+  true,
+  true,
   true
 ))
 
@@ -206,6 +210,8 @@ export const Spec1dot4: Readonly<_SpecProtocol> = Object.freeze(new _Spec(
   ],
   true,
   false,
+  true,
+  true,
   true
 ))
 
@@ -302,6 +308,8 @@ export const Spec1dot5: Readonly<_SpecProtocol> = Object.freeze(new _Spec(
   ],
   true,
   true,
+  true,
+  true,
   true
 ))
 

tests/README.md

@@ -12,7 +12,12 @@ to be picked up.
 ## Snapshots
 
 Some tests check against snapshots.  
-To update these, set the env var `CJL_TEST_UPDATE_SNAPSHOTS` to a non-falsy value.
+To update these, build and set the env var `CJL_TEST_UPDATE_SNAPSHOTS` to a non-falsy value.
+
+```shell
+npm run build
+CJL_TEST_UPDATE_SNAPSHOTS=true npm test
+```
 
 ## Run node tests
 

tests/_data/models.js

@@ -87,7 +87,15 @@ module.exports.createComplexStructure = function () {
             name: 'Jane "the-other-supplier" Doe'
           })
         ])
-      })
+      }),
+      licenses: new Models.LicenseRepository([
+        new Models.SpdxLicense('0BSD'),
+        new Models.NamedLicense('Some license name')
+      ]),
+      properties: new Models.PropertyRepository([
+        new Models.Property('a', 'b'),
+        new Models.Property('cdx:reproducible', 'true')
+      ])
     })
   })