ClearingResultTest.php

<?php
/*
Copyright (C) 2014-2018, Siemens AG

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

namespace Fossology\Lib\Data\Clearing;

use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Exception;
use Mockery as M;

class ClearingResultTest extends \PHPUnit\Framework\TestCase
{

  private $licenseRef;
  private $clearingEvent;
  private $agentClearingEvent1;
  private $agentClearingEvent2;
  private $licenseDecisionResult;


  protected function setUp()
  {
    $this->licenseRef = M::mock(LicenseRef::class);
    $this->clearingEvent = M::mock(ClearingEvent::class);

    $this->agentClearingEvent1 = M::mock(AgentClearingEvent::class);
    $this->agentClearingEvent2 = M::mock(AgentClearingEvent::class);

    $this->assertCountBefore = \Hamcrest\MatcherAssert::getCount();
  }

  protected function tearDown()
  {
    $this->addToAssertionCount(\Hamcrest\MatcherAssert::getCount()-$this->assertCountBefore);
  }

  public function testHasAgentDecisionEventIsTrue()
  {
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1, $this->agentClearingEvent2));
    assertThat($this->licenseDecisionResult->hasAgentDecisionEvent(), is(true));
  }

  public function testHasAgentDecisionEventIsFalse()
  {
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent);
    assertThat($this->licenseDecisionResult->hasAgentDecisionEvent(), is(false));
  }

  public function testHasDecisionEventIsTrue()
  {
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1, $this->agentClearingEvent2));
    assertThat($this->licenseDecisionResult->hasClearingEvent(), is(true));
  }

  public function testHasDecisionEventIsFalse()
  {
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->hasClearingEvent(), is(false));
  }

  public function testGetLicenseRefFromClearingEvent()
  {
    $this->clearingEvent->shouldReceive("getLicenseRef")->once()->andReturn($this->licenseRef);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseRef(), is($this->licenseRef));
  }

  public function testGetLicenseRefFromAgentEvents()
  {
    $this->agentClearingEvent1->shouldReceive("getLicenseRef")->once()->andReturn($this->licenseRef);
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1, $this->agentClearingEvent2));
    assertThat($this->licenseDecisionResult->getLicenseRef(), is($this->licenseRef));
  }

  public function testGetLicenseIdFromClearingEvent()
  {
    $licenseId = 123;
    $this->clearingEvent->shouldReceive("getLicenseId")->once()->andReturn($licenseId);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseId(), is($licenseId));
  }


  public function testGetLicenseIdFromAgentEvent()
  {
    $licenseId = 123;
    $this->agentClearingEvent1->shouldReceive("getLicenseId")->once()->andReturn($licenseId);
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseId(), is($licenseId));
  }

  public function testGetLicenseShortName()
  {
    $licenseShortName = "<shortName>";
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    $this->clearingEvent->shouldReceive("getLicenseShortName")->once()->andReturn($licenseShortName);
    assertThat($this->licenseDecisionResult->getLicenseShortName(), is($licenseShortName));
  }

  public function testGetLicenseFullName()
  {
    $licenseFullName = "<fullName>";
    $this->clearingEvent->shouldReceive("getLicenseFullName")->once()->andReturn($licenseFullName);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseFullName(), is($licenseFullName));
  }

  public function testGetCommentWithClearingEvent()
  {
    $comment = "<comment>";
    $this->clearingEvent->shouldReceive("getComment")->once()->andReturn($comment);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getComment(), is($comment));
  }

  public function testGetCommentWithoutClearingEvent()
  {
    $comment = "";
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getComment(), is($comment));
  }

  public function testGetReportInfoWithClearingEvent()
  {
    $reportInfo = "<reportInfo>";
    $this->clearingEvent->shouldReceive("getReportinfo")->once()->andReturn($reportInfo);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getReportinfo(), is($reportInfo));
  }


  public function testGetAcknowledgementWithClearingEvent()
  {
    $acknowledgement = "<acknowledgement>";
    $this->clearingEvent->shouldReceive("getAcknowledgement")->once()->andReturn($acknowledgement);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getAcknowledgement(), is($acknowledgement));
  }

  public function testGetReportInfoWithoutClearingEvent()
  {
    $reportInfo = "";
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getReportinfo(), is($reportInfo));
  }

  public function testGetAcknowledgementWithoutClearingEvent()
  {
    $acknowledgement = "";
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getAcknowledgement(), is($acknowledgement));
  }

  public function testIsRemoved()
  {
    $this->clearingEvent->shouldReceive("isRemoved")->once()->andReturn(true);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->isRemoved(), is(true));
  }

  public function testGetTimeStamp()
  {
    $ts = time();
    $this->clearingEvent->shouldReceive("getTimeStamp")->once()->andReturn($ts);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getTimeStamp(), is($ts));
  }

  public function testEventTypeWithClearingEvent()
  {
    $eventType = "<eventType>";
    $this->clearingEvent->shouldReceive("getEventType")->once()->andReturn($eventType);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getEventType(), is($eventType));
  }

  public function testEventTypeWithoutClearingEvent()
  {
    $eventType = "<eventType>";
    $this->agentClearingEvent1->shouldReceive("getEventType")->once()->andReturn($eventType);
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getEventType(), is($eventType));
  }

  public function testGetLicenseIdWithClearingEvent()
  {
    $licenseId = 123;
    $this->clearingEvent->shouldReceive("getLicenseId")->once()->andReturn($licenseId);
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseId(), is($licenseId));
  }

  public function testGetLicenseIdWithoutClearingEvent()
  {
    $licenseId = 123;
    $this->agentClearingEvent1->shouldReceive("getLicenseId")->once()->andReturn($licenseId);
    $this->licenseDecisionResult = new ClearingResult(null, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getLicenseId(), is($licenseId));
  }

  public function testGetClearingEvent()
  {
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1));
    assertThat($this->licenseDecisionResult->getClearingEvent(), is($this->clearingEvent));
  }

  public function testGetAgentClearingEvents()
  {
    $this->licenseDecisionResult = new ClearingResult($this->clearingEvent, array($this->agentClearingEvent1, $this->agentClearingEvent2));
    assertThat($this->licenseDecisionResult->getAgentDecisionEvents(), is(array(
        $this->agentClearingEvent1, $this->agentClearingEvent2)));
  }

  public function testCreateClearingResultCreationFailsOfNoEventsWereFound()
  {
    new ClearingResult(null);
  }
}