Fix broken codeception tests #201

deathbird · 2019-04-02T08:47:43Z

Problem and/or solution

The previous commit introduced some changes that caused codeception
unit tests to break. This commit fixes this by introducing a new
service class Transifex_Live_Integration_WP_Services to wrap WP API
functionality. This refactoring enables mocking the WP API in the
tests.
Also a new test class, BaseTestCase, is introduced to cater for
different PHPUnit versions between production and development
environment.

How to test

Run unit tests locally by first downloading codeception in the plugin directory
and then executing:

export TEST_ENV='dev'
php codecept.phar run unit --debug

Manual testing of generated urls:
- From WP admin UI in a sample post add a block of HTML content that contains links that point to both local or external links.
- From WP admin UI create a new (Appearance > Menus) that contains both local and external links. Add the menu to some WP pages.
- Preview the above created links in the frontend selecting a translated language from the language selector.

Important note: The plugin does NOT support URL rewritting of partial
links (without a host part eg: '/test-page2')

Diontsoumas · 2019-04-02T09:01:13Z

includes/lib/transifex-live-integration-rewrite.php

@@ -40,6 +40,7 @@ public function __construct( $settings, $rewrite_options ) {
 		Plugin_Debug::logTrace();
 		include_once TRANSIFEX_LIVE_INTEGRATION_DIRECTORY_BASE . '/includes/common/transifex-live-integration-validators.php';
 		include_once TRANSIFEX_LIVE_INTEGRATION_DIRECTORY_BASE . '/includes/override/transifex-live-integration-generate-rewrite-rules.php';
+		include_once __DIR__ .'/transifex-live-integration-wp-services.php';


Why not TRANSIFEX_LIVE_INTEGRATION_DIRECTORY_BASE as above?

It's a mystery to me how when this class is included in tests it resolves TRANSIFEX_LIVE_INTEGRATION_DIRECTORY_BASE constant to its correct value :) . That's why I referenced the added include relatively via path. I agree with you that for uniformity reasons though it should use TRANSIFEX_LIVE_INTEGRATION_DIRECTORY_BASE as above.

Diontsoumas · 2019-04-02T09:02:39Z

includes/lib/transifex-live-integration-wp-services.php

+
+    /*
+	 * Wraps WP site_url().
+	 * @return string Site URL link with optional path appended.


Where is the optional path appended part in the code?

I just copied the docstring from the site_url() source code and this created the misunderstanding: https://core.trac.wordpress.org/browser/tags/5.1.1/src/wp-includes/link-template.php#L3141. For this I'll remove the @return line altogether.

Diontsoumas · 2019-04-02T09:03:39Z

includes/lib/transifex-live-integration-wp-services.php

+<?php
+
+/*
+ * Language rewrites


Language rewrites doesn't seem accurate for this class. Maybe add a couple of lines of what should be added here?

You're right it's not accurate, will remove. No need for extra description since we follow the convention 1 class per file and the class contains docstrings.

Diontsoumas · 2019-04-02T09:04:48Z

tests/unit/BaseTestCase.php

+ *   export TEST_ENV=<environment>
+ *   php codecept.phar run unit --debug
+ */
+$test_env = null !== getenv('TEST_ENV') ? getenv('TEST_ENV') : 'prod';


$test_env is probably not a good attribute name, especially if it can have the prod value. What about just $env?

Also, prod is the CI environment?

Actually 'prod' is just a placeholder that stands for: 'NOT development environment'. AFAIK the CI environment does not have a distinction of environment.

Diontsoumas · 2019-04-02T09:07:08Z

tests/unit/BaseTestCase.php

+$test_env = null !== getenv('TEST_ENV') ? getenv('TEST_ENV') : 'prod';
+
+if ($test_env !== 'dev') {
+	// php 5.6, production environment


By production environment I guess you mean the environment in the CI. Can you please rename it here?

Diontsoumas · 2019-04-02T09:08:52Z

tests/unit/BaseTestCase.php

+	class BaseTestCase extends \PHPUnit_Framework_TestCase {}
+} else {
+	// php 7+, dev environment
+	class BaseTestCase extends PHPunit\Framework\TestCase {}


This assumes that PHP 7+ is used for developing, which may not be always the case (for example if an engineer uses another docker-compose file with an older PHP version). I wonder if we can try / catch the error if the first TestCase class doesn't exist, then load the alternative one.

Bravo @Diontsoumas, excellent idea! In fact PHP has the function class_exists() just for that ;)

Diontsoumas · 2019-04-02T09:09:57Z

tests/unit/ReverseHardLinkTest.php

-			$result = Transifex_Live_Integration_Rewrite::reverse_hard_link(
+			// stub
+			$rewrite->wp_services = \Codeception\Stub::make(Transifex_Live_Integration_WP_Services::class, ['get_site_url' => $i['host']]);
+			$result = $rewrite->reverse_hard_link(
 							$i['lang'], $i['link'], $i['languages_map'], $i['souce_lang'], $i['pattern']
 			);

 //            eval(\Psy\sh());


Those two lines have comments, can we please delete them?

The previous commit introduced some changes that caused codeception unit tests to break. This commit fixes this by introducing a new service class Transifex_Live_Integration_WP_Services to wrap WP API functionality. This refactoring enables mocking the WP API in the tests. Also a new test class, BaseTestCase, is introduced to cater for different PHPUnit versions between production and development environment.

Diontsoumas suggested changes Apr 2, 2019

View reviewed changes

deathbird force-pushed the fix-broken-tests branch from 5113479 to baafb71 Compare April 2, 2019 10:55

deathbird force-pushed the fix-broken-tests branch from baafb71 to f895b64 Compare April 2, 2019 10:59

deathbird requested a review from Diontsoumas April 2, 2019 11:02

ThemisB mentioned this pull request Jun 1, 2020

Hreflang generator should respect http protocol #213

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix broken codeception tests #201

Fix broken codeception tests #201

deathbird commented Apr 2, 2019

Diontsoumas Apr 2, 2019

deathbird Apr 2, 2019

Diontsoumas Apr 2, 2019

deathbird Apr 2, 2019

Diontsoumas Apr 2, 2019

deathbird Apr 2, 2019

Diontsoumas Apr 2, 2019

Diontsoumas Apr 2, 2019

deathbird Apr 2, 2019

Diontsoumas Apr 2, 2019

Diontsoumas Apr 2, 2019

deathbird Apr 2, 2019

Diontsoumas Apr 2, 2019

Fix broken codeception tests #201

Are you sure you want to change the base?

Fix broken codeception tests #201

Conversation

deathbird commented Apr 2, 2019

Problem and/or solution

How to test

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment