Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getyourguide/istio-config-validator
https://github.com/getyourguide/istio-config-validator
go121 istio sre validation virtualservice
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/getyourguide/istio-config-validator
- Owner: getyourguide
- License: apache-2.0
- Created: 2020-05-28T09:30:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T14:54:02.000Z (7 months ago)
- Last Synced: 2024-04-08T18:17:05.311Z (7 months ago)
- Topics: go121, istio, sre, validation, virtualservice
- Language: Go
- Homepage:
- Size: 629 KB
- Stars: 39
- Watchers: 62
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# istio-config-validator
[](https://goreportcard.com/report/github.com/getyourguide/istio-config-validator)
[](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=getyourguide/istio-config-validator&utm_campaign=Badge_Grade)
[](https://www.codacy.com?utm_source=github.com&utm_medium=referral&utm_content=getyourguide/istio-config-validator&utm_campaign=Badge_Coverage)
> The `istio-config-validator` tool is a **Work In Progress** project.
It provides to developers and cluster operators a way to test their changes in VirtualServices. We do it by mocking Istio/Envoy behavior to decide to which destination the request would go to. Eg:
```yaml
apiVersion: networking.istio.io/v1alpha3
kind: VirtualService
metadata:
name: example
namespace: example
spec:
hosts:
- www.example.com
- example.com
http:
- match:
- uri:
regex: /users(/.*)?
headers:
x-user-type:
exact: qa
route:
- destination:
host: users.users.svc.cluster.local
port:
number: 80
- route:
- destination:
host: monolith.monolith.svc.cluster.local
```
Given the above `VirtualService`, developers can introduce test cases that covers the intended behavior as the following:
```yaml
testCases:
- description: Only QA users should go to the new Users microservice.
wantMatch: true
request:
authority: ["www.example.com", "example.com"]
method: ["GET", "OPTIONS", "POST"]
uri: ["/users", "/users/"]
headers:
x-user-type: qa
route:
- destination:
host: users.users.svc.cluster.local
port:
number: 80
- description: Fallback other user types to the monolith
wantMatch: true
request:
authority: ["www.example.com", "example.com"]
method: ["GET", "OPTIONS", "POST"]
uri: ["/users", "/users/"]
route:
- destination:
host: monolith.monolith.svc.cluster.local
```
Have a look in the [TestCase Reference](docs/test-cases.md) to learn more how to define the tests.
## Installation
Either install the go package
```
# go install github.com/getyourguide/istio-config-validator/cmd/istio-config-validator@latest
```
Or alternatively install the docker image
```
# docker pull getyourguide/istio-config-validator:latest
```
## Usage
```
# istio-config-validator -h
Usage: istio-config-validator -t [-t ...] [ ...]
-t value
Testcase files/folders
```
```
# istio-config-validator -t examples/virtualservice_test.yml examples/virtualservice.yml
2020-05-29T18:45:39.261018Z info running test: happy path users
2020-05-29T18:45:39.261106Z info PASS input:[{www.example.com GET /users map[x-user-id:abc123]}]
2020-05-29T18:45:39.261128Z info PASS input:[{www.example.com GET /users/ map[x-user-id:abc123]}]
2020-05-29T18:45:39.261141Z info PASS input:[{www.example.com POST /users map[x-user-id:abc123]}]
2020-05-29T18:45:39.261157Z info PASS input:[{www.example.com POST /users/ map[x-user-id:abc123]}]
2020-05-29T18:45:39.261169Z info PASS input:[{example.com GET /users map[x-user-id:abc123]}]
2020-05-29T18:45:39.261184Z info PASS input:[{example.com GET /users/ map[x-user-id:abc123]}]
2020-05-29T18:45:39.261207Z info PASS input:[{example.com POST /users map[x-user-id:abc123]}]
2020-05-29T18:45:39.261220Z info PASS input:[{example.com POST /users/ map[x-user-id:abc123]}]
===========================
2020-05-29T18:45:39.261228Z info running test: Partner service only accepts GET or OPTIONS
2020-05-29T18:45:39.261256Z info PASS input:[{example.com PUT /partners map[]}]
2020-05-29T18:45:39.261274Z info PASS input:[{example.com PUT /partners/1 map[]}]
2020-05-29T18:45:39.261284Z info PASS input:[{example.com POST /partners map[]}]
2020-05-29T18:45:39.261900Z info PASS input:[{example.com POST /partners/1 map[]}]
2020-05-29T18:45:39.261940Z info PASS input:[{example.com PATCH /partners map[]}]
2020-05-29T18:45:39.261984Z info PASS input:[{example.com PATCH /partners/1 map[]}]
===========================
```
## Contributing
If you're interested in contributing to this project or running a dev version, have a look into the [CONTRIBUTING](CONTRIBUTING.md) document
## Known Limitations
The API for test cases does not cover all aspects of VirtualServices.
- Supported [HTTPMatchRequests](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPMatchRequest) fields to match requests against are: `authority`, `method`, `headers` and `uri`.
- Not supported ones: `scheme`, `port`, `queryParams`, etc.
- Supported assert against [HTTPRouteDestination](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRouteDestination), [HTTPRewrite](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRewrite), [HTTPFaultInjection](https://istio.io/latest/docs/reference/config/networking/virtual-service/#HTTPFaultInjection), [Headers](https://istio.io/latest/docs/reference/config/networking/virtual-service/#Headers), [Delegate](https://istio.io/latest/docs/reference/config/networking/virtual-service/#Delegate) and [HTTPRedirect](https://istio.io/docs/reference/config/networking/virtual-service/#HTTPRedirect).
## Security
For sensitive security matters please contact [[email protected]](mailto:[email protected]).
## Legal
Copyright 2020 GetYourGuide GmbH.
istio-config-validator is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text.