Page MenuHomeIn-Portal Phabricator
Differential D494

INP-1863 - Correct PHPUnit integration
Needs ReviewPublic
Actions

Authored by alex on Fri, Nov 8, 1:11 PM.

Details

Reviewers
erik
Test Plan
IMPORTANT: Apply patch using arc patch D494 command, because the Phabricator-generated patch doesn't correctly display file moves, that have no content changes.

Preparations

  1. apply patch from the D496 and D495
  2. if you don't have Selenium Server installed, then install it using instructions from the Preparations section of the D451
  3. in IDE:
    • in the core/tests/Functional folder create CoreWorkflowTest.php file with this content:
<?php
class CoreWorkflowTest extends AbstractBrowserTestCase
{

    public function testSample()
    {
        $session = $this->getSession();

        $url = $this->Application->HREF('platform/login/register', '', array('no_amp' => 1));
        $session->visit($url);

        $this->assertTrue(true);
    }

}
  1. remove contents of the core/units/helpers/xml_helper.php and core/units/helpers/xml_helper5.php files
  2. in the "tools/build/targets/common.xml" file add these lines after <arg path="${phpunit.config.file}"/> line (4 places) <arg value="--testdox"/> line
  3. in the tools/run_event.php file comment out the exit_code(1, 'This script needs to be enabled manually !'); line
  4. in CLI:
    • run the composer install command, to actualize vendor folder content
    • run the phing -f tools/build/build_custom.xml db-dump command to create a dump
    • for each of the build-*.sql files created in the system directory:
      • remove the mysqldump: [Warning] Using a password on the command line interface can be insecure. line (if found)
      • save changes

Part 1 - the PHPUnit isn't used in the default build workflow

  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml build command
  3. confirm, by looking at the colorized output of the above command, that phpunit-ci or phpunit targets weren't called
  4. delete the "build" folder
  5. run the phing -f tools/build/build_custom.xml build command
  6. confirm, by looking at the colorized output of the above command, that phpunit-ci or phpunit targets weren't called

Part 2 - core test suite structure testing (via phpunit itself)

  1. run the vendor/bin/phpunit -c tools/build/inc/phpunit.xml --testdox command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...

CoreWorkflow
...

SampleWorkflow
...
  1. run the vendor/bin/phpunit -c tools/build/inc/phpunit.xml --testdox --testsuite Unit command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...
  1. run the vendor/bin/phpunit -c tools/build/inc/phpunit.xml --testdox --testsuite Functional command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

CoreWorkflow
...
SampleWorkflow
...

Part 3 - custom test suite structure testing (via phpunit itself)

  1. run the vendor/bin/phpunit -c tools/build/inc/custom_phpunit.xml --testdox command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

SampleUnit
...

SampleWorkflow
...
  1. run the vendor/bin/phpunit -c tools/build/inc/custom_phpunit.xml --testdox --testsuite Unit command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

SampleUnit
...
  1. run the vendor/bin/phpunit -c tools/build/inc/custom_phpunit.xml --testdox --testsuite Functional command
  2. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: .../tools/build/inc/phpunit.xml

SampleWorkflow
...

