more SPDX unit tests to illustrate matching behavior

__tests__/external-config.test.ts

@@ -34,7 +34,7 @@ test('it reads an external config file', async () => {
 
   const config = await readConfig()
   expect(config.fail_on_severity).toEqual('critical')
-  expect(config.allow_licenses).toEqual(['BSD', 'GPL 2'])
+  expect(config.allow_licenses).toEqual(['BSD-3-Clause', 'GPL-2.0'])
 })
 
 test('raises an error when the config file was not found', async () => {

__tests__/fixtures/config-allow-sample.yml

@@ -1,4 +1,4 @@
 fail_on_severity: critical
 allow_licenses:
-  - 'BSD'
-  - 'GPL 2'
+  - 'BSD-3-Clause'
+  - 'GPL-2.0'

__tests__/spdx.test.ts

@@ -1,11 +1,188 @@
-import {expect, jest, test} from '@jest/globals'
+import {expect, test} from '@jest/globals'
 import * as spdx from '../src/spdx'
 
+test('satisfiesAny', () => {
+  const units = [
+    {
+      candidate: 'MIT',
+      licenses: ['MIT'],
+      expected: true
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: true
+    },
+    {
+      candidate: '(MIT AND ISC) OR Apache-2.0',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: true
+    },
+    {
+      candidate: 'MIT AND Apache-2.0',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: false
+    },
+    {
+      candidate: 'MIT AND BSD-3-Clause',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: false
+    }
+  ]
+
+  for (const unit of units) {
+    let got: boolean = spdx.satisfiesAny(unit.candidate, unit.licenses)
+    if (got != unit.expected) {
+      console.log(
+        `failing unit test inputs: candidate(${unit.candidate}) licenses(${unit.licenses})`
+      )
+    }
+    expect(got).toBe(unit.expected)
+  }
+})
+
+test('satisfiesAll', () => {
+  const units = [
+    {
+      candidate: 'MIT',
+      licenses: ['MIT'],
+      expected: true
+    },
+    {
+      candidate: 'Apache-2.0',
+      licenses: ['MIT', 'ISC', 'Apache-2.0'],
+      expected: false
+    },
+    {
+      candidate: 'MIT AND Apache-2.0',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: true
+    },
+    {
+      candidate: '(MIT OR ISC) AND Apache-2.0',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: true
+    },
+    {
+      candidate: 'MIT OR BSD-3-Clause',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: false
+    },
+    {
+      candidate: 'BSD-3-Clause OR ISC',
+      licenses: ['MIT', 'Apache-2.0'],
+      expected: false
+    },
+    {
+      candidate: '(MIT AND ISC) OR Apache-2.0',
+      licenses: ['MIT', 'ISC'],
+      expected: true
+    }
+  ]
+
+  for (const unit of units) {
+    let got: boolean = spdx.satisfiesAll(unit.candidate, unit.licenses)
+    if (got != unit.expected) {
+      console.log(
+        `failing unit test inputs: candidate(${unit.candidate}) licenses(${unit.licenses})`
+      )
+    }
+    expect(got).toBe(unit.expected)
+  }
+})
+
 test('satisfies', () => {
-  expect(spdx.satisfies('MIT', 'MIT')).toBe(true)
+  const units = [
+    {
+      candidate: 'MIT',
+      constraint: 'MIT',
+      expected: true
+    },
+    {
+      candidate: 'Apache-2.0',
+      constraint: 'MIT',
+      expected: false
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      constraint: 'MIT',
+      expected: true
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      constraint: 'Apache-2.0',
+      expected: true
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      constraint: 'BSD-3-Clause',
+      expected: false
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      constraint: 'Apache-2.0 OR BSD-3-Clause',
+      expected: true
+    },
+    {
+      candidate: 'MIT AND Apache-2.0',
+      constraint: 'MIT AND Apache-2.0',
+      expected: true
+    },
+    {
+      candidate: 'MIT OR Apache-2.0',
+      constraint: 'MIT AND Apache-2.0',
+      expected: false
+    },
+    {
+      candidate: 'ISC OR (MIT AND Apache-2.0)',
+      constraint: 'MIT AND Apache-2.0',
+      expected: true
+    }
+  ]
+
+  for (const unit of units) {
+    let got: boolean = spdx.satisfies(unit.candidate, unit.constraint)
+    if (got != unit.expected) {
+      console.log(
+        `failing unit test inputs: candidateExpr(${unit.candidate}) constraintExpr(${unit.constraint})`
+      )
+    }
+    expect(got).toBe(unit.expected)
+  }
 })
 
 test('isValid', () => {
-  expect(spdx.isValid('MIT')).toBe(true)
-  expect(spdx.isValid('FOOBARBAZ')).toBe(false)
+  const units = [
+    {
+      candidate: 'MIT',
+      expected: true
+    },
+    {
+      candidate: 'MIT AND BSD-3-Clause',
+      expected: true
+    },
+    {
+      candidate: '(MIT AND ISC) OR BSD-3-Clause',
+      expected: true
+    },
+    {
+      candidate: 'NOASSERTION',
+      expected: false
+    },
+    {
+      candidate: 'Foobar',
+      expected: false
+    },
+    {
+      candidate: '',
+      expected: false
+    }
+  ]
+  for (const unit of units) {
+    let got: boolean = spdx.isValid(unit.candidate)
+    if (got != unit.expected) {
+      console.log(`failing unit test inputs: candidateExpr(${unit.candidate})`)
+    }
+    expect(got).toBe(unit.expected)
+  }
 })

src/spdx.ts

@@ -1,25 +1,25 @@
-import * as spdx from '@onebeyond/spdx-license-satisfies'
+import * as spdxlib from '@onebeyond/spdx-license-satisfies'
 import parse from 'spdx-expression-parse'
 
 export function satisfies(
   candidateExpr: string,
   constraintExpr: string
 ): boolean {
-  return spdx.satisfies(candidateExpr, constraintExpr)
+  return spdxlib.satisfies(candidateExpr, constraintExpr)
 }
 
 export function satisfiesAny(
   candidateExpr: string,
   licenses: string[]
 ): boolean {
-  return spdx.satisfiesAny(candidateExpr, licenses)
+  return spdxlib.satisfiesAny(candidateExpr, licenses)
 }
 
 export function satisfiesAll(
   candidateExpr: string,
   licenses: string[]
 ): boolean {
-  return spdx.satisfiesAll(candidateExpr, licenses)
+  return spdxlib.satisfiesAll(candidateExpr, licenses)
 }
 
 // can be a single license or an SPDX expression