From 6e6250fb5028ab7e1729d6e649ae6564ac7f3d0f Mon Sep 17 00:00:00 2001 From: Ezequiel <73295972+iw-ezequiel@users.noreply.github.com> Date: Wed, 27 Oct 2021 10:04:49 +0100 Subject: [PATCH 1/2] Reformat quality checks --- quality-checks.md | 53 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 5 deletions(-) diff --git a/quality-checks.md b/quality-checks.md index 01e55e31..bc781a03 100644 --- a/quality-checks.md +++ b/quality-checks.md @@ -8,10 +8,11 @@ Quality checks are at the heart of good engineering, and are essential for rapid The checks are classified here based on the concerns they help to address: -* Functionality -* Security -* Resilience -* Maintainability +* [Functionality](#1-functionality-checks) +* [Security](#2-security-checks) +* [Resilience](#3-resilience-checks) +* [Maintainability](#4-maintainability-checks) +* [General checks] (#5-general-checks) ## Usage @@ -38,7 +39,49 @@ We recommend tracking progress on an Engineering Quality dashboard, for example: ![Example Dashboard](images/quality-dashboard.png) -## Details + +## 1. Functionality checks +* [Unit tests](#unit-tests) +* [Integration tests](#integration-tests) +* API/Contract tests +* UI Tests + +### Unit Tests ![](https://img.shields.io/badge/-Universal-blue) +#### About +* What it is: Logic tests for individual blocks of code, e.g. individual methods. +* Why we care: This is the quickest (to execute) type of functional test, so these are essential to achieve both rapid and thorough functional testing. +* Endorsed tools/configuration: TBD +* Further details: See [Test practices](./practices/testing.md) + +#### Thresholds +* ![](https://img.shields.io/badge/-Green-green) Builds fail if any tests fail. +* ![](https://img.shields.io/badge/-Amber-yellow) TBD + +### Integration tests ![](https://img.shields.io/badge/-Universal-blue) +#### About +* What it is: Check interactions with other components and dependant systems. e.g. across microservices, authentication layers, database, third-party systems. Ideally includes full end-to-end testing across all components. +* Why we care: When components are developed in isolation, it's vital that we regularly test them working together. Changes in one component can break the whole system. +* Endorsed tools/configuration: TBD + +#### Thresholds +* ![](https://img.shields.io/badge/-Green-green) Builds fail if any tests fail. +* ![](https://img.shields.io/badge/-Amber-yellow) TBD + +## 2. Security checks +Checks here + +## 3. Resilience checks +Checks here + +## 4. Maintainability checks +Checks here + +## 5. General checks + + + + +## --Deprecated below--Details | Quality check | Classification | Applicability | What it means | Why we care | Tolerances for green | Endorsed tools / configuration | Further details | | :--------------------- | :-------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ | From 285c2afbdc181b6f951a36e3195f23872dc79d29 Mon Sep 17 00:00:00 2001 From: Ezequiel <73295972+iw-ezequiel@users.noreply.github.com> Date: Wed, 27 Oct 2021 10:06:45 +0100 Subject: [PATCH 2/2] Typos --- quality-checks.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/quality-checks.md b/quality-checks.md index bc781a03..cd91e102 100644 --- a/quality-checks.md +++ b/quality-checks.md @@ -12,7 +12,7 @@ The checks are classified here based on the concerns they help to address: * [Security](#2-security-checks) * [Resilience](#3-resilience-checks) * [Maintainability](#4-maintainability-checks) -* [General checks] (#5-general-checks) +* [General checks](#5-general-checks) ## Usage @@ -41,8 +41,8 @@ We recommend tracking progress on an Engineering Quality dashboard, for example: ## 1. Functionality checks -* [Unit tests](#unit-tests) -* [Integration tests](#integration-tests) +* [Unit tests](#unit-tests-) +* [Integration tests](#integration-tests-) * API/Contract tests * UI Tests