/bad-server

Primary LanguageGo

bad-server

bad-server is an http server that can be told to respond in various bad ways. It is primarily intended for testing clients to make sure they're resilient to server outages.

Usage

bad-server figures out what behavior to exhibit based on headers you send it. In general, the first header will win if you have multiple instances of the same header in a request. Exceptions to this include:

  • X-Response-Code-Histogram
  • X-Return-Header
  • X-Random-Json

Headers

X-Response-Code-Histogram: send a status code based on an input histogram

  • X-Response-Code-Histogram: 500 => 100% 500 errors
  • X-Response-Code-Histogram: 500=50,200=50 will return 500s half the time, 200s the other
  • X-Response-Code-Histogram: 490 will return 490 even though it's not a standard http code

X-Request-Body-As-Response: send the request body back in the response

X-Pause-Before-Response-Start: wait the specified amount of time before sending a response.

  • X-Pause-Before-Response-Start: 300 => wait 300ms before responding
  • X-Pause-Before-Response-Start: 1m => wait one minute before responding (uses golang duration syntax)

X-Add-Noise: randomly mutate bytes based on randomness percentage

  • X-Add-Noise: 3.0 => up to 3% of bytes will be randomly mutated

X-Return-Header: set the given header to the given value. Multiple instances of this header will get collated

  • X-Return-Header: Content-Type: application/json => response will have a Content-Type: application/json header

X-Generate-Random: generate random data for the given number of bytes

  • X-Generate-Random: 100 => 100 random bytes are returned

X-Random-Delays: randomly delay sending chunks of data

  • X-Random-Delays: 100 => chunks of data will be sent with up to 100ms delays sprinkled in
  • X-Random-Delays: 10ns=70.0;100ms => chunks of data will be sent with up to 10ns delays 70% of the time, and up to 100ms for 30% of the time

X-Proxy-To-Host: send the exact same request to the specified host and feed the response to the client. Note that other header and request generators will be ignored if this is set. However, headers that affect the transmission will still be used.

X-Random-Json: send random but structured JSON to the client to simulate unexpectedly large payloads

  • X-Random-Json: response_template=[string]:100 => sends an array of 100 strings
  • X-Random-Json: response_template=[returnObject]:100;returnObject=id/int,name/string => send 100 objects that have a numeric ID field and a string name field
  • X-Random-Json: response_template=[returnObject]:100;returnObject=author/authorObject;authorObject=id/int,name/string => send 100 records where each one will have an author key that will in turn be an object with an id and name
  • X-Random-Json: response_template=titlesContainer;titlesContainer=titles/[string]:100 => return an object that contains a field named titles that is 100 random strings
  • X-Random-Json: response_template=[string|blue,red,yellow] => Return a string array where the values will be one of "blue," "red," or "yellow"
  • X-Random-Json: response_template=returnObject;returnObject=commandType/int|1,2,3 => Return an object that has a commandType field that is either 1, 2, or 3

More on X-Random-Json

Here are the primitive data types you can use for a field:

  • string
  • int
  • float
  • bool
  • increment - a numeric field that increases in each record
  • - another object defined within the same header

    Each of these can have [] placed around them to create an array of that type. Primitive types (string, int, float) can have an enum of appropriate values. Arrays are 10,000 items unless you specify a length with ":N" after the array. The "root" item must be identified with "response_template="

    Complex Examples

    Combining headers lets you create other types of unexpected behaviors.

    Response's content-type does not match content.

    X-Return-Header: Content-Type: application/json
X-Generate-Random: 600

    Response's Content-Length is longer than content.

    X-Return-Header: Content-Length: 6000
X-Generate-Random: 1000

    Response's Content-Length is shorter than content.

    X-Return-Header: Content-Length: 1000
X-Generate-Random: 6000

    Administration

    The server also has an admin port that you can use for certain global operations

    • /headers:
      • POST all the headers in the request will be used as defaults that are merged into incoming requests on the main port
      • GET will give you the current set of default headers as headers in the response
      • DELETE will clear out any defaults

    Development

    bad-server works by creating an ordered pipeline of functions that all take http.ResponseWriter pointers. Functions are placed into the pipeline in this order:

    1. status_code generator
    2. header generators
    3. response body generator wrapped in response affectors

    Only one status code generator and response body generator will be derived from the headers sent to bad-server. If you include multiple response body generators in your header, they will be processed in this order (from general.go)

    1. X-Request-Body-As-Response
2. X-Generate-Random
3. X-Random-Json
4. empty string