Merge pull request fossology#3200 from krrish175-byte/feat/spdx3-api-support

feat(api): Add SPDX3 Format Support to API Report Endpoint

Reviewed-by: shaheem.azmal@siemens.com
Tested-by: shaheem.azmal@siemens.com

Author: shaheemazmalmmd

src/www/ui/api/Controllers/ReportController.php

@@ -17,6 +17,7 @@
 use Fossology\DecisionImporter\UI\AgentDecisionImporterPlugin;
 use Fossology\ReadmeOSS\UI\ReadMeOssPlugin;
 use Fossology\Spdx\UI\SpdxTwoGeneratorUi;
+use Fossology\Spdx\UI\SpdxThreeGeneratorUi;
 use Fossology\UI\Api\Exceptions\HttpBadRequestException;
 use Fossology\UI\Api\Exceptions\HttpErrorException;
 use Fossology\UI\Api\Exceptions\HttpForbiddenException;
@@ -54,7 +55,10 @@ class ReportController extends RestController
     'unifiedreport',
     'clixml',
     'decisionexporter',
-    'cyclonedx'
+    'cyclonedx',
+    'spdx3json',
+    'spdx3rdf',
+    'spdx3jsonld'
   );
 
   /**
@@ -140,6 +144,14 @@ public function getReport($request, $response, $args)
         list ($jobId, $jobQueueId) = $cyclonedxGenerator->scheduleAgent(
           $this->restHelper->getGroupId(), $upload);
         break;
+      case $this->reportsAllowed[8]:
+      case $this->reportsAllowed[9]:
+      case $this->reportsAllowed[10]:
+        /** @var SpdxThreeGeneratorUi $spdx3Generator */
+        $spdx3Generator = $this->restHelper->getPlugin('ui_spdx3');
+        list ($jobId, $jobQueueId, $error) = $spdx3Generator->scheduleAgent(
+          $this->restHelper->getGroupId(), $upload, $reportFormat);
+        break;
       default:
         throw new HttpInternalServerErrorException("Some error occured!");
     }

src/www/ui/api/documentation/openapi.yaml

@@ -4424,6 +4424,9 @@ paths:
               - unifiedreport
               - clixml
               - cyclonedx
+              - spdx3json
+              - spdx3rdf
+              - spdx3jsonld
         - name: groupName
           description: The group name to chose while generating a report
           in: header

src/www/ui/api/documentation/openapiv2.yaml

@@ -4261,6 +4261,9 @@ paths:
               - unifiedreport
               - clixml
               - cyclonedx
+              - spdx3json
+              - spdx3rdf
+              - spdx3jsonld
         - name: groupName
           description: The group name to chose while generating a report
           in: query

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

@@ -51,7 +51,11 @@ class ReportControllerTest extends \PHPUnit\Framework\TestCase
     'readmeoss',
     'unifiedreport',
     'clixml',
-    'decisionexporter'
+    'decisionexporter',
+    'cyclonedx',
+    'spdx3json',
+    'spdx3rdf',
+    'spdx3jsonld'
   );
 
   /**
@@ -114,6 +118,18 @@ class ReportControllerTest extends \PHPUnit\Framework\TestCase
    */
   private $decisionExporterPlugin;
 
+  /**
+   * @var M\MockInterface $cyclonedxPlugin
+   * CycloneDXGeneratorUi mock
+   */
+  private $cyclonedxPlugin;
+
+  /**
+   * @var M\MockInterface $spdx3Plugin
+   * SpdxThreeGeneratorUi mock
+   */
+  private $spdx3Plugin;
+
   /**
    * @var DbManager $dbManager
    * DbManager mock
@@ -151,6 +167,8 @@ protected function setUp() : void
     $this->clixmlPlugin = M::mock('CliXmlGeneratorUi');
     $this->unifiedPlugin = M::mock('FoUnifiedReportGenerator');
     $this->decisionExporterPlugin = M::mock('DecisionExporterAgentPlugin');
+    $this->cyclonedxPlugin = M::mock('CycloneDXGeneratorUi');
+    $this->spdx3Plugin = M::mock('SpdxThreeGeneratorUi');
     $this->downloadPlugin = M::mock('ui_download');
 
     $this->dbHelper->shouldReceive('getDbManager')->andReturn($this->dbManager);
@@ -172,6 +190,10 @@ protected function setUp() : void
       ->andReturn($this->unifiedPlugin);
     $this->restHelper->shouldReceive('getPlugin')
       ->withArgs(['agent_fodecisionexporter'])->andReturn($this->decisionExporterPlugin);
+    $this->restHelper->shouldReceive('getPlugin')
+      ->withArgs(array('ui_cyclonedx'))->andReturn($this->cyclonedxPlugin);
+    $this->restHelper->shouldReceive('getPlugin')
+      ->withArgs(array('ui_spdx3'))->andReturn($this->spdx3Plugin);
 
     $container->shouldReceive('get')->withArgs(array(
       'helper.restHelper'))->andReturn($this->restHelper);
@@ -278,6 +300,12 @@ public function testGetReportAllFormats()
       ->withArgs([$this->groupId, $upload])->andReturn([32, 33, ""]);
     $this->decisionExporterPlugin->shouldReceive('scheduleAgent')
       ->withArgs([$this->groupId, $upload])->andReturn([32, 33]);
+    $this->cyclonedxPlugin->shouldReceive('scheduleAgent')
+      ->withArgs([$this->groupId, $upload])->andReturn([32, 33]);
+    $this->spdx3Plugin->shouldReceive('scheduleAgent')
+      ->withArgs([$this->groupId, $upload, M::anyOf($this->reportsAllowed[8],
+        $this->reportsAllowed[9], $this->reportsAllowed[10])])
+      ->andReturn([32, 33, ""]);
 
     $expectedResponse = new Info(201, "http://localhost/repo/api/v1/report/32",
       InfoType::INFO);