Skip to content

Commit

Permalink
Address comments v3
Browse files Browse the repository at this point in the history
Signed-off-by: David Kornel <[email protected]>
  • Loading branch information
kornys committed Mar 12, 2024
1 parent 1c5ca71 commit 91837c5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Library for easy testing of Kubernetes deployments and operators using Fabric8 A

## Provided functionality
### Kubernetes resource manager
[KubeResoruceManager](test-frame-common/src/main/java/io/skodjob/testframe/resources/KubeResourceManager.java) provides management of resources created during test phases.
Every Kubernetes resource created by `KubeResoruceManager` is automatically deleted at the end of the test, whether the test passed or failed.
[KubeResourceManager](test-frame-common/src/main/java/io/skodjob/testframe/resources/KubeResourceManager.java) provides management of resources created during test phases.
Every Kubernetes resource created by `KubeResourceManager` is automatically deleted at the end of the test, whether the test passed or failed.
So the Kubernetes environment is clean before and after every test run and user do not need to handle it.
Working with Kubernetes resources using `KubeResoruceManager` also provides proper wait for resource readiness.
Working with Kubernetes resources using `KubeResourceManager` also provides proper wait for resource readiness.

### Fabric8 Kubernetes client and CMD client
Instance of `KubeResoruceManager` contains accessible fabric8 kubernetes client and kubernetes cmd client.
Instance of `KubeResourceManager` contains accessible fabric8 kubernetes client and kubernetes cmd client.
These clients are initialized and connected to the test cluster based on the configuration provided by the env file, env variables, or kubeconfig.

### Test visual separation
Expand All @@ -30,7 +30,7 @@ For better clarity regarding the test logs, `TestFrame` library provides ASCII v
<artifactId>test-frame-common</artifactId>
</dependency>
```
2. Use annotations for working with `KubeResoruceManager` or other provided functionality
2. Use annotations for working with `KubeResourceManager` or other provided functionality
```java
//...
@ResourceManager
Expand All @@ -40,7 +40,7 @@ class Test {
}
//...
```
3. Work with `KubeResoruceManager` and clients
3. Work with `KubeResourceManager` and clients
```java
//...
@ResourceManager
Expand Down

0 comments on commit 91837c5

Please sign in to comment.