UploadControllerTest.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2020 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 SPDX-FileCopyrightText: © 2022 Samuel Dushimimana <dushsam100@gmail.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\UI\Api\Test\Controllers;
 
use Fossology\Lib\Auth\Auth;
use Fossology\Lib\BusinessRules\ReuseReportProcessor;
use Fossology\Lib\Dao\AgentDao;
use Fossology\Lib\Dao\ClearingDao;
use Fossology\Lib\Dao\FolderDao;
use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Dao\UploadDao;
use Fossology\Lib\Dao\UserDao;
use Fossology\Lib\Data\AgentRef;
use Fossology\Lib\Data\Tree\ItemTreeBounds;
use Fossology\Lib\Data\UploadStatus;
use Fossology\Lib\Db\DbManager;
use Fossology\UI\Api\Controllers\UploadController;
use Fossology\UI\Api\Exceptions\HttpBadRequestException;
use Fossology\UI\Api\Exceptions\HttpForbiddenException;
use Fossology\UI\Api\Exceptions\HttpInternalServerErrorException;
use Fossology\UI\Api\Exceptions\HttpNotFoundException;
use Fossology\UI\Api\Exceptions\HttpServiceUnavailableException;
use Fossology\UI\Api\Helper\DbHelper;
use Fossology\UI\Api\Helper\ResponseHelper;
use Fossology\UI\Api\Helper\RestHelper;
use Fossology\UI\Api\Models\ApiVersion;
use Fossology\UI\Api\Models\Hash;
use Fossology\UI\Api\Models\Info;
use Fossology\UI\Api\Models\InfoType;
use Fossology\UI\Api\Models\License;
use Fossology\UI\Api\Models\Upload;
use Mockery as M;
use Slim\Psr7\Factory\StreamFactory;
use Slim\Psr7\Headers;
use Slim\Psr7\Request;
use Slim\Psr7\Uri;
 
function TryToDelete($uploadpk, $user_pk, $group_pk, $uploadDao)
{
  return UploadControllerTest::$functions->TryToDelete($uploadpk, $user_pk,
    $group_pk, $uploadDao);
}
 
class UploadControllerTest extends \PHPUnit\Framework\TestCase
{
  public static $functions;
 
  private $assertCountBefore;
 
  private $userId;
 
  private $groupId;
 
  private $dbHelper;
 
  private $dbManager;
 
  private $restHelper;
 
  private $uploadController;
 
  private $uploadDao;
 
  private $folderDao;
 
  private $agentDao;
 
  private $clearingDao;
 
  private $licenseDao;
 
  private $reuseReportProcess;
 
  private $streamFactory;
 
  protected function setUp() : void
  {
    global $container;
    $this->userId = 2;
    $this->groupId = 2;
    $container = M::mock('ContainerBuilder');
    self::$functions = M::mock();
    $this->dbHelper = M::mock(DbHelper::class);
    $this->dbManager = M::mock(DbManager::class);
    $this->restHelper = M::mock(RestHelper::class);
    $this->uploadDao = M::mock(UploadDao::class);
    $this->folderDao = M::mock(FolderDao::class);
    $this->agentDao = M::mock(AgentDao::class);
    $this->userDao = M::mock(UserDao::class);
    $this->clearingDao = M::mock(ClearingDao::class);
    $this->licenseDao = M::mock(LicenseDao::class);
    $this->reuseReportProcess = M::mock(ReuseReportProcessor::class);
 
    $this->dbManager->shouldReceive('getSingleRow')
      ->withArgs([M::any(), [$this->groupId, UploadStatus::OPEN,
        Auth::PERM_READ]]);
    $this->dbHelper->shouldReceive('getDbManager')->andReturn($this->dbManager);
 
    $this->restHelper->shouldReceive('getDbHelper')->andReturn($this->dbHelper);
    $this->restHelper->shouldReceive('getGroupId')->andReturn($this->groupId);
    $this->restHelper->shouldReceive('getUserId')->andReturn($this->userId);
    $this->restHelper->shouldReceive('getUploadDao')
      ->andReturn($this->uploadDao);
    $this->restHelper->shouldReceive('getFolderDao')
      ->andReturn($this->folderDao);
    $this->restHelper->shouldReceive('getUserDao')
      ->andReturn($this->userDao);
    $container->shouldReceive('get')->withArgs(['dao.license'])->andReturn(
      $this->licenseDao);
    $container->shouldReceive('get')->withArgs(array(
      'dao.clearing'))->andReturn($this->clearingDao);
    $container->shouldReceive('get')->withArgs(array(
      'helper.restHelper'))->andReturn($this->restHelper);
    $container->shouldReceive('get')->withArgs(array(
      'dao.agent'))->andReturn($this->agentDao);
    $container->shouldReceive('get')->withArgs(array(
      'dao.upload'))->andReturn($this->uploadDao);
    $container->shouldReceive('get')->withArgs(
      ['db.manager'])->andReturn($this->dbManager);
    $container->shouldReceive('get')->withArgs(array('dao.license'))->andReturn($this->licenseDao);
    $container->shouldReceive('get')->withArgs(array(
      'businessrules.reusereportprocessor'))->andReturn($this->reuseReportProcess);
    $this->uploadController = new UploadController($container);
    $this->assertCountBefore = \Hamcrest\MatcherAssert::getCount();
    $this->streamFactory = new StreamFactory();
  }
 
