Skip to content

Commit

Permalink
chore: rename TestKube to Testkube
Browse files Browse the repository at this point in the history
  • Loading branch information
exu committed Feb 10, 2022
1 parent e9c7d76 commit 3449e28
Show file tree
Hide file tree
Showing 81 changed files with 229 additions and 231 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Bug report
about: Create a report to help us improve TestKube
about: Create a report to help us improve Testkube
title: ''
labels: 'bug 🐛'
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Enhancement
about: Suggest an enhancement to existing TestKube functionality
about: Suggest an enhancement to existing Testkube functionality
title: ''
labels: 'enhancement 🚀'
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest an idea or new feature for TestKube
about: Suggest an idea or new feature for Testkube
title: ''
labels: 'feature-request 🚀'
assignees: ''
Expand Down
4 changes: 1 addition & 3 deletions .goreleaser-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,7 @@ brews:
homepage: https://testkube.io
license: "MIT"
nfpms:
-
maintainer: TestKube team
- maintainer: Testkube team
license: "MIT"
formats:
- deb

2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ brews:
homepage: https://testkube.io
license: "MIT"
nfpms:
- maintainer: TestKube team
- maintainer: Testkube team
license: "MIT"
formats:
- deb
Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TestKube (by Kubeshop) Community Code of Conduct
# Testkube (by Kubeshop) Community Code of Conduct

testkube follows the CNCF Code of Conduct. The text of the CNCF CoC is replicated below. If you notice that this is out of date, please file an issue.

Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -83,17 +83,17 @@ create-examples:

test-reload-sanity-script:
kubectl delete script sanity -ntestkube || true
kubectl testkube scripts create -f test/e2e/TestKube-Sanity.postman_collection.json --name sanity
kubectl testkube scripts create -f test/e2e/Testkube-Sanity.postman_collection.json --name sanity


# test local api server intance - need local-postman/collection type registered to local postman executor
test-api-local:
newman run test/e2e/TestKube-Sanity.postman_collection.json --env-var script_name=fill-me --env-var script_type=postman/collection --env-var api_uri=http://localhost:8088 --env-var script_api_uri=http://localhost:8088 --env-var execution_name=fill --verbose
newman run test/e2e/Testkube-Sanity.postman_collection.json --env-var script_name=fill-me --env-var script_type=postman/collection --env-var api_uri=http://localhost:8088 --env-var script_api_uri=http://localhost:8088 --env-var execution_name=fill --verbose

# run by newman but on top of port-forwarded cluster service to api-server
# e.g. kubectl port-forward svc/testkube-api-server 8088
test-api-port-forwarded:
newman run test/e2e/TestKube-Sanity.postman_collection.json --env-var script_name=fill-me --env-var script_type=postman/collection --env-var api_uri=http://localhost:8088 --env-var execution_name=fill --env-var script_api_uri=http://testkube-api-server:8088 --verbose
newman run test/e2e/Testkube-Sanity.postman_collection.json --env-var script_name=fill-me --env-var script_type=postman/collection --env-var api_uri=http://localhost:8088 --env-var execution_name=fill --env-var script_api_uri=http://testkube-api-server:8088 --verbose

# run script by testkube plugin
test-api-on-cluster:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Testkube advantages:
- Centralizes all test results in a consistent format for "actionable QA analytics"
- Provides a modular architecture for adding new types of test scripts and executors

Main TestKube components are:
Main Testkube components are:

