jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/347618 )
Change subject: Initial commit
......................................................................
Initial commit
Move TestingAccessWrapper from MediaWiki into a separate library.
Code was taken from the following files in
MediaWiki commit 82d3ab93ad15a34089ab81a9a9d62ecd3d2e48ec:
- tests/phpunit/includes/TestingAccessWrapper.php
- tests/phpunit/includes/TestingAccessWrapperTest.php
- tests/phpunit/data/helpers/WellProtectedClass.php
Contributors to those files, per git shortlog:
2 Adam Roses Wight <awi...@wikimedia.org>
1 Brad Jorsch <bjor...@wikimedia.org>
1 Gergő Tisza <gti...@wikimedia.org>
Change-Id: I387dd09b9a1c995f2e535c0b112997f3a72d2126
Depends-On: I877ec9b988019d99c8a1734c3ec1b7e3f8684a47
---
A .editorconfig
A .gitattributes
A .gitignore
A .travis.yml
A Doxyfile
A LICENSE
A README.md
A composer.json
A phpcs.xml
A phpunit.xml.dist
A src/TestingAccessWrapper.php
A tests/TestingAccessWrapperTest.php
A tests/WellProtectedClass.php
A tests/WellProtectedParentClass.php
14 files changed, 872 insertions(+), 0 deletions(-)
Approvals:
jenkins-bot: Verified
Anomie: Looks good to me, approved
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..c2dfc46
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,6 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+indent_size = tab
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..b6fe658
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,10 @@
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitreview export-ignore
+.travis.yml export-ignore
+Doxyfile export-ignore
+composer.json export-ignore
+phpcs.xml export-ignore
+phpunit.xml.dist export-ignore
+tests/ export-ignore
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..10534bf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,11 @@
+# Editors
+*~
+.*.swp
+
+# Composer
+/vendor
+/composer.lock
+
+# Building and testing
+/doc
+/coverage
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..e52d774
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+sudo: false
+language: php
+php:
+ - "5.3"
+ - "5.4"
+ - "5.5"
+ - "5.6"
+ - "7.0"
+ - "hhvm"
+install:
+ - composer install
+script:
+ - composer test
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..45ca02a
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,27 @@
+# Doxyfile for testing-access-wrapper
+#
+# See <http://www.stack.nl/~dimitri/doxygen/manual/config.html>
+# for help on how to use this file to configure Doxygen.
+
+PROJECT_NAME = "testing-access-wrapper"
+PROJECT_BRIEF = "Simple unit test helper for accessing non-public
properties/methods."
+OUTPUT_DIRECTORY = doc
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = YES
+WARN_NO_PARAMDOC = YES
+INPUT = README.md src/
+FILE_PATTERNS = *.php
+RECURSIVE = YES
+USE_MDFILE_AS_MAINPAGE = README.md
+HTML_DYNAMIC_SECTIONS = YES
+GENERATE_TREEVIEW = YES
+TREEVIEW_WIDTH = 250
+GENERATE_LATEX = NO
+HAVE_DOT = YES
+DOT_FONTNAME = Helvetica
+DOT_FONTSIZE = 10
+TEMPLATE_RELATIONS = YES
+CALL_GRAPH = NO
+CALLER_GRAPH = NO
+DOT_MULTI_TARGETS = YES
+ALIASES += license="\par License:\n"
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..019694a
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,342 @@
+== GNU GENERAL PUBLIC LICENSE ==
+
+Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+=== Preamble ===
+
+The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+== TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION ==
+
+'''0.''' This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+'''1.''' You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+'''2.''' You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ '''a)''' You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ '''b)''' You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ '''c)''' If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+'''3.''' You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ '''a)''' Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ '''b)''' Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ '''c)''' Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+'''4.''' You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+'''5.''' You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+'''6.''' Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+'''7.''' If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+'''8.''' If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+'''9.''' The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+'''10.''' If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+=== NO WARRANTY ===
+
+'''11.''' BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+'''12.''' IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ '''END OF TERMS AND CONDITIONS'''
+
+== How to Apply These Terms to Your New Programs ==
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+
+ Copyright (C) <year> <name of author>
+
+ 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 2 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, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show
w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb9b0a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+[![Latest Stable
Version]](https://packagist.org/packages/wikimedia/testing-access-wrapper)
[![License]](https://packagist.org/packages/wikimedia/testing-access-wrapper)
+
+Wikimedia Testing Access Wrapper
+================================
+
+Testing Access Wrapper is a simple helper for writing unit tests which provides
+convenient shortcuts for using reflection to access non-public
properties/methods.
+
+The code was originally part of MediaWiki. See composer.json for a list of
authors.
+
+Usage
+-----
+
+```php
+use Wikimedia\TestingAccessWrapper;
+
+class NonPublic {
+ protected $prop;
+ protected function func() {}
+ protected static function staticFunc() {}
+}
+
+$object = new NonPublic();
+$wrapper = TestingAccessWrapper::newFromObject( $object );
+$classWrapper = TestingAccessWrapper::newFromClass( NonPublic::class );
+
+$wrapper->prop = 'foo';
+$wrapper->func();
+$classWrapper->staticFunc();
+```
+
+Running tests
+-------------
+
+ composer install
+ composer test
+
+
+---
+[Latest Stable Version]:
https://poser.pugx.org/wikimedia/testing-access-wrapper/v/stable.svg
+[License]: https://poser.pugx.org/wikimedia/testing-access-wrapper/license.svg
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000..765b359
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,50 @@
+{
+ "name": "wikimedia/testing-access-wrapper",
+ "description": "A simple helper class to access non-public elements of
a class when testing.",
+ "license": "GPL-2.0+",
+ "homepage": "https://www.mediawiki.org/wiki/Testing-access-wrapper";,
+ "authors": [
+ {
+ "name": "Adam Roses Wight",
+ "email": "awi...@wikimedia.org"
+ },
+ {
+ "name": "Brad Jorsch",
+ "email": "bjor...@wikimedia.org"
+ },
+ {
+ "name": "Gergő Tisza",
+ "email": "gti...@wikimedia.org"
+ }
+ ],
+ "autoload": {
+ "classmap": [
+ "src/"
+ ]
+ },
+ "autoload-dev": {
+ "classmap": [
+ "tests/"
+ ]
+ },
+ "require": {
+ "php": ">=5.3.0"
+ },
+ "require-dev": {
+ "jakub-onderka/php-parallel-lint": "0.9.2",
+ "mediawiki/mediawiki-codesniffer": "0.7.2",
+ "phpunit/phpunit": "4.8.31"
+ },
+ "scripts": {
+ "lint": "parallel-lint . --exclude vendor",
+ "phpcs": "phpcs -p -s",
+ "fix": "phpcbf",
+ "phpunit": "phpunit $PHPUNIT_ARGS",
+ "coverage": "phpunit --coverage-html coverage $PHPUNIT_ARGS",
+ "test": [
+ "composer lint",
+ "composer phpcs",
+ "composer phpunit"
+ ]
+ }
+}
diff --git a/phpcs.xml b/phpcs.xml
new file mode 100644
index 0000000..06c43bc
--- /dev/null
+++ b/phpcs.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset>
+ <rule ref="vendor/mediawiki/mediawiki-codesniffer/MediaWiki"/>
+ <file>.</file>
+ <arg name="encoding" value="UTF-8"/>
+ <arg name="extensions" value="php"/>
+ <exclude-pattern>coverage</exclude-pattern>
+ <exclude-pattern>vendor</exclude-pattern>
+ <exclude-pattern>doc/html</exclude-pattern>
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
new file mode 100644
index 0000000..c70d3d2
--- /dev/null
+++ b/phpunit.xml.dist
@@ -0,0 +1,14 @@
+<phpunit colors="true"
+ beStrictAboutTestsThatDoNotTestAnything="true"
+ beStrictAboutOutputDuringTests="true">
+ <testsuites>
+ <testsuite name="testing-access-wrapper tests">
+ <directory>./tests</directory>
+ </testsuite>
+ </testsuites>
+ <filter>
+ <whitelist addUncoveredFilesFromWhitelist="true">
+ <directory suffix=".php">./src</directory>
+ </whitelist>
+ </filter>
+</phpunit>
diff --git a/src/TestingAccessWrapper.php b/src/TestingAccessWrapper.php
new file mode 100644
index 0000000..762df77
--- /dev/null
+++ b/src/TestingAccessWrapper.php
@@ -0,0 +1,155 @@
+<?php
+
+namespace Wikimedia;
+
+use DomainException;
+use InvalidArgumentException;
+use ReflectionClass;
+use ReflectionException;
+use ReflectionMethod;
+use ReflectionProperty;
+
+/**
+ * Circumvent access restrictions on object internals
+ *
+ * This can be helpful for writing tests that can probe object internals,
+ * without having to modify the class under test to accomodate.
+ *
+ * Wrap an object with private methods as follows:
+ * $title = TestingAccessWrapper::newFromObject( Title::newFromDBkey( $key
) );
+ *
+ * You can access private and protected instance methods and variables:
+ * $formatter = $title->getTitleFormatter();
+ *
+ */
+class TestingAccessWrapper {
+ /** @var mixed The object, or the class name for static-only access */
+ public $object;
+
+ /**
+ * Return a proxy object which can be used the same way as the original,
+ * except that access restrictions can be ignored (protected and
private methods and properties
+ * are available for any caller).
+ * @param object $object
+ * @return TestingAccessWrapper
+ * @throws InvalidArgumentException
+ */
+ public static function newFromObject( $object ) {
+ if ( !is_object( $object ) ) {
+ throw new InvalidArgumentException( __METHOD__ . ' must
be called with an object' );
+ }
+ $wrapper = new TestingAccessWrapper();
+ $wrapper->object = $object;
+ return $wrapper;
+ }
+
+ /**
+ * Allow access to non-public static methods and properties of the
class.
+ * Returns an object whose methods/properties will correspond to the
+ * static methods/properties of the given class.
+ * @param string $className
+ * @return TestingAccessWrapper
+ * @throws InvalidArgumentException
+ */
+ public static function newFromClass( $className ) {
+ if ( !is_string( $className ) ) {
+ throw new InvalidArgumentException( __METHOD__ . ' must
be called with a class name' );
+ }
+ $wrapper = new TestingAccessWrapper();
+ $wrapper->object = $className;
+ return $wrapper;
+ }
+
+ public function __call( $method, $args ) {
+ $methodReflection = $this->getMethod( $method );
+
+ if ( $this->isStatic() && !$methodReflection->isStatic() ) {
+ throw new DomainException( __METHOD__
+ . ': Cannot call non-static method when
wrapping static class' );
+ }
+
+ return $methodReflection->invokeArgs(
$methodReflection->isStatic() ? null : $this->object,
+ $args );
+ }
+
+ public function __set( $name, $value ) {
+ $propertyReflection = $this->getProperty( $name );
+
+ if ( $this->isStatic() && !$propertyReflection->isStatic() ) {
+ throw new DomainException( __METHOD__
+ . ': Cannot set non-static property when
wrapping static class' );
+ }
+
+ $propertyReflection->setValue( $this->object, $value );
+ }
+
+ public function __get( $name ) {
+ $propertyReflection = $this->getProperty( $name );
+
+ if ( $this->isStatic() && !$propertyReflection->isStatic() ) {
+ throw new DomainException( __METHOD__
+ . ': Cannot get non-static property when
wrapping static class' );
+ }
+
+ return $propertyReflection->getValue( $this->object );
+ }
+
+ /**
+ * Tells whether this object was created for an object or a class.
+ * @return bool
+ */
+ private function isStatic() {
+ return is_string( $this->object );
+ }
+
+ /**
+ * Return a method and make it accessible.
+ * @param string $name
+ * @return ReflectionMethod
+ */
+ private function getMethod( $name ) {
+ $classReflection = new ReflectionClass( $this->object );
+ $methodReflection = $classReflection->getMethod( $name );
+ $methodReflection->setAccessible( true );
+ return $methodReflection;
+ }
+
+ /**
+ * Return a property and make it accessible.
+ *
+ * ReflectionClass::getProperty() fails if the private property is
defined
+ * in a parent class. This works more like ReflectionClass::getMethod().
+ *
+ * @param string $name
+ * @return ReflectionProperty
+ * @throws ReflectionException
+ */
+ private function getProperty( $name ) {
+ $classReflection = new ReflectionClass( $this->object );
+ try {
+ $propertyReflection = $classReflection->getProperty(
$name );
+ } catch ( ReflectionException $ex ) {
+ while ( true ) {
+ $classReflection =
$classReflection->getParentClass();
+ if ( !$classReflection ) {
+ throw $ex;
+ }
+ try {
+ $propertyReflection =
$classReflection->getProperty( $name );
+ } catch ( ReflectionException $ex2 ) {
+ continue;
+ }
+ if ( $propertyReflection->isPrivate() ) {
+ break;
+ } else {
+ // @codeCoverageIgnoreStart
+ throw $ex;
+ // @codeCoverageIgnoreEnd
+ }
+ }
+ }
+ $propertyReflection->setAccessible( true );
+ return $propertyReflection;
+ }
+}
+
diff --git a/tests/TestingAccessWrapperTest.php
b/tests/TestingAccessWrapperTest.php
new file mode 100644
index 0000000..d0e27c8
--- /dev/null
+++ b/tests/TestingAccessWrapperTest.php
@@ -0,0 +1,128 @@
+<?php
+
+namespace Wikimedia;
+
+class TestingAccessWrapperTest extends \PHPUnit_Framework_TestCase {
+ protected $raw;
+ protected $wrapped;
+ protected $wrappedStatic;
+
+ function setUp() {
+ parent::setUp();
+
+ $this->raw = new WellProtectedClass();
+ $this->wrapped = TestingAccessWrapper::newFromObject(
$this->raw );
+ $this->wrappedStatic = TestingAccessWrapper::newFromClass(
WellProtectedClass::class );
+ }
+
+ /**
+ * @expectedException \InvalidArgumentException
+ */
+ function testConstructorException() {
+ TestingAccessWrapper::newFromObject( WellProtectedClass::class
);
+ }
+
+ /**
+ * @expectedException \InvalidArgumentException
+ */
+ function testStaticConstructorException() {
+ TestingAccessWrapper::newFromClass( new WellProtectedClass() );
+ }
+
+ function testGetProperty() {
+ $this->assertSame( 1, $this->wrapped->property );
+ $this->assertSame( 42, $this->wrapped->privateProperty );
+ $this->assertSame( 9000, $this->wrapped->privateParentProperty
);
+ $this->assertSame( 'sp', $this->wrapped->staticProperty );
+ $this->assertSame( 'spp', $this->wrapped->staticPrivateProperty
);
+ $this->assertSame( 'sp', $this->wrappedStatic->staticProperty );
+ $this->assertSame( 'spp',
$this->wrappedStatic->staticPrivateProperty );
+ }
+
+ /**
+ * @expectedException \DomainException
+ */
+ function testGetException() {
+ $this->wrappedStatic->property;
+ }
+
+ function testSetProperty() {
+ $this->wrapped->property = 10;
+ $this->assertSame( 10, $this->wrapped->property );
+ $this->assertSame( 10, $this->raw->getProperty() );
+
+ $this->wrapped->privateProperty = 11;
+ $this->assertSame( 11, $this->wrapped->privateProperty );
+ $this->assertSame( 11, $this->raw->getPrivateProperty() );
+
+ $this->wrapped->privateParentProperty = 12;
+ $this->assertSame( 12, $this->wrapped->privateParentProperty );
+ $this->assertSame( 12, $this->raw->getPrivateParentProperty() );
+
+ $this->wrapped->staticProperty = 'x';
+ $this->assertSame( 'x', $this->wrapped->staticProperty );
+ $this->assertSame( 'x', $this->wrappedStatic->staticProperty );
+
+ $this->wrapped->staticPrivateProperty = 'y';
+ $this->assertSame( 'y', $this->wrapped->staticPrivateProperty );
+ $this->assertSame( 'y',
$this->wrappedStatic->staticPrivateProperty );
+
+ $this->wrappedStatic->staticProperty = 'X';
+ $this->assertSame( 'X', $this->wrapped->staticProperty );
+ $this->assertSame( 'X', $this->wrappedStatic->staticProperty );
+
+ $this->wrappedStatic->staticPrivateProperty = 'Y';
+ $this->assertSame( 'Y', $this->wrapped->staticPrivateProperty );
+ $this->assertSame( 'Y',
$this->wrappedStatic->staticPrivateProperty );
+
+ // don't rely on PHPUnit to restore static properties
+ $this->wrapped->staticProperty = 'sp';
+ $this->wrapped->staticPrivateProperty = 'spp';
+ }
+
+ /**
+ * @expectedException \DomainException
+ */
+ function testSetException() {
+ $this->wrappedStatic->property = 1;
+ }
+
+ /**
+ * @expectedException \ReflectionException
+ */
+ function testMissingPropertyException() {
+ $this->wrapped->missingProperty = 1;
+ }
+
+ function testCallMethod() {
+ $this->wrapped->incrementPropertyValue();
+ $this->assertSame( 2, $this->wrapped->property );
+ $this->assertSame( 2, $this->raw->getProperty() );
+
+ $this->wrapped->incrementPrivatePropertyValue();
+ $this->assertSame( 43, $this->wrapped->privateProperty );
+ $this->assertSame( 43, $this->raw->getPrivateProperty() );
+
+ $this->wrapped->incrementPrivateParentPropertyValue();
+ $this->assertSame( 9001, $this->wrapped->privateParentProperty
);
+ $this->assertSame( 9001, $this->raw->getPrivateParentProperty()
);
+
+ $this->assertSame( 'sm', $this->wrapped->staticMethod() );
+ $this->assertSame( 'spm', $this->wrapped->staticPrivateMethod()
);
+ $this->assertSame( 'sm', $this->wrappedStatic->staticMethod() );
+ $this->assertSame( 'spm',
$this->wrappedStatic->staticPrivateMethod() );
+ }
+
+ function testCallMethodTwoArgs() {
+ $this->assertSame( 'two', $this->wrapped->whatSecondArg( 'one',
'two' ) );
+ }
+
+ /**
+ * @expectedException \DomainException
+ */
+ function testCallMethodException() {
+ $this->wrappedStatic->incrementPropertyValue();
+ }
+
+}
+
diff --git a/tests/WellProtectedClass.php b/tests/WellProtectedClass.php
new file mode 100644
index 0000000..42e0a24
--- /dev/null
+++ b/tests/WellProtectedClass.php
@@ -0,0 +1,45 @@
+<?php
+
+namespace Wikimedia;
+
+class WellProtectedClass extends WellProtectedParentClass {
+ protected static $staticProperty = 'sp';
+ private static $staticPrivateProperty = 'spp';
+
+ protected $property;
+ private $privateProperty;
+
+ protected static function staticMethod() {
+ return 'sm';
+ }
+
+ private static function staticPrivateMethod() {
+ return 'spm';
+ }
+
+ public function __construct() {
+ parent::__construct();
+ $this->property = 1;
+ $this->privateProperty = 42;
+ }
+
+ protected function incrementPropertyValue() {
+ $this->property++;
+ }
+
+ private function incrementPrivatePropertyValue() {
+ $this->privateProperty++;
+ }
+
+ public function getProperty() {
+ return $this->property;
+ }
+
+ public function getPrivateProperty() {
+ return $this->privateProperty;
+ }
+
+ protected function whatSecondArg( $a, $b = false ) {
+ return $b;
+ }
+}
diff --git a/tests/WellProtectedParentClass.php
b/tests/WellProtectedParentClass.php
new file mode 100644
index 0000000..05f267e
--- /dev/null
+++ b/tests/WellProtectedParentClass.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace Wikimedia;
+
+class WellProtectedParentClass {
+ private $privateParentProperty;
+
+ public function __construct() {
+ $this->privateParentProperty = 9000;
+ }
+
+ private function incrementPrivateParentPropertyValue() {
+ $this->privateParentProperty++;
+ }
+
+ public function getPrivateParentProperty() {
+ return $this->privateParentProperty;
+ }
+}
+
--
To view, visit https://gerrit.wikimedia.org/r/347618
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I387dd09b9a1c995f2e535c0b112997f3a72d2126
Gerrit-PatchSet: 5
Gerrit-Project: testing-access-wrapper
Gerrit-Branch: master
Gerrit-Owner: Gergő Tisza <gti...@wikimedia.org>
Gerrit-Reviewer: Anomie <bjor...@wikimedia.org>
Gerrit-Reviewer: Bmansurov <bmansu...@wikimedia.org>
Gerrit-Reviewer: Gergő Tisza <gti...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
