Skip to content

Conversation

@mariogrenadine
Copy link

@mariogrenadine mariogrenadine commented Sep 30, 2022

Description

Colorizer+ConsoleUtils Classes Version 1 (new)

  • encapsulated Colorizer methods

  • updated Colorizer class to differentiate outputs between filer/prompt for Unix based systems. ANSI codes won't be fed into
    files through Colorizer instances.

  • Due to this functionality Colorizer_test had to be rewritten. The test file run automatically suppresses commandline outputs therefore Colorizer instances for Unix based systems don't colorize the text and their full functionality could not be tested
    directly. As a partial solution to this a separate subclass ColorizerTester of Colorizer was created that implements original coloring functinality of Colorizer but for stringstreams instead or cout/cerr streams for the commandline. In this way,
    the coloring functionality can be tested, however should Colorizer methods be ever changed, the ColorizerTester methods should be changed accordingly in order for the tests to be accurate. Commandline output supression also limits testing of Colorizer instances.

  • updated ConsoleUtils and Consoleutils_test - added encapsulated Colorizer methods, added a new BreakString function

  • updated ConsoleUtils_test to match new functionality of ConsoleUtils class

Checklist

  • Make sure that you are listed in the AUTHORS file
  • Add relevant changes and new features to the CHANGELOG file
  • I have commented my code, particularly in hard-to-understand areas
  • New and existing unit tests pass locally with my changes
  • Updated or added python bindings for changed or new classes (Tick if no updates were necessary.)

How can I get additional information on failed tests during CI

Click to expand If your PR is failing you can check out
  • The details of the action statuses at the end of the PR or the "Checks" tab.
  • http://cdash.openms.de/index.php?project=OpenMS and look for your PR. Use the "Show filters" capability on the top right to search for your PR number.
    If you click in the column that lists the failed tests you will get detailed error messages.

Advanced commands (admins / reviewer only)

Click to expand
  • /reformat (experimental) applies the clang-format style changes as additional commit. Note: your branch must have a different name (e.g., yourrepo:feature/XYZ) than the receiving branch (e.g., OpenMS:develop). Otherwise, reformat fails to push.
  • setting the label "NoJenkins" will skip tests for this PR on jenkins (saves resources e.g., on edits that do not affect tests)
  • commenting with rebuild jenkins will retrigger Jenkins-based CI builds

⚠️ Note: Once you opened a PR try to minimize the number of pushes to it as every push will trigger CI (automated builds and test) and is rather heavy on our infrastructure (e.g., if several pushes per day are performed).

mariogrenadine and others added 30 commits May 13, 2022 00:39
…. There's a problem that now the colorizer testclass doesn't work as is should, working around this
…still needed like cerr/cout recognition, CU testclass finalization
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