Skip to content

chore: Make test log more readable by using 120 columns and colors#1320

Merged
Czaki merged 1 commit intodevelopfrom
color_log
Oct 15, 2025
Merged

chore: Make test log more readable by using 120 columns and colors#1320
Czaki merged 1 commit intodevelopfrom
color_log

Conversation

@Czaki
Copy link
Collaborator

@Czaki Czaki commented Oct 15, 2025

Summary by Sourcery

Improve test log readability by enabling colored output and widening console display

CI:

  • Enable colored output for test logs by setting FORCE_COLOR to 1
  • Increase test workflow log column width to 120 via the COLUMNS environment variable

Summary by CodeRabbit

  • Chores
    • Updated continuous integration configuration to set global environment variables for test workflows, enabling colored output and a fixed 120-column width in logs. This standardizes how logs render across terminals and runners. No modifications were made to job definitions, steps, or runtime behavior of the app or tests. No user-facing changes.

@Czaki Czaki added this to the 0.16.4 milestone Oct 15, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Oct 15, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR improves test log readability by configuring the GitHub Actions test workflow to always produce colored output and enforce a 120-column display width.

File-Level Changes

Change Details Files
Enable colored output and set log width to 120 columns
  • Add env block to the tests workflow
  • Set FORCE_COLOR=1 to force colorized logs
  • Set COLUMNS=120 to wrap output at 120 columns
.github/workflows/tests.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

Walkthrough

Added two environment variables to the CI workflow at the top-level env: FORCE_COLOR=1 and COLUMNS=120. No jobs, steps, or other configurations were changed.

Changes

Cohort / File(s) Summary of Changes
CI workflow config
\.github/workflows/tests.yml
Introduced top-level env vars: FORCE_COLOR=1 and COLUMNS=120 to enforce colored output and fixed column width.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I tapped the CI drum with glee,
Set colors bright for all to see.
A tidy width, one-twenty wide—
Logs now march in perfect stride.
Thump-thump, the pipeline hops along,
A rabbit’s build, both crisp and strong. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title accurately captures the main change by specifying that test logs will be more readable through the addition of 120-column output and color enforcement, and it does so concisely without extraneous details.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch color_log

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 11c3869 and dd73fa8.

📒 Files selected for processing (1)
  • .github/workflows/tests.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)
  • GitHub Check: 4DNucleome.PartSeg (Tests_other test windows)
  • GitHub Check: 4DNucleome.PartSeg (Tests_other test macos)
  • GitHub Check: 4DNucleome.PartSeg (Tests_linux test_linux)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller windows)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller macos_arm)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller macos)
  • GitHub Check: 4DNucleome.PartSeg (Builds pyinstaller_linux)
  • GitHub Check: 4DNucleome.PartSeg (Builds sdist)
  • GitHub Check: Base py3.11 / macos-15-intel py 3.11 latest PyQt5
  • GitHub Check: Test PartSeg minimal / ubuntu-24.04 py 3.9 latest PyQt5
  • GitHub Check: test_coverage / ubuntu-24.04 py 3.12 latest PyQt5
  • GitHub Check: 4DNucleome.PartSeg (Documentation_check help)
  • GitHub Check: 4DNucleome.PartSeg (manifest_check manifest_check)
  • GitHub Check: 4DNucleome.PartSeg (GetTestData linux)
  • GitHub Check: 4DNucleome.PartSeg (formatting_check check_formating)
  • GitHub Check: 4DNucleome.PartSeg (Documentation_check Notebook_check)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Sourcery review
🔇 Additional comments (1)
.github/workflows/tests.yml (1)

19-22: Nice job on improving log readability.

Forcing color and widening the column width at the workflow level should make the CI summaries far easier to parse, especially on the longer tox runs. 👍


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link

@codecov
Copy link

codecov bot commented Oct 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.17%. Comparing base (11c3869) to head (dd73fa8).
⚠️ Report is 29 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1320      +/-   ##
===========================================
+ Coverage    93.16%   93.17%   +0.01%     
===========================================
  Files          210      210              
  Lines        33285    33285              
===========================================
+ Hits         31009    31014       +5     
+ Misses        2276     2271       -5     

☔ 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.

@Czaki Czaki merged commit d84f597 into develop Oct 15, 2025
60 checks passed
@Czaki Czaki deleted the color_log branch October 15, 2025 07:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments