dolibarr/test/phpunit/ReceptionTest.php

<?php
/* Copyright (C) 2023 Alexandre Janniaux   <alexandre.janniaux@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */

/**
 *      \file       test/phpunit/ReceptionTest.php
 *      \ingroup    test
 *      \brief      PHPUnit test for the Reception code
 *      \remarks    To run this script as CLI:  phpunit filename.php
 */

global $conf,$user,$langs,$db;

require_once dirname(__FILE__).'/../../htdocs/master.inc.php';
require_once dirname(__FILE__).'/../../htdocs/societe/class/societe.class.php';
require_once dirname(__FILE__).'/../../htdocs/reception/class/reception.class.php';
$langs->load("dict");

if (empty($user->id)) {
	print "Load permissions for admin user nb 1\n";
	$user->fetch(1);
	$user->getrights();
}
$conf->global->MAIN_DISABLE_ALL_MAILS=1;

/**
 * Class for PHPUnit tests
 *
 * @backupGlobals disabled
 * @backupStaticAttributes enabled
 * @remarks	backupGlobals must be disabled to have db,conf,user and lang not erased.
 */
class ReceptionTest extends PHPUnit\Framework\TestCase
{
	protected $savconf;
	protected $savuser;
	protected $savlangs;
	protected $savdb;

	/**
	 * Constructor
	 * We save global variables into local variables
	 *
	 * @param 	string	$name		Name
	 * @return SocieteTest
	 */
	public function __construct($name = '')
	{
		parent::__construct($name);

		//$this->sharedFixture
		global $conf,$user,$langs,$db;
		$this->savconf=$conf;
		$this->savuser=$user;
		$this->savlangs=$langs;
		$this->savdb=$db;

		print __METHOD__." db->type=".$db->type." user->id=".$user->id;
		//print " - db ".$db->db;
		print "\n";
	}

	/**
	 * setUpBeforeClass
	 *
	 * @return void
	 */
	public static function setUpBeforeClass(): void
	{
		global $conf,$user,$langs,$db;

		$db->begin();	// This is to have all actions inside a transaction even if test launched without suite.

		print __METHOD__."\n";
	}

	/**
	 * tearDownAfterClass
	 *
	 * @return	void
	 */
	public static function tearDownAfterClass(): void
	{
		global $conf,$user,$langs,$db;
		$db->rollback();

		print __METHOD__."\n";
	}

	/**
	 * Init phpunit tests
	 *
	 * @return	void
	 */
	protected function setUp(): void
	{
		global $conf,$user,$langs,$db;
		$conf=$this->savconf;
		$user=$this->savuser;
		$langs=$this->savlangs;
		$db=$this->savdb;

		print __METHOD__."\n";
	}

	/**
	 * End phpunit tests
	 *
	 * @return  void
	 */
	protected function tearDown(): void
	{
		print __METHOD__."\n";
	}

	/**
	 * testSocieteCreate
	 *
	 * @return int
	 */
	public function testReceptionCreate()
	{
		global $conf,$user,$langs,$db;
		$conf=$this->savconf;
		$user=$this->savuser;
		$langs=$this->savlangs;
		$db=$this->savdb;

		$soc = new Societe($db);
		$soc->name = "ReceptionTest Unittest";
		$soc_id = $soc->create($user);
		$this->assertLessThanOrEqual($soc_id, 0,
			"Cannot create Societe object: ".
			$soc->errorsToString()
		);

		$localobject = new Reception($db);
		$localobject->socid = $soc_id;
		$result = $localobject->create($user);
		$this->assertLessThanOrEqual($result, 0, "Cannot create Reception object:\n".
									 $localobject->errorsToString());
		return $result;
	}

