File structure refactor for tests

[Zacholme7]

Although I have an understanding of it now, going through and understanding the spec tests and how everything fits/works together was quite confusing.

I would propose keeping the top level p2p, qbft, ssv, and types directories to contain spec related code, but migrate everything testing related into a new tests directory.

Few picky nits that I think would help a lot in the readability of the code

• I think some of the names should be tweaked so the directories and file names convey more meaning. For example, when navigating the repo at first it was confusing to see spectest/tests and also spectests/generate/tests.
• I think all logic should be kept out of the generated directory. This should only contain the input json and state comparisons.
• Quick off the head structure I think makes sense (sorry for bad formatting)

test/

• qbft/
  • generated/
    • input_json/
    • state_comparison/
  • qbft-categories/
    • test categories here
  • all_tests.go
  • runner.go
  • generator.go
• ... repeat for others
• utils

[GalRogozinski]

@Zacholme7

I think all logic should be kept out of the generated directory. This should only contain the input json and state comparisons.

What logic do you see here?
It is all generated code.

I think some of the names should be tweaked so the directories and file names convey more meaning. For example, when navigating the repo at first it was confusing to see spectest/tests and also spectests/generate/tests.

I understand what you mean. For you the real tests are the generated files, right? I think you want to rename spectest/tests -> spectest/qbft-categories? That's also a confusing name... maybe test_impl works better?

We can also do some separation between spec code and test code that are now currently under the same folder (e.g. messages.go and instance_test.go are in the same folder).

[Zacholme7]

1. Just the main.go in the generate directories. My suggestion was that this should be moved up a directory and called something like generator.go so that the generate directory only contains generated files
2. Yea, or something like test_inputs. Doesnt matter too much, I just found the double test name to be confusing.

[GalRogozinski]

also we should rename json files to have _ instead of spaces while we're at it