From 559df7f88c9fc574e565f0fe76d824df913b935b Mon Sep 17 00:00:00 2001 From: kukkok3 <93382903+kukkok3@users.noreply.github.com> Date: Tue, 7 May 2024 14:53:49 +0200 Subject: [PATCH] markdown fix --- .github/ISSUE_TEMPLATE/test_plan.yml | 4 +- .../10_quality/testplans/template.md | 81 ++++++++++++------- docs/src/index.md | 2 +- 3 files changed, 53 insertions(+), 34 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/test_plan.yml b/.github/ISSUE_TEMPLATE/test_plan.yml index b8330c7403..889d205f99 100644 --- a/.github/ISSUE_TEMPLATE/test_plan.yml +++ b/.github/ISSUE_TEMPLATE/test_plan.yml @@ -14,7 +14,7 @@ body: - type: input attributes: label: Test plan document - placeholder: https://input-output-hk.github.io/catalyst-voices/architecture/10_quality/testplans/template + placeholder: https://input-output-hk.github.io/catalyst-voices/architecture/10_quality/testplans/template.md description: A link to the test plan document. validations: required: true @@ -22,7 +22,7 @@ body: - type: textarea attributes: label: Test cases - description: The of the test cases that are part of the test plan + description: The list of the test cases that are part of the test plan placeholder: | -[] https://github.com/input-output-hk/catalyst-voices/issues/1 -[] https://github.com/input-output-hk/catalyst-voices/issues/1 diff --git a/docs/src/architecture/10_quality/testplans/template.md b/docs/src/architecture/10_quality/testplans/template.md index 20484741e0..6911f1a1bb 100644 --- a/docs/src/architecture/10_quality/testplans/template.md +++ b/docs/src/architecture/10_quality/testplans/template.md @@ -7,40 +7,42 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink *This is meant to be only a guideline, the paragraphs can be removed or added as they fit* # [Test Plan Template](https://github.com/input-output-hk/catalyst-voices/issues/1) -*insert test plan name and link to the github testplan issue* -- [General informations](#general-informations) - - [Abstract](#abstract) - - [Stakeholders](#stakeholders) - - [Requirements](#requirements) - - [Tools](#tools) -- [ACC framework](#acc-framework) - - [Attributes](#attributes) - - [Components](#components) - - [Capabilities](#capabilities) -- [Unit tests](#unit-tests) - - [Unit tests strategy](#unit-tests-strategy) - - [Unit test cases](#unit-test-cases) -- [Functional tests](#functional-tests) - - [Functional tests strategy](#functional-tests-strategy) - - [Functional test cases](#functional-test-cases) -- [Regression tests](#regression-tests) - - [Regression tests strategy](#regression-tests-strategy) - - [Regression test cases](#regression-test-cases) -- [Integration tests](#integration-tests) - - [Integration tests strategy](#integration-tests-strategy) - - [Integration test cases](#integration-test-cases) -- [End-to-end tests](#end-to-end-tests) - - [End-to-end tests strategy](#end-to-end-tests-strategy) - - [End-to-end test cases](#end-to-end-test-cases) +*insert test plan name and link to the github testplan issue* +* [General informations](#general-informations) + * [Abstract](#abstract) + * [Stakeholders](#stakeholders) + * [Requirements](#requirements) + * [Tools](#tools) +* [ACC framework](#acc-framework) + * [Attributes](#attributes) + * [Components](#components) + * [Capabilities](#capabilities) +* [Unit tests](#unit-tests) + * [Unit tests strategy](#unit-tests-strategy) + * [Unit test cases](#unit-test-cases) +* [Functional tests](#functional-tests) + * [Functional tests strategy](#functional-tests-strategy) + * [Functional test cases](#functional-test-cases) +* [Regression tests](#regression-tests) + * [Regression tests strategy](#regression-tests-strategy) + * [Regression test cases](#regression-test-cases) +* [Integration tests](#integration-tests) + * [Integration tests strategy](#integration-tests-strategy) + * [Integration test cases](#integration-test-cases) +* [End-to-end tests](#end-to-end-tests) + * [End-to-end tests strategy](#end-to-end-tests-strategy) + * [End-to-end test cases](#end-to-end-test-cases) ## General Informations ### Abstract + *Describe the design and architecture of the system in a way that highlights possible points of failure* ### Stakeholders + *Insert the relevant stakeholders that need to understand, review and approve the test plan* | Role/Name | Contact | Approval | @@ -51,28 +53,38 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink | *SRE* | | | | *Testers* | | | - ### Requirements + *Business requirements, insert links to relevant Github or JIRA tickets, list what platforms are supported, what will not be tested, etc* ### Tools + *Describe what tools will be needed for the testing, if new tools are needed to be developed* ## ACC framework + *Use the [ACC framework](https://testing.googleblog.com/2011/09/10-minute-test-plan.html) to help you define the test cases* ### Attributes -*The adverbs and adjectives that describe the high level concepts testing is meant to ensure. Attributes such as fast, usable, secure, accessible and so forth. The quality metrics document in this repo should and can be used as a guideline* + +*The adverbs and adjectives that describe the high level concepts testing is meant to ensure. +Attributes such as fast, usable, secure, accessible and so forth. +The quality metrics document in this repo should and can be used as a guideline* ### Components -*The nouns that define the major code chunks that comprise the product. These are classes, module names and features of the application.* + +*The nouns that define the major code chunks that comprise the product. +These are classes, module names and features of the application.* ### Capabilities -*The verbs that describe user actions and activities. Every capability should be testable.* + +*The verbs that describe user actions and activities. +Every capability should be testable.* ## Unit tests ### Unit tests strategy + *Evaluate new features and bug fixes introduced in this release, and the extent of the unit tests* ### Unit test cases @@ -84,6 +96,7 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink ## Functional tests ### Functional tests strategy + *Evaluate new features introduced in this release, and the extent of the functional tests* ### Functional test cases @@ -95,6 +108,7 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink ## Regression tests ### Regression tests strategy + *Ensure that previously developed and tested software still performs after change.* ### Regression test cases @@ -106,6 +120,7 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink ## Integration tests ### Integration tests strategy + *Evaluate all integrations with other functions, services etc.* ### Integration test cases @@ -117,10 +132,14 @@ Based on: https://books.google.it/books?id=vHlTOVTKHeUC&hl=it&source=gbs_navlink ## End-to-end tests ### End-to-end tests strategy -*Evaluate how will test infrastructure, systems under test, and other dependencies be managed? How will they be deployed? How will persistence be set-up/torn-down? How will you handle required migrations from one datacenter to another?* + +*Evaluate how will test infrastructure, systems under test, and other dependencies be managed? +How will they be deployed? +How will persistence be set-up/torn-down? +How will you handle required migrations from one datacenter to another?* ### End-to-end test cases | \# | OBJECTIVE | INPUT | EXPECTED RESULTS | TO BE AUTOMATED | | --- | --------- | ----- | ---------------- | --------------- | -| 1 | | | | | \ No newline at end of file +| 1 | | | | | diff --git a/docs/src/index.md b/docs/src/index.md index 1d2cf2695b..d6e791c23d 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -7,4 +7,4 @@ icon: material/chat ## How the docs are built * [MkDocs](https://www.mkdocs.org) -* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) \ No newline at end of file +* [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)