dolibarr/test/phpunit/SocieteTest.php

<?php

/* Copyright (C) 2010 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) 2023 Alexandre Janniaux   <alexandre.janniaux@gmail.com>
 * Copyright (C) 2024       Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2025		MDW						<mdeweerd@users.noreply.github.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/SocieteTest.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/societe/class/societe.class.php';
require_once dirname(__FILE__).'/CommonClassTest.class.php';

$langs->load("dict");

if (empty($user->id)) {
	print "Load permissions for admin user nb 1\n";
	$user->fetch(1);
	$user->loadRights();
}
$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 SocieteTest extends CommonClassTest
{
	/**
	 * setUpBeforeClass
	 *
	 * @return void
	 */
	public static function setUpBeforeClass(): void
	{
		global $conf,$user,$langs,$db;

		if (getDolGlobalString('SOCIETE_CODECLIENT_ADDON') != 'mod_codeclient_monkey') {
			print "\n".__METHOD__." third party ref checker must be setup to 'mod_codeclient_monkey' not to '" . getDolGlobalString('SOCIETE_CODECLIENT_ADDON')."'.\n";
			die(1);
		}

		if (getDolGlobalString('MAIN_DISABLEPROFIDRULES')) {
			print "\n".__METHOD__." constant MAIN_DISABLEPROFIDRULES must be empty (if a module set it, disable module).\n";
			die(1);
		}

		if ($langs->defaultlang != 'en_US') {
			print "\n".__METHOD__." default language of company must be set to autodetect.\n";
			die(1);
		}

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

		print __METHOD__."\n";
	}

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

		$localobject = new Societe($db);
		$localobject->initAsSpecimen();

		$localobject->country_id = 0;
		$localobject->country_code = 'ES';

		$result = $localobject->create($user);

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

		return $result;
	}

	/**
	 * testSocieteFetch
	 *
	 * @param  int $id Company id
	 * @return Societe $localobject    Company
	 *
	 * @depends testSocieteCreate
	 * The depends says test is run only if previous is ok
	 */
	public function testSocieteFetch($id)
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

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

		$result = $localobject->verify();
		print __METHOD__." id=".$id." result=".$result."\n";
		$this->assertEquals($result, 0);

		return $localobject;
	}

	/**
	 * testSocieteUpdate
	 *
	 * @param  Societe $localobject Company
	 * @return Societe $localobject    Company
	 *
	 * @depends testSocieteFetch
	 * The depends says test is run only if previous is ok
	 */
	public function testSocieteUpdate($localobject)
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

		$localobject->note_private = 'New private note after update';
		$localobject->note_public = 'New public note after update';
		$localobject->name = 'New name';
		$localobject->address = 'New address';
		$localobject->zip = 'New zip';
		$localobject->town = 'New town';
		$localobject->country_id = 2;
		$localobject->status = 0;
		$localobject->phone = 'New tel';
		$localobject->fax = 'New fax';
		$localobject->email = 'newemail@newemail.com';
		$localobject->url = 'New url';
		$localobject->idprof1 = 'new idprof1';
		$localobject->idprof2 = 'new idprof2';
		$localobject->idprof3 = 'new idprof3';
		$localobject->idprof4 = 'new idprof4';

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

		$result = $localobject->update_note($localobject->note_private, '_private');
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThan($result, 0, 'Holiday::update_note (private) error');

		$result = $localobject->update_note($localobject->note_public, '_public');
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThan($result, 0, 'Holiday::update_note (public) error');

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

		$this->assertEquals($localobject->note_private, $newobject->note_private);
		//$this->assertEquals($localobject->note_public, $newobject->note_public);
		$this->assertEquals($localobject->name, $newobject->name);
		$this->assertEquals($localobject->address, $newobject->address);
		$this->assertEquals($localobject->zip, $newobject->zip);
		$this->assertEquals($localobject->town, $newobject->town);
		$this->assertEquals($localobject->country_id, $newobject->country_id);
		$this->assertEquals('BE', $newobject->country_code);
		$this->assertEquals($localobject->status, $newobject->status);
		$this->assertEquals($localobject->phone, $newobject->phone);
		$this->assertEquals($localobject->fax, $newobject->fax);
		$this->assertEquals($localobject->email, $newobject->email);
		$this->assertEquals($localobject->url, $newobject->url);
		$this->assertEquals($localobject->idprof1, $newobject->idprof1);
		$this->assertEquals($localobject->idprof2, $newobject->idprof2);
		$this->assertEquals($localobject->idprof3, $newobject->idprof3);
		$this->assertEquals($localobject->idprof4, $newobject->idprof4);

		return $localobject;
	}

	/**
	 * testIdProfCheck
	 *
	 * @param  Societe $localobject Company
	 * @return Societe $localobject    Company
	 *
	 * @depends testSocieteUpdate
	 * The depends says test is run only if previous is ok
	 */
	public function testIdProfCheck($localobject)
	{
		// OK FR
		$localobject->country_code = 'FR';
		$localobject->idprof1 = 493861496;
		$localobject->idprof2 = 49386149600021;
		$result = $localobject->id_prof_check(1);    // Must be > 0
		print __METHOD__." OK FR idprof1 result=".$result."\n";
		$this->assertGreaterThanOrEqual(1, $result);
		$result = $localobject->id_prof_check(2);    // Must be > 0
		print __METHOD__." OK FR idprof2 result=".$result."\n";
		$this->assertGreaterThanOrEqual(1, $result);

		// KO FR
		$localobject->country_code = 'FR';
		$localobject->idprof1 = 'id1ko';
		$localobject->idprof2 = 'id2ko';
		$result = $localobject->id_prof_check(1);    // Must be <= 0
		print __METHOD__." KO FR idprof1 result=".$result."\n";
		$this->assertLessThan(1, $result);
		$result = $localobject->id_prof_check(2);    // Must be <= 0
		print __METHOD__." KO FR idprof2 result=".$result."\n";
		$this->assertLessThan(1, $result);

		// KO ES
		$localobject->country_code = 'ES';
		$localobject->idprof1 = 'id1ko';
		$result = $localobject->id_prof_check(1);    // Must be <= 0
		print __METHOD__." KO ES idprof1 result=".$result."\n";
		$this->assertLessThan(1, $result);

		// OK AR
		$localobject->country_code = 'AR';
		$localobject->idprof1 = 'id1ko';
		$localobject->idprof2 = 'id2ko';
		$result = $localobject->id_prof_check(1);    // Must be > 0
		print __METHOD__." OK AR idprof1 result=".$result."\n";
		$this->assertGreaterThanOrEqual(0, $result);
		$result = $localobject->id_prof_check(2);    // Must be > 0
		print __METHOD__." OK AR idprof2 result=".$result."\n";
		$this->assertGreaterThanOrEqual(1, $result);

		return $localobject;
	}


	/**
	 * testSocieteOther
	 *
	 * @param  Societe $localobject Company
	 * @return int     $id             Id of company
	 *
	 * @depends testIdProfCheck
	 * The depends says test is run only if previous is ok
	 */
	public function testSocieteOther($localobject)
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

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

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

		$result = $localobject->set_remise_client(10, 'Gift', $user);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertLessThan($result, 0);

		$result = $localobject->getNomUrl(1);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertNotEquals($result, '');

		$localobject->country_code = 'FR';

		$result = $localobject->isInEEC();
		print __METHOD__." id=".$localobject->id." country_code=".$localobject->country_code." result=".$result."\n";
		$this->assertTrue($result);

		$localobject->country_code = 'US';

		$result = $localobject->isInEEC();
		print __METHOD__." id=".$localobject->id." country_code=".$localobject->country_code." result=".$result."\n";
		$this->assertFalse($result);

		/*$localobject->country_code = 'GB';

		$result=$localobject->isInEEC();
		print __METHOD__." id=".$localobject->id." country_code=".$localobject->country_code." result=".$result."\n";
		$this->assertTrue($result);
		*/

		$localobject->info($localobject->id);
		print __METHOD__." localobject->date_creation=".$localobject->date_creation."\n";
		$this->assertNotEquals($localobject->date_creation, '');

		return $localobject->id;
	}


	/**
	 * testGetOutstandingBills
	 *
	 * @param  int $id Id of company
	 * @return int
	 *
	 * @depends testSocieteOther
	 * The depends says test is run only if previous is ok
	 */
	public function testGetOutstandingBills($id)
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

		$localobject = new Societe($db);
		$localobject->fetch($id);

		$result = $localobject->getOutstandingBills();

		print __METHOD__." id=".$id." result=".var_export($result, true)."\n";
		$this->assertTrue(array_key_exists('opened', $result), 'Result of getOutstandingBills failed');

		return $id;
	}


	/**
	 * testSocieteDelete
	 *
	 * @param  int $id Id of company
	 * @return int
	 *
	 * @depends testGetOutstandingBills
	 * The depends says test is run only if previous is ok
	 */
	public function testSocieteDelete($id)
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

		$localobject = new Societe($db);
		$result = $localobject->fetch($id);

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

		return $result;
	}


	/**
	 * testSocieteGetFullAddress
	 *
	 * @return int     $id             Id of company
	 */
	public function testSocieteGetFullAddress()
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

		$localobjectadd = new Societe($db);
		$localobjectadd->initAsSpecimen();

		// France
		unset($localobjectadd->country_code);
		$localobjectadd->country_id = 1;
		$localobjectadd->name = 'New name';
		$localobjectadd->address = 'New address';
		$localobjectadd->zip = 'New zip';
		$localobjectadd->town = 'New town';
		$result = $localobjectadd->getFullAddress(1);
		print __METHOD__." id=".$localobjectadd->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew zip New town\nFrance", $result);

		// Belgium
		unset($localobjectadd->country_code);
		$localobjectadd->country_id = 2;
		$localobjectadd->name = 'New name';
		$localobjectadd->address = 'New address';
		$localobjectadd->zip = 'New zip';
		$localobjectadd->town = 'New town';
		$result = $localobjectadd->getFullAddress(1);
		print __METHOD__." id=".$localobjectadd->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew zip New town\nBelgium", $result);

		// Switzerland
		unset($localobjectadd->country_code);
		$localobjectadd->country_id = 6;
		$localobjectadd->name = 'New name';
		$localobjectadd->address = 'New address';
		$localobjectadd->zip = 'New zip';
		$localobjectadd->town = 'New town';
		$result = $localobjectadd->getFullAddress(1);
		print __METHOD__." id=".$localobjectadd->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew zip New town\nSwitzerland", $result);

		// USA
		unset($localobjectadd->country_code);
		$localobjectadd->country_id = 11;
		$localobjectadd->name = 'New name';
		$localobjectadd->address = 'New address';
		$localobjectadd->zip = 'New zip';
		$localobjectadd->town = 'New town';
		$localobjectadd->state = 'New state';
		$result = $localobjectadd->getFullAddress(1);
		print __METHOD__." id=".$localobjectadd->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew town, New state, New zip\nUnited States", $result);

		return $localobjectadd->id;
	}

	/**
	 * testSocieteMerge
	 *
	 * Check that we can merge two companies together. In this test,
	 * no other object is referencing the companies.
	 *
	 * @return int the result of the merge and fetch operation
	 */
	public function testSocieteMerge()
	{
		global $user, $db;

		$soc1 = new Societe($db);
		$soc1->initAsSpecimen();
		$soc1_id = $soc1->create($user);
		$this->assertLessThanOrEqual($soc1_id, 0);

		$soc2 = new Societe($db);
		$soc2->entity = 1;
		$soc2->name = "Copy of ".$soc1->name;
		$soc2->code_client = 'CC-0002';
		$soc2->code_fournisseur = 'SC-0002';
		$soc2_id = $soc2->create($user);
		$this->assertLessThanOrEqual($soc2_id, 0, implode('\n', $soc2->errors));

		$result = $soc1->mergeCompany($soc2_id);
		$this->assertLessThanOrEqual($result, 0, implode('\n', $soc1->errors));

		$result = $soc1->fetch($soc1_id);
		$this->assertLessThanOrEqual($result, 0);

		// Clean data for next tests
		$soc1->delete($soc1_id);
		$soc2->delete($soc2_id);

		print __METHOD__." result=".$result."\n";

		return $result;
	}

	/**
	 * testFindNearest
	 *
	 * @return int
	 */
	public function testSocieteFindNearest()
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;
		$localobject = new Societe($db);

		$soc1 = new Societe($db);
		$soc1->initAsSpecimen();
		$soc1->name = "Thirdparty Name Specimen";
		$soc1->barcode = "123456";
		$soc1->name_alias = "Thirdparty Name Specimen Alias";
		$soc1->code_client = -1;
		$soc1->code_fournisseur = -1;
		$soc1_id = $soc1->create($user);

		$result = $localobject->findNearest($soc1_id);
		$this->assertEquals($soc1_id, $result);

		// Test on bad values
		$result = $localobject->findNearest(0, 'Bad REF', 'Bad REF EXT', 'bad idprof1', 'bad idprof2', 'bad idprof3', 'bad idprof4', 'bad idprof5', 'bad idprof6', 'bad email', 'BAD REF ALIAS', 0, 0);
		$this->assertEquals(0, $result);

		// Test on good values
		$result = $localobject->findNearest(0, $soc1->name, $soc1->ref_ext, $soc1->barcode, $soc1->idprof1, $soc1->idprof2, $soc1->idprof3, $soc1->idprof4, $soc1->idprof5, $soc1->idprof6, $soc1->email, $soc1->name_alias, $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);

		// Test with Barcode
		$result = $localobject->findNearest(0, '', '', $soc1->barcode);
		$this->assertEquals($soc1_id, $result);

		// Test with profids
		$result = $localobject->findNearest(0, '', '', '', $soc1->idprof1, 'bad idprof2', 'bad idprof3', 'bad idprof4', 'bad idprof5', 'bad idprof6', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, '', '', '', 'bad idprof1', $soc1->idprof2, 'bad idprof3', 'bad idprof4', 'bad idprof5', 'bad idprof6', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, '', '', '', 'bad idprof1', 'bad idprof2', $soc1->idprof3, 'bad idprof4', 'bad idprof5', 'bad idprof6', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, '', '', '', 'bad idprof1', 'bad idprof2', 'bad idprof3', $soc1->idprof4, 'bad idprof5', 'bad idprof6', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, '', '', '', 'bad idprof1', 'bad idprof2', 'bad idprof3', 'bad idprof4', $soc1->idprof5, 'bad idprof6', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, '', '', '', 'bad idprof1', 'bad idprof2', 'bad idprof3', 'bad idprof4', 'bad idprof5', $soc1->idprof6, '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);

		// Test with email
		$result = $localobject->findNearest(0, '', '', '', '', '', '', '', '', '', $soc1->email, '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);

		// Test with refs
		$result = $localobject->findNearest(0, $soc1->name, 'Bad REF EXT', '', '', '', '', '', '', '', '', 'BAD REF ALIAS', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, 'Bad REF', $soc1->ref_ext, '', '', '', '', '', '', '', '', 'BAD REF ALIAS', $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);
		$result = $localobject->findNearest(0, 'Bad REF', 'Bad REF EXT', '', '', '', '', '', '', '', '', $soc1->name_alias, $soc1->client, $soc1->fournisseur);
		$this->assertEquals($soc1_id, $result);

		$soc2 = new Societe($db);
		$soc2->initAsSpecimen();
		$soc2->name = "Thirdparty Name Specimen";
		$soc2->code_client = -1;
		$soc2->code_fournisseur = -1;
		$soc2_id = $soc2->create($user);

		// Test on values not precise enough
		$result = $localobject->findNearest(0, 'Thirdparty Name Specimen', '', '', '', '', '', '', '', '', '', $soc1->client, $soc1->fournisseur);
		$this->assertEquals(-2, $result);

		// Clean data for next tests
		$soc1->delete($soc1_id);
		$soc2->delete($soc2_id);

		print __METHOD__." result=".$result."\n";
		return $result;
	}

	/**
	 * Test that Societe::setMysoc() always resolves country_code to an ISO country code.
	 *
	 * Regression test for issue #37826: when MAIN_INFO_SOCIETE_COUNTRY uses the legacy
	 * "id:label" (2-token) syntax, the second token is a country label (e.g. 'France'),
	 * not an ISO code. setMysoc() must not leave that label in country_code (it would break
	 * code-based lookups such as VAT rates and force a 0% rate), but rebuild it from the id.
	 *
	 * @return void
	 */
	public function testSetMysocCountryCode()
	{
		global $conf,$user,$langs,$db;
		$conf = $this->savconf;
		$user = $this->savuser;
		$langs = $this->savlangs;
		$db = $this->savdb;

		require_once dirname(__FILE__).'/../../htdocs/core/lib/company.lib.php';

		$frid = (int) getCountry('FR', '3', $db);
		$this->assertGreaterThan(0, $frid, 'Country FR must exist in dictionary c_country');

		$savcountryconst = getDolGlobalString('MAIN_INFO_SOCIETE_COUNTRY');

		// Canonical 3-token syntax "id:code:label".
		$conf->global->MAIN_INFO_SOCIETE_COUNTRY = $frid.':FR:France';
		$soc3 = new Societe($db);
		$soc3->setMysoc($conf);

		// Legacy 2-token syntax "id:label" (the #37826 case), second token is a label not a code.
		$conf->global->MAIN_INFO_SOCIETE_COUNTRY = $frid.':France';
		$soc2 = new Societe($db);
		$soc2->setMysoc($conf);

		// Restore the constant before asserting so a failure does not leak state to other tests.
		$conf->global->MAIN_INFO_SOCIETE_COUNTRY = $savcountryconst;

		$this->assertEquals('FR', $soc3->country_code, 'country_code must be the ISO code from a 3-token constant');
		$this->assertEquals($frid, $soc3->country_id);
		$this->assertEquals('FR', $soc2->country_code, 'country_code must be an ISO code, not a label, from a legacy 2-token constant (#37826)');
		$this->assertEquals($frid, $soc2->country_id);

		print __METHOD__." ok\n";
	}
}