111 lines
3.7 KiB
YAML
111 lines
3.7 KiB
YAML
uuid:
|
|
- value: 80c27b8b-ebb6-486e-9fb8-a4d29ade396c
|
|
langcode:
|
|
- value: en
|
|
type:
|
|
- target_id: daily_email
|
|
target_type: node_type
|
|
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
|
|
revision_timestamp:
|
|
- value: '2025-05-11T09:00:28+00:00'
|
|
revision_uid:
|
|
- target_type: user
|
|
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
|
|
revision_log: { }
|
|
status:
|
|
- value: true
|
|
uid:
|
|
- target_type: user
|
|
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
|
|
title:
|
|
- value: |
|
|
Writing good test names
|
|
created:
|
|
- value: '2023-11-18T00:00:00+00:00'
|
|
changed:
|
|
- value: '2025-05-11T09:00:28+00:00'
|
|
promote:
|
|
- value: false
|
|
sticky:
|
|
- value: false
|
|
default_langcode:
|
|
- value: true
|
|
revision_translation_affected:
|
|
- value: true
|
|
path:
|
|
- alias: /daily/2023/11/18/writing-good-test-names
|
|
langcode: en
|
|
body:
|
|
- value: |
|
|
<p>In PHPUnit, there are different ways to write test methods.</p>
|
|
|
|
<p>The standard way is to use camel-case method names with a <code>test</code> prefix, for example:</p>
|
|
|
|
<pre><code class="language-php">public function testTheProjectNameShouldBeAString(): void
|
|
{
|
|
// ...
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Another popular way, particularly in some frameworks, is to use snake-case method names:</p>
|
|
|
|
<pre><code class="language-php">/** @test */
|
|
public function the_project_name_should_be_a_string(): void
|
|
{
|
|
// ...
|
|
}
|
|
</code></pre>
|
|
|
|
<p>This may be more readable but only works if the <code>@test</code> annotation is present.</p>
|
|
|
|
<p>What if you need to add another annotation, such as <code>@dataProvider</code> to the test? Do you do multi-line docblocks everywhere, or mix and match single and multiple line docblocks depending on the test?</p>
|
|
|
|
<h2 id="here%27s-the-thing">Here's the thing</h2>
|
|
|
|
<p>My preference switches between both ways of writing test methods.</p>
|
|
|
|
<p>But, whichever way I write it, I write descriptive method names that explain what the test does - even if it means having a long method name.</p>
|
|
|
|
<p>I avoid short and generic names like <code>testUpdate()</code>.</p>
|
|
|
|
<p>People should be able to read the test name and understand what it does and what it's testing.</p>
|
|
|
|
|
|
format: full_html
|
|
processed: |
|
|
<p>In PHPUnit, there are different ways to write test methods.</p>
|
|
|
|
<p>The standard way is to use camel-case method names with a <code>test</code> prefix, for example:</p>
|
|
|
|
<pre><code class="language-php">public function testTheProjectNameShouldBeAString(): void
|
|
{
|
|
// ...
|
|
}
|
|
</code></pre>
|
|
|
|
<p>Another popular way, particularly in some frameworks, is to use snake-case method names:</p>
|
|
|
|
<pre><code class="language-php">/** @test */
|
|
public function the_project_name_should_be_a_string(): void
|
|
{
|
|
// ...
|
|
}
|
|
</code></pre>
|
|
|
|
<p>This may be more readable but only works if the <code>@test</code> annotation is present.</p>
|
|
|
|
<p>What if you need to add another annotation, such as <code>@dataProvider</code> to the test? Do you do multi-line docblocks everywhere, or mix and match single and multiple line docblocks depending on the test?</p>
|
|
|
|
<h2 id="here%27s-the-thing">Here's the thing</h2>
|
|
|
|
<p>My preference switches between both ways of writing test methods.</p>
|
|
|
|
<p>But, whichever way I write it, I write descriptive method names that explain what the test does - even if it means having a long method name.</p>
|
|
|
|
<p>I avoid short and generic names like <code>testUpdate()</code>.</p>
|
|
|
|
<p>People should be able to read the test name and understand what it does and what it's testing.</p>
|
|
|
|
|
|
summary: null
|
|
field_daily_email_cta: { }
|