brunty/cigar

Smoke testing tool written in PHP.

Cigar

, _(*1)

A smoke testing tool inspired by symm/vape, _(*2)

Similar tools include:, _(*3)

• Blackfire Player

Installation

Install via composer:, _(*4)

composer require brunty/cigar --dev, _(*5)

Pull via docker:, _(*6)

docker pull brunty/cigar, _(*7)

To use

Create a .cigar.json file that contains an array of json objects specifying the url, status, (optional) content, and (optional) content-type to check., _(*8)

[
  {
    "url": "http://httpbin.org/status/418",
    "status": 418,
    "content": "teapot"
  },
  {
    "url": "http://httpbin.org/status/200",
    "status": 200,
    "content-type": "text/html"
  },
  {
    "url": "http://httpbin.org/status/304",
    "status": 304
  },
  {
    "url": "http://httpbin.org/status/500",
    "status": 500
  }
]

When installed via composer:, _(*9)

Run vendor/bin/cigar to have it check each of the URLs return the status code expected., _(*10)

When pulled via docker:, _(*11)

Run docker run -v $(pwd):/app --rm brunty/cigar to have it check each of the URLs return the status code expected., _(*12)

> vendor/bin/cigar                                           
✓ http://httpbin.org/status/418 [418:418] teapot
✓ http://httpbin.org/status/200 [200:200] [text/html:text/html] 
✓ http://httpbin.org/status/304 [304:304] 
✓ http://httpbin.org/status/500 [500:500] 

The format of the lines in the output is:, _(*13)

pass/fail url [expected_code:actual_code] [optional_expected_content-type:optional_actual_content-type] optional_text

If all tests pass, the return code $? will be 0 - if any of them don't return the expected status code, the return code will be 1, _(*14)

Quiet test mode

If you wish to suppress the output of the test run, pass the --quiet option to the command: vendor/bin/cigar --quiet, _(*15)

Alternative configuration files

If you wish to use an alternative configuration file, use the vendor/bin/cigar -c file.json or vendor/bin/cigar --config=file.json options when running the command., _(*16)

Passing a base URL to check against

If you wish to check a file of URLs relative to the root of a site against a base URL, you can do so with by using vendor/bin/cigar -u http://httpbin.org or vendor/bin/cigar --url=http://httpbin.org, _(*17)

Your configuration file can then contain URLs including:, _(*18)

• Full absolute URLs as before (cigar won't use the base URL when checking an absolute URL)

[
  {
    "url": "http://httpbin.org/status/418",
    "status": 418,
    "content": "teapot"
  }
]

• URLs relative to the base url that you've specified, either with or without a leading slash., _(*19)

  [
  {
  "url": "/status/418",
  "status": 418,
  "content": "teapot"
  },
  
  {
  "url": "status/418",
  "status": 418,
  "content": "teapot"
  }
  ]
  

Disabling SSL cert verification

If you wish to run the tool without checking SSL certs, use the -i or --insecure option to the command: vendor/bin/cigar -i or vendor/bin/cigar --insecure, _(*20)

Only use this if absolutely necessary., _(*21)

Passing Authorization header

If you wish to add the Authorization header, use the -a or --auth option to the command: vendor/bin/cigar -a "Basic dXNyOnBzd2Q=" or vendor/bin/cigar --auth="Basic dXNyOnBzd2Q=", _(*22)

Passing custom header

If you wish to add any custom header(s), use the -h or --header option to the command: vendor/bin/cigar -h "Cache-control: no-cache" or vendor/bin/cigar --header="Cache-control: no-cache", _(*23)

Command help & command version

If you want to see all the available options for Cigar, use the command: vendor/bin/cigar --help, _(*24)

If you wish to see what version of Cigar you're using, use the command: vendor/bin/cigar --version, _(*25)

Contributing

This started as a small personal project., _(*26)

Although this project is small, openness and inclusivity are taken seriously. To that end a code of conduct (listed in the contributing guide) has been adopted., _(*27)

Contributor Guide, _(*28)