FOSSology  4.7.1
Open Source License Compliance by Open Source Software
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Fossology\Lib\Application\CustomTextImportTest Class Reference

Test for class CustomTextImport. More...

Inheritance diagram for Fossology\Lib\Application\CustomTextImportTest:
Inheritance graph
Collaboration diagram for Fossology\Lib\Application\CustomTextImportTest:
Collaboration graph

Public Member Functions

 testMapHeadersBuildsLicensesArrayFromFlatCsvRow ()
 
 testMapHeadersParsesRemovingLeniently ()
 
 testMapHeadersPassesThroughNestedLicensesArray ()
 
 testMapHeadersRestoresEscapedNewlinesForCsvSource ()
 
 testMapHeadersDoesNotUnescapeForJsonSource ()
 
 testMapHeadersUnescapesLicenseMetadataForCsvSource ()
 
 testParseBoolean ($input, bool $expected)
 
 testAssociateLicensesPassesGroupIdForCandidateResolution ()
 
 testAssociateLicensesUsesConstantStatementNameForMappingCheck ()
 
 testAssociateLicensesCountsExistingMappingAsSkippedNotInserted ()
 
 testAssociateLicensesHandlesMissingMetadataKeysWithoutWarning ()
 
 testAssociateLicenseNamesLooksUpSpdxNameDirectly ()
 
 testAssociateLicenseNamesHandlesCommaSeparatedList ()
 
 testAssociateLicenseNamesReportsUnknownLicense ()
 
 testImportSinglePhraseRejectsEmptyText ()
 
 testImportSinglePhraseRejectsArrayText ()
 
 testImportSinglePhraseSkipsLicenseEntryWithArrayShortname ()
 
 testImportSinglePhraseTreatsArrayIsActiveAsFalse ()
 
 testImportPhrasesOneMalformedRowDoesNotAbortRemainingRows ()
 
 testImportSinglePhraseCreatesNewPhrase ()
 
 testImportSinglePhraseOnDuplicateTextWithNewLicenseAddsToExisting ()
 
 testImportSinglePhraseOnDuplicateTextWithAlreadyMappedLicenseIsUnchanged ()
 
 testImportSinglePhraseOnDuplicateTextWithNoLicenseIsUnchanged ()
 
 testImportSinglePhraseOnDuplicateTextWithUnknownLicenseFails ()
 
 testImportPhrasesProducesCorrectCountMessage ()
 
 testImportPhrasesReportsUnchangedRowsSeparately ()
 
 testImportPhrasesEmptyDataReportsNothingNewToImport ()
 
 testImportPhrasesReportsErrorRowsAlongSideSuccesses ()
 
 testReimportingSameDataIsIdempotentAndReportedAsUnchanged ()
 
 testHandleCsvFileCreatesSinglePhrase ()
 
 testHandleCsvFileMultiLicenseSameTextUpdatesExisting ()
 
 testHandleCsvFileRejectsColumnCountMismatch ()
 
 testHandleCsvFileUnescapesNewlinesInText ()
 
 testHandleJsonFileCreatesTwoPhrases ()
 
 testHandleJsonFileRejectsInvalidJson ()
 
 testHandleJsonFileRejectsNonArrayRoot ()
 
 testHandleJsonFileSameTextTwiceAddsLicenseToExisting ()
 

Static Public Member Functions

static parseBooleanProvider ()
 

Protected Member Functions

 setUp ()
 
 tearDown ()
 

Private Member Functions

 makeLicense (int $id)
 
 writeTempFile (string $content, string $ext)
 
 markAsCsvSource ()
 

Private Attributes

 $assertCountBefore
 
 $dbManager
 
 $userDao
 
 $licenseDao
 
 $importer
 
 $tmpFiles = []
 

Detailed Description

Test for class CustomTextImport.

Definition at line 21 of file CustomTextImportTest.php.

Member Function Documentation

