Skip to content

Commit

Permalink
Merge pull request DiceDB#1481 from DiceDB/arpit-readiness-cli-chat
Browse files Browse the repository at this point in the history
Issue template made grammatically correct
  • Loading branch information
arpitbbhayani authored Feb 11, 2025
2 parents cd43cae + e35d57b commit c1d513c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/write_integration_tests_for_cmd.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ assignees: ''

We reimplemented the core of the DiceDB engine and re-wrote - the wire protocol, execution engine, and config management. This rewrite helped us gain 32% throughput over our existing benchmark.

To make DiceDB is stable even after 100s of changes, we have to put effort
into making sure we have a comprehensive integration test suite for each command. This issue will be used to cover the port and fixes for integration tests related to the command `{CMD}`.
To make DiceDB stable even after 100s of changes, we have to put effort
into making sure we have a comprehensive integration test suite for each command. This issue will be used to cover the port and fixes for integration tests related to the command `CMD`.

Here are the pre-requisite

1. setup DiceDB server locally from the source - [instructions](https://github.com/dicedb/dice)
2. setup DiceDB Go SDK locally from the source - [instructions](https://github.com/dicedb/dicedb-go)
3. refer to `Pointing to local checked-out `dicedb-go` section in `README`.
3. refer to the `Pointing to local checked-out `dicedb-go` section in `README`.

### Start the DiceDB server with IronHawk engine

Expand All @@ -25,9 +25,9 @@ $ go run main.go --engine ironhawk --log-level debug

## Setting up Integration Tests

0. Make sure DiceDB server is running. This is essential for you to run the tests
1. Integration tests of all the commands can be found under `tests/commands/ironhawk` with the name `{cmd}_test.go`.
2. For the command `{CMD}` find the tests
0. Make sure the DiceDB server is running. This is essential for you to run the tests
1. Integration tests of all the commands can be found under `tests/commands/ironhawk` with the name `cmd_test.go`.
2. For the command `cmd` find the tests
3. Run the test function using the following command

```
Expand All @@ -42,15 +42,15 @@ executes only one function which is `TestSet`.

1. Fix any dependency error (refer `set_test.go` file)
2. Fix any execution error (refer `set_test.go` file)
3. There are some utility functions written, use them, but as per `set_test.go` file.
3. There are some utility functions written, use them, but as per the `set_test.go` file.

Ideally all the tests should pass. If some are failing
Ideally, all the tests should pass. If some are failing

1. either fix them (if you think it is a bug in the tests)
2. or raise a bug if you think there is an implementation mistake

Eventually we need 100% integration test coverage for all the commands to
prove that DiceDB is stable and production ready.
Eventually, we need 100% integration test coverage for all the commands to
prove that DiceDB is stable and production-ready.

If you find any other bug while you are implementing it, you can either

Expand Down

0 comments on commit c1d513c

Please sign in to comment.