The linter now supports new optional rul (turned off by default). This rule validates the async functions' timeout and polling arguments.
The linter checks for three things:
best effort: if the time interval is known (when using integr literals or time.Duration values), the linter validates that the timeout is not shorter than the polling interval.
Forces the timeout and the polling arguments of the Eventually and Consistently functions, to be of type time.Duration.
Best effort auto-fix: in cases that the linter can do that, e.g. for an integer value, it suggests replacing this value with a multiply with time.Second.
Forces up to one timeout and up to one polling arguments.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #129
Type of change
Please delete options that are not relevant.
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
[x] Added test case and related test data
[x] Update the functional test
Checklist:
[x] I have performed a self-review of my own code
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
Description
The linter now supports new optional rul (turned off by default). This rule validates the async functions' timeout and polling arguments.
The linter checks for three things:
time.Duration
values), the linter validates that the timeout is not shorter than the polling interval.Forces the timeout and the polling arguments of the
Eventually
andConsistently
functions, to be of typetime.Duration
.Best effort auto-fix: in cases that the linter can do that, e.g. for an integer value, it suggests replacing this value with a multiply with time.Second.
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes #129
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: