Remove t() from asserts for reroute email tests [#2056193]

As per #500866: [META] remove t() from assert message, in particular:

Strip t() from plain-string assertion messages that are still using it.
<?php
$this->assertWhatever($condition, t('My custom message here'));
?>
Becomes:
<?php
 $this->assertWhatever($condition, 'My custom message here');
?>
Assertion messages that have placeholders or variables will be converted to format_string(). This can be done separately if the patch is particularly large. (Mark issues that have already had messages with placeholders converted in the list below.)

Other parameters of assertions (beside the message parameter) are not changed.

Other uses of t() in automated tests are not changed.

Also, referring to a recent commit to Drupal 7, see 66bc8fb (Wed, 3 Jul 2013) as an example of what inspired this ticket.

It seems it would be recommended to remove calls to t() function in all asserts in reroute_email.test, for example in reroute_email.test, line 68:

$this->assertTrue($has_info, t('Found the correct "Originally to" line in the body'));

would become:

$this->assertTrue($has_info, 'Found the correct "Originally to" line in the body');

This is perhaps a rather minor change, but I thought it would allow us to keep the module a bit cleaner and aligned closer with Core standards.

Please let me know if you would have any questions, objections, comments, suggestions, recommendations or concerns on any aspects of this issue, I would be glad to provide more information or explain in more details.

Any questions, feedback, testing, changes, recommendations would be highly appreciated.
Thanks to all in advance.

Comments

Comment #1

dydave commented 7 August 2013 at 07:38

Status:

Active

» Fixed

Quick follow-up on this issue:

All calls to t() function have either been removed or replaced by format_string() for all asserts in reroute_email.test.

I went ahead and committed the changes against the 7.x-1.x branch at a9d571b .

I allowed myself to mark this issue as fixed for now, but feel free to re-open it, or post a new ticket, at any time if you have any further objections with this issue or the changes made at a9d571b (we would surely be happy to hear your feedback).

Please let me know if you would have any further comments, feedback, questions, issues, objections, suggestions or concerns on the commit or this ticket in general, I would be glad to provide more information or explain in more details.

Thanks in advance to everyone for your testing, reviews, feedback and comments on this issue.
Cheers!

Comment #2

21 August 2013 at 07:41

Status:

Fixed

» Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

Comment #3

dydave commented 30 April 2015 at 05:32

Component:	Code	» SimpleTests
Related issues:		+#1681890: Use format_string() instead of t() for assertion message text, +#500866: [META] remove t() from assert message

Wanted to log a little bit more information/documentation in this ticket about this question:

See similar issue #1681890: Use format_string() instead of t() for assertion message text.
Assertions: Great documentation with many examples about assertions.
Testing (simpletest) Tutorial (Drupal 7): Very complete documentation on simple tests, in this case, we would be particularly interested in the part:
When not to use t()

Do not use t() in:
- Strings in getInfo().
- Test assertion messages. Repeating the example from above:
```
$this->assertText(t('Access denied'), 'Access denied message found on forbidden foo page.');
```
  The second string, 'Access denied message found on forbidden foo page.', is for the test runner's information only, and so it is not translated.
- Test module and theme output, unless the test module is intended to test translation functionality.
In all the cases above, you can use format_string() if you need to format and sanitize variables for output in the string.
For drupalPost: It is possible to use t(), the $submit value should most likely most of the time be wrapped in t().
For example, see: Core Block block.test, line 71, Core Image image.test, line 95.
For verbose, I checked >all the calls in Core and it is not really clear. Nothing is really specified: we see a little bit of everything...
- Using strtr: in testTableSortInit, in tablesort.test, line 60.
- Nothing: replacements, variables or formatting are directly in the text. For example in testLineBreakFilter, in filter.test, line 946 or assertFilteredString, in filter.test, line 1573.
- t() function replacements: For example, in assertNodeViewTextHelper, in field_ui.test, line 655 or verboseEmail, in drupal_web_test_case.php, line 3706.

Remove t() from asserts for reroute email tests

Comments

Comment #1

Comment #2

Comment #3

When not to use t()

Related issues

News items

Our community

Documentation

Drupal code base

Governance of community