Merge pull request #29152 from mdeweerd/test/compat/deprecations

Fix Tests for compatibility with deprecations
This commit is contained in:
Laurent Destailleur 2024-04-02 13:41:04 +02:00 committed by GitHub
commit d25ef761ad
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 132 additions and 139 deletions

View file

@ -2,6 +2,7 @@
/* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
* Copyright (C) 2016 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2020 Frédéric France <frederic.france@netlogic.fr>
* Copyright (C) 2024 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
@ -134,16 +135,41 @@ class DolibarrApi
*/
protected function _filterObjectProperties($object, $properties)
{
// phpcs:enable
// If properties is empty, we return all properties
if (empty($properties)) {
return $object;
}
// Else we filter properties
// Copy of exploded array for efficiency
$arr_properties = explode(',', $properties);
$magic_properties = array();
$real_properties = get_object_vars($object);
// Unsetting real properties may unset magic properties.
// We keep a copy of the requested magic properties
foreach ($arr_properties as $key) {
if (!array_key_exists($key, $real_properties)) {
// Not a real property,
// check if $key is a magic property (we want to keep '$obj->$key')
if (property_exists($object, $key) && isset($object->$key)) {
$magic_properties[$key] = $object->$key;
}
}
}
// Filter real properties (may indirectly unset magic properties)
foreach (get_object_vars($object) as $key => $value) {
if (!in_array($key, explode(',', $properties))) {
if (!in_array($key, $arr_properties)) {
unset($object->$key);
}
}
// Restore the magic properties
foreach ($magic_properties as $key => $value) {
$object->$key = $value;
}
return $object;
}

View file

@ -1367,6 +1367,41 @@ function dol_buildpath($path, $type = 0, $returnemptyifnotfound = 0)
return $res;
}
/**
* Get properties for an object - including magic properties when requested
*
* Only returns properties that exist
*
* @param object $obj Object to get properties from
* @param string[] $properties Optional list of properties to get.
* When empty, only gets public properties.
* @return array<string,mixed> Hash for retrieved values (key=name)
*/
function dol_get_object_properties($obj, $properties = [])
{
// Get real properties using get_object_vars() if $properties is empty
if (empty($properties)) {
return get_object_vars($obj);
}
$existingProperties = [];
$realProperties = get_object_vars($obj);
// Get the real or magic property values
foreach ($properties as $property) {
if (array_key_exists($property, $realProperties)) {
// Real property, add the value
$existingProperties[$property] = $obj->{$property};
} elseif (property_exists($obj, $property)) {
// Magic property
$existingProperties[$property] = $obj->{$property};
}
}
return $existingProperties;
}
/**
* Create a clone of instance of object (new instance with same value for each properties)
* With native = 0: Property that are reference are different memory area in the new object (full isolation clone). This means $this->db of new object may not be valid.

View file

@ -235,6 +235,69 @@ abstract class CommonClassTest extends TestCase
}
}
/**
* Call method, even if protected.
*
* @param object $obj Object on which to call method
* @param string $name Method to call
* @param array $args Arguments to provide in method call
* @return mixed Return value
*/
public static function callMethod($obj, $name, array $args = [])
{
$class = new \ReflectionClass($obj);
$method = $class->getMethod($name);
// If PHP is older then 8.1.0
if (PHP_VERSION_ID < 80100) {
$method->setAccessible(true);
}
return $method->invokeArgs($obj, $args);
}
/**
* Compare all public properties values of 2 objects
*
* @param Object $oA Object operand 1
* @param Object $oB Object operand 2
* @param boolean $ignoretype False will not report diff if type of value differs
* @param array $fieldstoignorearray Array of fields to ignore in diff
* @return array Array with differences
*/
public function objCompare($oA, $oB, $ignoretype = true, $fieldstoignorearray = array('id'))
{
$retAr = array();
if (get_class($oA) !== get_class($oB)) {
$retAr[] = "Supplied objects are not of same class.";
} else {
$oVarsA = get_object_vars($oA);
$oVarsB = get_object_vars($oB);
$aKeys = array_keys($oVarsA);
if (method_exists($oA, 'deprecatedProperties')) {
// Update exclusions
foreach (self::callMethod($oA, 'deprecatedProperties') as $deprecated => $new) {
if (in_array($deprecated, $fieldstoignorearray)) {
$fieldstoignorearray[] = $new;
}
}
}
foreach ($aKeys as $sKey) {
if (in_array($sKey, $fieldstoignorearray)) {
continue;
}
if (! $ignoretype && ($oVarsA[$sKey] !== $oVarsB[$sKey])) {
$retAr[] = get_class($oA).'::'.$sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : json_encode($oVarsA[$sKey])).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : json_encode($oVarsB[$sKey]));
}
if ($ignoretype && ($oVarsA[$sKey] != $oVarsB[$sKey])) {
$retAr[] = get_class($oA).'::'.$sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : json_encode($oVarsA[$sKey])).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : json_encode($oVarsB[$sKey]));
}
}
}
return $retAr;
}
/**
* Map deprecated module names to new module names
*/

View file

