Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose Update to Manifesto - Add test env content #359

Merged
merged 8 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions content/MinimumCD/ProdLike/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
---
title: Test == Prod
description: Production-like test environment
title: Prod-Like Test Environment
description: Leveraging production-like test environments in your CI/CD pipeline enables reliable testing.
weight: 5
draft: true
---
## Definition
It is crucial to leverage pre-production environments in your CI/CD to run all of your tests (Unit / Integration / UAT / Manual QA / E2E) early and often. Test environments increase interaction with new features and exposure to bugs -- both of which are important prerequisites for reliable software.

## Example Implementations
There are different types of pre-production test environments. Most organizations will employ both static and short-lived environments and utilize them for case-specific stages of the SDLC.
- **Staging environment**: Ideally, this is the last environment that teams will run automated tests against prior to deployment, particularly for testing interaction between all new features after a merge. Its infrastructure will reflect production as closely as possible.
- **Ephemeral environments (collected from [EphemeralEnvironments.io](https://ephemeralenvironments.io))**: These are full-stack, on-demand environments that are spun up on every code change. Each ephemeral environment should be leveraged in your pipeline, which will run E2E, unit, and integration tests against them on every code change. These environments are defined in version control and created and destroyed automatically on demand. They are short-lived by definition but should closely resemble production; they are intended to replace long-lived “static” environments and the maintenance required to keep those stable, i.e., “development,” “QA1”, “QA2”, “testing,” etc.

## What is Improved
- **Infrastructure is kept consistent**: Test environments deliver results that reflect real-world performance. Few unprecedented bugs sneak into production since using prod-like data and dependencies allows you to run your entire test suite earlier against multiple prod-like environments.
- **Test against latest changes**: These environments will rebuild upon code changes with no DevOps team intervention.
- **Test before merge**: Attaching an ephemeral environment to every PR enables E2E testing in your CI before code changes get deployed to staging. New features get tested in parallel, avoiding the dreaded “waiting to run my tests” blocking your entire SDLC.
2 changes: 1 addition & 1 deletion content/MinimumCD/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The minimum activities required for CD are:
- Artifacts created by the pipeline always meet the organization's [definition of deployable](../faq/#what-do-we-mean-by-definition-of-deployable)
- [Immutable artifact](../minimumcd/immutable/) (no human changes after commit)
- All feature work stops when the pipeline is red
- Production-like test environment
- [Production-like test environment](../minimumcd/prodlike/)
- Rollback on-demand
- [Application configuration](../faq/#what-is-application-configuration) deploys with artifact

Expand Down
2 changes: 2 additions & 0 deletions data/names/contributors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,5 @@ list:
contact: https://www.linkedin.com/in/ravindranath-wickramanayake-62375916
- name: Jarkko Piiroinen
contact: https://www.linkedin.com/in/jarkko-piiroinen/
- name: Natalie Lunbeck
contact: https://www.linkedin.com/in/natalie-lunbeck-477b45114/
2 changes: 2 additions & 0 deletions data/names/signatures.yml
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,8 @@ list:
contact: https://www.linkedin.com/in/jakub-stary
- name: Jarkko Piiroinen
contact: https://www.linkedin.com/in/jarkko-piiroinen/
- name: Natalie Lunbeck
contact: https://www.linkedin.com/in/natalie-lunbeck-477b45114/
- name: Eric Minick
contact: https://www.linkedin.com/in/ericminick/
- name: Marc Loupias
Expand Down
Loading