Merge pull request #1108 from qtomlinson/qt/sourcearchive-location

Add source location in definitions for sourcearchive packages

business/definitionService.js

@@ -561,10 +561,10 @@ class DefinitionService {
     if (get(definition, 'described.sourceLocation')) return updateSourceLocation(definition.described.sourceLocation)
     // For source components there may not be an explicit harvested source location (it is self-evident)
     // Make it explicit in the definition
-    switch (coordinates.provider) {
-      case 'golang':
-      case 'gitlab':
-      case 'github':
+    switch (coordinates.type) {
+      case 'go':
+      case 'git':
+      case 'sourcearchive':
       case 'pypi': {
         const url = buildSourceUrl(coordinates)
         if (!url) return

test/business/aggregatorTest.js

@@ -0,0 +1,191 @@
+// (c) Copyright 2024, SAP SE and ClearlyDefined contributors. Licensed under the MIT license.
+// SPDX-License-Identifier: MIT
+
+const AggregatorService = require('../../business/aggregator')
+const SummaryService = require('../../business/summarizer')
+const EntityCoordinates = require('../../lib/entityCoordinates')
+const { setIfValue } = require('../../lib/utils')
+const deepEqualInAnyOrder = require('deep-equal-in-any-order')
+const chai = require('chai')
+chai.use(deepEqualInAnyOrder)
+const expect = chai.expect
+
+describe('Aggregation service', () => {
+  it('handles no tool data', async () => {
+    const { service } = setupAggregator()
+    const aggregated = service.process({})
+    expect(aggregated).to.be.null
+  })
+
+  it('handles one tool one version data', async () => {
+    const summaries = { tool2: { '1.0.0': { files: [buildFile('foo.txt', 'MIT')] } } }
+    const { service } = setupAggregator()
+    const aggregated = service.process(summaries)
+    expect(aggregated.files.length).to.eq(1)
+  })
+
+  it('handles one tool multiple version data', async () => {
+    const summaries = {
+      tool2: {
+        '1.0.0': { files: [buildFile('foo.txt', 'MIT'), buildFile('bar.txt', 'MIT')] },
+        '2.0.0': { files: [buildFile('foo.txt', 'GPL-2.0')] }
+      }
+    }
+    const { service } = setupAggregator()
+    const aggregated = service.process(summaries)
+    expect(aggregated.files.length).to.eq(1)
+    expect(aggregated.files[0].path).to.eq('foo.txt')
+    expect(aggregated.files[0].license).to.eq('GPL-2.0')
+  })
+
+  it('handles multiple tools and one file data', async () => {
+    const summaries = {
+      tool2: {
+        '1.0.0': { files: [buildFile('foo.txt', 'MIT')] },
+        '2.0.0': { files: [buildFile('foo.txt', 'GPL-2.0')] }
+      },
+      tool1: { '3.0.0': { files: [buildFile('foo.txt', 'BSD-3-Clause')] } }
+    }
+    const { service } = setupAggregator()
+    const aggregated = service.process(summaries)
+    expect(aggregated.files.length).to.eq(1)
+    expect(aggregated.files[0].license).to.equal('BSD-3-Clause AND GPL-2.0')
+  })
+
+  it('handles multiple tools and multiple file data with extras ignored', async () => {
+    const summaries = {
+      tool2: {
+        '1.0.0': { files: [buildFile('foo.txt', 'MIT')] },
+        '2.0.0': { files: [buildFile('foo.txt', 'GPL-2.0')] }
+      },
+      tool1: {
+        '3.0.0': { files: [buildFile('foo.txt', 'BSD-3-Clause')] },
+        '2.0.0': { files: [buildFile('bar.txt', 'GPL-2.0')] }
+      }
+    }
+    const { service } = setupAggregator()
+    const aggregated = service.process(summaries)
+    expect(aggregated.files.length).to.eq(1)
+    expect(aggregated.files[0].license).to.equal('BSD-3-Clause AND GPL-2.0')
+  })
+
+  it('handles multiple tools and multiple file data with extras included', async () => {
+    const summaries = {
+      tool2: {
+        '1.0.0': { files: [buildFile('foo.txt', 'MIT')] },
+        '2.0.0': { files: [buildFile('foo.txt', 'GPL-2.0')] }
+      },
+      tool1: {
+        '3.0.0': { files: [buildFile('foo.txt', 'BSD-3-Clause'), buildFile('bar.txt', 'GPL-2.0')] },
+        '2.0.0': { files: [buildFile('bar.txt', 'GPL-2.0')] }
+      }
+    }
+    const { service } = setupAggregator()
+    const aggregated = service.process(summaries)
+    expect(aggregated.files.length).to.eq(2)
+    expect(aggregated.files[0].path).to.eq('foo.txt')
+    expect(aggregated.files[0].license).to.equal('BSD-3-Clause AND GPL-2.0')
+    expect(aggregated.files[1].path).to.eq('bar.txt')
+    expect(aggregated.files[1].license).to.eq('GPL-2.0')
+  })
+
+  it('handles Rust crates with license choices', async () => {
+    const testcases = [
+      {
+        name: 'slog',
+        version: '2.7.0',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        // Ideally this would be declared without any parentheses, but currently
+        // the SPDX normalization adds them.
+        expected: 'MPL-2.0 OR (MIT OR Apache-2.0)'
+      },
+      {
+        name: 'quote',
+        version: '0.6.4',
+        tools: [['clearlydefined', 'fossology', 'licensee', 'scancode']],
+        expected: 'MIT OR Apache-2.0'
+      },
+      {
+        name: 'quote',
+        version: '1.0.9',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        expected: 'MIT OR Apache-2.0'
+      },
+      {
+        name: 'rand',
+        version: '0.8.2',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        expected: 'MIT OR Apache-2.0'
+      },
+      {
+        name: 'regex',
+        version: '1.5.3',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        expected: 'MIT OR Apache-2.0'
+      },
+      {
+        name: 'serde',
+        version: '1.0.123',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        expected: 'MIT OR Apache-2.0'
+      },
+      {
+        name: 'mpmc',
+        version: '0.1.6',
+        tools: [['clearlydefined', 'licensee', 'scancode']],
+        expected: 'BSD-2-Clause-Views'
+      }
+    ]
+
+    const summary_options = {}
+    const summaryService = SummaryService(summary_options)
+
+    for (const testcase of testcases) {
+      const coordSpec = `crate/cratesio/-/${testcase.name}/${testcase.version}`
+      const coords = EntityCoordinates.fromString(coordSpec)
+      const raw = require(`./evidence/crate-${testcase.name}-${testcase.version}.json`)
+      const tools = testcase.tools
+      const summaries = summaryService.summarizeAll(coords, raw)
+      const { service } = setupAggregatorWithParams(coordSpec, tools)
+      const aggregated = service.process(summaries, coords)
+      expect(aggregated.licensed.declared, `${testcase.name}-${testcase.version}`).to.eq(testcase.expected)
+    }
+  })
+
+  it('should handle composer/packagist components', () => {
+    const tools = [['clearlydefined', 'licensee', 'scancode', 'reuse']]
+    const coordSpec = 'composer/packagist/mmucklo/krumo/0.7.0'
+    const coords = EntityCoordinates.fromString(coordSpec)
+    const raw = require(`./evidence/${coordSpec.replace(/\//g, '-')}.json`)
+
+    const summary_options = {}
+    const summaryService = SummaryService(summary_options)
+    const summaries = summaryService.summarizeAll(coords, raw)
+    const { service } = setupAggregatorWithParams(coordSpec, tools)
+    const aggregated = service.process(summaries, coords)
+    expect(aggregated.licensed.declared).to.be.ok
+    // package manifest: LGPL-2.0-or-later, license: LGPL-2.1-only
+    expect(aggregated.licensed.declared).to.be.not.equal('NOASSERTION')
+  })
+})
+
+function buildFile(path, license, holders) {
+  const result = { path }
+  setIfValue(result, 'license', license)
+  setIfValue(result, 'attributions', holders ? holders.map(entry => `Copyright ${entry}`) : null)
+  return result
+}
+
+function setupAggregator() {
+  const coordinates = EntityCoordinates.fromString('npm/npmjs/-/test/1.0')
+  const config = { precedence: [['tool1', 'tool2', 'tool3']] }
+  const service = AggregatorService(config)
+  return { service, coordinates }
+}
+
+function setupAggregatorWithParams(coordSpec, tool_precedence) {
+  const coordinates = EntityCoordinates.fromString(coordSpec)
+  const config = { precedence: tool_precedence }
+  const service = AggregatorService(config)
+  return { service, coordinates }
+}