@ -1,6 +1,7 @@
<?php
/* Copyright (C) 2013 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2023 Alexandre Janniaux <alexandre.janniaux@gmail.com>
* Copyright (C) 2024 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
@ -117,38 +118,4 @@ class FactureRecTest extends CommonClassTest
$localobject->note_private = 'New note';
//$localobject->note='New note after update';
}
/**
* Compare all public properties values of 2 objects
*
* @param Object $oA Object operand 1
* @param Object $oB Object operand 2
* @param boolean $ignoretype False will not report diff if type of value differs
* @param array $fieldstoignorearray Array of fields to ignore in diff
* @return array Array with differences
*/
public function objCompare($oA, $oB, $ignoretype = true, $fieldstoignorearray = array('id'))
{
$retAr = array();
if (get_class($oA) !== get_class($oB)) {
$retAr[] = "Supplied objects are not of same class.";
} else {
$oVarsA = get_object_vars($oA);
$oVarsB = get_object_vars($oB);
$aKeys = array_keys($oVarsA);
foreach ($aKeys as $sKey) {
if (in_array($sKey, $fieldstoignorearray)) {
continue;
}
if (! $ignoretype && ($oVarsA[$sKey] !== $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
if ($ignoretype && ($oVarsA[$sKey] != $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
}
}
return $retAr;
}
}

View file

@ -2,6 +2,7 @@
/* Copyright (C) 2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2018 Frédéric France <frederic.france@netlogic.fr>
* Copyright (C) 2023 Alexandre Janniaux <alexandre.janniaux@gmail.com>
* Copyright (C) 2024 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
@ -155,7 +156,7 @@ class FactureTest extends CommonClassTest
$this->assertLessThan($result, 0);
// Test everything are still same than specimen
// Test everything is still the same as specimen
$newlocalobject = new Facture($db);
$newlocalobject->initAsSpecimen();
$this->changeProperties($newlocalobject);
@ -168,6 +169,7 @@ class FactureTest extends CommonClassTest
$localobject,
$newlocalobject,
true,
// Not comparing:
array(
'newref','oldref','id','lines','client','thirdparty','brouillon','user_creation_id','date_creation','date_validation','datem','date_modification',
'ref','statut','status','paye','specimen','ref','actiontypecode','actionmsg2','actionmsg','mode_reglement','cond_reglement',
@ -281,38 +283,4 @@ class FactureTest extends CommonClassTest
$localobject->note_private = 'New note';
//$localobject->note='New note after update';
}
/**
* Compare all public properties values of 2 objects
*
* @param Object $oA Object operand 1
* @param Object $oB Object operand 2
* @param boolean $ignoretype False will not report diff if type of value differs
* @param array $fieldstoignorearray Array of fields to ignore in diff
* @return array Array with differences
*/
public function objCompare($oA, $oB, $ignoretype = true, $fieldstoignorearray = array('id'))
{
$retAr = array();
if (get_class($oA) !== get_class($oB)) {
$retAr[] = "Supplied objects are not of same class.";
} else {
$oVarsA = get_object_vars($oA);
$oVarsB = get_object_vars($oB);
$aKeys = array_keys($oVarsA);
foreach ($aKeys as $sKey) {
if (in_array($sKey, $fieldstoignorearray)) {
continue;
}
if (! $ignoretype && ($oVarsA[$sKey] !== $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
if ($ignoretype && ($oVarsA[$sKey] != $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
}
}
return $retAr;
}
}

View file

@ -2,6 +2,7 @@
/* Copyright (C) 2010 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2018 Frédéric France <frederic.france@netlogic.fr>
* Copyright (C) 2023 Alexandre Janniaux <alexandre.janniaux@gmail.com>
* Copyright (C) 2024 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
@ -267,38 +268,4 @@ class InventoryTest extends CommonClassTest
return $result;
}
/**
* Compare all public properties values of 2 objects
*
* @param Object $oA Object operand 1
* @param Object $oB Object operand 2
* @param boolean $ignoretype False will not report diff if type of value differs
* @param array $fieldstoignorearray Array of fields to ignore in diff
* @return array Array with differences
*/
public function objCompare($oA, $oB, $ignoretype = true, $fieldstoignorearray = array('id'))
{
$retAr = array();
if (get_class($oA) !== get_class($oB)) {
$retAr[] = "Supplied objects are not of same class.";
} else {
$oVarsA = get_object_vars($oA);
$oVarsB = get_object_vars($oB);
$aKeys = array_keys($oVarsA);
foreach ($aKeys as $sKey) {
if (in_array($sKey, $fieldstoignorearray)) {
continue;
}
if (! $ignoretype && ($oVarsA[$sKey] !== $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
if ($ignoretype && ($oVarsA[$sKey] != $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
}
}
return $retAr;
}
}

View file

@ -1,6 +1,7 @@
<?php
/* Copyright (C) 2010-2015 Laurent Destailleur <eldy@users.sourceforge.net>
* Copyright (C) 2023 Alexandre Janniaux <alexandre.janniaux@gmail.com>
* Copyright (C) 2024 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
@ -403,38 +404,4 @@ class UserTest extends CommonClassTest
{
$localobject->note_private = 'New note after update';
}
/**
* Compare all public properties values of 2 objects
*
* @param Object $oA Object operand 1
* @param Object $oB Object operand 2
* @param boolean $ignoretype False will not report diff if type of value differs
* @param array $fieldstoignorearray Array of fields to ignore in diff
* @return array Array with differences
*/
public function objCompare($oA, $oB, $ignoretype = true, $fieldstoignorearray = array('id'))
{
$retAr = array();
if (get_class($oA) !== get_class($oB)) {
$retAr[] = "Supplied objects are not of same class.";
} else {
$oVarsA = get_object_vars($oA);
$oVarsB = get_object_vars($oB);
$aKeys = array_keys($oVarsA);
foreach ($aKeys as $sKey) {
if (in_array($sKey, $fieldstoignorearray)) {
continue;
}
if (! $ignoretype && ($oVarsA[$sKey] !== $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
if ($ignoretype && ($oVarsA[$sKey] != $oVarsB[$sKey])) {
$retAr[] = $sKey.' : '.(is_object($oVarsA[$sKey]) ? get_class($oVarsA[$sKey]) : $oVarsA[$sKey]).' <> '.(is_object($oVarsB[$sKey]) ? get_class($oVarsB[$sKey]) : $oVarsB[$sKey]);
}
}
}
return $retAr;
}
}