Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/integralist/ero
Ero is a cli tool, built in Go, used to diff between local & remote Fastly VCL files
https://github.com/integralist/ero
cdn cli client diff fastly go golang varnish vcl
Last synced: 2 months ago
JSON representation
Ero is a cli tool, built in Go, used to diff between local & remote Fastly VCL files
- Host: GitHub
- URL: https://github.com/integralist/ero
- Owner: Integralist
- License: mit
- Created: 2017-02-24T10:23:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-24T09:19:40.000Z (over 7 years ago)
- Last Synced: 2024-06-20T12:06:08.275Z (6 months ago)
- Topics: cdn, cli, client, diff, fastly, go, golang, varnish, vcl
- Language: Go
- Homepage:
- Size: 9.77 KB
- Stars: 7
- Watchers: 5
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ero
Ero is a cli tool, built in [Go](https://golang.org), used to diff between local & remote [Fastly CDN](https://www.fastly.com/) VCL files
> ero is "difference" in Finnish
If you require a cli tool for uploading local VCL files to a remote version within a Fastly account, then see [Lataa](https://github.com/Integralist/lataa)
## Why?
Typically when modifying VCL files, I'll be working within a 'staging' environment (this would be where we test out any VCL changes _before_ applying them to our production environment).
Lots of different engineers 'borrow' the staging environment so they can test their changes, but they don't necessarily put the `master` version back (which leaves the stage environment in an unknown, and possibly unstable, state).
This ultimately means I don't know what's changed in comparison to the branch I happen to be working on. What I've experienced in the past is a scenario where I upload a single VCL file to stage (this would be the file I'm modifying), but things don't work as expected because another VCL file has been changed to something from another engineer's testing branch and it causes a conflict or some other odd behaviour.
The `ero` cli tool allows me to quickly verify which files I _actually_ need to update (i.e. the file on stage isn't the same as what's in `master`). Otherwise I'll be forced to blindly upload 10+ separate VCL files via the Fastly UI to ensure that stage is in a stable state for me to upload my own changes on top of.
## Installation
```bash
go get github.com/integralist/ero
```
## Usage
```bash
ero -help
-debug
show the error/diff output
-dir string
vcl directory to compare files against (default "VCL_DIRECTORY")
-help
show available flags
-match string
regex for matching vcl directories
-service string
your service id (default "FASTLY_SERVICE_ID")
-skip string
regex for skipping vcl directories (default "^____")
-token string
your fastly api token (default "FASTLY_API_TOKEN")
-vcl-version string
specify Fastly service 'version' to verify against
-version
show application version
```
Specify credentials via cli flags:
```bash
ero -service 123abc -token 456def
```
> If no flags provided, fallback to environment vars:
> `FASTLY_SERVICE_ID` and `FASTLY_API_TOKEN`
View the error/diff output using the debug flag:
```bash
ero -debug
```
> Typically you'll not care for the output,
> you just want to know the files didn't match up
Specify which nested directories you want to verfiy against:
```bash
ero -match 'foo|bar'
```
> Note: .git directories are automatically ignored
> If no flag provided, we'll look for the environment var:
> `VCL_MATCH_DIRECTORY`
Specify which nested directories you want to skip over:
```bash
ero -skip 'foo|bar'
```
> If no flag provided, we'll look for the environment var:
> `VCL_SKIP_DIRECTORY`
## Example
The following example execution has presumed the use of the environment variables: `VCL_DIRECTORY`, `FASTLY_API_TOKEN`, `FASTLY_SERVICE_ID` to keep the length of the command short.
```bash
$ ero -match www -debug
No difference between the version (123) of 'ab_tests_callback' and the version found locally
/Users/foo/code/cdn/www/fastly/ab_tests_callback.vcl
No difference between the version (123) of 'ab_tests_deliver' and the version found locally
/Users/foo/code/cdn/www/fastly/ab_tests_deliver.vcl
No difference between the version (123) of 'blacklist' and the version found locally
/Users/foo/code/cdn/www/fastly/blacklist.vcl
No difference between the version (123) of 'ab_tests_config' and the version found locally
/Users/foo/code/cdn/www/fastly/ab_tests_config.vcl
No difference between the version (123) of 'set_country_cookie' and the version found locally
/Users/foo/code/cdn/www/fastly/set_country_cookie.vcl
No difference between the version (123) of 'ab_tests_recv' and the version found locally
/Users/foo/code/cdn/www/fastly/ab_tests_recv.vcl
There was a difference between the version (123) of 'main' and the version found locally
/Users/foo/code/cdn/www/fastly/main.vcl
18,21c18
< # Blacklist check
< # Add any IP or User-Agent that should be blacklisted to the blacklist.vcl file
< call check_ip_blacklist;
< call check_url_blacklist;
---
> call check_foo_blacklist;
```
## Build
I find using [Gox](https://github.com/mitchellh/gox) the simplest way to build multiple OS versions of a Golang application:
```bash
go get github.com/mitchellh/gox
gox -osarch="linux/amd64" -osarch="darwin/amd64" -osarch="windows/amd64" -output="ero.{{.OS}}"
./ero.darwin -h
```
## Environment Variables
The use of environment variables help to reduce the amount of flags required to get stuff done. For example, I always diff against a stage environment of Fastly and so I don't want to have to put in the same credentials all the time.
Below is a list of environment variables this tool supports:
* `FASTLY_API_TOKEN`
* `FASTLY_SERVICE_ID`
* `VCL_DIRECTORY`
* `VCL_MATCH_DIRECTORY`
* `VCL_SKIP_DIRECTORY`