Bug 168520 - Give automated tests human-readable names
Summary: Give automated tests human-readable names
Status: NEW
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: LibreOffice (show other bugs)
Version:
(earliest affected)
unspecified
Hardware: All All
: medium normal
Assignee: Not Assigned
URL:
Whiteboard: target:26.2.0
Keywords: difficultyBeginner, easyHack, topicQA
Depends on:
Blocks: Dev-related
  Show dependency treegraph
 
Reported: 2025-09-23 09:22 UTC by Buovjaga
Modified: 2025-09-24 16:31 UTC (History)
2 users (show)

See Also:
Crash report or crash signature:


Attachments
descriptions for 172 unamed .py (17.43 KB, text/csv)
2025-09-24 08:09 UTC, fpy
Details
170 unamed .py, with tentative identifiers (generated by gemini) (19.14 KB, application/vnd.oasis.opendocument.spreadsheet)
2025-09-24 08:42 UTC, fpy
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Buovjaga 2025-09-23 09:22:32 UTC
> There are only two hard things in Computer Science:
> cache invalidation and naming things.
> - Phil Karlton

https://www.karlton.org/2017/12/naming-things-hard/

Due to the mentioned hard problem, our code base has lots of automated tests named like `tdf123456`, where tdf refers to this bug tracker and the number to the ID of a report. It would be nice to change this for the better, so readers of the code could get an idea of what a test is about at a glance.

Doing a search like this reveals multiple things:

git grep -Ei 'tdf[0-9]+' '*qa*.cxx' '*uitest*.py'

Some of the names do include text hinting about the topic.

Some of the test documents need to be renamed as well.

Many Python UI test files are named like `tdf123456` and need to be renamed as well.

To find only the lonesome cryptic names we may use this search:

git grep -Ei 'tdf[0-9]+[\(\)"]' '*qa*.cxx' '*uitest*.py'

The suggestion is to rename tests and files in the style of `tdf123456_hint_on_what_the_test_is_about`

The task can be a nice opportunity for new developers to get familiar with automated testing. While thinking about a better name, read and understand the test code and the bug report and run the single test as explained in the wiki articles:

https://wiki.documentfoundation.org/Development/Cpp_Unit_Tests

https://wiki.documentfoundation.org/Development/UITests
Comment 1 Commit Notification 2025-09-23 13:25:51 UTC
Ilmari Lauhakangas committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/15ee592a791acd921ed5356f374f18f660e5fc4f

tdf#168520 basic: rename testTdf149157* and testTdf149402* tests to

It will be available in 26.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 2 fpy 2025-09-24 08:09:10 UTC
Created attachment 202945 [details]
descriptions for 172 unamed .py

For reference, attached the list of 172 unamed .py

cd sw/qa/uitest && find -name tdf*.py | perl -pe 's/..//; ($i)=/(\d+).py$/; $d=`./wgetbz $i `; $_= "$d,$_" ' > desc.csv

with ./wgetbz =>  wget -qO - "https://bugs.documentfoundation.org/buglist.cgi?bug_id=$1&ctype=csv&columnlist=short_desc,bug_id" | tail -1


see https://wiki.documentfoundation.org/QA/Bugzilla/Export
Comment 3 fpy 2025-09-24 08:42:24 UTC
Created attachment 202946 [details]
170 unamed .py, with tentative identifiers (generated by gemini)

e.g.
calc_default_image_anchor_to_cell	Make anchor to cell the default for copy-paste and drag-and-drop images in Calc	writer_tests2/tdf133299.py
template_manager_cannot_rename_user_categories	Cannot rename user-defined categories in template manager	writer_tests2/tdf146375.py
insert_caption_separator_option_resets	Insert - Caption - Options - Separator does not work (resets to previous values)	writer_tests2/tdf153244.py
Comment 4 Buovjaga 2025-09-24 08:56:04 UTC
(In reply to fpy from comment #3)
> Created attachment 202946 [details]
> 170 unamed .py, with tentative identifiers (generated by gemini)
> 
> e.g.
> calc_default_image_anchor_to_cell	Make anchor to cell the default for
> copy-paste and drag-and-drop images in Calc	writer_tests2/tdf133299.py
> template_manager_cannot_rename_user_categories	Cannot rename user-defined
> categories in template manager	writer_tests2/tdf146375.py
> insert_caption_separator_option_resets	Insert - Caption - Options -
> Separator does not work (resets to previous values)
> writer_tests2/tdf153244.py

https://wiki.documentfoundation.org/Development/AI_policy

"You must not use an LLM to solve easy hacks."
Comment 5 Commit Notification 2025-09-24 15:25:51 UTC
Andreas Heinisch committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/3e8a15d37d11ee05cb70a1a52e7070cdd887848a

tdf#168520 - Rename tdf168478 to tdf168478_restore_multiple_cell_selection

It will be available in 26.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 6 Commit Notification 2025-09-24 15:25:55 UTC
Andreas Heinisch committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/0bda7192ca2a4a46bd3a3a11e6d0cddb4f2f4889

tdf#168520 - Rename tdf117328 to tdf117328_restore_empty_cells

It will be available in 26.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.
Comment 7 Commit Notification 2025-09-24 16:31:05 UTC
Andreas Heinisch committed a patch related to this issue.
It has been pushed to "master":

https://git.libreoffice.org/core/commit/091ad8440e15762daad5f20cabb12e201686b234

tdf#168520 - Rename tdf165846 to tdf165846_nu_min_value

It will be available in 26.2.0.

The patch should be included in the daily builds available at
https://dev-builds.libreoffice.org/daily/ in the next 24-48 hours. More
information about daily builds can be found at:
https://wiki.documentfoundation.org/Testing_Daily_Builds

Affected users are encouraged to test the fix and report feedback.