Package org.spdx.licenselistpublisher.licensegenerator

Class LicenseTester

java.lang.Object

org.spdx.licenselistpublisher.licensegenerator.LicenseTester

All Implemented Interfaces:

ILicenseTester

public class LicenseTester
extends Object
implements ILicenseTester

Test SPDX licenses against a directory of test licenses. The directory of test licenses contains license text with the following file naming convention: {license-id}/(license|header|exception)/(good|bad)/{test-id}.txt

Author:

Gary O'Neall

Constructor Summary

Constructors

Constructor	Description
LicenseTester(File licenseTestDirectory)

Method Summary

Modifier and Type	Method	Description
String	getExceptionTestText(String licenseExceptionId)
String	getLicenseTestText(String licenseId)
List<String>	testException(org.spdx.library.model.license.LicenseException exception)	Test exception against the test files directory
List<String>	testLicense(org.spdx.library.model.license.License license)	Test a license against the license test files

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LicenseTester

public LicenseTester(File licenseTestDirectory)

Parameters:

licenseTestDirectory - Directory of license text files for comparison in the form {license-id}/(license|header|exception)/(good|bad)/{test-id}.txt

Method Details

testLicense

public List<String> testLicense(org.spdx.library.model.license.License license) throws IOException, org.spdx.utility.compare.SpdxCompareException, org.spdx.library.InvalidSPDXAnalysisException

Test a license against the license test files

Specified by:

testLicense in interface ILicenseTester

Parameters:

license - license to test

Returns:

list of test failure descriptions. List is empty if all tests pass.

Throws:

IOException

org.spdx.utility.compare.SpdxCompareException

org.spdx.library.InvalidSPDXAnalysisException

testException

public List<String> testException(org.spdx.library.model.license.LicenseException exception) throws IOException, org.spdx.library.InvalidSPDXAnalysisException

Test exception against the test files directory

Specified by:

testException in interface ILicenseTester

Parameters:

exception -

Returns:

Throws:

IOException

org.spdx.library.InvalidSPDXAnalysisException

getLicenseTestText

public String getLicenseTestText(String licenseId) throws IOException

Specified by:

getLicenseTestText in interface ILicenseTester

Returns:

text for the test for a license ID, null if no license text is found

Throws:

IOException

getExceptionTestText

public String getExceptionTestText(String licenseExceptionId) throws IOException

Specified by:

getExceptionTestText in interface ILicenseTester

Returns:

text for the test for a exception ID, null if no license text is found

Throws:

IOException