Skip to content

Commit

Permalink
Adding command details to testing plan (#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
plauche authored May 3, 2023
1 parent 46b3574 commit db7377e
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions testing/testing-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Steps:
1. Using controller software, send the `RequestAvailableBlocks` command to the `myceli` space instance.
- This step passes if an `AvailableBlocks` response is received. Any other response / no response is a failure.

Command Details:
- `RequestAvailableBlocks` takes no parameters. A `myceli` node which receives this command will respond with an `AvailableBlocks` message to the sending address.
- Example: `./controller myceli-service:8080 -l request-available-blocks`

This test case passes if both steps pass.

## Test Case - Retrieve an IPFS File
Expand All @@ -27,6 +31,16 @@ Steps:
1. Using the controller software, send the `ExportDag` command to the `myceli` ground instance with the CID obtained from the `FileImported` response and a writeable file path.
- This step passes if `myceli` is able to correctly write a file to the given file path.

Command Details:
- **`ImportFile`** takes one parameter, the path of the file to import. A `myceli` node which receives this command will respond with a `FileImported` message to the sending address.
- Example: `./controller myceli-service:8080 -l import-file /path/to/file`
- **`TransmitDag`** takes three parameters: the CID of the dag to transfer, the address to transmit the dag to, and the number of retries allowed in the transfer. A `myceli` node which receives this command will begin a dag transmission session with the specified address, which is assumed to be another `myceli` node, and will not respond back to the sending address.
- Example: `./controller myceli-service:8080 transmit-dag cid-here radio-service:8081 5`
- **`ValidateDag`** takes one parameter: the CID of the dag to validate. A `myceli` node which receives this command will respond with a `ValidateDagResponse` to the sending address, which is assumed to be another `myceli` node.
- Example: `./controller myceli-service:8080 -l validate-dag cid-here`
- **`ExportDag`** takes two parameters: the CID of the dag to export and a filepath to export to. A `myceli` node which receives this command will not send a response back.
- Example: `./controller myceli-service:8080 export-dag cid-here /path/to/file`

This test case passes if the final step is successful and the resulting written file matches the onboard payload file.

## Test Case - Send and Retrieve New IPFS File
Expand All @@ -44,4 +58,14 @@ Steps:
1. Using the controller software, send the `ExportDag` command to the `myceli` ground instance with the CID obtained from the `FileImported` response and a writeable file path.
- This step passes if `myceli` is able to correctly write a file to the given file path.

Command Details:
- **`ImportFile`** takes one parameter, the path of the file to import. A `myceli` node which receives this command will respond with a `FileImported` message to the sending address.
- Example: `./controller myceli-service:8080 -l import-file /path/to/file`
- **`TransmitDag`** takes three parameters: the CID of the dag to transfer, the address to transmit the dag to, and the number of retries allowed in the transfer. A `myceli` node which receives this command will begin a dag transmission session with the specified address, which is assumed to be another `myceli` node, and will not respond back to the sending address.
- Example: `./controller myceli-service:8080 transmit-dag cid-here radio-service:8081 5`
- **`ValidateDag`** takes one parameter: the CID of the dag to validate. A `myceli` node which receives this command will respond with a `ValidateDagResponse` to the sending address.
- Example: `./controller myceli-service:8080 -l validate-dag cid-here`
- **`ExportDag`** takes two parameters: the CID of the dag to export and a filepath to export to. A `myceli` node which receives this command will not send a response back.
- Example: `./controller myceli-service:8080 export-dag cid-here /path/to/file`

This test case passes if the final step is successful and the resulting written file matches the originally transmitted payload file.

0 comments on commit db7377e

Please sign in to comment.