From b4b84b9ce45de41461077218ea5ca9decfb4a398 Mon Sep 17 00:00:00 2001 From: Kyongsik Yun Date: Thu, 7 Dec 2023 07:25:32 -0800 Subject: [PATCH] Update continuous-testing-plan-example.md --- .../continuous-testing-plan-example.md | 55 +++++++------------ 1 file changed, 19 insertions(+), 36 deletions(-) diff --git a/docs/guides/software-lifecycle/continuous-testing/continuous-testing-plan-example.md b/docs/guides/software-lifecycle/continuous-testing/continuous-testing-plan-example.md index 1116724df..085d6b44a 100644 --- a/docs/guides/software-lifecycle/continuous-testing/continuous-testing-plan-example.md +++ b/docs/guides/software-lifecycle/continuous-testing/continuous-testing-plan-example.md @@ -1,29 +1,20 @@ -To be updated with a real example - -### Example -``` -### [INSERT PROJECT NAME HERE] Continuous Testing Plan +### [Project X] Continuous Testing Plan #### Introduction: -This document aims to provide a general approach to Continuous Testing for [INSERT PROJECT NAME HERE]. It encompasses planning, test phases, tool recommendations, and test specifications. +This document outlines the Continuous Testing plan for Project X, a Python-based web application for project management. The plan includes testing strategy, phases, tool recommendations, and specifications. --- #### **1. Project Overview** -- **Project Name:** [INSERT PROJECT NAME HERE] -- **Project Description:** [INSERT SHORT PROJECT DESCRIPTION HERE] -- **Testing Lead:** [INSERT PROJECT LEAD NAME HERE] +- **Project Name:** Project X +- **Project Description:** A web-based application for project management. +- **Testing Lead:** Jane Doe #### **2. Test Requirements** -- **Objective:** Why are we testing? [INSERT OBJECTIVE HERE] - - -- **Test Artifacts:** What are we testing? [INSERT ARTIFACTS HERE] - - +- **Objective:** Ensure codebase integrity, performance, and security for reliable software releases. +- **Test Artifacts:** Front-end components, APIs, Database layer. #### **3. Testing Workflow Architecture** -``` ```mermaid graph TD; A[Code] @@ -55,33 +46,25 @@ graph TD; O[Collect Metrics] P[Generate Reports] end - ``` -``` #### **4. Test Specifications** -Before customizing the table entries below, evaluate your project's specific needs and requirements. Add, remove, or modify rows in the table to best represent the phases, tests, tools, and people associated with your testing approach. -``` + | Phase | High-level Tests | Recommended Tool | Description | Starter Kit | Key People | |-------|------------------|-----------------|-------------|-------------|------------| -| Security Testing | Vulnerability Scan | [GitHub Dependabot](https://dependabot.com/) | Monitors dependencies for known vulnerabilities. | [GitHub Docs](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) | [INSERT NAME HERE] | -| | Secure Code Review | [SonarQube](https://www.sonarqube.org/) | Continuous inspection of code quality. | [SonarQube Docs](https://docs.sonarqube.org/latest/) | [INSERT NAME HERE] | -| Unit Testing | Function Validity | [JUnit](https://junit.org/junit5/) | Verifies individual units of Java software. | [JUnit 5 Guide](https://junit.org/junit5/docs/current/user-guide/) | [INSERT NAME HERE] | -| | Null Checks | [xUnit](https://xunit.net/) | Unit testing tool for .NET. | [xUnit.net Docs](https://xunit.github.io/docs/) | [INSERT NAME HERE] | -| Regression Testing | Feature Consistency | [Cucumber](https://cucumber.io/) | Supports behavior-driven development (BDD). | [Cucumber Starter](https://cucumber.io/docs/guides/10-minute-tutorial/) | [INSERT NAME HERE] | -| | User Flow Validation | [Selenium](https://www.selenium.dev/) | Ensures that new code changes do not adversely affect existing functionalities. | [Selenium HQ](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/) | [INSERT NAME HERE] | -| Integration Testing | API Contract Validation | [REST Assured](https://rest-assured.io/) | Java DSL for simplifying testing of REST based services. | [REST Assured Guide](https://github.com/rest-assured/rest-assured/wiki/GettingStarted) | [INSERT NAME HERE] | -| | Data Flow Checks | [Postman](https://www.postman.com/) | Validates the interfaces and interactions between different software modules. | [Postman Learning Center](https://learning.postman.com/) | [INSERT NAME HERE] | -| Performance Testing | Load Testing | [JMeter](https://jmeter.apache.org/) | Measures system performance under various conditions. | [JMeter User Manual](https://jmeter.apache.org/usermanual/index.html) | [INSERT NAME HERE] | -| Requirements Verification & Validation | Requirement Traceability | [TestRail](https://www.gurock.com/testrail) | Ensures that the system meets the defined requirements. | [TestRail Docs](https://www.gurock.com/testrail/docs/) | [INSERT NAME HERE] | -| Deployment Testing | Cloud Deployment | [Terraform](https://www.terraform.io/) | Infrastructure as code for cloud provisioning. | [Terraform Get Started](https://learn.hashicorp.com/terraform/getting-started/install.html) | [INSERT NAME HERE] | -| | Chaos Testing | [Chaos Monkey](https://github.com/Netflix/chaosmonkey) | Simulates random failures to test system resilience. | [Chaos Monkey Wiki](https://github.com/Netflix/chaosmonkey/wiki) | [INSERT NAME HERE] | +| Security Testing | Vulnerability Scan | [GitHub Dependabot](https://dependabot.com/) | Monitors dependencies for known vulnerabilities. | [GitHub Docs](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates) | Jane Doe | +| | Secure Code Review | [SonarQube](https://www.sonarqube.org/) | Continuous inspection of code quality. | [SonarQube Docs](https://docs.sonarqube.org/latest/) | Jane Doe | +| Unit Testing | Function Validity | [pytest](https://docs.pytest.org/en/latest/) | Verifies individual units of Python software. | [pytest Docs](https://docs.pytest.org/en/latest/) | Jane Doe | +| Regression Testing | User Flow Validation | [Selenium](https://www.selenium.dev/) | Ensures that new code changes do not adversely affect existing functionalities. | [Selenium Doc](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/) | Jane Doe | +| Integration Testing | System Validation | [pytest](https://docs.pytest.org/en/latest/) | Pytest supports integration testing. | [pytest Docs](https://docs.pytest.org/en/latest/) | Jane Doe | +| Performance Testing | Load Testing | [Apache JMeter](https://jmeter.apache.org/) | Measures system performance under various conditions. | [JMeter User Manual](https://jmeter.apache.org/usermanual/index.html) | Jane Doe | +| Requirements Verification & Validation | Requirement Traceability | [Pylint](https://pypi.org/project/pylint/) | Checks Python code against coding standards and helps catch errors. | [Pylint Docs](https://pylint.readthedocs.io/en/latest/) | Jane Doe | + #### 5. Implementation Checklist -- [ ] Continuous Testing Plan (this document) defined, including all relevant parts -- [ ] Security Testing tools, people, and tests implemented -- [ ] Unit Testing tools, people, and tests implemented +- [ ] Continuous Testing Plan defined, including all relevant parts. +- [ ] Security Testing tools, people, and tests implemented. +- [ ] Unit Testing tools, people, and tests implemented. - [ ] All planned test cases defined in the test plan are implemented. - [ ] Defects are reported and tracked. - [ ] Test summary report is generated and shared with stakeholders. -