  protected function tearDown() : void
  {
    $this->addToAssertionCount(
      \Hamcrest\MatcherAssert::getCount() - $this->assertCountBefore);
    M::close();
  }
 
  private function getResponseJson($response)
  {
    $response->getBody()->seek(0);
    return json_decode($response->getBody()->getContents(), true);
  }
 
  private function getUploadBounds($id)
  {
    if ($id > 4) {
      return false;
    }
    $itemId = ($id * 100) + 1;
    $left = ($id * 100) + 2;
    $right = ($id * 100) + 50;
    return new ItemTreeBounds($itemId, 'uploadtree_a', $id, $left, $right);
  }
 
  private function getUpload($id)
  {
    $uploadName = "";
    $description = "";
    $uploadDate = "";
    $folderId = 2;
    $folderName = "SR";
    $fileSize = 0;
    switch ($id) {
      case 2:
        $uploadName = "top$id";
        $uploadDate = "01-01-2020";
        $fileSize = 123;
        break;
      case 3:
        $uploadName = "child$id";
        $uploadDate = "02-01-2020";
        $fileSize = 133;
        break;
      case 4:
        $uploadName = "child$id";
        $uploadDate = "03-01-2020";
        $fileSize = 153;
        break;
      default:
        return null;
    }
    $hash = new Hash('sha1checksum', 'md5checksum', 'sha256checksum', $fileSize);
    return new Upload($folderId, $folderName, $id, $description,
      $uploadName, $uploadDate, null, $hash);
  }
 
