Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TECHDEBT] [P2P] Raintree test suite improvements: Double check expected calls counting #277

Closed
9 tasks
deblasis opened this issue Oct 3, 2022 · 1 comment · Fixed by #304 or #317
Closed
9 tasks
Assignees
Labels
p2p P2P specific changes

Comments

@deblasis
Copy link
Contributor

deblasis commented Oct 3, 2022

Objective

Tend for this TODO left in the code:

./p2p/module_raintree_test.go:// INVESTIGATE(olshansky): Double check that how the expected calls are counted is accurate per the

Origin Document

Looking at the configuration for a single RainTree test:

Screen Shot 2022-10-15 at 4 49 52 PM

Along with the visuals and the configs for a single test:

Screen Shot 2022-10-15 at 4 38 07 PM

It is not clear what these are supposed to mean in the context of gossip.

Goals

  • Make the RainTree testing framework counters more intuitive in terms of reads/writes from/to the network
  • Add some clarifying documentation to the RainTree testing framework/modules

Deliverable

A PR that includes the following

  • Changes to how the RainTree testing framework counters are managed and validated
  • Supporting documentation on what the counters mean and why

Non-goals / Non-deliverables

  • Modify Raintree implementation
  • Code cleanup
  • Code refactoring
  • Add the tooling/utilities to gain visibility into RainTree
  • Add the tooling/utilities to generate RainTree unit tests

General issue deliverables

  • Update the appropriate CHANGELOG
  • Update any relevant READMEs (local and/or global)
  • Update any relevant global documentation & references
  • If applicable, update the source code tree explanation
  • If applicable, add or update a state, sequence or flowchart diagram using mermaid

Testing Methodology

  • Task specific tests: make test_p2p
  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @deblasis
Co-Owners: @Olshansk

@deblasis deblasis added the p2p P2P specific changes label Oct 3, 2022
@deblasis deblasis self-assigned this Oct 3, 2022
@deblasis deblasis changed the title [TECHDEBT] [P2P] Raintree test suite improvements: Double check that how the expected calls counting [TECHDEBT] [P2P] Raintree test suite improvements: Double check expected calls counting Oct 3, 2022
@Olshansk Olshansk assigned Olshansk and unassigned deblasis Oct 5, 2022
@Olshansk
Copy link
Member

Olshansk commented Oct 5, 2022

This is being tackled in #179.

@Olshansk Olshansk removed the triage It requires some decision-making at team level (it can't be worked on as it stands) label Oct 15, 2022
Olshansk added a commit that referenced this issue Oct 21, 2022
## Description

Adding a missing changelog not added in #304

## Issue

Fixes #277

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [ ] Code health or cleanup
- [ ] Major breaking change
- [x] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Updated P2P changelog corresponding to #304

## Testing

- [x] `make develop_test`
- [x] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README`

## Required Checklist

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas
- [x] I have tested my changes using the available tooling
- [x] I have updated the corresponding CHANGELOG

### If Applicable Checklist
- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added, or updated, [mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding README(s)
- [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p2p P2P specific changes
Projects
Status: Done
2 participants