dolibarr/test/phpunit/CoreTest.php

<?php
/* Copyright (C) 2010-2013 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/CoreTest.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';

if (! defined('NOREQUIREUSER')) {
	define('NOREQUIREUSER', '1');
}
if (! defined('NOREQUIREDB')) {
	define('NOREQUIREDB', '1');
}
if (! defined('NOREQUIRESOC')) {
	define('NOREQUIRESOC', '1');
}
if (! defined('NOREQUIRETRAN')) {
	define('NOREQUIRETRAN', '1');
}
if (! defined('NOCSRFCHECK')) {
	define('NOCSRFCHECK', '1');
}
if (! defined('NOTOKENRENEWAL')) {
	define('NOTOKENRENEWAL', '1');
}
if (! defined('NOREQUIREMENU')) {
	define('NOREQUIREMENU', '1'); // If there is no menu to show
}
if (! defined('NOREQUIREHTML')) {
	define('NOREQUIREHTML', '1'); // If we don't need to load the html.form.class.php
}
if (! defined('NOREQUIREAJAX')) {
	define('NOREQUIREAJAX', '1');
}
if (! defined("NOLOGIN")) {
	define("NOLOGIN", '1');       // If this page is public (can be called outside logged session)
}


/**
 * Class to test core functions
 *
 * @backupGlobals disabled
 * @backupStaticAttributes enabled
 * @remarks	backupGlobals must be disabled to have db,conf,user and lang not erased.
 */
class CoreTest 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 CoreTest
	 */
	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";
	}


	/**
	 * testDetectURLROOT
	 *
	 * @return	void
	 */
	public function testDetectURLROOT()
	{
		global $dolibarr_main_prod;

		global $dolibarr_main_url_root;
		global $dolibarr_main_data_root;
		global $dolibarr_main_document_root;
		global $dolibarr_main_data_root_alt;
		global $dolibarr_main_document_root_alt;
		global $dolibarr_main_db_host;
		global $dolibarr_main_db_port;
		global $dolibarr_main_db_type;
		global $dolibarr_main_db_prefix;

		$testtodo=0;

		// Case 1:
		// Test for subdir dolibarrnew (that point to htdocs) in root directory /var/www
		// URL: http://localhost/dolibarrnew/admin/system/phpinfo.php
		// To prepare this test:
		// - Create link from htdocs to /var/www/dolibarrnew
		// - Put into conf.php $dolibarr_main_document_root='/var/www/dolibarrnew';
		if ($testtodo == 1) {
			$_SERVER["HTTPS"]='';
			$_SERVER["SERVER_NAME"]='localhost';
			$_SERVER["SERVER_PORT"]='80';
			$_SERVER["DOCUMENT_ROOT"]='/var/www';
			$_SERVER["SCRIPT_NAME"]='/dolibarrnew/admin/system/phpinfo.php';
			$expectedresult='/dolibarrnew';
		}

		// Case 2:
		// Test for subdir aaa (that point to dolibarr) in root directory /var/www
		// URL: http://localhost/aaa/htdocs/admin/system/phpinfo.php
		// To prepare this test:
		// - Create link from dolibarr to /var/www/aaa
		// - Put into conf.php $dolibarr_main_document_root='/var/www/aaa/htdocs';
		if ($testtodo == 2) {
			$_SERVER["HTTPS"]='';
			$_SERVER["SERVER_NAME"]='localhost';
			$_SERVER["SERVER_PORT"]='80';
			$_SERVER["DOCUMENT_ROOT"]='/var/www';
			$_SERVER["SCRIPT_NAME"]='/aaa/htdocs/admin/system/phpinfo.php';
			$expectedresult='/aaa/htdocs';
		}

		// Case 3:
		// Test for virtual host localhostdolibarrnew that point to htdocs directory with
		// a direct document root
		// URL: http://localhostdolibarrnew/admin/system/phpinfo.php
		// To prepare this test:
		// - Create virtual host localhostdolibarrnew that point to /home/ldestailleur/git/dolibarr/htdocs
		// - Put into conf.php $dolibarr_main_document_root='/home/ldestailleur/git/dolibarr/htdocs';
		if ($testtodo == 3) {
			$_SERVER["HTTPS"]='';
			$_SERVER["SERVER_NAME"]='localhostdolibarrnew';
			$_SERVER["SERVER_PORT"]='80';
			$_SERVER["DOCUMENT_ROOT"]='/home/ldestailleur/git/dolibarr/htdocs';
			$_SERVER["SCRIPT_NAME"]='/admin/system/phpinfo.php';
			$expectedresult='';
		}

		// Case 4:
		// Test for virtual host localhostdolibarrnew that point to htdocs directory with
		// a symbolic link
		// URL: http://localhostdolibarrnew/admin/system/phpinfo.php
		if ($testtodo == 4) {
			$_SERVER["HTTPS"]='';
			$_SERVER["SERVER_NAME"]='localhostdolibarrnew';
			$_SERVER["SERVER_PORT"]='80';
			$_SERVER["DOCUMENT_ROOT"]='/var/www/dolibarr';	// This is a link that point to /home/ldestail/workspace/dolibarr/htdocs
			$_SERVER["SCRIPT_NAME"]='/admin/system/phpinfo.php';
			$expectedresult='';
		}

		// Case 5:
		// Test for alias /dolibarralias, Test when using nginx, Test when using lighttpd
		// URL: http://localhost/dolibarralias/admin/system/phpinfo.php
		// To prepare this test:
		// - Copy content of dolibarr project into /var/www/dolibarr
		// - Put into conf.php $dolibarr_main_document_root='/var/www/dolibarr/htdocs';
		// - Put into conf.php $dolibarr_main_url_root='http://localhost/dolibarralias';  (because autodetect will fails in this case)
		if ($testtodo == 5) {
			$_SERVER["HTTPS"]='';
			$_SERVER["SERVER_NAME"]='localhost';
			$_SERVER["SERVER_PORT"]='80';
			$_SERVER["DOCUMENT_ROOT"]='/var/www';
			$_SERVER["SCRIPT_NAME"]='/dolibarralias/admin/system/phpinfo.php';
			$expectedresult='/dolibarralias';
		}

		// Force to rerun filefunc.inc.php
		include dirname(__FILE__).'/../../htdocs/filefunc.inc.php';

		if ($testtodo != 0) {
			print __METHOD__." DOL_MAIN_URL_ROOT=".DOL_MAIN_URL_ROOT."\n";
			print __METHOD__." DOL_URL_ROOT=".DOL_URL_ROOT."\n";
			$this->assertEquals($expectedresult, DOL_URL_ROOT);
		}

		return true;
	}
}