Improve Test Coverage for Dominant Color Images Plugin #1837

sarthak-19 · 2025-01-30T11:07:12Z

Summary

This is part of #1789:

Ignore Coverage for Non-Critical Code Blocks
Add Missing @covers Annotations
Add Missing Tests

Before: 48.15% ⚠️	After: 82.00% ✅

cc : @westonruter

…ugin

codecov · 2025-01-30T11:22:02Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.99%. Comparing base (98b8d54) to head (272ae78).
Report is 19 commits behind head on trunk.

Additional details and impacted files

@@            Coverage Diff             @@
##            trunk    #1837      +/-   ##
==========================================
+ Coverage   69.76%   70.99%   +1.23%     
==========================================
  Files          86       85       -1     
  Lines        6965     6958       -7     
==========================================
+ Hits         4859     4940      +81     
+ Misses       2106     2018      -88

Flag	Coverage Δ
multisite	`70.99% <ø> (+1.23%)`	⬆️
single	`40.93% <ø> (+1.20%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

westonruter · 2025-01-31T21:54:52Z

plugins/dominant-color-images/tests/test-dominant-color.php

@@ -42,7 +42,7 @@ public function test_dominant_color_metadata( string $image_path, array $expecte
 	 *
 	 * @dataProvider provider_get_dominant_color
 	 *
-	 * @covers ::dominant_color_get_dominant_color
+	 * @covers helper::dominant_color_get_dominant_color


This doesn't seem right? The :: here refers to the global namespace.

Suggested change

* @covers helper::dominant_color_get_dominant_color

* @covers ::dominant_color_get_dominant_color

:: refers to the global namespace, and it works for rest of the functions however, when I'm trying to generate coverage report, for the functions where I've added helper & hooks it's showing 0 coverage without file reference.

Previous Result :

When setting annotation to * @covers ::dominant_color_get_dominant_color & * @covers ::dominant_color_img_tag_add_dominant_color

helper.php

hooks.php

New Result :

When setting annotation to * @covers helper::dominant_color_get_dominant_color & * @covers hooks::dominant_color_img_tag_add_dominant_color

helper.php

hooks.php

So how should I proceed with this since helper.php & hooks.php file don't have a class so ClassName:functionName annotations will not work I also tried adding namespace to helper.php & hooks.php but it results in failing all the test cases and throws error?

cc : @westonruter

Strange. I don't know why that would be. I also don't understand adding hooks and helper to the beginning of those functions. They would seem to indicate there are classes called hooks and helper, which there aren't.

You're seeing this with local coverage report, but are you also seeing it with the Codecov coverage report?

They would seem to indicate there are classes called hooks and helper, which there aren't.

Exactly, still for some reason it seems to work.

You're seeing this with local coverage report, but are you also seeing it with the Codecov coverage report?

Yes, in Codecov coverage report also the same is happening.

@westonruter

@thelovekesh any ideas?

@sarthak-19 can you please upload the xml coverage report? maybe that can help analyze how code coverage driver is looking for things?

@thelovekesh Here's the link to xml report : https://drive.google.com/drive/folders/1Mj8KLo6IcnqsYstaZkRekREtkBzn0-9z?usp=sharing

westonruter · 2025-01-31T21:54:57Z

plugins/dominant-color-images/tests/test-dominant-color.php

@@ -91,7 +91,7 @@ public function test_has_transparency_metadata( string $image_path, array $expec
 	 *
 	 * @dataProvider provider_get_dominant_color
 	 *
-	 * @covers ::dominant_color_get_dominant_color
+	 * @covers helper::dominant_color_get_dominant_color


Suggested change

* @covers helper::dominant_color_get_dominant_color

* @covers ::dominant_color_get_dominant_color

westonruter · 2025-01-31T21:55:24Z

plugins/dominant-color-images/tests/test-dominant-color.php

@@ -113,7 +113,7 @@ public function test_dominant_color_has_transparency( string $image_path, array
 	 *
 	 * @dataProvider provider_get_dominant_color
 	 *
-	 * @covers ::dominant_color_img_tag_add_dominant_color
+	 * @covers hooks::dominant_color_img_tag_add_dominant_color


Suggested change

* @covers hooks::dominant_color_img_tag_add_dominant_color

* @covers ::dominant_color_img_tag_add_dominant_color

westonruter · 2025-01-31T21:55:29Z

plugins/dominant-color-images/tests/test-dominant-color.php

@@ -199,7 +199,7 @@ public function data_dominant_color_img_tag_add_dominant_color_requires_proper_q
 	 *
 	 * @dataProvider data_provider_dominant_color_check_inline_style
 	 *
-	 * @covers ::dominant_color_img_tag_add_dominant_color
+	 * @covers hooks::dominant_color_img_tag_add_dominant_color


Suggested change

* @covers hooks::dominant_color_img_tag_add_dominant_color

* @covers ::dominant_color_img_tag_add_dominant_color

plugins/dominant-color-images/tests/test-dominant-color-image-editor-imagick.php

github-actions · 2025-02-01T07:17:51Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @[email protected].

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: [email protected].

Co-authored-by: sarthak-19 <[email protected]>
Co-authored-by: westonruter <[email protected]>
Co-authored-by: mukeshpanchal27 <[email protected]>
Co-authored-by: thelovekesh <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

sarthak-19 · 2025-02-21T09:57:18Z

@westonruter Should I make any changes in this one?

westonruter · 2025-02-22T05:52:17Z

@sarthak-19 We still need to figure out what is going on with #1837 (comment)

sarthak-19 · 2025-03-06T15:48:22Z

Updated the code to address #1837 (comment) , turns out it was indeed invalid name, and if we pass any invalid name lets say instead of hooks::dominant_color_img_tag_add_dominant_color I write xyz::dominant_color_img_tag_add_dominant_color
It would still work as it will just look for the function globally.

But the issue mentioned in speculation plugin PR #1845 (review) is present in this also, that's why removed 2 @cover annotations for improving Code Coverage.

cc : @westonruter

This reverts commit e6c54b0.

westonruter

Almost there

plugins/dominant-color-images/tests/test-dominant-color.php

westonruter · 2025-03-10T22:16:01Z

The current test failure is not related to this PR. It's fixed in #1913. Once that is merged you can update this branch with those changes to clear that error.

westonruter

Thanks for this!

… update/dci-test-coverage * 'trunk' of https://github.com/WordPress/performance: Update embed-optimizer snapshots Update image-prioritizer test case Remove transitional XPath

Add test cases and improve code coverage for dominant color images pl…

5ae68b8

…ugin

sarthak-19 mentioned this pull request Jan 30, 2025

Improve code coverage through annotations #1789

Open

Replaced addMethods with onlyMethods

7d1af5f

westonruter added no milestone PRs that do not have a defined milestone for release skip changelog PRs that should not be mentioned in changelogs [Plugin] Image Placeholders Issues for the Image Placeholders plugin (formerly Dominant Color Images) labels Jan 31, 2025

westonruter reviewed Jan 31, 2025

View reviewed changes

westonruter added the [Type] Enhancement A suggestion for improvement of an existing feature label Jan 31, 2025

Added default class annotation

af9f180

sarthak-19 marked this pull request as ready for review February 1, 2025 07:17

sarthak-19 requested review from felixarntz and pbearne as code owners February 1, 2025 07:17

sarthak-19 requested review from thelovekesh and westonruter February 11, 2025 12:11

sarthak-19 added 3 commits February 14, 2025 17:05

Merge branch 'trunk' into update/dci-test-coverage

7509b08

Merge branch 'trunk' into update/dci-test-coverage

a30c811

Merge branch 'trunk' into update/dci-test-coverage

b65df2d

Fixed incorrect annotation helper & hooks in covers

cf65c01

sarthak-19 and others added 7 commits March 6, 2025 21:18

Merge branch 'trunk' into update/dci-test-coverage

feb3c2d

Add missing code coverage ignore annotation

c14bbb1

Remove unneeded imports and disable irrelevant inspections

ce31697

Extract common PHP into helper method

e6c54b0

Address remaining PhpStorm static analysis complaints

e04692d

Revert "Extract common PHP into helper method"

cae4b7f

This reverts commit e6c54b0.

Add skip_if_mime_type_unsupported helper method

b881254

westonruter reviewed Mar 10, 2025

View reviewed changes

plugins/dominant-color-images/tests/test-dominant-color.php Outdated Show resolved Hide resolved

plugins/dominant-color-images/tests/test-dominant-color.php Outdated Show resolved Hide resolved

mukeshpanchal27 and others added 2 commits March 11, 2025 14:38

Merge branch 'trunk' into update/dci-test-coverage

5534c0d

Reset wp_styles after each test

0175e0b

sarthak-19 requested a review from westonruter March 11, 2025 14:20

Reuse wp_style_is()

0c76f08

westonruter approved these changes Mar 11, 2025

View reviewed changes

westonruter merged commit ad15727 into WordPress:trunk Mar 11, 2025
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve Test Coverage for Dominant Color Images Plugin #1837

Improve Test Coverage for Dominant Color Images Plugin #1837

sarthak-19 commented Jan 30, 2025 •

edited by westonruter

Loading

codecov bot commented Jan 30, 2025 •

edited

Loading

westonruter Jan 31, 2025

sarthak-19 Feb 1, 2025 •

edited

Loading

westonruter Feb 1, 2025

sarthak-19 Feb 1, 2025

westonruter Feb 1, 2025

thelovekesh Feb 2, 2025

sarthak-19 Feb 3, 2025

westonruter Jan 31, 2025

westonruter Jan 31, 2025

westonruter Jan 31, 2025

github-actions bot commented Feb 1, 2025 •

edited

Loading

sarthak-19 commented Feb 21, 2025

westonruter commented Feb 22, 2025

sarthak-19 commented Mar 6, 2025

westonruter left a comment

westonruter commented Mar 10, 2025

westonruter left a comment

	* @covers helper::dominant_color_get_dominant_color
	* @covers ::dominant_color_get_dominant_color

	* @covers hooks::dominant_color_img_tag_add_dominant_color
	* @covers ::dominant_color_img_tag_add_dominant_color

Improve Test Coverage for Dominant Color Images Plugin #1837

Improve Test Coverage for Dominant Color Images Plugin #1837

Conversation

sarthak-19 commented Jan 30, 2025 • edited by westonruter Loading

Summary

codecov bot commented Jan 30, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

sarthak-19 Feb 1, 2025 • edited Loading

Choose a reason for hiding this comment

Previous Result :

New Result :

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

github-actions bot commented Feb 1, 2025 • edited Loading

Unlinked Accounts

sarthak-19 commented Feb 21, 2025

westonruter commented Feb 22, 2025

sarthak-19 commented Mar 6, 2025

westonruter left a comment

Choose a reason for hiding this comment

westonruter commented Mar 10, 2025

westonruter left a comment

Choose a reason for hiding this comment

sarthak-19 commented Jan 30, 2025 •

edited by westonruter

Loading

codecov bot commented Jan 30, 2025 •

edited

Loading

sarthak-19 Feb 1, 2025 •

edited

Loading

github-actions bot commented Feb 1, 2025 •

edited

Loading