	/**
	 * testReceptionFetch
	 *
	 * Check that a Reception object can be fetched from database.
	 *
	 * @param $id The id of an existing Reception object to fetch.
	 *
	 * @depends testReceptionCreate
	 * @return Reception $localobject
	 */
	public function testReceptionFetch($id)
	{
		global $db;

		$localobject = new Reception($db);
		$result = $localobject->fetch($id);
		print __METHOD__." id=".$id." result=".$result."\n";
		$this->assertLessThan($result, 0);

		return $localobject;
	}

	/**
	 * testReceptionUpdate
	 *
	 * Check that a Reception object can be updated.
	 *
	 * @param $localobject An existing Reception object to update.
	 *
	 * @depends testReceptionFetch
	 * @return Reception a Reception object with data fetched and name changed
	 */
	public function testReceptionUpdate($localobject)
	{
		global $user;

		$localobject->name = "foobar";

		$result = $localobject->update($localobject->id, $user);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThan($result, 0, $localobject->errorsToString());

		return $localobject;
	}

	/**
	 * testReceptionValid
	 *
	 * Check that a Reception with status == Reception::STATUS_DRAFT can be
	 * re-opened with the Reception::reOpen() function.
	 *
	 * @param $localobject An existing Reception object to validate.
	 *
	 * @depends testReceptionUpdate
	 * @return Reception a Reception object with data fetched and STATUS_VALIDATED
	 */
	public function testReceptionValid($localobject)
	{
		global $db, $user, $conf;

		$conf->global->MAIN_USE_ADVANCED_PERMS = '';
		$user->rights->reception = new stdClass;
		$user->rights->reception->creer = 1;

		$result = $user->fetch($user->id);
		$this->assertLessThan($result, 0, $user->errorsToString());

		$result = $localobject->fetch($localobject->id);
		$this->assertLessThan($result, 0, $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_DRAFT, $localobject->statut);
		$this->assertEquals(Reception::STATUS_DRAFT, $localobject->status);

		$result = $localobject->valid($user);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThan($result, 0, $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->status);

		$obj = new Reception($db);
		$obj->fetch($localobject->id);
		$this->assertEquals(Reception::STATUS_VALIDATED, $obj->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $obj->status);
		return $obj;
	}

	/**
	 * testReceptionSetClosed
	 *
	 * Check that a Reception can be closed with the Reception::setClosed()
	 * function, after it has been validated.
	 *
	 * @param $localobject An existing validated Reception object to close.
	 *
	 * @depends testReceptionValid
	 * @return Reception a Reception object with data fetched and STATUS_CLOSED
	 */
	public function testReceptionSetClosed($localobject)
	{
		global $db, $user;

		$result = $localobject->fetch($localobject->id);
		$this->assertLessThanOrEqual($result, 0, "Cannot fetch Reception object:\n".
									 $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->status);

		$result = $localobject->setClosed($user);
		$this->assertLessThanOrEqual($result, 0, "Cannot close Reception object:\n".
									 $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_CLOSED, $localobject->status,
							"Checking that \$localobject->status is STATUS_CLOSED");
		$this->assertEquals(Reception::STATUS_CLOSED, $localobject->statut,
							"Checking that \$localobject->statut is STATUS_CLOSED");

		$obj = new Reception($db);
		$result = $obj->fetch($localobject->id);
		$this->assertLessThanOrEqual($result, 0, "Cannot fetch Reception object:\n".
									 $obj->errorsToString());
		$this->assertEquals(Reception::STATUS_CLOSED, $obj->status,
							"Checking that \$obj->status is STATUS_CLOSED");
		$this->assertEquals(Reception::STATUS_CLOSED, $obj->statut,
							"Checking that \$obj->statut is STATUS_CLOSED");

		return $obj;
	}

