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.

Sign up for GitHub

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

Jump to bottom

[Testing, Docs] refactor: move /internal/... to /testutil/... for godocs #153

Merged
merged 2 commits into from
Nov 7, 2023
Merged

[Testing, Docs] refactor: move /internal/... to /testutil/... for godocs #153

merged 2 commits into from
Nov 7, 2023

Conversation

bryanchriswhite
Copy link
Contributor

@bryanchriswhite bryanchriswhite commented Nov 7, 2023 •
edited
Loading

Summary

Human Summary

Moves test helpers and mocks previously located at poktroll/internal/... to poktroll/testutil/..., exposing it via the godoc UI:

(e.g.: github.com/pokt-network/poktroll/testutil/testeventsquery)
image

Issue

Godoc doesn't render /internal packages which hides a lot of useful information about existing test helpers that are available and the structure thereof.

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Run all unit tests: make go_develop_and_test
  • Verify Localnet manually: See the instructions [here](TODO: add link to instructions)

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have performed a self-review of my own code
  • I have commented my code, updated documentation and left TODOs throughout the codebase

@bryanchriswhite bryanchriswhite added documentation Improvements or additions to documentation testing Test (or test utils) additions, fixes, improvements or other code health Cleans up some code labels Nov 7, 2023
@bryanchriswhite bryanchriswhite self-assigned this Nov 7, 2023
@bryanchriswhite bryanchriswhite force-pushed the refactor/internal-to-testutils branch 2 times, most recently from fcb8cf5 to 5d47b11 Compare November 7, 2023 09:16
@bryanchriswhite bryanchriswhite force-pushed the refactor/internal-to-testutils branch from 5d47b11 to ab37ab5 Compare November 7, 2023 09:19
@bryanchriswhite bryanchriswhite marked this pull request as ready for review November 7, 2023 09:24
@bryanchriswhite bryanchriswhite linked an issue Nov 7, 2023 that may be closed by this pull request
[Code Health] Move poktroll/internal/ test packages into poktroll/testutil #133
Closed
5 tasks
@bryanchriswhite bryanchriswhite changed the title [Testing, Docs] refactor: move /internal/... to /testutil/... to expose in the g… [Testing, Docs] refactor: move /internal/... to /testutil/... for godocs Nov 7, 2023
h5law
h5law approved these changes Nov 7, 2023
View reviewed changes
Copy link
Contributor

@h5law h5law left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :shipit:

@bryanchriswhite bryanchriswhite merged commit c66c251 into main Nov 7, 2023
7 checks passed
Olshansk pushed a commit that referenced this pull request Nov 7, 2023
@bryanchriswhite @Olshansk
[Testing, Docs] refactor: move /internal/... to /testutil/... for god…
13479cf 
…ocs (#153)

* refactor: move /internal pkgs to /testutil

* chore: cleanup
Olshansk pushed a commit that referenced this pull request Nov 8, 2023
@bryanchriswhite @Olshansk
[Testing, Docs] refactor: move /internal/... to /testutil/... for god…
ad081ee 
…ocs (#153)

* refactor: move /internal pkgs to /testutil

* chore: cleanup
@Olshansk Olshansk deleted the refactor/internal-to-testutils branch May 29, 2024 16:44
okdas pushed a commit that referenced this pull request Nov 14, 2024
@bryanchriswhite
[Testing, Docs] refactor: move /internal/... to /testutil/... for god…
41fb5d9 
…ocs (#153)

* refactor: move /internal pkgs to /testutil

* chore: cleanup
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@h5law h5law h5law approved these changes

@Olshansk Olshansk Olshansk approved these changes

@red-0ne red-0ne Awaiting requested review from red-0ne

Assignees

@bryanchriswhite bryanchriswhite

Labels
code health Cleans up some code documentation Improvements or additions to documentation testing Test (or test utils) additions, fixes, improvements or other
Projects
Shannon
Status: ✅ Done
Milestone
Quality of Life
Development

Successfully merging this pull request may close these issues.

[Code Health] Move poktroll/internal/ test packages into poktroll/testutil
3 participants
@bryanchriswhite @Olshansk @h5law