Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06a1bc01 | 4 | | CiviCRM version 4.5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
06a1bc01 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License along with this program; if not, contact CiviCRM LLC | | |
21 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
22 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
23 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
24 | +--------------------------------------------------------------------+ | |
25 | */ | |
26 | ||
27 | /** | |
28 | * Mail utils for use during unit testing to allow retrieval | |
29 | * and examination of 'sent' emails. | |
30 | * | |
31 | * Basic usage: | |
32 | * | |
33 | * $mut = new CiviMailUtils( $this, true ); //true automatically starts spooling | |
34 | * ... do stuff ... | |
35 | * $msg = $mut->getMostRecentEmail( 'raw' ); // or 'ezc' to get an ezc mail object | |
36 | * ... assert stuff about $msg ... | |
37 | * $mut->stop(); | |
38 | * | |
39 | * | |
40 | * @package CiviCRM | |
41 | */ | |
42 | ||
43 | require_once 'ezc/Base/src/ezc_bootstrap.php'; | |
44 | require_once 'ezc/autoload/mail_autoload.php'; | |
45 | ||
4cbe18b8 EM |
46 | /** |
47 | * Class CiviMailUtils | |
48 | */ | |
6a488035 TO |
49 | class CiviMailUtils extends PHPUnit_Framework_TestCase { |
50 | ||
51 | /** | |
52 | * @var mixed current outbound email option | |
53 | */ | |
54 | protected $_outBound_option = NULL; | |
55 | ||
56 | /** | |
57 | * @var bool is this a webtest | |
58 | */ | |
59 | protected $_webtest = FALSE; | |
60 | ||
61 | /** | |
62 | * Constructor | |
63 | * | |
858d0bf8 EM |
64 | * @param CiviSeleniumTestCase|CiviUnitTestCase $unit_test The currently running test |
65 | * @param bool $startImmediately Start writing to db now or wait until start() is called | |
6a488035 TO |
66 | */ |
67 | function __construct(&$unit_test, $startImmediately = TRUE) { | |
70520a0b CW |
68 | $this->_ut = $unit_test; |
69 | ||
6a488035 TO |
70 | // Check if running under webtests or not |
71 | if (is_subclass_of($unit_test, 'CiviSeleniumTestCase')) { | |
72 | $this->_webtest = TRUE; | |
73 | } | |
74 | ||
75 | if ($startImmediately) { | |
76 | $this->start(); | |
77 | } | |
78 | } | |
79 | ||
80 | /** | |
81 | * Start writing emails to db instead of current option | |
82 | */ | |
83 | function start() { | |
84 | if ($this->_webtest) { | |
85 | // Change outbound mail setting | |
14d3f751 | 86 | $this->_ut->openCiviPage('admin/setting/smtp', "reset=1", "_qf_Smtp_next"); |
6a488035 TO |
87 | |
88 | // First remember the current setting | |
89 | $this->_outBound_option = $this->getSelectedOutboundOption(); | |
90 | ||
91 | $this->_ut->click('xpath=//input[@name="outBound_option" and @value="' . CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB . '"]'); | |
14d3f751 | 92 | $this->_ut->clickLink("_qf_Smtp_next"); |
6a488035 TO |
93 | |
94 | // Is there supposed to be a status message displayed when outbound email settings are changed? | |
95 | // assert something? | |
96 | ||
97 | } | |
98 | else { | |
99 | ||
100 | // save current setting for outbound option, then change it | |
101 | $mailingBackend = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
102 | 'mailing_backend' | |
103 | ); | |
104 | ||
105 | $this->_outBound_option = $mailingBackend['outBound_option']; | |
106 | $mailingBackend['outBound_option'] = CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB; | |
107 | ||
108 | CRM_Core_BAO_Setting::setItem($mailingBackend, | |
109 | CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
110 | 'mailing_backend' | |
111 | ); | |
112 | ||
113 | $mailingBackend = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
114 | 'mailing_backend' | |
115 | ); | |
116 | } | |
117 | } | |
118 | ||
119 | function stop() { | |
120 | if ($this->_webtest) { | |
054c3522 CW |
121 | if ($this->_outBound_option != CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB) { |
122 | // Change outbound mail setting | |
123 | $this->_ut->openCiviPage('admin/setting/smtp', "reset=1", "_qf_Smtp_next"); | |
124 | $this->_ut->click('xpath=//input[@name="outBound_option" and @value="' . $this->_outBound_option . '"]'); | |
3a35908d | 125 | // There will be a warning when switching from test to live mode |
054c3522 | 126 | if ($this->_outBound_option != CRM_Mailing_Config::OUTBOUND_OPTION_DISABLED) { |
499508f0 | 127 | $this->_ut->getAlert(); |
054c3522 CW |
128 | } |
129 | $this->_ut->clickLink("_qf_Smtp_next"); | |
130 | } | |
6a488035 TO |
131 | } |
132 | else { | |
133 | ||
134 | $mailingBackend = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
135 | 'mailing_backend' | |
136 | ); | |
137 | ||
138 | $mailingBackend['outBound_option'] = $this->_outBound_option; | |
139 | ||
140 | CRM_Core_BAO_Setting::setItem($mailingBackend, | |
141 | CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, | |
142 | 'mailing_backend' | |
143 | ); | |
144 | } | |
145 | } | |
146 | ||
4cbe18b8 EM |
147 | /** |
148 | * @param string $type | |
149 | * | |
150 | * @return ezcMail|string | |
151 | */ | |
6a488035 TO |
152 | function getMostRecentEmail($type = 'raw') { |
153 | $msg = ''; | |
154 | ||
6a488035 | 155 | if ($this->_webtest) { |
6a488035 | 156 | // I don't understand but for some reason we have to load the page twice for a recent mailing to appear. |
14d3f751 CW |
157 | $this->_ut->openCiviPage('mailing/browse/archived', 'reset=1'); |
158 | $this->_ut->openCiviPage('mailing/browse/archived', 'reset=1', 'css=td.crm-mailing-name'); | |
159 | } | |
160 | // We can't fetch mailing headers from webtest so we'll only try if the format is raw | |
161 | if ($this->_webtest && $type == 'raw') { | |
6a488035 | 162 | // This should select the first "Report" link in the table, which is sorted by Completion Date descending, so in theory is the most recent email. Not sure of a more robust way at the moment. |
b3d40287 | 163 | $this->_ut->clickLink('xpath=//tr[contains(@id, "crm-mailing_")]//a[text()="Report"]'); |
6a488035 TO |
164 | |
165 | // Also not sure how robust this is, but there isn't a good | |
166 | // identifier for this link either. | |
167 | $this->_ut->waitForElementPresent('xpath=//a[contains(text(), "View complete message")]'); | |
a5d61f09 | 168 | $this->_ut->clickAjaxLink('xpath=//a[contains(text(), "View complete message")]'); |
14d3f751 | 169 | $msg = $this->_ut->getText('css=.ui-dialog-content.crm-ajax-container'); |
6a488035 TO |
170 | } |
171 | else { | |
172 | $dao = CRM_Core_DAO::executeQuery('SELECT headers, body FROM civicrm_mailing_spool ORDER BY id DESC LIMIT 1'); | |
173 | if ($dao->fetch()) { | |
174 | $msg = $dao->headers . "\n\n" . $dao->body; | |
175 | } | |
176 | $dao->free(); | |
177 | } | |
178 | ||
179 | switch ($type) { | |
180 | case 'raw': | |
181 | // nothing to do | |
182 | break; | |
183 | case 'ezc': | |
184 | $msg = $this->convertToEzc($msg); | |
185 | break; | |
186 | } | |
187 | return $msg; | |
188 | } | |
189 | ||
190 | /** | |
191 | * @param string $type 'raw'|'ezc' | |
cbdcc634 EM |
192 | * |
193 | * @throws Exception | |
6a488035 TO |
194 | * @return array(ezcMail)|array(string) |
195 | */ | |
196 | function getAllMessages($type = 'raw') { | |
197 | $msgs = array(); | |
198 | ||
199 | if ($this->_webtest) { | |
200 | throw new Exception("Not implementated: getAllMessages for WebTest"); | |
201 | } | |
202 | else { | |
203 | $dao = CRM_Core_DAO::executeQuery('SELECT headers, body FROM civicrm_mailing_spool ORDER BY id'); | |
204 | while ($dao->fetch()) { | |
205 | $msgs[] = $dao->headers . "\n\n" . $dao->body; | |
206 | } | |
207 | $dao->free(); | |
208 | } | |
209 | ||
210 | switch ($type) { | |
211 | case 'raw': | |
212 | // nothing to do | |
213 | break; | |
214 | case 'ezc': | |
215 | foreach ($msgs as $i => $msg) { | |
216 | $msgs[$i] = $this->convertToEzc($msg); | |
217 | } | |
218 | break; | |
219 | } | |
220 | ||
221 | return $msgs; | |
222 | } | |
223 | ||
4cbe18b8 EM |
224 | /** |
225 | * @return int | |
226 | */ | |
6a488035 TO |
227 | function getSelectedOutboundOption() { |
228 | $selectedOption = CRM_Mailing_Config::OUTBOUND_OPTION_MAIL; | |
229 | // Is there a better way to do this? How do you get the currently selected value of a radio button in selenium? | |
230 | for ($i = 0; $i <= 5; $i++) { | |
231 | if ($i != CRM_Mailing_Config::OUTBOUND_OPTION_MOCK) { | |
232 | if ($this->_ut->getValue('xpath=//input[@name="outBound_option" and @value="' . $i . '"]') == "on") { | |
233 | $selectedOption = $i; | |
234 | break; | |
235 | } | |
236 | } | |
237 | } | |
238 | return $selectedOption; | |
239 | } | |
240 | ||
241 | /* | |
242 | * Utility functions (previously part of CiviUnitTestCase) | |
243 | * Included for backward compatibility with existing tests. | |
244 | */ | |
245 | ||
246 | /** | |
247 | * Check contents of mail log | |
77b97be7 | 248 | * |
6a488035 TO |
249 | * @param array $strings strings that should be included |
250 | * @param array $absentStrings strings that should not be included | |
77b97be7 | 251 | * @param string $prefix |
6a488035 | 252 | * |
77b97be7 | 253 | * @return \ezcMail|string |
6a488035 TO |
254 | */ |
255 | function checkMailLog($strings, $absentStrings = array(), $prefix = '') { | |
256 | $mail = $this->getMostRecentEmail('raw'); | |
257 | foreach ($strings as $string) { | |
258 | $this->_ut->assertContains($string, $mail, "$string . not found in $mail $prefix"); | |
259 | } | |
260 | foreach ($absentStrings as $string) { | |
261 | $this->_ut->assertEmpty(strstr($mail, $string), "$string incorrectly found in $mail $prefix"); | |
262 | ; | |
263 | } | |
264 | return $mail; | |
265 | } | |
266 | ||
267 | /** | |
268 | * Check that mail log is empty | |
269 | */ | |
270 | function assertMailLogEmpty($prefix = '') { | |
271 | $mail = $this->getMostRecentEmail('raw'); | |
272 | $this->_ut->assertEmpty($mail, 'mail sent when it should not have been ' . $prefix); | |
273 | } | |
274 | ||
275 | /** | |
276 | * Assert that $expectedRecipients (and no else) have received emails | |
277 | * | |
278 | * @param array $expectedRecipients array($msgPos => array($recipPos => $emailAddr)) | |
279 | */ | |
280 | function assertRecipients($expectedRecipients) { | |
281 | $recipients = array(); | |
282 | foreach ($this->getAllMessages('ezc') as $message) { | |
283 | $recipients[] = CRM_Utils_Array::collect('email', $message->to); | |
284 | } | |
285 | sort($recipients); | |
286 | sort($expectedRecipients); | |
287 | $this->_ut->assertEquals( | |
288 | $expectedRecipients, | |
289 | $recipients, | |
290 | "Incorrect recipients: " . print_r(array('expected' => $expectedRecipients, 'actual' => $recipients), TRUE) | |
291 | ); | |
292 | } | |
293 | ||
294 | /** | |
295 | * Remove any sent messages from the log | |
296 | */ | |
297 | function clearMessages() { | |
298 | if ($this->_webtest) { | |
299 | throw new Exception("Not implementated: clearMessages for WebTest"); | |
300 | } | |
301 | else { | |
302 | CRM_Core_DAO::executeQuery('DELETE FROM civicrm_mailing_spool ORDER BY id DESC LIMIT 1'); | |
303 | } | |
304 | } | |
305 | ||
306 | /** | |
307 | * @param string $msg email header and body | |
308 | * @return ezcMail | |
309 | */ | |
310 | private function convertToEzc($msg) { | |
14d3f751 | 311 | $set = new ezcMailVariableSet($msg); |
6a488035 TO |
312 | $parser = new ezcMailParser(); |
313 | $mail = $parser->parseMail($set); | |
314 | $this->_ut->assertNotEmpty($mail, 'Cannot parse mail'); | |
315 | return $mail[0]; | |
316 | } | |
317 | } |