◆ markAsCsvSource()

Fossology\Lib\Application\CustomTextImportTest::markAsCsvSource ( )
private

Force mapHeaders()/importSinglePhrase() into "CSV source" mode without going through a real file.

Definition at line 88 of file CustomTextImportTest.php.

◆ testAssociateLicenseNamesHandlesCommaSeparatedList()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicenseNamesHandlesCommaSeparatedList ( )
Test:
Comma-separated license list is split and each name looked up independently.

Definition at line 410 of file CustomTextImportTest.php.

◆ testAssociateLicenseNamesLooksUpSpdxNameDirectly()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicenseNamesLooksUpSpdxNameDirectly ( )
Test:
Regression: GPL-2.0-only must be looked up as-is, not mangled.

Definition at line 389 of file CustomTextImportTest.php.

◆ testAssociateLicenseNamesReportsUnknownLicense()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicenseNamesReportsUnknownLicense ( )
Test:
An unknown license name is reported in 'failed', not silently dropped.

Definition at line 431 of file CustomTextImportTest.php.

◆ testAssociateLicensesCountsExistingMappingAsSkippedNotInserted()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicensesCountsExistingMappingAsSkippedNotInserted ( )
Test:
  1. Associate a license that is already mapped to the phrase.
  2. Verify it is counted as 'skipped', never 'inserted'. Regression: counting an already-existing mapping as "associated" made a duplicate re-import falsely report new licenses added.

Definition at line 341 of file CustomTextImportTest.php.

◆ testAssociateLicensesHandlesMissingMetadataKeysWithoutWarning()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicensesHandlesMissingMetadataKeysWithoutWarning ( )
Test:
  1. Associate a license whose metadata fields are entirely absent from the entry.
  2. Verify no "Undefined array key" warning is triggered and NULLs are inserted.

Definition at line 364 of file CustomTextImportTest.php.

◆ testAssociateLicensesPassesGroupIdForCandidateResolution()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicensesPassesGroupIdForCandidateResolution ( )
Test:
  1. Look up a license by shortname while a groupId is supplied.
  2. Verify getLicenseByShortName() is called WITH that groupId. Regression: candidate licenses only resolve when LicenseDao::getLicenseByCondition() gets a non-null groupId.

Definition at line 278 of file CustomTextImportTest.php.

◆ testAssociateLicensesUsesConstantStatementNameForMappingCheck()

Fossology\Lib\Application\CustomTextImportTest::testAssociateLicensesUsesConstantStatementNameForMappingCheck ( )
Test:
  1. Associate the same (cpPk, licenseId) pair via two different entries.
  2. Verify both mapping-existence checks share a single, constant prepared-statement name rather than one name per pair. Regression: embedding cpPk/licenseId in the statement name creates one server-side prepared statement per row on a large import.

Definition at line 306 of file CustomTextImportTest.php.

◆ testHandleCsvFileCreatesSinglePhrase()

Fossology\Lib\Application\CustomTextImportTest::testHandleCsvFileCreatesSinglePhrase ( )
Test:
  1. Write a UTF-8 BOM CSV file using the exact header format from BulkTextExport.
  2. Import via handleFile() and verify one phrase is created.

Definition at line 869 of file CustomTextImportTest.php.

◆ testHandleCsvFileMultiLicenseSameTextUpdatesExisting()

Fossology\Lib\Application\CustomTextImportTest::testHandleCsvFileMultiLicenseSameTextUpdatesExisting ( )
Test:
  1. Write a CSV with 3 rows sharing the same text (one phrase, 3 licenses). This mirrors the output of BulkTextExport for a phrase with 3 license mappings.
  2. Row 1 creates the phrase and associates GPL-2.0-or-later.
  3. Rows 2 and 3 detect the duplicate text and add LGPL-2.1-or-later / MPL-1.1+.
  4. Verify message: "1 phrase(s) created, 2 license(s) added to existing phrase(s)".

Definition at line 901 of file CustomTextImportTest.php.

◆ testHandleCsvFileRejectsColumnCountMismatch()

Fossology\Lib\Application\CustomTextImportTest::testHandleCsvFileRejectsColumnCountMismatch ( )
Test:
  1. Write a CSV where a data row has fewer columns than the header.
  2. Verify handleFile returns a column-count error message without importing.

Definition at line 943 of file CustomTextImportTest.php.

◆ testHandleCsvFileUnescapesNewlinesInText()

Fossology\Lib\Application\CustomTextImportTest::testHandleCsvFileUnescapesNewlinesInText ( )
Test:
  1. Write a CSV where the phrase text contains a literal backslash-n two-character sequence (as BulkTextExport would have flattened a real newline into).
  2. Verify the imported phrase text has a real newline, not '
    ' text.

Definition at line 964 of file CustomTextImportTest.php.

◆ testHandleJsonFileCreatesTwoPhrases()

Fossology\Lib\Application\CustomTextImportTest::testHandleJsonFileCreatesTwoPhrases ( )
Test:
  1. Write a JSON file with two independent phrases in nested licenses[] format.
  2. Verify handleFile creates 2 phrases.

Definition at line 994 of file CustomTextImportTest.php.

◆ testHandleJsonFileRejectsInvalidJson()

Fossology\Lib\Application\CustomTextImportTest::testHandleJsonFileRejectsInvalidJson ( )
Test:
  1. Write a JSON file whose content is not valid JSON.
  2. Verify handleFile returns an error message containing "Invalid JSON".

Definition at line 1029 of file CustomTextImportTest.php.

◆ testHandleJsonFileRejectsNonArrayRoot()

Fossology\Lib\Application\CustomTextImportTest::testHandleJsonFileRejectsNonArrayRoot ( )
Test:
  1. Write a JSON file whose top-level value is a scalar (not an array).
  2. Verify handleFile returns a "must contain an array" error.

Definition at line 1043 of file CustomTextImportTest.php.

◆ testHandleJsonFileSameTextTwiceAddsLicenseToExisting()

Fossology\Lib\Application\CustomTextImportTest::testHandleJsonFileSameTextTwiceAddsLicenseToExisting ( )
Test:
  1. Import a JSON phrase where the same text appears twice in the array but row 2 carries a new license.
  2. Verify: 1 phrase(s) created, 1 license(s) added to existing phrase(s).

Definition at line 1058 of file CustomTextImportTest.php.

◆ testImportPhrasesEmptyDataReportsNothingNewToImport()

Fossology\Lib\Application\CustomTextImportTest::testImportPhrasesEmptyDataReportsNothingNewToImport ( )
Test:
  1. Import an empty data array.
  2. Verify the message says "nothing new to import".

Definition at line 783 of file CustomTextImportTest.php.

◆ testImportPhrasesOneMalformedRowDoesNotAbortRemainingRows()

Fossology\Lib\Application\CustomTextImportTest::testImportPhrasesOneMalformedRowDoesNotAbortRemainingRows ( )
Test:
  1. Import a batch where row 2's text is an array (malformed).
  2. Verify row 1 and row 3 still succeed and row 2 is reported as an error, instead of a crash aborting the whole batch.

Definition at line 536 of file CustomTextImportTest.php.

◆ testImportPhrasesProducesCorrectCountMessage()

Fossology\Lib\Application\CustomTextImportTest::testImportPhrasesProducesCorrectCountMessage ( )
Test:
  1. Import two rows that share the same text but carry different, not-yet-mapped licenses.
  2. Row 1: new phrase created + MIT associated.
  3. Row 2: same text, existing phrase, Apache-2.0 added.
  4. Verify message is "1 phrase(s) created, 1 license(s) added to existing phrase(s)".

Definition at line 716 of file CustomTextImportTest.php.

