Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rbarilani/eskip-match
A package that helps you test skipper `.eskip` files routing matching logic
https://github.com/rbarilani/eskip-match
Last synced: about 1 month ago
JSON representation
A package that helps you test skipper `.eskip` files routing matching logic
- Host: GitHub
- URL: https://github.com/rbarilani/eskip-match
- Owner: rbarilani
- License: mit
- Created: 2018-03-30T10:51:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-04T11:46:51.000Z (over 5 years ago)
- Last Synced: 2024-11-09T07:31:48.562Z (3 months ago)
- Language: Go
- Homepage:
- Size: 90.8 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/rbarilani/eskip-match) [](https://codecov.io/gh/rbarilani/eskip-match) [](https://goreportcard.com/report/github.com/rbarilani/eskip-match) [](https://godoc.org/github.com/rbarilani/eskip-match) [](https://img.shields.io/github/tag/rbarilani/eskip-match.svg)
# eskip-match
A package that helps you test [skipper](https://github.com/zalando/skipper) [`.eskip`](https://zalando.github.io/skipper/dataclients/eskip-file/) files routing matching logic.
* [Install](#install)
* [Usage](#usage)
* [CLI](#cli)
* [License](#license)
## Install
```
go get github.com/rbarilani/eskip-match/...
```
## Usage
Given an `.eskip` file:
*routes.eskip*
```
foo: Path("/foo") -> http://foo.com
bar: Path("/bar") -> http://bar.com
```
You can write a `go test` able to check if the matching logic is what you expect.
A simple example:
*main_test.go*
```go
package main
import (
"testing"
"github.com/rbarilani/eskip-match/matcher"
)
func TestExample(t *testing.T) {
m, err := matcher.New(&matcher.Options{
RoutesFile: "./routes.eskip",
})
if err != nil {
t.Fatal(err)
return
}
res := m.Test(&matcher.RequestAttributes{
Method: "GET",
Path: "/bar",
})
route := res.Route()
if route == nil {
t.Error("Expect matching but no match")
return
}
if route.Id != "bar" {
t.Errorf("Expect matching route: %s but got %s", "bar", route.Id)
}
}
```
## CLI
The package provide a binary cli tool: `eskip-match`
```
NAME:
eskip-match - A command line tool that helps you test .eskip files routing matching logic
USAGE:
eskip-match [global options] command [command options] [arguments...]
COMMANDS:
test, t Given a routes file and request attributes, checks a route matches
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--config FILE, -c FILE Load configuration from FILE
--help, -h show help
--version, -v print the version
```
### Commands
### Test
With `eskip-match test` command you can check if a route matches given specific request attributes.
#### Examples
Test if a request to path `/foo` matches a route:
```bash
eskip-match test routes.eskip -p /foo
```
Test if a request to path `/foo` using `GET` method matches a route:
```bash
eskip-match test routes.eskip -p /foo -m GET
```
Specifying headers:
```bash
eskip-match test routes.eskip -p /foo -H Accept=application/json -H Authorization="Bearer XXX"
```
Using **verbose output** might help when something doesn't seem to work as expected:
```bash
eskip-match test routes.eskip -v -p /foo
```
If your routes are using **custom filters** the tool must be informed via a **configuration file** named `.eskip-match.yml`, eg:
*.eskip-match.yml*
```yaml
customfilters:
- myCustomFilter1
- myCustomFilter2
```
```bash
eskip-match test routes.eskip -p /foo
```
> By default the tool will try to load `.eskip-match.yml` in the current working directory, but you can provide a custom location with `-c` global option, eg:
```bash
eskip-match -c config.yml test routes.eskip -p /foo
```
## License
Copyright 2018 Ruben Barilani
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.