	/**
	 * testReceptionReOpen
	 *
	 * Check that a Reception with status == Reception::STATUS_CLOSED can be
	 * re-opened with the Reception::reOpen() function.
	 *
	 * @param $localobject An existing closed Reception object to re-open.
	 *
	 * @depends testReceptionSetClosed
	 * @return Reception a Reception object with data fetched and STATUS_VALIDATED
	 */
	public function testReceptionReOpen($localobject)
	{
		global $db;

		$result = $localobject->fetch($localobject->id);
		$this->assertLessThanOrEqual($result, 0, "Cannot fetch Reception object:\n".
									 $localobject->errorsToString());

		$this->assertEquals(Reception::STATUS_CLOSED, $localobject->status);
		$this->assertEquals(Reception::STATUS_CLOSED, $localobject->statut);

		$result = $localobject->reOpen();
		$this->assertLessThanOrEqual($result, 0, "Cannot reOpen Reception object:\n".
									 $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->status);

		$obj = new Reception($db);
		$obj->fetch($localobject->id);
		$this->assertEquals(Reception::STATUS_VALIDATED, $obj->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $obj->status);

		return $obj;
	}

	/**
	 * testReceptionSetDraft
	 *
	 * Check that a Reception with status == Reception::STATUS_CLOSED can be
	 * re-opened with the Reception::reOpen() function.
	 *
	 * @param $localobject An existing validated Reception object to mark as Draft.
	 *
	 * @depends testReceptionReOpen
	 * @return Reception a Reception object with data fetched and STATUS_DRAFT
	 */
	public function testReceptionSetDraft($localobject)
	{
		global $db, $user, $conf;

		//$conf->global->MAIN_USE_ADVANCED_PERMS = 1;
		//$user->rights->reception->creer = 1;
		//$user->rights->reception_advance->validate = 1;

		$result = $localobject->fetch($localobject->id);
		$this->assertLessThan($result, 0);
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->statut);
		$this->assertEquals(Reception::STATUS_VALIDATED, $localobject->status);

		$result = $localobject->setDraft($user);
		$this->assertLessThanOrEqual($result, 0, "Cannot setDraft on Reception object:\n".
									 $localobject->errorsToString());
		$this->assertEquals(Reception::STATUS_DRAFT, $localobject->statut);
		$this->assertEquals(Reception::STATUS_DRAFT, $localobject->status);

		$obj = new Reception($db);
		$obj->fetch($localobject->id);
		$this->assertEquals(Reception::STATUS_DRAFT, $obj->statut);
		$this->assertEquals(Reception::STATUS_DRAFT, $obj->status);

		return $obj;
	}

	/**
	 * testReceptionMergeCompanies
	 *
	 * Check that a Reception referencing a Societe object being merged into
	 * another is correctly migrated to use the new Societe object.
	 *
	 * @param $localobject An existing validated Reception object to mark as Draft.
	 *
	 * @depends testReceptionSetDraft
	 * @return Reception a Reception object with data fetched
	 */
	public function testReceptionMergeCompanies($localobject)
	{
		global $db, $user;
		$soc2 = new Societe($db);
		$soc2->name = "Test reception";
		$soc2_id = $soc2->create($user);
		$this->assertLessThanOrEqual($soc2_id, 0, "Cannot create second Societe object:\n".
									 $soc2->errorsToString());

		$result = $soc2->mergeCompany($localobject->id);
		$this->assertLessThanOrEqual($result, 0, "Cannot merge Societe object:\n".
									 $soc2->errorsToString());

		print __METHOD__." result=".$result."\n";
		$this->assertLessThanOrEqual($result, 0);

		return $result;
	}

	/**
	 * testReceptionDelete
	 *
	 * Check that a Reception object can be deleted.
	 *
	 * @param $localobject An existing Reception object to delete.
	 *
	 * @depends testReceptionReOpen
	 * @return int the result of the delete operation
	 */
	public function testReceptionDelete($localobject)
	{
		global $db, $user;

		$result = $localobject->delete($user);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThanOrEqual($result, 0);

		$soc = new Societe($db);
		$result = $soc->delete($localobject->socid);
		$this->assertLessThanOrEqual($result, 0);

		return $result;
	}
}