nunnatsa / ginkgolinter

golang linter for ginkgo and gomega
MIT License
24 stars 6 forks source link

New rule: validate async intervals #139

Closed nunnatsa closed 3 months ago

nunnatsa commented 3 months ago

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:

  1. 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.
  2. 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.

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

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:

coveralls commented 3 months ago

Pull Request Test Coverage Report for Build 8317036138

Details


Totals Coverage Status
Change from base Build 8280785109: 0.2%
Covered Lines: 202
Relevant Lines: 301

💛 - Coveralls