SATFORD - (Simple api testing for developers)

The idea behind this service is to provide a self hosted alternative to services like updown.io. Test your services, apis and hosts to know when they are not working as expected. In the current state this project only provides tests for GET, POST and PING provided by a configuration file. Beside the console output, there are two webpages served as endpoints:

• /agenda

  Shows informations about sceduled job (Thanks to Agendash).

• /

  Shows a live updating page for all tests. You can view results for each test in addition to graphs showing the success/failure rate.

To get notified about failing tests the idea is to configure one or more notification targets. Whenever a test failes or comes back to live, a notification will be send to the notification target. Actually there is only a mattermost target available.

Getting started

Create a configuration

The time intervall can be configured as follows:

Agenda uses Human Interval for specifying the intervals. It supports the following units: seconds, minutes, hours, days,weeks, months -- assumes 30 days, years -- assumes 365 days

As options to http-get or http-post you can pass everything that request accepts as options (https://github.com/request/request).

config.json

{
    "tests": [{
        "isActive": true,
        "name": "service A",
        "type": "http-get",
        "options": {
            "endpoint": "http://serviceA.de",
            "expectedStatusCode": 200
        },
        "frequency": "5 minutes",
        "allowedFails": 1
    }, {
        "isActive": true,
        "name": "service B",
        "type": "http-post",
        "options": {
            "endpoint": "http://serviceB.de",
            "expectedStatusCode": 200
        },
        "frequency": "30 minutes"
    }, {
        "isActive": true,
        "name": "host B",
        "options": {
            "host": "hostB.mydomain",
        },
        "type": "ping",
        "frequency": "30 minutes"
    }],
    "mattermost": {
        "url": "",
        "username": ""
    }
}

Create a docker-compose file:

version: '2'

services:
  app: 
    image: blural/satford
    restart: always
    ports: 
      - 80:80
    environment:
      - PORT=80
      - CONFIG_FILE=/config/config.json
      - MONGODB_URL=mongodb://mongo/agenda
    volumes:
      - ./config.json:/config/config.json
    depends_on: 
      - mongo

  mongo:
    image: mongo:latest
    volumes: 
      - '/srv/satford/mongodb/db:/data/db'

Start the service:

docker-compose up -d

Roadmap

• Implement module system
• E-Mail notification target
• Slack notification target
• Show link to backend in notification
• Show link to text that describes how to react on an error

Development

In development mode we spin up an in memory mongodb with example data for the last 30 days.

npm install
npm test
npm start

Release new versions

Releasing new versions means building and pushing docker images to the hub. There is one command which does exactly this. Before deploying, we increase the bugfix version number.

npm run complete:bugfix
docker login
npm run deploy