Part 4 - core test suite structure testing (via phing's "phpunit" task)

  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...

CoreWorkflow
...

SampleWorkflow
...
  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit -Dphpunit.testsuite=Unit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...
  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit -Dphpunit.testsuite=Functional command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

CoreWorkflow
...

SampleWorkflow
...

Part 5 - core test suite structure testing (via phing's "phpunit-ci" task)

  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit-ci command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...

CoreWorkflow
...

SampleWorkflow
...

Generating code coverage report in Clover XML format ... done
  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit-ci -Dphpunit.testsuite=Unit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

kFormatter
...

SampleUnit
...


Generating code coverage report in Clover XML format ... done
  1. delete the "build" folder
  2. run the phing -f tools/build/build_all.xml phpunit-ci -Dphpunit.testsuite=Functional command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/phpunit.xml

CoreWorkflow
...

SampleWorkflow
...


Generating code coverage report in Clover XML format ... done

Part 6 - custom test suite structure testing (via phing's "phpunit" task)

  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleUnit
...

SampleWorkflow
...
  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit -Dphpunit.testsuite=Unit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleUnit
...
  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit -Dphpunit.testsuite=Functional command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files doesn't exist
  4. confirm, by looking at the colorized output of the above command, that phpunit target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleWorkflow
...

Part 7 - custom test suite structure testing (via phing's "phpunit-ci" task)

  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit-ci command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleUnit
...

SampleWorkflow
...

Generating code coverage report in Clover XML format ... done
  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit-ci -Dphpunit.testsuite=Unit command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleUnit
...


Generating code coverage report in Clover XML format ... done
  1. delete the "build" folder
  2. run the phing -f tools/build/build_custom.xml phpunit-ci -Dphpunit.testsuite=Functional command
  3. confirm, that "build/logs/clover.xml" and "build/logs/junit.xml" files were created and they're not empty
  4. confirm, by looking at the colorized output of the above command, that phpunit-ci target was called
  5. confirm, that the output looks similar to this:
PHPUnit 5.7.27 by Sebastian Bergmann and contributors.

Runtime:       PHP 5.6.40 with Xdebug 2.5.5
Configuration: /mnt/UserData/home/alex/web/d/in-portal.52x/tools/build/inc/custom_phpunit.xml

SampleWorkflow
...


Generating code coverage report in Clover XML format ... done

Testing (part 8 - the "/system/mink_config.php" requirement)

  1. move the "mink_config.php" file away from the "/system" folder
  2. run the vendor/bin/phpunit -c tools/build/inc/phpunit.xml command
  3. confirm, that command now fails with "The Mink configuration file does not exist." message (via thrown exception)
  4. move the "mink_config.php" file back to "/system" folder

Diff Detail

Repository
rINP In-Portal
Branch
/in-portal/branches/5.2.x
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 1328
Build 1328: arc lint + arc unit

Event Timeline

alex created this revision.Fri, Nov 8, 1:11 PM
alex requested review of this revision.Fri, Nov 8, 1:11 PM
Harbormaster completed remote builds in B1325: Diff 1275.Fri, Nov 8, 1:11 PM
Harbormaster completed remote builds in B1325: Diff 1275.
alex updated this revision to Diff 1276.Fri, Nov 8, 1:20 PM
  1. Updating D494: INP-1863 - Correct PHPUnit integration #
  2. Enter a brief description of the changes included in this update.
  3. The first line is used as subject, next lines as comment. #
  4. Included changes:
  6. M composer.json
  7. M composer.lock
  8. M core/kernel/application.php
  9. V core/tests/AbstractTestCase.php to: core/tests/Unit/AbstractTestCase.php
  10. V core/tests/Unit/AbstractTestCase.php from: core/tests/AbstractTestCase.php
  11. V core/tests/Unit/kernel/utility/formatters/kFormatterTest.php from: core/tests/kernel/utility/formatters/kFormatterTest.php
  12. V core/tests/kernel/utility/formatters/kFormatterTest.php to: core/tests/Unit/kernel/utility/formatters/kFormatterTest.php
Harbormaster completed remote builds in B1326: Diff 1276.Fri, Nov 8, 1:20 PM
Harbormaster completed remote builds in B1326: Diff 1276.
alex updated this revision to Diff 1277.Fri, Nov 8, 1:33 PM

Included moved files, that were missing in original diff.

alex edited the test plan for this revision. (Show Details)Fri, Nov 8, 1:48 PM
alex updated this revision to Diff 1278.Sat, Nov 9, 8:51 AM

Same diff, but file moves in "modules/custom" folder are displayed correctly.

alex edited the test plan for this revision. (Show Details)Sat, Nov 9, 9:11 AM
alex edited the summary of this revision. (Show Details)Sat, Nov 9, 9:16 AM
alex edited the summary of this revision. (Show Details)

Non-obvious Phabricator Differential logic:

  • the arc patch command svn mv SVN command (file move) as svn cp (file copy) + svn rm (file removal) commands;
  • directory removal, where file move occurred, isn't marked as removed.
erik added a comment.Mon, Nov 11, 8:42 AM

Partially tested, tests from part 4 like "confirm, by looking at the colorized output of the above command, that phpunit target was called" - failed. No PHPunit output generated.

alex added a comment.Mon, Nov 11, 8:47 AM
In D494#10041, @erik wrote:

Partially tested, tests from part 4 like "confirm, by looking at the colorized output of the above command, that phpunit target was called" - failed. No PHPunit output generated.

@erik , was the build itself successful?

erik added a comment.Mon, Nov 11, 8:50 AM

No, build was not successful.

[phingcall] /home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:37:41: Task exited with code 1

BUILD FAILED
/home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:25:6: /home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:29:22: Execution of the target buildfile failed. Aborting.

Total time: 29.8418 seconds

alex edited the test plan for this revision. (Show Details)Mon, Nov 11, 11:20 AM
alex added a comment.Mon, Nov 11, 11:22 AM
In D494#10043, @erik wrote:

No, build was not successful.

[phingcall] /home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:37:41: Task exited with code 1

BUILD FAILED
/home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:25:6: /home/sites/dev/web/SVN/5.2.x/tools/build/targets/deploy.xml:29:22: Execution of the target buildfile failed. Aborting.

Total time: 29.8418 seconds

I've added this item to the Preparations part of the test plan:

5. in the `tools/run_event.php` file comment out the `exit_code(1, 'This script needs to be enabled manually !');` line

Now the build should be successful.

erik added a comment.Tue, Nov 12, 4:36 AM

Can't test because of different php version on VM.

erik added a comment.Tue, Nov 12, 10:21 AM

tested, each test command, containing build_all.xml or build_custom.xml leads to config.php change where HMAC key containing variable ($_CONFIG['Misc']['SecurityHmacKey']) disappears, and then build failed due [InvalidArgumentException] "The HMAC key is empty."

Image with typical console output is attached.

alex edited the test plan for this revision. (Show Details)Wed, Nov 13, 10:15 AM
alex edited the test plan for this revision. (Show Details)
alex edited the test plan for this revision. (Show Details)
alex added a comment.Sun, Nov 17, 10:56 AM
In D494#10047, @erik wrote:

tested, each test command, containing build_all.xml or build_custom.xml leads to config.php change where HMAC key containing variable ($_CONFIG['Misc']['SecurityHmacKey']) disappears, and then build failed due [InvalidArgumentException] "The HMAC key is empty."

Image with typical console output is attached.

@erik , the fix for this issue was done in the D495. Please test that differential revision alone & in combination with this differential revision. Then decide if changes are needed to either of the differential revisions mentioned.

alex edited the test plan for this revision. (Show Details)Wed, Nov 20, 5:50 AM
alex updated this revision to Diff 1293.Fri, Nov 22, 5:03 AM

Rebasing.

Revision Contents
Changeset List

DiffIDBaseDescriptionCreatedLintUnit
BaseBase
Diff 1127516816Fri, Nov 8, 1:11 PM
★
★
Diff 2127616818Fri, Nov 8, 1:20 PM
★
★
Diff 3127716818Included moved files, that were missing in original diff.Fri, Nov 8, 1:33 PM
★
★
Diff 4127816818Same diff, but file moves in "modules/custom" folder are displayed correctly.Sat, Nov 9, 8:51 AM
★
★
Diff 5129316821Rebasing.Fri, Nov 22, 5:03 AM
★
★

Diff 1278

View Options

composer.json

Loading...
View Options

composer.lock

Loading...
View Options

core/kernel/application.php

Loading...
View Options

core/tests/AbstractBrowserTestCase.php

Loading...
View Options

core/tests/AbstractTestCase.php

Loading...
View Options

core/tests/Functional/AbstractBrowserTestCase.php

Loading...
View Options

core/tests/Unit/AbstractTestCase.php

Loading...
View Options

core/tests/Unit/kernel/utility/formatters/kFormatterTest.php

Loading...
View Options

core/tests/kernel/utility/formatters/kFormatterTest.php

Loading...
View Options

modules/custom/tests/Functional/SampleWorkflowTest.php

Loading...
View Options

modules/custom/tests/PageObject/UserRegistrationPage.php

Loading...
View Options

modules/custom/tests/SampleUnitTest.php

Loading...
View Options

modules/custom/tests/SampleWorkflowTest.php

Loading...
View Options

modules/custom/tests/Unit/SampleUnitTest.php

Loading...
View Options

modules/custom/tests/pages/UserRegistrationPage.php

Loading...
View Options

modules/custom/tests/tests_config.php

Loading...
View Options

tools/build/build.properties.dist

Loading...
View Options

tools/build/build_all.xml

Loading...
View Options

tools/build/build_custom.xml

Loading...
View Options

tools/build/inc/custom_phpunit.xml

Loading...
View Options

tools/build/inc/phpunit.xml

Loading...
View Options

tools/build/targets/common.xml

Loading...
In-Portal CMS · In-Portal Community Pages · In-Portal Issue Tracker · In-Portal Repository Browser · Quality Assurance · In-Portal CI Server