dolibarr/test/phpunit/ContactTest.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/ContactTest.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/contact/class/contact.class.php';
$langs->load("dict");

if ($langs->defaultlang != 'en_US') {
	print "Error: Default language for company to run tests must be set to en_US or auto. Current is ".$langs->defaultlang."\n";
	exit(1);
}

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 ContactTest 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 ContactTest
	 */
	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";
	}

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

		$localobject=new Contact($db);
		$localobject->initAsSpecimen();
		$result=$localobject->create($user);

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

		return $result;
	}

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

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

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

		return $localobject;
	}

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

		$localobject->oldcopy = clone $localobject;

		$localobject->note_private='New private note after update';
		$localobject->note_public='New public note after update';
		$localobject->lastname='New name';
		$localobject->firstname='New firstname';
		$localobject->address='New address';
		$localobject->zip='New zip';
		$localobject->town='New town';
		$localobject->country_id=2;
		//$localobject->status=0;
		$localobject->phone_pro='New tel pro';
		$localobject->phone_perso='New tel perso';
		$localobject->phone_mobile='New tel mobile';
		$localobject->fax='New fax';
		$localobject->email='newemail@newemail.com';
		$localobject->socialnetworks['jabber']='New im id';
		$localobject->default_lang='es_ES';

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

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

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

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

		print __METHOD__." old=".$localobject->note_private." new=".$newobject->note_private."\n";
		$this->assertEquals($localobject->note_private, $newobject->note_private);
		//print __METHOD__." old=".$localobject->note_public." new=".$newobject->note_public."\n";
		//$this->assertEquals($localobject->note_public, $newobject->note_public);
		print __METHOD__." old=".$localobject->lastname." new=".$newobject->lastname."\n";
		$this->assertEquals($localobject->lastname, $newobject->lastname);
		print __METHOD__." old=".$localobject->firstname." new=".$newobject->firstname."\n";
		$this->assertEquals($localobject->firstname, $newobject->firstname);
		print __METHOD__." old=".$localobject->address." new=".$newobject->address."\n";
		$this->assertEquals($localobject->address, $newobject->address);
		print __METHOD__." old=".$localobject->zip." new=".$newobject->zip."\n";
		$this->assertEquals($localobject->zip, $newobject->zip);
		print __METHOD__." old=".$localobject->town." new=".$newobject->town."\n";
		$this->assertEquals($localobject->town, $newobject->town);
		print __METHOD__." old=".$localobject->country_id." new=".$newobject->country_id."\n";
		$this->assertEquals($localobject->country_id, $newobject->country_id);
		print __METHOD__." old=BE new=".$newobject->country_code."\n";
		$this->assertEquals('BE', $newobject->country_code);
		//print __METHOD__." old=".$localobject->status." new=".$newobject->status."\n";
		//$this->assertEquals($localobject->status, $newobject->status);
		print __METHOD__." old=".$localobject->phone_pro." new=".$newobject->phone_pro."\n";
		$this->assertEquals($localobject->phone_pro, $newobject->phone_pro);
		print __METHOD__." old=".$localobject->phone_pro." new=".$newobject->phone_pro."\n";
		$this->assertEquals($localobject->phone_perso, $newobject->phone_perso);
		print __METHOD__." old=".$localobject->phone_mobile." new=".$newobject->phone_mobile."\n";
		$this->assertEquals($localobject->phone_mobile, $newobject->phone_mobile);
		print __METHOD__." old=".$localobject->fax." new=".$newobject->fax."\n";
		$this->assertEquals($localobject->fax, $newobject->fax);
		print __METHOD__." old=".$localobject->email." new=".$newobject->email."\n";
		$this->assertEquals($localobject->email, $newobject->email);
		print __METHOD__." old=".$localobject->socialnetworks['jabber']." new=".$newobject->socialnetworks['jabber']."\n";
		$this->assertEquals($localobject->socialnetworks['jabber'], $newobject->socialnetworks['jabber']);
		print __METHOD__." old=".$localobject->default_lang." new=".$newobject->default_lang."\n";
		$this->assertEquals($localobject->default_lang, $newobject->default_lang);

		return $localobject;
	}

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

		//$localobject->fetch($localobject->id);

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

		$result=$localobject->getFullAddress(1);
		print __METHOD__." id=".$localobject->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew zip New town\nBelgium", $result);

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

		return $localobject->id;
	}

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

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

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

		return $result;
	}

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

		$localobjectadd=new Contact($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';
		$result=$localobjectadd->getFullAddress(1);
		print __METHOD__." id=".$localobjectadd->id." result=".$result."\n";
		$this->assertStringContainsString("New address\nNew town, New zip\nUnited States", $result);

		return $localobjectadd->id;
	}
}