dolibarr/test/phpunit/WebservicesInvoicesTest.php

<?php
/* Copyright (C) 2010 Laurent Destailleur  <eldy@users.sourceforge.net>
 * 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/WebservicesInvoicesTest.php
 *		\ingroup    test
 *      \brief      PHPUnit test
 *		\remarks	To run this script as CLI:  phpunit filename.php
 */

global $conf,$user,$langs,$db;
//define('TEST_DB_FORCE_TYPE','mysql');	// This is to force using mysql driver
//require_once 'PHPUnit/Autoload.php';
require_once dirname(__FILE__).'/../../htdocs/master.inc.php';
require_once dirname(__FILE__).'/../../htdocs/core/lib/date.lib.php';
require_once NUSOAP_PATH.'/nusoap.php';        // Include SOAP


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;

$conf->global->MAIN_UMASK='0666';


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

	private static $socid;

	protected $ns = 'http://www.dolibarr.org/ns/';

	protected $pass = 'admin';


	/**
	 * Constructor
	 * We save global variables into local variables
	 *
	 * @param 	string	$name		Name
	 * @return WebservicesInvoicesTest
	 */
	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;

		// Set the WebService URL
		$WS_DOL_URL = DOL_MAIN_URL_ROOT.'/webservices/server_invoice.php';
		print __METHOD__." create nusoap_client for URL=".$WS_DOL_URL."\n";
		$this->soapclient = new nusoap_client($WS_DOL_URL);
		if ($this->soapclient) {
			$this->soapclient->soap_defencoding='UTF-8';
			$this->soapclient->decodeUTF8(false);
		}

		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;

		$now = dol_now();

		// create a third_party, needed to create an invoice
		//
		// The third party is created in setUpBeforeClass() and not in the
		// constructor to avoid creating several objects (the constructor is
		// called for each test).
		//
		// The third party must be created before beginning the DB transaction
		// because there is a foreign key constraint between invoices and third
		// parties (tables: lx_facture and llx_societe) and with MySQL,
		// constraints are checked immediately, they are not deferred to
		// transaction commit. So if the invoice is created in the same
		// transaction than the third party, the FK constraint fails.
		// See this post for more detail: http://stackoverflow.com/a/5014744/5187108
		$societe=new Societe($db);
		$societe->ref='';
		$societe->name='name';
		$societe->ref_ext='ref-phpunit';
		$societe->status=1;
		$societe->client=1;
		$societe->code_client='CU0901-1234';
		$societe->code_fournisseur='SU0901-1234';
		$societe->fournisseur=0;
		$societe->date_creation=$now;
		$societe->tva_assuj=0;
		$societe->particulier=0;

		$societe->create($user);
		if (empty($societe->id)) {
			// Create failed, may be the thirdparty already exists, we fetch it
			$societe->fetch(0, 'name');
		}

		self::$socid = $societe->id;

		print __METHOD__." societe created or found with id=".$societe->id."\n";

		$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";
	}


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

		$WS_METHOD  = 'createInvoice';

		$body = array(
				"id" => null,
				"ref" => null,
				"ref_ext" => "ref-phpunit-2",
				"thirdparty_id" => self::$socid,
				"fk_user_author" => null,
				"fk_user_valid" => null,
				"date" => "2015-04-19 20:16:53",
				"date_due" => "",
				"date_creation" => "",
				"date_validation" => "",
				"date_modification" =>  "",
				"type" => "",
				"total_net" => "36.30",
				"total_vat" => "6.00",
				"total" => "42.30",
				"payment_mode_id" => 50,
				"note_private" => "Synchronised from Prestashop",
				"note_public" => "",
				"status" => "1",
				"close_code" => null ,
				"close_note" => null,
				"project_id" => null,
				"lines" => array(
					array("id" => null,
					"type" => 0,
					"desc" => "Horloge Vinyle Serge",
					"vat_rate" => 20,
					"qty" => 1,
					"unitprice" => "30.000000",
					"total_net" => "30.000000",
					"total_vat" => "6.00",
					"total" => "36.000000",
					"date_start" => "",
					"date_end" => "",
					"payment_mode_id" => "",
					"product_id" => "",
					"product_ref" => "",
					"product_label" => "",
					"product_desc" => "" ))
					);

		// Call the WebService method and store its result in $result.
		$authentication=array(
		'dolibarrkey'=>$conf->global->WEBSERVICES_KEY,
		'sourceapplication'=>'DEMO',
		'login'=>'admin',
		'password'=>$this->pass,
		'entity'=>'');

		// Test URL
		$result='';
		$parameters = array('authentication'=>$authentication,'invoice'=>$body);
		print __METHOD__." call method ".$WS_METHOD."\n";
		try {
			$result = $this->soapclient->call($WS_METHOD, $parameters, $this->ns, '');
		} catch (SoapFault $exception) {
			echo $exception;
			$result=0;
		}
		if (! $result || !empty($result['faultstring'])) {
			//var_dump($soapclient);
			print $this->soapclient->error_str;
			print "\n<br>\n";
			print $this->soapclient->request;
			print "\n<br>\n";
			print $this->soapclient->response;
			print "\n";
		}

		print __METHOD__." result=".$result['result']['result_code']." ".$result['result']['result_label']."\n";
		$this->assertEquals('OK', $result['result']['result_code']);
		$this->assertEquals('ref-phpunit-2', $result['ref_ext']);


		return $result;
	}

	/**
	 * testWSInvoicesGetInvoiceByRefExt
	 *
	 * Retrieve an invoice using ref_ext
	 * @depends testWSInvoicesCreateInvoice
	 *
	 * @param	array	$result		Invoice created by create method
	 * @return	array				Invoice
	 */
	public function testWSInvoicesGetInvoiceByRefExt($result)
	{
		global $conf,$user,$langs,$db;
		$conf=$this->savconf;
		$user=$this->savuser;
		$langs=$this->savlangs;
		$db=$this->savdb;

		$WS_METHOD  = 'getInvoice';

		// Call the WebService method and store its result in $result.
		$authentication=array(
		'dolibarrkey'=>$conf->global->WEBSERVICES_KEY,
		'sourceapplication'=>'DEMO',
		'login'=>'admin',
		'password'=>$this->pass,
		'entity'=>'');

		// Test URL
		$result='';
		$parameters = array('authentication'=>$authentication, 'id'=>null, 'ref'=>null, 'ref_ext'=>'ref-phpunit-2');
		print __METHOD__." call method ".$WS_METHOD."\n";
		try {
			$result = $this->soapclient->call($WS_METHOD, $parameters, $this->ns, '');
		} catch (SoapFault $exception) {
			echo $exception;
			$result=0;
		}
		if (! $result || !empty($result['faultstring'])) {
			print $this->soapclient->error_str;
			print "\n<br>\n";
			print $this->soapclient->request;
			print "\n<br>\n";
			print $this->soapclient->response;
			print "\n";
		}
		print __METHOD__." result=".$result['result']['result_code']."\n";
		$this->assertEquals('OK', $result['result']['result_code']);
		$this->assertEquals('ref-phpunit-2', $result['invoice']['ref_ext']);


		return $result;
	}

	/**
	 * testWSInvoicesUpdateInvoiceByRefExt
	 *
	 * Update an invoice using ref_ext
	 * @depends testWSInvoicesCreateInvoice
	 *
	 * @param	array	$result		invoice created by create method
	 * @return	array 				Invoice
	 */
	public function testWSInvoicesUpdateInvoiceByRefExt($result)
	{
		global $conf,$user,$langs,$db;
		$conf=$this->savconf;
		$user=$this->savuser;
		$langs=$this->savlangs;
		$db=$this->savdb;

		$WS_METHOD  = 'updateInvoice';

		// update status to 2
		$body = array(
			"id" => null,
			"ref" => null,
			"ref_ext" => "ref-phpunit-2",
			"thirdparty_id" => self::$socid,
			"fk_user_author" => null,
			"fk_user_valid" => null,
			"date" => "2015-04-19 20:16:53",
			"date_due" => "",
			"date_creation" => "",
			"date_validation" => "",
			"date_modification" =>  "",
			"type" => "",
			"total_net" => "36.30",
			"total_vat" => "6.00",
			"total" => "42.30",
			"payment_mode_id" => 50,
			"note_private" => "Synchronised from Prestashop",
			"note_public" => "",
			"status" => "2",
			"close_code" => null ,
			"close_note" => null,
			"project_id" => null,
			"lines"  => array(
				array(
				"id"  => null,
				"type" => 0,
				"desc" => "Horloge Vinyle Serge",
				"vat_rate" => 20,
				"qty" => "1",
				"unitprice" => "30.000000",
				"total_net" => "30.000000",
				"total_vat" => "6.00",
				"total" => "36.000000",
				"date_start" => "",
				"date_end" => "",
				"payment_mode_id" => "",
				"product_id" => "",
				"product_ref" => "",
				"product_label" => "",
				"product_desc" => "" ))
			);

		// Call the WebService method and store its result in $result.
		$authentication=array(
		'dolibarrkey'=>$conf->global->WEBSERVICES_KEY,
		'sourceapplication'=>'DEMO',
		'login'=>'admin',
		'password'=>$this->pass,
		'entity'=>'');

		// Test URL
		$result='';
		$parameters = array('authentication'=>$authentication,'invoice'=>$body);
		print __METHOD__." call method ".$WS_METHOD."\n";
		try {
			$result = $this->soapclient->call($WS_METHOD, $parameters, $this->ns, '');
		} catch (SoapFault $exception) {
			echo $exception;
			$result=0;
		}
		if (! $result || !empty($result['faultstring'])) {
			print 'Error: '.$this->soapclient->error_str;
			print "\n<br>\n";
			print $this->soapclient->request;
			print "\n<br>\n";
			print $this->soapclient->response;
			print "\n";
		}

		print __METHOD__." count(result)=".(is_array($result) ? count($result) : 0)."\n";
		print __METHOD__." result=".$result['result']['result_code'].$result['result']['result_label']."\n";
		$this->assertEquals('OK', $result['result']['result_code']);
		$this->assertEquals('ref-phpunit-2', $result['ref_ext']);

		return $result;
	}
}