- kubectl Testkube plugin - simple - installed w/o 3rd party repositories (like Krew etc), communicates with
- API Server - work orchestrator, runs executors, gather execution results
- [CRDs Operator](https://github.com/kubeshop/testkube-operator) - watches TestKube CR, handles changes, communicates with API Server
- [CRDs Operator](https://github.com/kubeshop/testkube-operator) - watches Testkube CR, handles changes, communicates with API Server
- Executors - runs tests defined for specific runner
- [Postman Executor](https://github.com/kubeshop/testkube-executor-postman) - runs Postman Collections
- [Cypress Executor](https://github.com/kubeshop/testkube-executor-cypress) - runs Cypress Tests
Expand Down
6 changes: 3 additions & 3 deletions api/v1/kusk.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -532,12 +532,12 @@ spec:
info:
contact:
email: testkube@kubeshop.io
description: TestKube provides a Kubernetes-native framework for test definition,
description: Testkube provides a Kubernetes-native framework for test definition,
execution and results
license:
name: MIT
url: https://opensource.org/licenses/MIT
title: TestKube API
title: Testkube API
version: 1.0.0
openapi: 3.0.1
paths:
Expand Down Expand Up @@ -1144,7 +1144,7 @@ spec:
- scripts
- executions
tags:
- description: TestKube API operations
- description: Testkube API operations
name: api
- description: Script operations
name: scripts
Expand Down
16 changes: 8 additions & 8 deletions api/v1/testkube.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
openapi: 3.0.1

info:
title: TestKube API
description: "TestKube provides a Kubernetes-native framework for test definition, execution and results"
title: Testkube API
description: "Testkube provides a Kubernetes-native framework for test definition, execution and results"
contact:
email: testkube@kubeshop.io
license:
Expand All @@ -16,13 +16,13 @@ externalDocs:

tags:
- name: api
description: "TestKube API operations"
description: "Testkube API operations"
- name: tests
description: "Script operations"
description: "Tests operations"
- name: executions
description: "Execution operations"
description: "Test suites and tests execution operations"
- name: test-suites
description: "Scripts orchestration operations"
description: "Tests orchestration operations"
- name: tags
description: "Listing all available tags"

Expand Down Expand Up @@ -112,7 +112,7 @@ paths:
items:
$ref: "#/components/schemas/Problem"

/test-executions:
/test-suite-executions:
get:
tags:
- executions
Expand Down Expand Up @@ -144,7 +144,7 @@ paths:
items:
$ref: "#/components/schemas/Problem"

/test-executions/{id}:
/test-suite-executions/{id}:
get:
parameters:
- in: path
Expand Down
2 changes: 1 addition & 1 deletion assets/grafana-dasboard.json
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@
},
"timepicker": {},
"timezone": "",
"title": "TestKube",
"title": "Testkube",
"uid": "jMtrP3nnz",
"version": 2
}
2 changes: 1 addition & 1 deletion cmd/kubectl-testkube/commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func ValidateVersions(c apiclient.Client) error {
}

if clientVersion.LessThan(serverVersion) {
ui.Warn("Your TestKube API version is newer than your `kubectl testkube` plugin")
ui.Warn("Your Testkube API version is newer than your `kubectl testkube` plugin")
ui.Info("Testkube API version", serverVersion.String())
ui.Info("Testkube kubectl plugin client", clientVersion.String())
ui.Info("It's recommended to upgrade client to version close to API server version")
Expand Down
14 changes: 7 additions & 7 deletions cmd/tools/commands/release.go
Original file line number Diff line number Diff line change
Expand Up @@ -59,32 +59,32 @@ func NewReleaseCmd() *cobra.Command {
ui.ExitOnError("getting chart path", err)

testkubeVersion := helm.GetVersion(chart)
nextTestKubeVersion := getNextVersion(dev, testkubeVersion, version.Patch)
ui.Info("Generated new testkube version", nextTestKubeVersion)
nextTestkubeVersion := getNextVersion(dev, testkubeVersion, version.Patch)
ui.Info("Generated new testkube version", nextTestkubeVersion)

// bump main testkube chart version
helm.SaveString(&chart, "version", nextTestKubeVersion)
helm.SaveString(&chart, "appVersion", nextTestKubeVersion)
helm.SaveString(&chart, "version", nextTestkubeVersion)
helm.SaveString(&chart, "appVersion", nextTestkubeVersion)

// set app dependency version
helm.UpdateDependencyVersion(chart, appName, nextAppVersion)

err = helm.Write(path, chart)
ui.ExitOnError("saving testkube Chart.yaml file", err)

gitAddCommitAndPush(dir, "updating testkube to "+nextTestKubeVersion+" and "+appName+" to "+nextAppVersion)
gitAddCommitAndPush(dir, "updating testkube to "+nextTestkubeVersion+" and "+appName+" to "+nextAppVersion)

tab := ui.NewArrayTable([][]string{
{appName + " previous version", currentAppVersion},
{"testkube previous version", testkubeVersion},
{appName + " next version", nextAppVersion},
{"testkube next version", nextTestKubeVersion},
{"testkube next version", nextTestkubeVersion},
})

ui.NL()
ui.Table(tab, os.Stdout)

ui.Completed("Release completed - Helm charts: ", "testkube:"+nextTestKubeVersion, appName+":"+nextAppVersion)
ui.Completed("Release completed - Helm charts: ", "testkube:"+nextTestkubeVersion, appName+":"+nextAppVersion)
ui.NL()
},
}
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ If you're new in Open-source community there is nice guide how to start contribu

Checkout [development page](development.md) for more details about how to develop and run testkube on your machine.

## General guidance for contributing to TestKube project
## General guidance for contributing to Testkube project

You're very welcome to help in TestKube development 🔥, there is a lot of incoming work to do :).
You're very welcome to help in Testkube development 🔥, there is a lot of incoming work to do :).

We're trying hard to limit technical debt from the beginning so we defined simple rules when putting some code into TestKube repo.
We're trying hard to limit technical debt from the beginning so we defined simple rules when putting some code into Testkube repo.

### For golang based components

Expand Down
14 changes: 7 additions & 7 deletions docs/dashboard.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# TestKube Dashboard
# Testkube Dashboard

The TestKube Dashboard provides a simple web-based UI for monitoring TestKube test-results via a web-browser.
The Testkube Dashboard provides a simple web-based UI for monitoring Testkube test-results via a web-browser.

![img.png](img/dashboard.png)

It can be accessed at [https://dashboard.testkube.io](https://dashboard.testkube.io) which will prompt for the
results endpoint of your TestKube installation in order to show your results (see below on how to find that). Once
results endpoint of your Testkube installation in order to show your results (see below on how to find that). Once
you have the results endpoint you can append it to the above URL (as an apiEndpoint parameter) for a direct link to
the dashboard with your results, i.e.

Expand All @@ -19,9 +19,9 @@ will uses port forwarding for accessing your local results endpoint (see more [h
To expose the results endpoint currently needed by the dashboard there are 2 options:

* Expose the results endpoint using an Ingress controller and use it in the dashboard at dashboard.testkube.io.
* Install the dashboard together with TestKube.
* Install the dashboard together with Testkube.

It can be achieved installing TestKube using helm charts located at github.com/kubeshop/helm-charts.
It can be achieved installing Testkube using helm charts located at github.com/kubeshop/helm-charts.

## Prerequisites

Expand All @@ -31,7 +31,7 @@ Add repo to helm
helm repo add kubeshop https://kubeshop.github.io/helm-charts && helm repo update
```

Exposing something to the outside world will need an ingress-controller, by default TestKube is using ingress-nginx, any other ingress can be used but this will need advanced configuration(a values file for guidance can be found [here](https://github.com/kubeshop/helm-charts/blob/39f73098630b333ba66db137e7fc016c39d92876/testkube/charts/testkube/values-demo.yaml)).
Exposing something to the outside world will need an ingress-controller, by default Testkube is using ingress-nginx, any other ingress can be used but this will need advanced configuration(a values file for guidance can be found [here](https://github.com/kubeshop/helm-charts/blob/39f73098630b333ba66db137e7fc016c39d92876/testkube/charts/testkube/values-demo.yaml)).

## Configure ingress for results endpoint

Expand All @@ -41,7 +41,7 @@ helm install testkube kubeshop/testkube --set api-server.ingress.enabled="true"

by default the results are using the path ```/results``` so the results will be accessible at ```ingress_host/results/```

The ingress configuration used is available int the [TestKube Helm Repo](https://github.com/kubeshop/helm-charts)
The ingress configuration used is available int the [Testkube Helm Repo](https://github.com/kubeshop/helm-charts)

## Installing dashboard

Expand Down
2 changes: 1 addition & 1 deletion docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ to install CRD's into your local cluster
## Running on local machine

Next critical component is testkube API (<https://github.com/kubeshop/testkube>) and some executor you can build - your
own tests executor or existing one from TestKube.
own tests executor or existing one from Testkube.

Checkout testkube project and run local API server:

Expand Down
2 changes: 1 addition & 1 deletion docs/executor-curl.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Curl Commands

TestKube is able to run curl commands as tests, there are 2 possibilities to validate the outputs of the curl command, one using the status returned and the other checking the body of the response. Bellow is an example on how to format the tests.
Testkube is able to run curl commands as tests, there are 2 possibilities to validate the outputs of the curl command, one using the status returned and the other checking the body of the response. Bellow is an example on how to format the tests.

```js
{
Expand Down
2 changes: 1 addition & 1 deletion docs/executor-custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You can check full example implementation here: <https://github.com/exu/testkube

### Implement Runner Components

[TestKube](https://github.com/kubeshop/testkube) provides the components to help implement a new runner which is responsible for running and parsing results. But you're not limited to use our components for `go` language - you can you whatever language you want - just remember about managing input and output.
[Testkube](https://github.com/kubeshop/testkube) provides the components to help implement a new runner which is responsible for running and parsing results. But you're not limited to use our components for `go` language - you can you whatever language you want - just remember about managing input and output.

Let's try to create new test runner which test if given URI call is successfull (`status code == 200`)

Expand Down
6 changes: 3 additions & 3 deletions docs/executor-cypress.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cypress Tests

TestKube is able to make simple runs of Cypress tests. As Cypress is organised in projects we allow to define your tests in Github repository (for now only public one is implemented).
Testkube is able to make simple runs of Cypress tests. As Cypress is organised in projects we allow to define your tests in Github repository (for now only public one is implemented).

To create new cypress test you need some Git repository with example cypress project (please follow Cypress docs for details - <https://docs.cypress.io/guides/dashboard/projects>)

Expand All @@ -26,7 +26,7 @@ describe('The Home Page', () => {

## Creating `testkube` test script

Now we need to create TestKube test script from this example (we need to pass repo, branch, path where project exists - in case of mono repo, name and type)
Now we need to create Testkube test script from this example (we need to pass repo, branch, path where project exists - in case of mono repo, name and type)

```sh
kubectl testkube scripts create --uri https://github.com/kubeshop/testkube-executor-cypress.git --git-branch main --git-path examples --name kubeshop-cypress --type cypress/project
Expand Down Expand Up @@ -284,4 +284,4 @@ Script execution completed in 1m45.405939s
## Summary
Our first test completed successfully! As we've seen above it's really easy to run Cypress tests with TestKube!
Our first test completed successfully! As we've seen above it's really easy to run Cypress tests with Testkube!
10 changes: 5 additions & 5 deletions docs/executor-postman.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Postman Collections

You can watch simple TestKube intro to get into Postman collections with TestKube
You can watch simple Testkube intro to get into Postman collections with Testkube

<iframe width="560" height="315" src="https://www.youtube.com/embed/rWqlbVvd8Dc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen>
</iframe>

TestKube is able to run Postman collections inside your Kubernetes cluster, you can use it to test internal or external services.
Testkube is able to run Postman collections inside your Kubernetes cluster, you can use it to test internal or external services.

## Test environment

Expand Down Expand Up @@ -36,7 +36,7 @@ I've saved it into `~/Downloads/API-Health.postman_collection.json`

Now we can create new testkube based on saved Postman Collection:

## Create new TestKube test script
## Create new Testkube test script

```sh
kubectl testkube scripts create --name api-incluster-test --file ~/Downloads/API-Health.postman_collection.json --type postman/collection
Expand Down Expand Up @@ -85,7 +85,7 @@ $ kubectl testkube scripts watch 615d6398b046f8fbd3d955d4

```
(keep in mind that you can also name your runs, if no name is passed TestKube will autogenerate name)
(keep in mind that you can also name your runs, if no name is passed Testkube will autogenerate name)
## Getting test results
Expand Down Expand Up @@ -140,4 +140,4 @@ Script execution completed in 598ms
## Summary
As we can see TestKube can help us to run tests inside our cluster, it can also store our tests and tests results.
As we can see Testkube can help us to run tests inside our cluster, it can also store our tests and tests results.
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Getting Started

Please follow [install steps](/docs/installing.md) first for TestKube installation (if not installed already)
Please follow [install steps](/docs/installing.md) first for Testkube installation (if not installed already)

## Getting help

Expand All @@ -16,7 +16,7 @@ kubectl testkube scripts --help
After installing you will need to add Test Scripts to your cluster, scripts are created as Custom Resource in Kubernetes
(access to Kubernetes cluster would be also needed)

For now TestKube only supports *Postman collections*, *basic CURL execition* and *Cypress* - but we plan to handle more testing tools soon,.
For now Testkube only supports *Postman collections*, *basic CURL execition* and *Cypress* - but we plan to handle more testing tools soon,.

If you don't want to create Custom Resources "by hand" we have a little helper for this:

Expand Down

0 comments on commit 3449e28

Please sign in to comment.