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

docs: update ADR 59 #22423

Merged
merged 1 commit into from
Nov 5, 2024
Merged

docs: update ADR 59 #22423

merged 1 commit into from
Nov 5, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Nov 4, 2024

Description

Replaces #22420


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Documentation
    • Updated testing strategy document to clarify the removal of end-to-end tests and their replacement with system tests.
    • Revised status to "PROPOSED Implemented" to reflect the current state of the document.
    • Enhanced decision table to indicate the transition from E2E tests to system tests, emphasizing the use of the full application in testing.

@julienrbrt julienrbrt requested a review from a team as a code owner November 4, 2024 20:27
Copy link
Contributor

coderabbitai bot commented Nov 4, 2024

📝 Walkthrough

Walkthrough

The pull request updates the document adr-059-test-scopes.md to reflect changes in the testing strategy. It notes the removal of end-to-end (E2E) tests in version 0.52, replaced by system tests. The document's status has been changed to "PROPOSED Implemented," and the E2E tests section has been revised to focus on system tests, which are designed to ensure the functionality of the application, CLI, and REST API. Additionally, the decision table has been updated to indicate the shift to system tests.

Changes

File Change Summary
docs/architecture/adr-059-test-scopes.md - Updated status from "PROPOSED Partially Implemented" to "PROPOSED Implemented".
- Added note about the removal of E2E tests and their replacement with system tests.
- Revised decision table to reflect the shift from E2E to system tests.
- Removed limitations section for E2E tests and adjusted consequences section to focus on system tests.

Possibly related PRs

  • docs: Add initial doc for system tests #22002: This PR adds initial documentation for system tests, which directly relates to the main PR's changes that replace end-to-end tests with system tests in the testing strategy.
  • docs: update learn/intro #22046: This PR updates the learn/intro documentation, which may include references to testing strategies, aligning with the main PR's focus on clarifying the testing framework.
  • docs: update gov docs #22048: This PR updates governance documentation, which may touch on testing implications for governance proposals, indirectly related to the main PR's focus on testing strategies.
  • docs: update package list #22063: This PR updates the package list, which may include references to testing packages, relevant to the main PR's changes in testing documentation.
  • docs: Update upgrade docs #22105: This PR updates upgrade documentation, which could relate to testing during upgrades, connecting to the main PR's emphasis on system tests.
  • docs(x/consensus): fixes #22114: This PR fixes documentation for the consensus module, which may include testing aspects relevant to the main PR's focus on system tests.
  • docs: fix several typos in the document  #22135: This PR addresses typos in documentation, which may include sections on testing, indirectly related to the main PR's focus on clarifying testing strategies.
  • docs: fix rendering issue #22211: This PR fixes rendering issues in core documentation, which may include references to testing components, indirectly related to the main PR's focus on testing strategies.

Suggested labels

Type: ADR

Suggested reviewers

  • tac0turtle

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 4, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
docs/architecture/adr-059-test-scopes.md (3)

145-147: Maintain consistent note block formatting.

While the content accurately describes the transition to system tests, consider using consistent formatting for the two note blocks. The first note block uses three colons (:::) while maintaining the same content.

-:::note
+::: note
 End-to-end tests have been removed from v0.52+ and have been replaced fully by system tests.
-:::
+::: 

Also applies to: 213-215, 217-220


176-176: Consider clarifying system tests vs E2E tests.

While the table correctly shows the transition to system tests, it would be helpful to add a brief note explaining the key differences between system tests and the previous E2E tests approach, particularly regarding the testing environment and scope.


148-148: Fix grammar and punctuation.

Two minor issues need to be addressed:

  1. "End to end" should be hyphenated as "End-to-end" for consistency
  2. Add a comma after "Presently" for better readability
-End to end tests exercise the entire system
+End-to-end tests exercise the entire system

-Presently these tests are located
+Presently, these tests are located

Also applies to: 150-150

🧰 Tools
🪛 LanguageTool

[grammar] ~148-~148: Did you mean the adjective “End-to-end” (spelled with hyphens)?
Context: ...en replaced fully by system tests. ::: End to end tests exercise the entire system as we ...

(END_TO_END_HYPHEN)

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e0f644b and 7387eca.

📒 Files selected for processing (1)
  • docs/architecture/adr-059-test-scopes.md (5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/architecture/adr-059-test-scopes.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool
docs/architecture/adr-059-test-scopes.md

[grammar] ~148-~148: Did you mean the adjective “End-to-end” (spelled with hyphens)?
Context: ...en replaced fully by system tests. ::: End to end tests exercise the entire system as we ...

(END_TO_END_HYPHEN)


[formatting] ~150-~150: Consider adding a comma after ‘Presently’ for more clarity.
Context: ...production environment as is practical. Presently these tests are located at [tests/e2e](...

(CONJUNCTIVE_LINKING_ADVERB_COMMA_PREMIUM)

🔇 Additional comments (1)
docs/architecture/adr-059-test-scopes.md (1)

8-8: LGTM: Status and changelog updates are accurate.

The status change to "PROPOSED Implemented" and the new changelog entry appropriately reflect the complete migration from E2E tests to system tests.

Also applies to: 12-12

@julienrbrt julienrbrt added this pull request to the merge queue Nov 5, 2024
Merged via the queue into main with commit e9436a6 Nov 5, 2024
75 of 76 checks passed
@julienrbrt julienrbrt deleted the julien/update-059 branch November 5, 2024 07:44
mergify bot pushed a commit that referenced this pull request Nov 5, 2024
(cherry picked from commit e9436a6)
@mergify mergify bot mentioned this pull request Nov 5, 2024
12 tasks
julienrbrt pushed a commit that referenced this pull request Nov 5, 2024
alpe added a commit that referenced this pull request Nov 6, 2024
* main: (24 commits)
  build(deps): upgrade to [email protected] (#22436)
  docs: Update tendermint validators query pagination documentation (#22412)
  refactor(client/v2): offchain uses client/v2/factory (#22344)
  feat: wire new handlers to grpc (#22333)
  fix(x/group): proper address rendering in error (#22425)
  refactor(serevr/v2/cometbft): update `RegisterQueryHandlers` and GRPC queries (#22403)
  docs: update ADR 59 (#22423)
  build(deps): Bump github.com/fsnotify/fsnotify from 1.7.0 to 1.8.0 in /tools/cosmovisor (#22407)
  docs: Module account address documentation (#22289)
  feat(baseapp): add per message telemetry (#22175)
  docs: Update Twitter Links to X in Documentation (#22408)
  docs: redirect the remote generation page (#22404)
  refactor(serverv2): remove unused interface methods, honuor context  (#22394)
  fix(server/v2): return ErrHelp (#22399)
  feat(indexer): implement `schema.HasModuleCodec` interface in the `bank` module (#22349)
  refactor(math): refactor ApproxRoot for readality (#22263)
  docs: fix KWallet Handbook (#22395)
  feat(client/v2): broadcast logic (#22282)
  refactor(server/v2): eager config loading (#22267)
  test(system): check feePayers signature (#22389)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release Type: ADR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants