[RHELC-1761] Format messages for consistency #1438

bocekm · 2024-11-25T22:36:25Z

no full stop at the end of a report message title
no word please (technical writers' rule)
~~unique report message ids~~
- breaking change => to be done under a separate PR targeted for 3.0.0
fix typos
add more details where messages are too short and vague
make TASK tense consistent (making => make)
ensure each Action has a task-level log message to not have only a stream of info-level messages without proper context
ensure every Action prints what it's done (not just print " has succeeded")
boot loader => bootloader (we had a mix of these two possible variants)
add unit tests to lines reported by caplog as uncovered (e.g. simply adding a full stop to a string triggers a codecov patch failure when the line was not previously covered)
etc.

Jira Issues:

RHELC-1761

Checklist

PR has been tested manually in a VM (either author or reviewer)
Jira issue has been made public if possible
[RHELC-] or [HMS-] is part of the PR title
Label depicting the kind of PR it is
PR title explains the change from the user's point of view
Code and tests are documented properly
The commits are squashed to as few commits as possible (without losing data)
When merged: Jira issue has been updated to Release Pending if relevant

has-bot · 2024-11-25T22:36:39Z

/packit test --labels tier0

Comment generated by an automation.

Log | Bot Usage

codecov · 2024-11-25T22:38:31Z

Codecov Report

Attention: Patch coverage is 98.91304% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.29%. Comparing base (9826704) to head (97b635d).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
convert2rhel/utils/__init__.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1438      +/-   ##
==========================================
+ Coverage   96.11%   96.29%   +0.17%     
==========================================
  Files          72       72              
  Lines        5178     5186       +8     
  Branches      895      896       +1     
==========================================
+ Hits         4977     4994      +17     
+ Misses        119      115       -4     
+ Partials       82       77       -5

Flag	Coverage Δ
centos-linux-7	`92.00% <96.73%> (+0.36%)`	⬆️
centos-linux-8	`92.67% <95.65%> (+0.18%)`	⬆️
centos-linux-9	`92.80% <95.65%> (+0.18%)`	⬆️

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.

has-bot · 2024-11-25T22:41:54Z

/packit test --labels sanity

Comment generated by an automation.

Log | Bot Usage

convert2rhel/unit_tests/actions/system_checks/tainted_kmods_test.py

Venefilyn · 2024-11-28T11:51:49Z

Lots of merge conflicts now 😬

convert2rhel/actions/pre_ponr_changes/backup_system.py

hosekadam

Some minor comments, but overall looks good

bocekm · 2024-12-03T15:29:05Z

Conflicts resolved.
Codecov says I have not covered with tests a couple of new lines I added. But I didn't add those lines, just edited them ¯_(ツ)_/¯
EDIT: I've now added a few. I'll cover them.

bocekm · 2024-12-04T22:39:55Z

@hosekadam, @Venefilyn, @danmyway, ready for review.

bocekm · 2024-12-06T16:40:22Z

/packit test

Venefilyn

Didn't get through most of the code yet but see some things to change about wording, dots inconsistencies.

Most importantly though, lets not change the IDs unless we plan on a major version bump.

Venefilyn · 2024-12-06T16:32:03Z

convert2rhel/actions/conversion/list_non_red_hat_pkgs_left.py

@@ -34,7 +34,7 @@ def run(self):
        super(ListNonRedHatPkgsLeft, self).run()
        loggerinst.task("List remaining non-Red Hat packages")

-        loggerinst.info("Listing packages not signed by Red Hat")
+        loggerinst.info("Listing packages not signed by Red Hat.")


This will be unique as most don't have a dot in them, but definitely more valid with a dot than without. Just an FYI

Most info messages had a full stop. For consistency I've added the full stop to all of them (and to other levels such as debug or critical as well).

convert2rhel/actions/conversion/preserve_only_rhel_kernel.py

Venefilyn · 2024-12-06T16:38:32Z

convert2rhel/actions/post_conversion/hostmetering.py

@@ -126,7 +126,7 @@ def _check_host_metering_configuration(self):
        :rtype: bool
        """
        if tool_opts.configure_host_metering is None:
-            logger.debug("You have not enabled configuration of host metering. Skipping it.")
+            logger.info("You have not enabled configuration of host metering. Skipping it.")
            return False


Dots seems to be removed by accident?

I'm not sure what you're referring to exactly here. In the line above I changed the debug log level to info because without the --debug option users wouldn't see this message that is more than just of debugging nature. No dots removed.

Venefilyn · 2024-12-06T16:39:19Z

convert2rhel/actions/post_conversion/modified_rpm_files_diff.py

@@ -46,7 +46,7 @@ def run(self):
            self.add_message(
                level="INFO",
                id="SKIPPED_MODIFIED_RPM_FILES_DIFF",
-                title="Skipped comparison of 'rpm -Va' output from before and after the conversion.",
+                title="Skipped comparison of 'rpm -Va' output from before and after the conversion",


Dot removed here as well

This is intentional. It's one of the goals of the PR - to remove full stops from message titles for consistency. Most titles didn't have it, so I opted for removing them from all.

The message titles are printed this way:

(INFO) MODIFIED_RPM_FILES_DIFF::FOUND_MODIFIED_RPM_FILES - Modified rpm files from before and after the conversion were found Description: ...

In Insights they are displayed in this fashion:

In both cases (CLI, Insights) it's more suitable to have the titles without full stops.

Venefilyn · 2024-12-06T16:40:32Z

convert2rhel/actions/pre_ponr_changes/backup_system.py

+        """Back up redhat release file before starting conversion process"""
+        logger.task("Back up redhat-release files")



I would say Backup instead of back up. What is the Red Hat preferred word?

Backup is a noun, back up is a verb.
"You are backing up a file and then you have a file backup."

convert2rhel/actions/pre_ponr_changes/handle_packages.py

convert2rhel/actions/system_checks/convert2rhel_latest.py

- no full stop at the end of a report message title - no word please (technical writers' rule) - boot loader => bootloader - fix typos - add missing context where messages are too short and vague - make TASK tense consistent - ensure each Action has a TASK level log message - ensure every Action prints what it's done - add unit tests to lines reported by caplog as uncovered

bocekm · 2024-12-06T20:16:43Z

/packit test

bocekm added skip/changelog If it should be excluded from changelog or Release notes. Such as infra, reverted PRs, etc. tests/tier0 PR ready to run the essential test suit. Equivalent to `/packit test --labels tier0`. kind/refactor labels Nov 25, 2024

bocekm requested review from Venefilyn and danmyway November 25, 2024 22:36

bocekm requested a review from a team as a code owner November 25, 2024 22:36

bocekm mentioned this pull request Nov 25, 2024

[RHELC-1511] Tell users to use config ini instead of env vars #1433

Merged

8 tasks

bocekm changed the title ~~Format messages for consistency~~ [RHELC-1761] Format messages for consistency Nov 25, 2024

bocekm added tests/sanity PR ready to run the sanity test suit. Equivalent to `/packit test --labels sanity`. and removed tests/tier0 PR ready to run the essential test suit. Equivalent to `/packit test --labels tier0`. labels Nov 25, 2024

hosekadam reviewed Nov 27, 2024

View reviewed changes

convert2rhel/unit_tests/actions/system_checks/tainted_kmods_test.py Outdated Show resolved Hide resolved

bocekm force-pushed the message-formatting-for-consistency branch 2 times, most recently from 5457d34 to 1fd0e5b Compare November 27, 2024 17:21

hosekadam reviewed Nov 28, 2024

View reviewed changes

convert2rhel/actions/pre_ponr_changes/backup_system.py Outdated Show resolved Hide resolved

hosekadam approved these changes Nov 28, 2024

View reviewed changes

bocekm force-pushed the message-formatting-for-consistency branch 2 times, most recently from e5b5f5c to c2c5673 Compare December 3, 2024 15:21

bocekm force-pushed the message-formatting-for-consistency branch 4 times, most recently from adc6f72 to 6bd4220 Compare December 3, 2024 20:12

bocekm requested a review from a team as a code owner December 3, 2024 20:12

bocekm force-pushed the message-formatting-for-consistency branch from 6bd4220 to dbce386 Compare December 4, 2024 22:32

bocekm force-pushed the message-formatting-for-consistency branch from dbce386 to d0fd418 Compare December 4, 2024 23:24

bocekm force-pushed the message-formatting-for-consistency branch 3 times, most recently from 60e471d to 4846937 Compare December 6, 2024 16:34

bocekm added tests/all Run the full test suite. Equivalent to `/packit test`. and removed tests/sanity PR ready to run the sanity test suit. Equivalent to `/packit test --labels sanity`. labels Dec 6, 2024

oamg deleted a comment from has-bot Dec 6, 2024

Venefilyn requested changes Dec 6, 2024

View reviewed changes

bocekm force-pushed the message-formatting-for-consistency branch from 4846937 to 97b635d Compare December 6, 2024 19:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[RHELC-1761] Format messages for consistency #1438

[RHELC-1761] Format messages for consistency #1438

bocekm commented Nov 25, 2024 •

edited

Loading

has-bot commented Nov 25, 2024

codecov bot commented Nov 25, 2024 •

edited

Loading

has-bot commented Nov 25, 2024

Venefilyn commented Nov 28, 2024

hosekadam left a comment

bocekm commented Dec 3, 2024 •

edited

Loading

bocekm commented Dec 4, 2024

bocekm commented Dec 6, 2024

Venefilyn left a comment •

edited

Loading

Venefilyn Dec 6, 2024

bocekm Dec 6, 2024

Venefilyn Dec 6, 2024

bocekm Dec 6, 2024

Venefilyn Dec 6, 2024

bocekm Dec 6, 2024

Venefilyn Dec 6, 2024

bocekm Dec 6, 2024

bocekm commented Dec 6, 2024

		"""Back up redhat release file before starting conversion process"""
		logger.task("Back up redhat-release files")

[RHELC-1761] Format messages for consistency #1438

Are you sure you want to change the base?

[RHELC-1761] Format messages for consistency #1438

Conversation

bocekm commented Nov 25, 2024 • edited Loading

has-bot commented Nov 25, 2024

codecov bot commented Nov 25, 2024 • edited Loading

Codecov Report

has-bot commented Nov 25, 2024

Venefilyn commented Nov 28, 2024

hosekadam left a comment

Choose a reason for hiding this comment

bocekm commented Dec 3, 2024 • edited Loading

bocekm commented Dec 4, 2024

bocekm commented Dec 6, 2024

Venefilyn left a comment • edited Loading

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

Choose a reason for hiding this comment

bocekm commented Dec 6, 2024

bocekm commented Nov 25, 2024 •

edited

Loading

codecov bot commented Nov 25, 2024 •

edited

Loading

bocekm commented Dec 3, 2024 •

edited

Loading

Venefilyn left a comment •

edited

Loading