◆ testImportPhrasesReportsErrorRowsAlongSideSuccesses()

Fossology\Lib\Application\CustomTextImportTest::testImportPhrasesReportsErrorRowsAlongSideSuccesses ( )
Test:
  1. Import a mix: one valid new phrase and one row with empty text.
  2. Verify the message includes "1 phrase(s) created" AND an error for the empty row.

Definition at line 796 of file CustomTextImportTest.php.

◆ testImportPhrasesReportsUnchangedRowsSeparately()

Fossology\Lib\Application\CustomTextImportTest::testImportPhrasesReportsUnchangedRowsSeparately ( )
Test:
  1. Import one row where the text already exists and carries no new licenses.
  2. Verify the result reports it under "already up to date", not as an error, and the overall summary still reads "nothing new to import" isn't used once there is at least one unchanged row to report.

Definition at line 760 of file CustomTextImportTest.php.

◆ testImportSinglePhraseCreatesNewPhrase()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseCreatesNewPhrase ( )
Test:
  1. Provide a unique phrase (no text_md5 match in DB).
  2. Verify importSinglePhrase inserts the phrase and returns success=true, not existing/unchanged.

Definition at line 566 of file CustomTextImportTest.php.

◆ testImportSinglePhraseOnDuplicateTextWithAlreadyMappedLicenseIsUnchanged()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseOnDuplicateTextWithAlreadyMappedLicenseIsUnchanged ( )
Test:
  1. Simulate a duplicate text whose only license is ALREADY mapped.
  2. Verify the row is reported as success=true, unchanged=true (not an error). This is the fix for re-importing the same export twice: it must be a safe no-op, not misreported as either a failure or a fresh update.

Definition at line 624 of file CustomTextImportTest.php.

◆ testImportSinglePhraseOnDuplicateTextWithNewLicenseAddsToExisting()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseOnDuplicateTextWithNewLicenseAddsToExisting ( )
Test:
  1. Simulate a duplicate text (existing row in custom_phrase).
  2. Include a license not yet mapped to that phrase.
  3. Verify the license is associated with the existing phrase (success=true, existing=true).

Definition at line 587 of file CustomTextImportTest.php.

◆ testImportSinglePhraseOnDuplicateTextWithNoLicenseIsUnchanged()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseOnDuplicateTextWithNoLicenseIsUnchanged ( )
Test:
  1. Simulate a duplicate text with no license payload at all.
  2. Verify success=true, unchanged=true (not a failure).

Definition at line 660 of file CustomTextImportTest.php.

◆ testImportSinglePhraseOnDuplicateTextWithUnknownLicenseFails()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseOnDuplicateTextWithUnknownLicenseFails ( )
Test:
  1. Simulate a duplicate text whose license entry fails to resolve (unknown license).
  2. Verify success=false with the unknown license named in the message.

Definition at line 683 of file CustomTextImportTest.php.

◆ testImportSinglePhraseRejectsArrayText()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseRejectsArrayText ( )
Test:
  1. Call importSinglePhrase with 'text' as a JSON array instead of a string (e.g. a hand-edited or malformed import file).
  2. Verify it returns a clean success=false result instead of an uncaught TypeError from md5(), and never opens a transaction.

Definition at line 469 of file CustomTextImportTest.php.

◆ testImportSinglePhraseRejectsEmptyText()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseRejectsEmptyText ( )
Test:
  1. Call importSinglePhrase with an empty text field.
  2. Verify it returns success=false without touching the DB.

Definition at line 449 of file CustomTextImportTest.php.

◆ testImportSinglePhraseSkipsLicenseEntryWithArrayShortname()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseSkipsLicenseEntryWithArrayShortname ( )
Test:
  1. One license entry carries an array 'shortname' instead of a string.
  2. Verify the malformed entry is dropped (not passed to trim()) and the phrase itself still imports successfully instead of crashing.

Definition at line 488 of file CustomTextImportTest.php.