  public function testGetSingleUploadV1()
  {
    $this->testGetSingleUpload(ApiVersion::V1);
  }
  public function testGetSingleUploadV2()
  {
    $this->testGetSingleUpload(ApiVersion::V2);
  }
  private function testGetSingleUpload($version)
  {
    $uploadId = 3;
    $options = [
      "folderId" => null,
      "name"     => null,
      "status"   => null,
      "assignee" => null,
      "since"    => null
    ];
    $upload = $this->getUpload($uploadId);
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads/$uploadId"), $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->uploadDao->shouldReceive('getParentItemBounds')
      ->withArgs([$uploadId])->andReturn($this->getUploadBounds($uploadId));
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, $uploadId, $options,
      true, $version])->andReturn([1, [$upload->getArray()]]);
    $expectedResponse = (new ResponseHelper())->withJson($upload->getArray(), 200);
    $actualResponse = $this->uploadController->getUploads($request,
      new ResponseHelper(), ['id' => $uploadId]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testGetSingleUploadInAccessible()
  {
    $uploadId = 3;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads/$uploadId"), $requestHeaders, [], [], $body);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(false);
    $this->expectException(HttpForbiddenException::class);
 
    $this->uploadController->getUploads($request, new ResponseHelper(),
      ['id' => $uploadId]);
  }
 
  public function testGetUploadWithFiltersV1()
  {
    $this->testGetUploadWithFilters(ApiVersion::V1);
  }
  public function testGetUploadWithFiltersV2()
  {
    $this->testGetUploadWithFilters(ApiVersion::V2);
  }
 
  private function testGetUploadWithFilters($version)
  {
    $options = [
      "folderId" => null,
      "name"     => null,
      "status"   => null,
      "assignee" => null,
      "since"    => null
    ];
 
    // Test for folder filter
    $folderId = 2;
    $folderOptions = $options;
    $folderOptions["folderId"] = $folderId;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FOLDER_PARAM . "=$folderId"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->folderDao->shouldReceive('isFolderAccessible')
      ->withArgs([$folderId, $this->userId])->andReturn(true)->once();
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $folderOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
 
    // Test for name filter
    $name = "foss";
    $nameOptions = $options;
    $nameOptions["name"] = $name;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FILTER_NAME . "=$name"), $requestHeaders,
      [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $nameOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
 
    // Test for status filter
    $statusString = "InProgress";
    $status = UploadStatus::IN_PROGRESS;
    $statusOptions = $options;
    $statusOptions["status"] = $status;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FILTER_STATUS . "=$statusString"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $statusOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
 
    // Test for assignee filter
    $assignee = "-me-";
    $assigneeOptions = $options;
    $assigneeOptions["assignee"] = $this->userId;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FILTER_ASSIGNEE . "=$assignee"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $assigneeOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
 
    // Test for since filter
    $since = "2021-02-28";
    $sinceOptions = $options;
    $sinceOptions["since"] = strtotime($since);
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FILTER_DATE . "=$since"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $sinceOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
 
    // Test for status and since filter
    $statusString = "Open";
    $status = UploadStatus::OPEN;
    $since = "2021-02-28";
    $combOptions = $options;
    $combOptions["since"] = strtotime($since);
    $combOptions["status"] = $status;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads", UploadController::FILTER_DATE . "=$since&" .
      UploadController::FILTER_STATUS . "=$statusString"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $combOptions,
      true, $version])->andReturn([1, []])->once();
    $this->uploadController->getUploads($request, new ResponseHelper(), []);
  }
 
  public function testGetUploadsV1(){
    $this->testGetUploads(ApiVersion::V1);
  }
  public function testGetUploadsV2(){
    $this->testGetUploads(ApiVersion::V2);
  }
  private function testGetUploads($version)
  {
    $uploads = [
      $this->getUpload(2)->getArray(),
      $this->getUpload(3)->getArray(),
      $this->getUpload(4)->getArray()
    ];
    $options = [
      "folderId" => null,
      "name"     => null,
      "status"   => null,
      "assignee" => null,
      "since"    => null
    ];
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads/"), $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('getUploads')
      ->withArgs([$this->userId, $this->groupId, 100, 1, null, $options, true, $version])
      ->andReturn([1, $uploads]);
    $expectedResponse = (new ResponseHelper())->withJson($uploads, 200);
    $actualResponse = $this->uploadController->getUploads($request,
      new ResponseHelper(), []);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testGetSingleUploadNotUnpacked()
  {
    $uploadId = 3;
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("GET", new Uri("HTTP", "localhost", 80,
      "/uploads/"), $requestHeaders, [], [], $body);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->uploadDao->shouldReceive('getParentItemBounds')
      ->withArgs([$uploadId])->andReturn(false);
    $this->expectException(HttpServiceUnavailableException::class);
 
    $this->uploadController->getUploads($request, new ResponseHelper(),
      ['id' => $uploadId]);
  }
 
  public function testCopyUploadV1()
  {
    $this->testCopyUpload(ApiVersion::V1);
  }
  public function testCopyUploadV2()
  {
    $this->testCopyUpload(ApiVersion::V2);
  }
  private function testCopyUpload($version)
  {
    $uploadId = 3;
    $folderId = 5;
    $info = new Info(202, "Upload $uploadId will be copied to folder $folderId",
      InfoType::INFO);
 
    $this->restHelper->shouldReceive('copyUpload')
      ->withArgs([$uploadId, $folderId, true])->andReturn($info);
    $expectedResponse = (new ResponseHelper())->withJson($info->getArray(),
      $info->getCode());
 
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
 
    if($version==ApiVersion::V1){
      $requestHeaders->setHeader('folderId', $folderId);
      $requestHeaders->setHeader('action', 'copy');
      $request = new Request("PUT", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
      $actualResponse = $this->uploadController->moveUpload($request,
        new ResponseHelper(), ['id' => $uploadId]);
    }
    else{
      $request = new Request("PUT", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
      if ($version == ApiVersion::V2) {
        $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
          ApiVersion::V2);
      }
      $actualResponse = $this->uploadController->moveUpload($request->withUri($request->getUri()->withQuery("folderId=$folderId&action=copy")),
        new ResponseHelper(), ['id' => $uploadId]);
    }
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testMoveUploadInvalidFolder()
  {
    $uploadId = 3;
 
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('folderId', 'alpha');
    $requestHeaders->setHeader('action', 'move');
    $body = $this->streamFactory->createStream();
    $request = new Request("PATCH", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
    $this->expectException(HttpBadRequestException::class);
 
    $this->uploadController->moveUpload($request, new ResponseHelper(),
      ['id' => $uploadId]);
  }
 
  public function testPostUploadV1()
  {
    $this->testPostUpload(ApiVersion::V1);
  }
 
  public function testPostUploadV2()
  {
    $this->testPostUpload(ApiVersion::V2);
  }
 
  private function testPostUpload(int $version)
  {
    $folderId = 2;
    $uploadId = 20;
    $uploadDescription = "Test Upload";
 
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-Type', 'application/json');
    if ($version == ApiVersion::V2) {
      $reqBody = [
        "location" => "data",
        "folderId" => $folderId,
        "uploadDescription" => $uploadDescription,
        "ignoreScm" => "true",
        "scanOptions" => "scanOptions",
        "uploadType" => "vcs"
      ];
    } else {
      $reqBody = [
        "location" => "data",
        "scanOptions" => "scanOptions"
      ];
      $requestHeaders->setHeader('folderId', $folderId);
      $requestHeaders->setHeader('uploadDescription', $uploadDescription);
      $requestHeaders->setHeader('ignoreScm', 'true');
      $requestHeaders->setHeader('Content-Type', 'application/json');
      $requestHeaders->setHeader('uploadType', 'vcs');
    }
 
 
    $body = $this->streamFactory->createStream(json_encode(
      $reqBody
    ));
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $uploadHelper = M::mock('overload:Fossology\UI\Api\Helper\UploadHelper');
    $uploadHelper->shouldReceive('createNewUpload')
      ->withArgs([$reqBody["location"], $folderId, $uploadDescription, 'protected', 'true',
        'vcs', false])
      ->andReturn([true, '', '', $uploadId]);
 
    $info = new Info(201, intval(20), InfoType::INFO);
 
    $uploadHelper->shouldReceive('handleScheduleAnalysis')->withArgs([$uploadId,$folderId,$reqBody["scanOptions"],false])
    ->andReturn($info);
 
    $this->folderDao->shouldReceive('getAllFolderIds')->andReturn([2,3,4]);
    $this->folderDao->shouldReceive('isFolderAccessible')
      ->withArgs([$folderId])->andReturn(true);
 
    $expectedResponse = (new ResponseHelper())->withJson($info->getArray(),
      $info->getCode());
    $actualResponse = $this->uploadController->postUpload($request,
      new ResponseHelper(), []);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testPostUploadFolderNotAccessibleV1()
  {
    $this->testPostUploadFolderNotAccessible(ApiVersion::V1);
  }
 
  public function testPostUploadFolderNotAccessibleV2()
  {
    $this->testPostUploadFolderNotAccessible(ApiVersion::V2);
  }
 
  private function testPostUploadFolderNotAccessible(int $version)
  {
    $folderId = 2;
    $uploadDescription = "Test Upload";
 
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-type', 'application/json');
    if ($version == ApiVersion::V2) {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "data",
        "folderId" => $folderId,
        "uploadDescription" => $uploadDescription,
        "ignoreScm" => "true",
        "scanOptions" => "scanOptions",
        "uploadType" => "vcs"
      ]));
    } else {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "data",
        "scanOptions" => "scanOptions"
      ]));
      $requestHeaders->setHeader('folderId', $folderId);
      $requestHeaders->setHeader('uploadDescription', $uploadDescription);
      $requestHeaders->setHeader('ignoreScm', 'true');
      $requestHeaders->setHeader('Content-Type', 'application/json');
      $requestHeaders->setHeader('uploadType', 'vcs');
    }
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
 
    $uploadHelper = M::mock('overload:Fossology\UI\Api\Helper\UploadHelper');
 
    $this->folderDao->shouldReceive('getAllFolderIds')->andReturn([2,3,4]);
    $this->folderDao->shouldReceive('isFolderAccessible')
      ->withArgs([$folderId])->andReturn(false);
    $this->expectException(HttpForbiddenException::class);
 
    $this->uploadController->postUpload($request, new ResponseHelper(),
      []);
  }
 
  public function testPostUploadFolderNotFoundV1()
  {
    $this->testPostUploadFolderNotFound(ApiVersion::V1);
  }
 
  public function testPostUploadFolderNotFoundV2()
  {
    $this->testPostUploadFolderNotFound(ApiVersion::V2);
  }
 
  private function testPostUploadFolderNotFound(int $version)
  {
    $folderId = 8;
    $uploadDescription = "Test Upload";
 
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-type', 'application/json');
    if ($version == ApiVersion::V2) {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "vcsData",
        "folderId" => $folderId,
        "uploadDescription" => $uploadDescription,
        "ignoreScm" => "true",
        "scanOptions" => "scanOptions",
        "uploadType" => "vcs"
      ]));
    } else {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "vcsData",
        "scanOptions" => "scanOptions"
      ]));
      $requestHeaders->setHeader('folderId', $folderId);
      $requestHeaders->setHeader('uploadDescription', $uploadDescription);
      $requestHeaders->setHeader('ignoreScm', 'true');
      $requestHeaders->setHeader('Content-Type', 'application/json');
      $requestHeaders->setHeader('uploadType', 'vcs');
    }
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
 
    $uploadHelper = M::mock('overload:Fossology\UI\Api\Helper\UploadHelper');
 
    $this->folderDao->shouldReceive('getAllFolderIds')->andReturn([2,3,4]);
    $this->expectException(HttpNotFoundException::class);
 
    $this->uploadController->postUpload($request, new ResponseHelper(),
      []);
  }
 
  public function testPostUploadInternalErrorV1()
  {
    $this->testPostUploadInternalError(ApiVersion::V1);
  }
 
  public function testPostUploadInternalErrorV2()
  {
    $this->testPostUploadInternalError(ApiVersion::V2);
  }
 
  private function testPostUploadInternalError(int $version)
  {
    $folderId = 3;
    $uploadDescription = "Test Upload";
    $errorMessage = "Failed to insert upload record";
    $errorDesc = "";
 
 
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-type', 'application/json');
    if ($version == ApiVersion::V2) {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "vcsData",
        "folderId" => $folderId,
        "uploadDescription" => $uploadDescription,
        "ignoreScm" => "true",
        "scanOptions" => "scanOptions",
        "uploadType" => "vcs"
      ]));
    } else {
      $body = $this->streamFactory->createStream(json_encode([
        "location" => "vcsData",
        "scanOptions" => "scanOptions"
      ]));
      $requestHeaders->setHeader('folderId', $folderId);
      $requestHeaders->setHeader('uploadDescription', $uploadDescription);
      $requestHeaders->setHeader('ignoreScm', 'true');
      $requestHeaders->setHeader('Content-Type', 'application/json');
      $requestHeaders->setHeader('uploadType', 'vcs');
    }
 
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
 
    $uploadHelper = M::mock('overload:Fossology\UI\Api\Helper\UploadHelper');
    $uploadHelper->shouldReceive('createNewUpload')
      ->withArgs(['vcsData', $folderId, $uploadDescription, 'protected', 'true',
        'vcs', false])
      ->andReturn([false, $errorMessage, $errorDesc, [-1]]);
 
    $this->folderDao->shouldReceive('getAllFolderIds')->andReturn([2,3,4]);
    $this->folderDao->shouldReceive('isFolderAccessible')
    ->withArgs([$folderId])->andReturn(true);
    $this->expectException(HttpInternalServerErrorException::class);
 
    $this->uploadController->postUpload($request, new ResponseHelper(), []);
  }
 
  public function testGetUploadLicensesV1()
  {
    $this->testGetUploadLicenses(ApiVersion::V1);
  }
  public function testGetUploadLicensesV2()
  {
    $this->testGetUploadLicenses(ApiVersion::V2);
  }
  private function testGetUploadLicenses($version)
  {
    $uploadId = 3;
    $agentsRun = [
      ['agentName' => 'nomos', 'currentAgentId' => 2, 'isAgentRunning' => false],
      ['agentName' => 'monk', 'currentAgentId' => 3, 'isAgentRunning' => false]
    ];
    $licenseResponse = [
      ['filePath' => 'filea', 'agentFindings' => 'MIT', 'conclusions' => 'MIT'],
      ['filePath' => 'fileb', 'agentFindings' => 'MIT',
        'conclusions' => 'No_license_found']
    ];
 
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("POST", new Uri("HTTP", "localhost", 80,
        "/uploads/$uploadId/licenses", UploadController::AGENT_PARAM .
        "=nomos,monk&containers=false"),
      $requestHeaders, [], [], $body);
    if ($version == ApiVersion::V2) {
      $request = $request->withAttribute(ApiVersion::ATTRIBUTE_NAME,
        ApiVersion::V2);
    }
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->uploadDao->shouldReceive('getParentItemBounds')
      ->withArgs([$uploadId])->andReturn($this->getUploadBounds($uploadId));
    $this->agentDao->shouldReceive('arsTableExists')
      ->withArgs([M::anyOf('nomos', 'monk')])->andReturn(true);
 
    $scanJobProxy = M::mock('overload:Fossology\Lib\Proxy\ScanJobProxy');
    $scanJobProxy->shouldReceive('createAgentStatus')
      ->withArgs([['nomos', 'monk']])
      ->andReturn($agentsRun);
 
    $uploadHelper = M::mock('overload:Fossology\UI\Api\Helper\UploadHelper');
    $uploadHelper->shouldReceive('getUploadLicenseList')
      ->withArgs([$uploadId, ['nomos', 'monk'], false, true, false, 0, 50, $version])
      ->andReturn(([[$licenseResponse], 1]));
 
    $expectedResponse = (new ResponseHelper())->withJson($licenseResponse, 200);
 
    $actualResponse = $this->uploadController->getUploadLicenses($request,
      new ResponseHelper(), ['id' => $uploadId]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse)[0]);
    $this->assertEquals('1',
      $actualResponse->getHeaderLine('X-Total-Pages'));
  }
 
  public function testGetUploadLicensesPendingScan()
  {
    $uploadId = 3;
    $agentsRun = [
      ['agentName' => 'nomos', 'currentAgentId' => 2, 'isAgentRunning' => true],
      ['agentName' => 'monk', 'currentAgentId' => 3, 'isAgentRunning' => false]
    ];
 
    $requestHeaders = new Headers();
    $body = $this->streamFactory->createStream();
    $request = new Request("POST", new Uri("HTTP", "localhost", 80,
        "/uploads/$uploadId/licenses", UploadController::AGENT_PARAM .
        "=nomos,monk&containers=false"),
      $requestHeaders, [], [], $body);
 
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->uploadDao->shouldReceive('getParentItemBounds')
      ->withArgs([$uploadId])->andReturn($this->getUploadBounds($uploadId));
    $this->agentDao->shouldReceive('arsTableExists')
      ->withArgs([M::anyOf('nomos', 'monk')])->andReturn(true);
 
    $scanJobProxy = M::mock('overload:Fossology\Lib\Proxy\ScanJobProxy');
    $scanJobProxy->shouldReceive('createAgentStatus')
      ->withArgs([['nomos', 'monk']])
      ->andReturn($agentsRun);
    $this->expectException(HttpServiceUnavailableException::class);
 
    $this->uploadController->getUploadLicenses($request, new ResponseHelper(),
      ['id' => $uploadId]);
  }
 
  public function testUpdateUpload()
  {
    $upload = 2;
    $assignee = 4;
    $status = UploadStatus::REJECTED;
    $comment = "Not helpful";
 
    $resource = fopen('data://text/plain;base64,' .
      base64_encode($comment), 'r+');
    $body = $this->streamFactory->createStreamFromResource($resource);
    $request = new Request("POST", new Uri("HTTP", "localhost", 80,
      "/uploads/$upload", UploadController::FILTER_STATUS . "=Rejected&" .
      UploadController::FILTER_ASSIGNEE . "=$assignee"),
      new Headers(), [], [], $body);
 
    $this->userDao->shouldReceive('isAdvisorOrAdmin')
      ->withArgs([$this->userId, $this->groupId])
      ->andReturn(true);
    $this->userDao->shouldReceive('getUserChoices')
      ->withArgs([$this->groupId])
      ->andReturn([$this->userId => "fossy", $assignee => "friendly-fossy"]);
    $this->dbManager->shouldReceive('getSingleRow')
      ->withArgs([M::any(), [$assignee, $this->groupId, $upload], M::any()]);
    $this->dbManager->shouldReceive('getSingleRow')
      ->withArgs([M::any(), [$status, $comment, $this->groupId, $upload],
        M::any()]);
    $this->dbManager->shouldReceive('getSingleRow')
      ->withArgs([M::any(), [$upload], M::any()])
      ->andReturn(["exists" => ""]);
 
    $info = new Info(202, "Upload updated successfully.", InfoType::INFO);
    $expectedResponse = (new ResponseHelper())->withJson($info->getArray(),
      $info->getCode());
    $actualResponse = $this->uploadController->updateUpload($request,
      new ResponseHelper(), ['id' => $upload]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testUpdateUploadNoPerm()
  {
    $upload = 2;
    $assignee = 4;
    $comment = "Not helpful";
 
    $resource = fopen('data://text/plain;base64,' .
      base64_encode($comment), 'r+');
    $body = $this->streamFactory->createStreamFromResource($resource);
    $request = new Request("POST", new Uri("HTTP", "localhost", 80,
      "/uploads/$upload", UploadController::FILTER_STATUS . "=Rejected&" .
      UploadController::FILTER_ASSIGNEE . "=$assignee"),
      new Headers(), [], [], $body);
 
    $this->userDao->shouldReceive('isAdvisorOrAdmin')
      ->withArgs([$this->userId, $this->groupId])
      ->andReturn(false);
    $this->expectException(HttpForbiddenException::class);
 
    $this->uploadController->updateUpload($request, new ResponseHelper(),
      ['id' => $upload]);
  }
 
  public function testGetMainLicenses()
  {
    $uploadId = 1;
    $licenseIds = array();
    $licenseId = 123;
    $licenseIds[$licenseId] = $licenseId;
    $license = new License($licenseId, "MIT", "MIT License", "risk", "texts", [],
      'type', false);
 
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->clearingDao->shouldReceive('getMainLicenseIds')->withArgs([$uploadId, $this->groupId])->andReturn($licenseIds);
    $this->licenseDao->shouldReceive('getLicenseObligations')->withArgs([[$licenseId], false])->andReturn([]);
    $this->licenseDao->shouldReceive('getLicenseObligations')->withArgs([[$licenseId], true])->andReturn([]);
    $this->licenseDao->shouldReceive('getLicenseById')->withArgs([$licenseId])->andReturn($license);
 
    $licenses[] = $license->getArray();
    $expectedResponse = (new ResponseHelper())->withJson($licenses, 200);
    $actualResponse = $this->uploadController->getMainLicenses(null, new ResponseHelper(), ['id' => $uploadId]);
    $this->assertEquals($expectedResponse->getStatusCode(), $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse), $this->getResponseJson($actualResponse));
  }
 
 
  public function testSetMainLicense()
  {
    $uploadId = 2;
    $shortName = "MIT";
    $licenseId = 1;
    $rq = [
      "shortName" => $shortName,
    ];
    $license = new License(2, $shortName, "MIT License", "risk", "texts", [],
      'type', 1);
    $licenseIds[$licenseId] = $licenseId;
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->licenseDao->shouldReceive('getLicenseByShortName')
      ->withArgs([$shortName, $this->groupId])->andReturn($license);
    $this->clearingDao->shouldReceive('getMainLicenseIds')->withArgs([$uploadId, $this->groupId])->andReturn($licenseIds);
    $this->clearingDao->shouldReceive('makeMainLicense')
      ->withArgs([$uploadId, $this->groupId, $license->getId()])->andReturn(null);
 
    $info = new Info(200, "Successfully added new main license", InfoType::INFO);
 
    $expectedResponse = (new ResponseHelper())->withJson($info->getArray(), $info->getCode());
    $reqBody = $this->streamFactory->createStream(json_encode(
      $rq
    ));
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-Type', 'application/json');
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $reqBody);
 
    $actualResponse = $this->uploadController->setMainLicense($request, new ResponseHelper(), ['id' => $uploadId]);
 
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testSetMainLicense_exists()
  {
    $uploadId = 2;
    $shortName = "MIT";
    $licenseId = 1;
    $rq = [
      "shortName" => $shortName,
    ];
    $license = new License($licenseId, $shortName, "MIT License", "risk", "texts", [],
     'type', 1);
    $licenseIds[$licenseId] = $licenseId;
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->licenseDao->shouldReceive('getLicenseByShortName')
      ->withArgs([$shortName, $this->groupId])->andReturn($license);
    $this->clearingDao->shouldReceive('getMainLicenseIds')->withArgs([$uploadId, $this->groupId])->andReturn($licenseIds);
    $this->clearingDao->shouldReceive('makeMainLicense')
      ->withArgs([$uploadId, $this->groupId, $license->getId()])->andReturn(null);
 
    $reqBody = $this->streamFactory->createStream(json_encode(
      $rq
    ));
    $requestHeaders = new Headers();
    $requestHeaders->setHeader('Content-Type', 'application/json');
    $request = new Request("POST", new Uri("HTTP", "localhost"),
      $requestHeaders, [], [], $reqBody);
    $this->expectException(HttpBadRequestException::class);
 
    $this->uploadController->setMainLicense($request, new ResponseHelper(), ['id' => $uploadId]);
  }
 
 
  public function testRemoveMainLicense()
  {
    $uploadId = 3;
    $licenseId = 1;
    $shortName = "MIT";
    $license = new License($licenseId, $shortName, "MIT License", "risk", "texts", [],
      'type', 1);
    $licenseIds[$licenseId] = $licenseId;
 
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["license_ref", "rf_pk", $licenseId])->andReturn(true);
    $this->clearingDao->shouldReceive('getMainLicenseIds')->withArgs([$uploadId, $this->groupId])->andReturn($licenseIds);
 
    $this->clearingDao->shouldReceive('removeMainLicense')->withArgs([$uploadId, $this->groupId, $licenseId])->andReturn(null);
    $this->licenseDao->shouldReceive('getLicenseByShortName')
      ->withArgs([$shortName, $this->groupId])->andReturn($license);
 
    $info = new Info(200, "Main license removed successfully.", InfoType::INFO);
    $expectedResponse = (new ResponseHelper())->withJson($info->getArray(),
      $info->getCode());
    $actualResponse = $this->uploadController->removeMainLicense(null,
      new ResponseHelper(), ['id' => $uploadId, 'shortName' => $shortName]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
 
  public function testGetClearingProgressInfo()
  {
    $uploadId = 3;
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->uploadDao->shouldReceive("getUploadtreeTableName")->withArgs([$uploadId])->andReturn("uploadtree");
    $this->uploadDao->shouldReceive("getGlobalDecisionSettingsFromInfo")->andReturn(false);
    $this->agentDao->shouldReceive("arsTableExists")->andReturn(true);
    $this->agentDao->shouldReceive("getSuccessfulAgentEntries")->andReturn([['agent_id' => 1, 'agent_rev' => 1]]);
    $this->agentDao->shouldReceive("getCurrentAgentRef")->andReturn(new AgentRef(1, "agent", 1));
    $this->dbManager->shouldReceive("getSingleRow")
      ->withArgs([M::any(), [], 'no_license_uploadtree' . $uploadId])
      ->andReturn(['count' => 1]);
    $this->dbManager->shouldReceive("getSingleRow")
      ->withArgs([M::any(), [], 'already_cleared_uploadtree' . $uploadId])
      ->andReturn(['count' => 0]);
    $this->licenseDao->shouldReceive('getLicenseByShortName')
      ->withArgs(['No_license_found'])->andReturn(null);
    $this->licenseDao->shouldReceive('getLicenseByShortName')
      ->withArgs(['Void'])->andReturn(null);
    $res = [
      "totalFilesOfInterest" => 1,
      "totalFilesCleared" => 1,
    ];
    $expectedResponse = (new ResponseHelper())->withJson($res, 200);
    $actualResponse = $this->uploadController->getClearingProgressInfo(null,
      new ResponseHelper(), ['id' => $uploadId]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
  public function testGetReuseReportSummary()
  {
    $uploadId = 2;
    $reuseReportSummary = [
        'declearedLicense' => "",
        'clearedLicense' => "MIT, BSD-3-Clause",
        'usedLicense' => "",
        'unusedLicense' => "",
        'missingLicense' => "MIT, BSD-3-Clause",
      ];
    $this->uploadDao->shouldReceive('isAccessible')
      ->withArgs([$uploadId, $this->groupId])->andReturn(true);
    $this->dbHelper->shouldReceive('doesIdExist')
      ->withArgs(["upload", "upload_pk", $uploadId])->andReturn(true);
    $this->reuseReportProcess->shouldReceive('getReuseSummary')
      ->withArgs([$uploadId])->andReturn($reuseReportSummary);
 
    $expectedResponse = (new ResponseHelper())->withJson($reuseReportSummary,
      200);
    $actualResponse = $this->uploadController->getReuseReportSummary(
      null, new ResponseHelper(), ['id' => $uploadId]);
    $this->assertEquals($expectedResponse->getStatusCode(),
      $actualResponse->getStatusCode());
    $this->assertEquals($this->getResponseJson($expectedResponse),
      $this->getResponseJson($actualResponse));
  }
}