How do you document blockchain testing results?

1 Define the testing scope and objectives

Before you begin testing, it's important to define the scope and objectives of your testing activities. This will help you plan and execute tests in an effective and efficient manner. You should document the type and level of testing, the test cases and scenarios, the expected outcomes and success criteria, as well as the tools and frameworks you will use for testing. These should all be based on the requirements and specifications of your blockchain application, such as the expected behavior, performance, security, and quality.

2 Record the testing environment and configuration

The testing environment and configuration are essential for obtaining accurate testing results. Therefore, it is important to document the testing environment and configuration to ensure reproducibility, reliability, and validity. This should include the hardware and software specifications of your testing machines, such as CPU, RAM, disk space, operating system, network, etc. Additionally, you should document the blockchain platform and protocol you are using, such as Ethereum or Hyperledger. Furthermore, blockchain network settings and parameters should be documented, such as the consensus mechanism, block size, block time, transaction fees, etc. Lastly, you should document the blockchain nodes and accounts you are using including the number, type, role, address, balance, etc.

3 Capture the testing execution and results

The testing execution and results are a key component of your documentation. Capturing the testing execution and results will help to demonstrate the functionality, pinpoint any issues, and analyze the performance of your blockchain application. You should document the test steps and actions you performed, such as the input data, commands, and transactions. Additionally, you should record the test outputs and responses you received, such as output data, messages, logs, and receipts. Additionally, you should note the test status and verdicts you assigned, such as pass, fail, error, or skip. Lastly, you should measure and record the test metrics and measurements you collected like response time, throughput, latency, and gas consumption.

4 Report the testing issues and defects

Testing issues and defects are the problems and errors encountered during testing. It is important to report these issues and defects to communicate their severity, impact, and root cause. When documenting your testing issues and defects, it is necessary to include the issue or defect ID and title, category and priority, description and details, as well as status and resolution. This includes a unique identifier, a brief description of the problem or error, type, level, and urgency of the issue or error, steps to reproduce, expected and actual results, screenshots, logs, status, assignee, comments, actions, etc.

5 Review and update the testing documentation

The testing documentation is not a static document that you create once and forget. You should review and update the testing documentation regularly to reflect the changes, feedback, and improvements of your testing and development process. This should include the version number and date of the last update, a summary and details of any changes or revisions made, any feedback or suggestions from stakeholders, reviewers, or users of the testing documentation, as well as an improvement and action plan for enhancing the quality and usability of the document.

6 Here’s what else to consider

This is a space to share examples, stories, or insights that don’t fit into any of the previous sections. What else would you like to add?