◆ testImportSinglePhraseTreatsArrayIsActiveAsFalse()

Fossology\Lib\Application\CustomTextImportTest::testImportSinglePhraseTreatsArrayIsActiveAsFalse ( )
Test:
  1. 'is_active' arrives as a JSON array instead of a boolean/string.
  2. Verify parseBoolean() treats it as false instead of crashing trim().

Definition at line 513 of file CustomTextImportTest.php.

◆ testMapHeadersBuildsLicensesArrayFromFlatCsvRow()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersBuildsLicensesArrayFromFlatCsvRow ( )
Test:
  1. Build a flat CSV row using the headers produced by BulkTextExport.
  2. Call mapHeaders().
  3. Verify the result carries a licenses[] array built from the flat columns.

Definition at line 101 of file CustomTextImportTest.php.

◆ testMapHeadersDoesNotUnescapeForJsonSource()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersDoesNotUnescapeForJsonSource ( )
Test:
  1. Leave the importer in JSON mode (unescapeNewlines = false, the default).
  2. Pass text containing a literal backslash-n two-character sequence (e.g. from source code, not an export-time escape).
  3. Verify mapHeaders leaves it untouched. Regression: unescaping unconditionally would corrupt any JSON-sourced phrase whose real content contains the two characters '\' 'n'.

Definition at line 197 of file CustomTextImportTest.php.

◆ testMapHeadersParsesRemovingLeniently()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersParsesRemovingLeniently ( )
Test:
  1. Build a row with 'Removing' set to a non-literal-"true" truthy value ('1').
  2. Verify it is still parsed as a remove mapping. Regression: the old code only recognised the exact string "true"; "1"/"yes"/"t" silently became an add mapping instead of a remove.

Definition at line 133 of file CustomTextImportTest.php.

◆ testMapHeadersPassesThroughNestedLicensesArray()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersPassesThroughNestedLicensesArray ( )
Test:
  1. Build a row that already contains a nested licenses[] array (JSON format).
  2. Verify mapHeaders passes it through unchanged.

Definition at line 151 of file CustomTextImportTest.php.

◆ testMapHeadersRestoresEscapedNewlinesForCsvSource()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersRestoresEscapedNewlinesForCsvSource ( )
Test:
  1. Mark the importer as reading a CSV source (unescapeNewlines = true).
  2. Pass a text value containing literal
    escape sequences (as written by BulkTextExport).
  3. Verify mapHeaders restores them to real newlines.

Definition at line 176 of file CustomTextImportTest.php.

◆ testMapHeadersUnescapesLicenseMetadataForCsvSource()

Fossology\Lib\Application\CustomTextImportTest::testMapHeadersUnescapesLicenseMetadataForCsvSource ( )
Test:
  1. Mark the importer as CSV source.
  2. Pass per-license comment/reportinfo/acknowledgement containing escaped newlines.
  3. Verify all three are unescaped, not just the phrase text.

Definition at line 214 of file CustomTextImportTest.php.

◆ testParseBoolean()

Fossology\Lib\Application\CustomTextImportTest::testParseBoolean (   $input,
bool  $expected 
)
Test:
  1. Call parseBoolean with various truthy and falsy string/bool values.
  2. Verify each maps to the expected bool.

@dataProvider parseBooleanProvider

Definition at line 244 of file CustomTextImportTest.php.

◆ testReimportingSameDataIsIdempotentAndReportedAsUnchanged()

Fossology\Lib\Application\CustomTextImportTest::testReimportingSameDataIsIdempotentAndReportedAsUnchanged ( )
Test:
  1. Re-import the exact same single-phrase, single-license dataset twice in a row (simulating "download export, re-upload unmodified").
  2. Verify the second import reports 1 unchanged row and 0 created/updated.

Definition at line 820 of file CustomTextImportTest.php.

The documentation for this class was generated from the following file: