amOnPage('/wp-login.php'); if ($i->loadSessionSnapshot('login')) { return; } // remove any other WP auth & login cookies to avoid login/logout errors $authCookies = $i->grabCookiesWithPattern('/^wordpress_[a-z0-9]{32}$/') ?: []; $loginCookies = $i->grabCookiesWithPattern('/^wordpress_logged_in_[a-z0-9]{32}$/') ?: []; foreach (array_merge($authCookies, $loginCookies) as $cookie) { $i->resetCookie($cookie->getName()); } $i->wait(1);// this needs to be here, Username is not filled properly without this line $i->fillField('Username', 'admin'); $i->fillField('Password', 'password'); $i->click('Log In'); $i->waitForText('MailPoet', 10); $i->saveSessionSnapshot('login'); } /** * Define custom actions here */ public function logOut() { $i = $this; $i->amOnPage('/wp-login.php?action=logout'); $i->click('log out'); $i->waitForText('You are now logged out.'); $i->deleteSessionSnapshot('login'); } /** * Navigate to the specified Mailpoet page in the admin. * * @param string $page The page to visit e.g. Inbox or Status */ public function amOnMailpoetPage($page) { $i = $this; if ($page === 'Emails') { $path = 'newsletters'; } elseif ($page === 'Lists') { $path = 'segments'; } else { $path = strtolower($page); } $i->amOnPage("/wp-admin/admin.php?page=mailpoet-$path"); } /** * Navigate to Mailhog page and wait for angular to load */ public function amOnMailboxAppPage() { $i = $this; $i->amOnUrl(self::MAIL_URL); // ensure that angular is loaded by checking angular specific class $i->waitForElement('.messages.ng-scope'); } public function clickItemRowActionByItemName($itemName, $link) { $i = $this; $i->moveMouseOver(['xpath' => '//*[text()="' . $itemName . '"]//ancestor::tr']); $i->click($link, ['xpath' => '//*[text()="' . $itemName . '"]//ancestor::tr']); } /** * Select a value from select2 input field. * For multiple selection the element is textarea.select2-search__field (default), * for single selection specify the input.select2-search__field element. * * @param string $value * @param string $element */ public function selectOptionInSelect2($value, $element = 'textarea.select2-search__field') { $i = $this; $i->waitForElement($element); $i->fillField($element, $value); $optionsContainer = $i->grabAttributeFrom($element, 'aria-controls'); // Wait until the searched value is in select options. There might be some delay on API $i->waitForText($value, 5, "#$optionsContainer"); $i->pressKey($element, WebDriverKeys::ENTER); } /** * Check selected value in select2.. * * @param string $value * @param string $element */ public function seeSelectedInSelect2($value, $element = '.select2-container') { $i = $this; $i->waitForElement($element); $i->see($value, $element); } public function selectOptionInReactSelect($value, $selector) { $i = $this; $i->waitForElement($selector); $i->fillField($selector . ' input', $value); $i->pressKey($selector . ' input', WebDriverKeys::RETURN_KEY); } /** * Navigate to the editor for a newsletter. * * @param int $id */ public function amEditingNewsletter($id) { $i = $this; $i->amOnPage('/wp-admin/admin.php?page=mailpoet-newsletter-editor&id=' . $id); $i->waitForElement('[data-automation-id="newsletter_title"]'); $i->waitForElementNotVisible('.velocity-animating'); } public function createFormAndSubscribe($form = null) { $i = $this; // create form widget if (!$form) { $formFactory = new Form(); $form = $formFactory->withName('Confirmation Form')->create(); } $i->cli(['widget', 'reset', 'sidebar-1']); $i->cli(['widget', 'add', 'mailpoet_form', 'sidebar-1', '2', "--form=$form->id", '--title=Subscribe to Our Newsletter']); // subscribe /** @var SettingsController $settingsController */ $settingsController = ContainerWrapper::getInstance()->get(SettingsController::class); $i->amOnUrl(self::WP_URL); $i->fillField('[data-automation-id="form_email"]', 'subscriber@example.com'); $i->click('[data-automation-id="subscribe-submit-button"]'); $i->waitForText($settingsController->getDefaultSuccessMessage(), 30, '.mailpoet_validate_success'); $i->seeNoJSErrors(); } public function waitForListingItemsToLoad() { $i = $this; $i->waitForElementNotVisible('.mailpoet-listing-loading'); } public function waitForEmailSendingOrSent() { $i = $this; $i->waitForElement('.mailpoet-listing-status:not(.mailpoet-listing-status-unknown)', 30); } public function clickLabelWithInput($inputName, $inputValue) { $i = $this; $i->click("//*[name()='label'][.//*[name()='input'][@name='{$inputName}'][@value='{$inputValue}']]"); } public function clickToggleYes($yesNoCSSSelector) { $i = $this; $i->click($yesNoCSSSelector . ' .mailpoet-form-yesno-yes'); } public function clickToggleNo($yesNoCSSSelector) { $i = $this; $i->click($yesNoCSSSelector . ' .mailpoet-form-yesno-no'); } public function assertAttributeContains($selector, $attribute, $contains) { $i = $this; $attributeValue = $i->grabAttributeFrom($selector, $attribute); expect($attributeValue)->stringContainsString($contains); } public function assertAttributeNotContains($selector, $attribute, $notContains) { $i = $this; $attributeValue = $i->grabAttributeFrom($selector, $attribute); expect($attributeValue)->stringNotContainsString($notContains); } public function searchFor($query, $element = '#search_input') { $i = $this; $i->waitForElement($element); $i->waitForElementNotVisible(self::LISTING_LOADING_SELECTOR); $i->clearField($element); $i->fillField($element, $query); $i->pressKey($element, WebDriverKeys::ENTER); $i->waitForElementNotVisible(self::LISTING_LOADING_SELECTOR); } public function createListWithSubscriber() { $segmentFactory = new Segment(); $segmentName = 'List ' . \MailPoet\Util\Security::generateRandomString(); $segment = $segmentFactory->withName($segmentName)->create(); $subscriberFactory = new Subscriber(); $subscriberEmail = \MailPoet\Util\Security::generateRandomString() . '@domain.com'; $subscriberFirstName = 'John'; $subscriberLastName = 'Doe'; $subscriberFactory->withSegments([$segment]) ->withEmail($subscriberEmail) ->withFirstName($subscriberFirstName) ->withLastName($subscriberLastName) ->create(); return $segmentName; } public function switchToNextTab($offset = 1) { $this->_switchToNextTab($offset); // workaround for frozen tabs when opened by clicking on links $this->wait(1); } public function click($link, $context = null) { // retry click in case of "element click intercepted... Other element would receive the click" error $retries = 3; while (true) { try { $retries--; $this->_click($link, $context); break; } catch (UnrecognizedExceptionException $e) { if ($retries > 0 && strpos($e->getMessage(), 'element click intercepted') !== false) { continue; } throw $e; } } } /** * Override waitFor* methods to have a common default timeout */ public function waitForElement($element, $timeout = 10) { return $this->_waitForElement($element, $this->getDefaultTimeout($timeout)); } public function waitForElementChange($element, \Closure $callback, $timeout = 30) { return $this->_waitForElementChange($element, $callback, $this->getDefaultTimeout($timeout)); } public function waitForElementClickable($element, $timeout = 10) { return $this->_waitForElementClickable($element, $this->getDefaultTimeout($timeout)); } public function waitForElementNotVisible($element, $timeout = 10) { return $this->_waitForElementNotVisible($element, $this->getDefaultTimeout($timeout)); } public function waitForElementVisible($element, $timeout = 10) { return $this->_waitForElementVisible($element, $this->getDefaultTimeout($timeout)); } public function waitForJS($script, $timeout = 5) { return $this->_waitForJS($script, $this->getDefaultTimeout($timeout)); } public function waitForText($text, $timeout = 10, $selector = null) { return $this->_waitForText($text, $this->getDefaultTimeout($timeout), $selector); } public function scrollToTop() { return $this->scrollTo('#wpcontent'); } private function getDefaultTimeout($timeout) { return (int)getenv('WAIT_TIMEOUT') ?: $timeout; } public function activateWooCommerce() { $i = $this; $i->cli(['plugin', 'activate', self::WOO_COMMERCE_PLUGIN]); } public function deactivateWooCommerce() { $i = $this; $i->cli(['plugin', 'deactivate', self::WOO_COMMERCE_PLUGIN]); } public function activateWooCommerceSubscriptions() { $i = $this; $i->cli(['plugin', 'activate', self::WOO_COMMERCE_SUBSCRIPTIONS_PLUGIN]); } public function deactivateWooCommerceSubscriptions() { $i = $this; $i->cli(['plugin', 'deactivate', self::WOO_COMMERCE_SUBSCRIPTIONS_PLUGIN]); } /** * Order a product and create an account within the order process */ public function orderProduct(array $product, $userEmail, $doRegister = true, $doSubscribe = true) { $i = $this; $i->addProductToCart($product); $i->goToCheckout(); $i->fillCustomerInfo($userEmail); if ($doRegister) { $i->optInForRegistration(); } $i->selectPaymentMethod(); if ($doSubscribe) { $i->optInForSubscription(); } else { $i->optOutOfSubscription(); } $i->placeOrder(); if ($doRegister) { $i->logOut(); } } /** * WooCommerce ordering process methods, should be used sequentially */ /** * Add a product to cart */ public function addProductToCart(array $product) { $i = $this; $i->amOnPage('product/' . $product['slug']); $i->click('Add to cart'); $i->waitForText("“{$product['name']}” has been added to your cart."); } /** * Go to the checkout page */ public function goToCheckout() { $i = $this; $i->amOnPage('checkout'); } /** * Fill the customer info */ public function fillCustomerInfo($userEmail) { $i = $this; $i->fillField('billing_first_name', 'John'); $i->fillField('billing_last_name', 'Doe'); $i->fillField('billing_address_1', 'Address 1'); $i->fillField('billing_city', 'Paris'); $i->fillField('billing_email', $userEmail); $i->fillField('billing_postcode', '75000'); $i->fillField('billing_phone', '123456'); } /** * Check the option for creating an account */ public function optInForRegistration() { $i = $this; $i->scrollTo(['css' => '#createaccount'], 0, -40); $i->click('#createaccount'); } /** * Check the option for subscribing to the WC list */ public function optInForSubscription() { $i = $this; $checked = $i->executeJS('return document.getElementById("mailpoet_woocommerce_checkout_optin").checked'); if (!$checked) { $i->scrollTo(['css' => '[data-automation-id="woo-commerce-subscription-opt-in"]'], 0, -40); $i->waitForElementClickable('[data-automation-id="woo-commerce-subscription-opt-in"]'); $i->click('[data-automation-id="woo-commerce-subscription-opt-in"]'); } } /** * Uncheck the option for subscribing to the WC list */ public function optOutOfSubscription() { $i = $this; $checked = $i->executeJS('return document.getElementById("mailpoet_woocommerce_checkout_optin").checked'); if ($checked) { $i->scrollTo(['css' => '[data-automation-id="woo-commerce-subscription-opt-in"]'], 0, -40); $i->waitForElementClickable('[data-automation-id="woo-commerce-subscription-opt-in"]'); $i->click('[data-automation-id="woo-commerce-subscription-opt-in"]'); } } /** * Select a payment method (cheque, cod, ppec_paypal) */ public function selectPaymentMethod($method = 'cod') { $i = $this; // We need to scroll with some negative offset so that the input is not hidden above the top page fold $approximatePaymentMethodInputHeight = 40; $i->scrollTo('#payment_method_' . $method, 0, -$approximatePaymentMethodInputHeight); $i->waitForElementNotVisible('.blockOverlay', 30); // wait for payment method loading overlay to disappear $i->click('label[for="payment_method_' . $method . '"]'); } /** * Place the order */ public function placeOrder() { $i = $this; $i->waitForText('Place order'); $i->click('Place order'); $i->waitForText('Your order has been received'); } // Enforce WP-CLI to be called with array because: // - It's recommended now (https://github.com/lucatume/wp-browser/commit/6dbf93709194c630191c0c7de527b577105be743). // - It's default in Symfony\Process now. // - String variant is still buggy even after a fix (https://github.com/lucatume/wp-browser/commit/b078ef37917b4f0668d064ea950e4b41f1773cb6). public function cli(array $userCommand) { return $this->_cli($userCommand); } public function cliToArray(array $userCommand) { return $this->_cliToArray($userCommand); } public function cliToString(array $userCommand) { return $this->_cliToString($userCommand); } /** * Creates post and returns its URL */ public function createPost(string $title, string $body): string { $post = $this->cliToArray(['post', 'create', '--format=json', '--porcelain', '--post_status=publish', '--post_type=post', '--post_title="' . $title . '"', '--post_content="' . $body . '"']); $postData = $this->cliToArray(['post', 'get', $post[0], '--format=json']); $postData = json_decode($postData[0], true); return $postData['guid']; } public function addFromBlockInEditor($name, $context = null) { $i = $this; $appender = '[data-automation-id="form_inserter_open"]'; if ($context) { $appender = "$context $appender"; } $i->click($appender);// CLICK the button that adds new blocks $i->fillField('.block-editor-inserter__search-input', $name); $i->waitForText($name, 5, '.block-editor-block-types-list__item-title'); $i->click($name, '.block-editor-block-types-list__list-item'); $i->click($appender);// close the inserter } public function saveFormInEditor() { $i = $this; $i->click('[data-automation-id="form_save_button"]'); $i->waitForText('Form saved', 10, '.automation-dismissible-notices'); $i->seeNoJSErrors(); } /** * Checks that email was received by looking for a subject in inbox. * In case it was not found reloads the inbox and check once more. * Emails are sent via cron and might not be sent immediately. * @param string $subject */ public function checkEmailWasReceived($subject) { $i = $this; $i->amOnMailboxAppPage(); try { $i->waitForText($subject, 30); } catch (\Exception $e) { $i->amOnMailboxAppPage(); $i->waitForText($subject, 60); } } /** * Makes sure that there is a newsletter template of given order on given template tab * @return string Template element selector */ public function checkTemplateIsPresent(int $templateIndex, string $templateCategory = 'standard'): string { $templateTab = "[data-automation-id=\"templates-$templateCategory\"]"; $i = $this; $i->waitForElement($templateTab); $i->click($templateTab); $template = "[data-automation-id=\"select_template_$templateIndex\"]"; $i->waitForElement($template); return $template; } public function clearFormField(string $selector) { $i = $this; $i->click($selector); // Focus in the field $value = $i->grabAttributeFrom($selector, 'value'); for ($j = 0; $j < mb_strlen($value); $j++) { $i->pressKey($selector, WebDriverKeys::BACKSPACE);// delete the field } } public function canTestWithPlugin(string $pluginSlug): bool { $i = $this; try { $result = $i->cli(['plugin', 'is-installed', $pluginSlug]); } catch (\Exception $e) { return false; } return (int)$result === 0; } }