openqa-logwarn

A logwarn wrapper with openQA log specific rules.

Usage

• Install logwarn via sudo zypper in logwarn if you're on openSUSE Tumbleweed or from https://github.com/archiecobbs/logwarn otherwise.
• Call logwarn_openqa. By default it will read logs from /var/log/openqa which is where openQA stores logs by default. You can pass another path as the first argument.
• Extend the list of known warnings by adding arguments to the logwarn call at the top of logwarn_openqa.

Testing

• For testing you can execute test_logwarn directly or prove test_logwarn.
• You can add new cases by extending in.log as well as test_logwarn.

Adding a new ignore rule

• First, make sure the test succeeds

• Add an example of the line to ignore to in.log, e.g.

  [error] [pid:123] Connect timeout: FooBar.publish failed, retrying 7 more times

  The unique thing about this is probably the FooBar.publish.

• Add a test in test_logwarn:

  is-ignored 'FooBar.publish'

  This is kept short on purpose. The test is supposed to ensure that the line containing FooBar.publish is not appearing in the filtered output. As soon as you try to add the whole line there you might make mistakes and the test will always succeed because of this.

• Now run the test. It should fail.

• Only as the last step add the rule to logwarn_openqa to make the test pass

Contribute

This project lives in https://github.com/os-autoinst/openqa-logwarn

Feel free to add issues in github or send pull requests.

Rules for commits

• Every commit is checked by GitHubActions as soon as you create a pull request but you should test locally, see the Usage section for details.

• Make sure to add test reference data for new scenarios. TDD is advised :-)

• For git commit messages use the rules stated on How to Write a Git Commit Message as a reference

If this is too much hassle for you feel free to provide incomplete pull requests for consideration or create an issue with a code change proposal.

License

This project is licensed under the MIT license, see LICENSE file for details.