testing processor #776
Draft
testing processor #776
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
4 tasks
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
337099f to
41c221f
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
3272d23 to
3661226
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
41c221f to
f4a5496
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
3661226 to
3614d53
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
f4a5496 to
7c9ef01
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
3614d53 to
a7aca8f
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
7c9ef01 to
443f3c1
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
a7aca8f to
b77f255
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
443f3c1 to
719d843
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
b77f255 to
e27f3c8
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
719d843 to
fc57bc1
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
e27f3c8 to
f9f765c
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
fc57bc1 to
ee03a7e
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
f9f765c to
a287733
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
ee03a7e to
8736bb3
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
a287733 to
9992188
Compare
yuunlimm
force-pushed
the
01-17-generating_test_transactions_with_move_script
branch
from
8736bb3 to
260f684
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
9992188 to
00949b3
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
00949b3 to
dfafeec
Compare
yuunlimm
force-pushed
the
01-17-testing_processor
branch
from
dfafeec to
67a13f5
Compare
rtso
reviewed
Jan 27, 2025
|
|
||
| ### General Flow of how Processor Testing Works | ||
|
|
||
| 1. Prepare testing transactions (refer to prior documentations). |
There was a problem hiding this comment.
let's add links to the previous documentations
| 3. Import new transactions. | ||
| 4. Write test cases. | ||
| 5. Generate expected database output and validate. | ||
| 6. Merge. |
| ## Prerequisites | ||
| <Callout> | ||
| Key Considerations: | ||
| - Each test runs in an isolated environment using a PostgreSQL container to prevent interference. |
There was a problem hiding this comment.
Might also want to callout in the beginning that this tutorial assumes you're using Postgres
|
|
||
|
|
||
| 1. Ensure Docker is running for PostgreSQL container support. | ||
| - Set up docker engine/daemon on your machine |
There was a problem hiding this comment.
add link on where to download / install
| - Set up docker engine/daemon on your machine | ||
| - Start Docker if it's not running | ||
| 2. Identify the transactions to test. | ||
| - Use imported transactions or write your own custom Move scripts to generate test transactions. Refer to Importing Transaction Guide and Generating Transaction using Move Script Guide for detailed instructions. |
| ``` | ||
|
|
||
| Arguments: | ||
| generate-output: A custom flag to indicate that expected outputs should be generated. |
There was a problem hiding this comment.
Suggested change
| generate-output: A custom flag to indicate that expected outputs should be generated. | |
| generate-output: Set this true if you want to generate or overwrite saved database output, or false if you want to compare database outputs in diff mode. |
|
|
||
| Arguments: | ||
| generate-output: A custom flag to indicate that expected outputs should be generated. | ||
| output-path: it's an optional argument to specify the output path for the db output. |
There was a problem hiding this comment.
Suggested change
| output-path: it's an optional argument to specify the output path for the db output. | |
| output-path: An optional argument to specify a custom output path for the db output. |
|
|
||
| ### What Types of Tests Does It Support? | ||
|
|
||
| - Database schema output diff. |
There was a problem hiding this comment.
Suggested change
| - Database schema output diff. | |
| - The testing framework allows you to write tests that compare the database outputs of processors. It helps you catch changes in database output when you're updating or developing your processor. |
| - **Adapting to Other Databases**: | ||
| - Replace PostgreSQL-specific code with relevant database code you intend to use (e.g., MySQL). | ||
| - Update schema initialization and query methods. | ||
| - **Docker Installation**: Follow the [Docker setup guide](https://docs.docker.com/get-docker/). |
There was a problem hiding this comment.
we should move this higher in a pre-reqs section so it's more visible
| - Replace PostgreSQL-specific code with relevant database code you intend to use (e.g., MySQL). | ||
| - Update schema initialization and query methods. | ||
| - **Docker Installation**: Follow the [Docker setup guide](https://docs.docker.com/get-docker/). | ||
| - **Referencing Existing Tests**: |
There was a problem hiding this comment.
Suggested change
| - **Referencing Existing Tests**: | |
| - **References to Processor Tests**: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Checklist
pnpm fmt?pnpm lint?