scripts icon indicating copy to clipboard operation
scripts copied to clipboard

Define policy for tests

Open TheDZhon opened this issue 2 years ago • 2 comments

Simple summary

We should discriminate omnibus votes into two categories: sensitive protocol upgrades & others

  • The First category requires unit, regression, snapshot, and integration test suites.
  • For the second category, it's possible to skip the snapshot tests for the sake of reducing process overheads

Motivation

We have adopted GitHub CI process recently for the repo. While it is always good to achieve a bright green mark for every pushed head by running as many tests as possible, it also requires additional effort to maintain the repo consistency.

Snapshot tests usually represent the following invariant: 'all states should be left as is except only X', thus you have to define 'X' properly for each voting script. If you have multiple voting scripts then complexity rises drastically. At the same time, other types of tests usually check only the new state and have no assumptions for the diff items over all state slots and their values.

Proposal

Option 1. Mark protocol upgrade votings differently (naive and dirty)

For e.g., we may use upvote_xx_xx_xx.py filename pattern which should be followed by the tests runner as a flag to run additional tests.

Option 2. Bake a framework for the snapshot tests

Following the approach, one will need to import the desired snapshot tests and define the expected state diffs for them.

Decision (TBA)

Personally, I believe that option 2 should be implemented. Other opinions and options are highly appreciated here.

FYI: @folkyatina, @ujenjt

TheDZhon avatar Jun 16 '22 11:06 TheDZhon