KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #codex #typescript #ai-agents #claude-code #dsh #dsh-plugin #deepseek-harness #cli #macos #ai-agent #open-source

vape

★ 29 Open GitHub ↗

Modern Smoke Testing tool. Written in Go.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vape
[![Build Status](https://img.shields.io/travis/symm/vape.svg)](https://travis-ci.org/symm/vape)
[![Codacy grade](https://img.shields.io/codacy/grade/75560a57ec104dbbb3f5b4d95990b80f.svg)](https://www.codacy.com/app/symm/vape)
[![Codecov](https://img.shields.io/codecov/c/github/symm/vape.svg)](https://codecov.io/gh/symm/vape)
[![Docker Pulls](https://img.shields.io/docker/pulls/symm/vape.svg)](https://hub.docker.com/r/symm/vape/)
[![license](https://img.shields.io/github/license/symm/vape.svg)]()

Modern [Smoke testing](https://en.wikipedia.org/wiki/Smoke_testing) tool written in Go.

Vape is intended to be used within a [Continuous Delivery Pipeline](https://en.wikipedia.org/wiki/Continuous_delivery) as a
post-deployment step.

It can quickly make assertions about the status code and content of a list of URIs to determine if
the release is good or not.

![Success](https://raw.githubusercontent.com/symm/vape/master/assets/success.png)
![Failure](https://raw.githubusercontent.com/symm/vape/master/assets/failure.png)

# How to use

## Configuration

Create a file named `Vapefile` file in the format:
```json
[
  {
    "uri": "/status/418",
    "status_code": 418,
    "content": "teapot"
  },
  {
    "uri": "/status/200",
    "status_code": 200
  },
  {
    "uri": "/status/304",
    "status_code": 304
  },
  {
    "uri": "/status/500",
    "status_code": 500
  }
]
```

The `uri` and `status_code` are required, `content` check is optional

## Run vape from a container (Recommended)

We publish a ready made image on [Docker Hub](https://hub.docker.com/r/symm/vape/)

Just create the `Vapefile` file as above and mount it inside a container:

```bash
docker run \
    --rm \
    -t \
    -v $(PWD)/Vapefile.example:/Vapefile \
    symm/vape:latest \
    https://your.domain
```

## Run vape from a binary

Grab a binary from our [releases page](https://github.com/symm/vape/releases) or build one by checking out this repo and running `make`
then execute `./vape http://your.domain` to run the tests

## Optional flags

The following optional command line flags may be passed:

```bash
Usage of ./vape:
  -concurrency int
    	The maximum number of requests to make at a time (default 3)
  -config string
    	The full path to the Vape configuration file (default "Vapefile")
  -skip-ssl-verification
    	Ignore bad SSL certs
  -authorization string
      Authorization header containing authentication credentials (e.g., "Bearer 123")
```

For example:

```bash
./vape -concurrency 10 -config vape.conf -skip-ssl-verification http://httpbin.org
```

# Links

- [Shisha](https://github.com/namshi/shisha) - The tool which originally inspired the creation of this project
- [Cigar](https://github.com/brunty/cigar) - PHP smoke testing tool.

vape

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README