Updated license comparison logic for sequence failures (#159)

* Refactor license comparison

* Updated license comparison logic to ignore sequence failures

* Update test case related to normalizeLicenseExpression function

* Refactor and rename file comparison function

Author: yashkohli88

tools/integration/lib/compareDefinitions.js

@@ -1,6 +1,7 @@
 // (c) Copyright 2024, GitHub and ClearlyDefined contributors. Licensed under the MIT license.
 // SPDX-License-Identifier: MIT
 
+const SPDX = require('@clearlydefined/spdx')
 function compareDocuments(staging, production, ignoredKeys, path = '') {
   let differences = {}
   let overallResults = []
@@ -215,4 +216,8 @@ function getType(value) {
   return typeof value
 }
 
-module.exports = { compareDocuments }
+function normalizeLicenseExpression(license) {
+  return license ? SPDX.expand(license).sort() : license
+}
+
+module.exports = { compareDocuments, normalizeLicenseExpression }

tools/integration/package-lock.json

@@ -33,6 +33,7 @@
     "typescript": "^5.8.3"
   },
   "dependencies": {
+    "@clearlydefined/spdx": "^0.1.7",
     "@octokit/rest": "^21.1.1",
     "async-retry": "^1.3.3"
   }

tools/integration/package.json

@@ -8,6 +8,7 @@ const { devApiBaseUrl, prodApiBaseUrl, getComponents, definition, fetchRetry } =
 const nock = require('nock')
 const fs = require('fs')
 const callFetch = createFetcherWithRetry(fetchRetry)
+const { normalizeLicenseExpression } = require('../../../lib/compareDefinitions')
 
 ;(async function () {
   const components = await getComponents()
@@ -89,10 +90,12 @@ function compareDefinition(recomputedDef, expectedDef) {
 }
 
 function compareLicensed(result, expectation) {
-  let actual = omit(result.licensed, ['facets'])
-  let expected = omit(expectation.licensed, ['facets'])
-  actual = { declared: undefined, ...actual }
-  expected = { declared: undefined, ...expected }
+  deepStrictEqual(
+    normalizeLicenseExpression(result.licensed.declared),
+    normalizeLicenseExpression(expectation.licensed.declared)
+  )
+  let actual = omit(result.licensed, ['facets', 'declared'])
+  let expected = omit(expectation.licensed, ['facets', 'declared'])
   deepStrictEqualExpectedEntries(actual, expected)
 }
 
@@ -107,13 +110,21 @@ function deepStrictEqualExpectedEntries(actual, expected) {
   deepStrictEqual(pickedActual, expected)
 }
 
+function isFileEqual(expectedFiles, f) {
+  const expected = expectedFiles.get(f.path)
+  const isLicenseEqual = isEqual(normalizeLicenseExpression(f.license), normalizeLicenseExpression(expected.license))
+  if (!isLicenseEqual) return false
+  const normResult = omit(f, ['license'])
+  const normExpect = omit(expected, ['license'])
+  return isEqual(normResult, normExpect)
+}
+
 function compareFiles(result, expectation) {
   const resultFiles = filesToMap(result)
   const expectedFiles = filesToMap(expectation)
   const extraInResult = result.files.filter(f => !expectedFiles.has(f.path))
   const missingInResult = expectation.files.filter(f => !resultFiles.has(f.path))
-  const differentEntries = result.files.filter(f => expectedFiles.has(f.path) && !isEqual(expectedFiles.get(f.path), f))
-
+  const differentEntries = result.files.filter(f => expectedFiles.has(f.path) && !isFileEqual(expectedFiles, f))
   const differences = [...extraInResult, ...missingInResult, ...differentEntries]
   differences.forEach(f => logDifferences(expectedFiles.get(f.path), resultFiles.get(f.path)))
 

tools/integration/test/integration/e2e-test-service/definitionTest.js

@@ -0,0 +1,47 @@
+const assert = require('assert')
+const { normalizeLicenseExpression } = require('../../lib/compareDefinitions')
+
+describe('normalizeLicenseExpression', () => {
+  it('should treat (MIT OR Apache-2.0) and (Apache-2.0 OR MIT) as equivalent', () => {
+    assert.deepStrictEqual(
+      normalizeLicenseExpression('(MIT OR Apache-2.0)'),
+      normalizeLicenseExpression('(Apache-2.0 OR MIT)')
+    )
+  })
+
+  it('should treat ( LGPL-2.1-only OR MIT) AND Apache-2.0 and ( MIT OR LGPL-2.1-only) AND Apache-2.0 as equivalent', () => {
+    const actual1 = '( LGPL-2.1-only OR MIT) AND Apache-2.0'
+    const expected1 = '( MIT OR LGPL-2.1-only) AND Apache-2.0'
+    assert.deepStrictEqual(normalizeLicenseExpression(actual1), normalizeLicenseExpression(expected1))
+  })
+
+  it('should treat (LGPL-2.1-only OR MIT) AND Apache-2.0 and (LGPL-2.1-only OR MIT) AND Apache-2.0 as equivalent', () => {
+    const actual2 = '(LGPL-2.1-only OR MIT) AND Apache-2.0'
+    const expected2 = '(LGPL-2.1-only OR MIT) AND Apache-2.0'
+    assert.deepStrictEqual(normalizeLicenseExpression(actual2), normalizeLicenseExpression(expected2))
+  })
+
+  it('should treat (LGPL-2.1-only OR MIT) OR Apache-2.0 and (MIT OR LGPL-2.1-only) OR Apache-2.0 as equivalent', () => {
+    const actual3 = '(LGPL-2.1-only OR MIT) OR Apache-2.0'
+    const expected3 = '(MIT OR LGPL-2.1-only) OR Apache-2.0'
+    assert.deepStrictEqual(normalizeLicenseExpression(actual3), normalizeLicenseExpression(expected3))
+  })
+
+  it('should treat (LGPL-2.1-only OR Apache-2.0) OR MIT and (MIT OR LGPL-2.1-only) OR Apache-2.0 as equivalent', () => {
+    const actual4 = '(LGPL-2.1-only OR Apache-2.0) OR MIT'
+    const expected4 = '(MIT OR LGPL-2.1-only) OR Apache-2.0'
+    assert.deepStrictEqual(normalizeLicenseExpression(actual4), normalizeLicenseExpression(expected4))
+  })
+
+  it('should treat ( LGPL-2.1-only OR MIT) AND Apache-2.0 and Apache-2.0 AND ( MIT OR LGPL-2.1-only) as equivalent', () => {
+    const actual6 = '( LGPL-2.1-only OR MIT) AND Apache-2.0'
+    const expected6 = 'Apache-2.0 AND ( MIT OR LGPL-2.1-only)'
+    assert.deepStrictEqual(normalizeLicenseExpression(actual6), normalizeLicenseExpression(expected6))
+  })
+
+  it('should NOT treat (LGPL-2.1-only OR Apache-2.0) AND MIT and (MIT OR LGPL-2.1-only) OR Apache-2.0 as equivalent', () => {
+    const actual5 = '(LGPL-2.1-only OR Apache-2.0) AND MIT'
+    const expected5 = '(MIT OR LGPL-2.1-only) OR Apache-2.0'
+    assert.notDeepStrictEqual(normalizeLicenseExpression(actual5), normalizeLicenseExpression(expected5))
+  })
+})