Skip to content

Commit

Permalink
Fix typos in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
komalsukhani authored Nov 18, 2021
1 parent 8412394 commit 6d24c50
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/design/test-harness-framework.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Go E2E Test Framework for Kubernetes

This document captures high-level design ideas for the next generation of a Go framework for testing components runnking on Kubernetes. The framework, referred to as `e2e-framework` provides ways that makes it easy to define tests functions that can programmatically test components running on a cluster. The two overall goals of the new framework are to allow developers to quickly and easily assemble end-to-end tests and to provide a collection of support packages to help with interacting with the API-server.
This document captures high-level design ideas for the next generation of a Go framework for testing components running on Kubernetes. The framework, referred to as `e2e-framework` provides ways that makes it easy to define tests functions that can programmatically test components running on a cluster. The two overall goals of the new framework are to allow developers to quickly and easily assemble end-to-end tests and to provide a collection of support packages to help with interacting with the API-server.

> See the original Google Doc design document [here](https://docs.google.com/document/d/11JKqcnUOrw5Lk98f_ylJXBXyxWSW1z3CZu27OLX1CbM/edit).
Expand Down Expand Up @@ -45,7 +45,7 @@ The initial design of the end-to-end test framework, defined here, will be heavi
![](./e2e-environment-design.png)

### Environment
The environment component is the heart of the framework. It allows devlopers to define attributes and features to be tested (see Test Features below). The environment uses callback functions to let developers implement customized behaviors before or after a test suite has been exercised.
The environment component is the heart of the framework. It allows developers to define attributes and features to be tested (see Test Features below). The environment uses callback functions to let developers implement customized behaviors before or after a test suite has been exercised.

The following shows a proposed type for the environment:

Expand Down Expand Up @@ -107,7 +107,7 @@ Before an `Environment` can be used to run tests, it goes through several stages

#### Propagating environment context
This framework is designed for a context to be injected early during the contstruction of the `Environment` value (see constructor functions above). A context can optionally be provided using constructor function `env.NewWithContext`. All other constructor function shall create a default context internally.
This framework is designed for a context to be injected early during the construction of the `Environment` value (see constructor functions above). A context can optionally be provided using constructor function `env.NewWithContext`. All other constructor function shall create a default context internally.

#### Updating the `Environment` context
In some instances, it will be necessary to update a previously injected (or the default) context. To update an environment's context, after the environment has been already created, test writers should use `Environment.WithContext` method to update the context and get a new environment with the newly updated context.
Expand Down Expand Up @@ -498,4 +498,4 @@ For instance, assuming a `support` package is part of the framework, the followi
* Knative Reconciler Test Framework - https://github.com/knative-sandbox/reconciler-test
* Contour Integration Test Harness - https://github.com/projectcontour/contour/issues/2222
* Integration Tester for Kubernetes - https://github.com/projectcontour/integration-tester
* https://github.com/kubernetes-sigs/ingress-controller-conformance
* https://github.com/kubernetes-sigs/ingress-controller-conformance

0 comments on commit 6d24c50

Please sign in to comment.