Fossology\UI\Api\Test\Controllers\ReportControllerTest Class Reference

Tests for ReportController. More...

Inheritance diagram for Fossology\UI\Api\Test\Controllers\ReportControllerTest:

Collaboration diagram for Fossology\UI\Api\Test\Controllers\ReportControllerTest:

Public Member Functions
	testGetReportAllFormats ()
	testGetReportInvalidFormat ()
	testGetReportInaccessibleUpload ()
	testGetReportInvalidUpload ()
	testDownloadReport ()
	testDownloadReportInAccessibleUpload ()
	testDownloadReportInvalidUpload ()
	testDownloadReportTryLater ()

Protected Member Functions
	setUp ()
	Setup test objects. More...
	tearDown ()
	Remove test objects. More...

Private Member Functions
	getResponseJson ($response)
	getUpload ($id)
	getResponseForReport ($uploadId, $reportFormat)

Private Attributes
	$reportsAllowed
	$reportController
	$uploadDao
	$userId
	$groupId
	$spdxPlugin
	$readmeossPlugin
	$clixmlPlugin
	$unifiedPlugin
	$downloadPlugin
	$decisionExporterPlugin
	$dbManager
	$assertCountBefore
	$streamFactory

Detailed Description

Tests for ReportController.

Definition at line 40 of file ReportControllerTest.php.

Member Function Documentation

getResponseForReport()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::getResponseForReport (   $uploadId,   $reportFormat  )

private

Helper function to call ReportController::getReport() and return response

Parameters

integer	$uploadId
string	$reportFormat

Returns

Response

Definition at line 242 of file ReportControllerTest.php.

getResponseJson()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::getResponseJson (   $response )

private

Helper function to get JSON array from response

Parameters

Response

$response

Returns

array Decoded response

Definition at line 200 of file ReportControllerTest.php.

getUpload()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::getUpload (   $id )

private

Helper function to generate uploads

Parameters

integer

$id

Upload id (if > 4, return NULL)

Returns

NULL|\Fossology\Lib\Data\Upload\Upload

Definition at line 211 of file ReportControllerTest.php.

setUp()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::setUp ( )

protected

Setup test objects.

See also

PHPUnit_Framework_TestCase::setUp()

Definition at line 139 of file ReportControllerTest.php.

tearDown()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::tearDown ( )

protected

Remove test objects.

See also

PHPUnit_Framework_TestCase::tearDown()

Definition at line 187 of file ReportControllerTest.php.

testDownloadReport()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testDownloadReport

(

)

Test:

1. Test ReportController::downloadReport()
2. Generate all mock objects
3. Generate a temporary file to be downloaded
4. Replicate expected headers
5. Check for actual headers
6. Check for actual file content

Definition at line 357 of file ReportControllerTest.php.

testDownloadReportInAccessibleUpload()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testDownloadReportInAccessibleUpload

(

)

Test:

1. Test ReportController::downloadReport() for inaccessible upload
2. Check for 403 response

Definition at line 415 of file ReportControllerTest.php.

testDownloadReportInvalidUpload()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testDownloadReportInvalidUpload

(

)

Test:

1. Test ReportController::downloadReport() for invalid upload
2. Check for 404 response

Definition at line 442 of file ReportControllerTest.php.

testDownloadReportTryLater()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testDownloadReportTryLater

(

)

Test:

1. Test ReportController::downloadReport() for early download
2. Check for 503 response with Retry-After headers.

Definition at line 462 of file ReportControllerTest.php.

testGetReportAllFormats()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testGetReportAllFormats

(

)

Test:

1. Test ReportController::getReport() for all available report types
2. Check the response for 201

Definition at line 260 of file ReportControllerTest.php.

testGetReportInaccessibleUpload()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testGetReportInaccessibleUpload

(

)

Test:

1. Test ReportController::getReport() for inaccessible upload
2. Check for 403 response

Definition at line 314 of file ReportControllerTest.php.

testGetReportInvalidFormat()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testGetReportInvalidFormat

(

)

Test:

1. Test ReportController::getReport() for invalid report type
2. Test for 400 response

Definition at line 299 of file ReportControllerTest.php.

testGetReportInvalidUpload()

Fossology\UI\Api\Test\Controllers\ReportControllerTest::testGetReportInvalidUpload

(

)

Test:

1. Test ReportController::getReport() for invalid upload
2. Check for 404 response

Definition at line 332 of file ReportControllerTest.php.

Member Data Documentation

$assertCountBefore

integer Fossology\UI\Api\Test\Controllers\ReportControllerTest::$assertCountBefore

private

Assertions before running tests

Definition at line 127 of file ReportControllerTest.php.

$clixmlPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$clixmlPlugin

private

CLIXMLPlugin mock

Definition at line 97 of file ReportControllerTest.php.

$dbManager

DbManager Fossology\UI\Api\Test\Controllers\ReportControllerTest::$dbManager

private

DbManager mock

Definition at line 121 of file ReportControllerTest.php.

$decisionExporterPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$decisionExporterPlugin

private

DecisionExporterAgentPlugin mock

Definition at line 115 of file ReportControllerTest.php.

$downloadPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$downloadPlugin

private

ui_download mock

Definition at line 109 of file ReportControllerTest.php.

$groupId

integer Fossology\UI\Api\Test\Controllers\ReportControllerTest::$groupId

private

Group id

Definition at line 79 of file ReportControllerTest.php.

$readmeossPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$readmeossPlugin

private

ReadMeOssPlugin mock

Definition at line 91 of file ReportControllerTest.php.

$reportController

ReportController Fossology\UI\Api\Test\Controllers\ReportControllerTest::$reportController

private

ReportController object to test

Definition at line 61 of file ReportControllerTest.php.

$reportsAllowed

array Fossology\UI\Api\Test\Controllers\ReportControllerTest::$reportsAllowed

private

Initial value:

= array(
    'dep5',
    'spdx2',
    'spdx2tv',
    'readmeoss',
    'unifiedreport',
    'clixml',
    'decisionexporter'
  )

Allowed agent names to create report

Definition at line 47 of file ReportControllerTest.php.

$spdxPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$spdxPlugin

private

SPDX generator mock

Definition at line 85 of file ReportControllerTest.php.

$streamFactory

StreamFactory Fossology\UI\Api\Test\Controllers\ReportControllerTest::$streamFactory

private

Stream factory to create body streams.

Definition at line 133 of file ReportControllerTest.php.

$unifiedPlugin

M MockInterface Fossology\UI\Api\Test\Controllers\ReportControllerTest::$unifiedPlugin

private

FoUnifiedReportGenerator mock

Definition at line 103 of file ReportControllerTest.php.

$uploadDao

UploadDao Fossology\UI\Api\Test\Controllers\ReportControllerTest::$uploadDao

private

UploadDao mock

Definition at line 67 of file ReportControllerTest.php.

$userId

integer Fossology\UI\Api\Test\Controllers\ReportControllerTest::$userId

private

User id

Definition at line 73 of file ReportControllerTest.php.

---

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

• src/www/ui_tests/api/Controllers/ReportControllerTest.php