README.md

PONG 🏓

Pong status checker.

Currently support only REST.

Usage

Give a json or yaml file with the following structure:

# LogLevel is the log level, default info
log_level: "debug"

# Delimeters for gotemplate, set the delimeter to avoid conflict with the other template engines
# delimeters:
# - "{{"
# - "}}"

client:
  rest:
  - concurrent: 1
    continueOnError: false
    setting:
      # InsecureSkipVerify is the flag to skip the verification of the server's certificate chain and host name
      insecureSkipVerify: false
    check:
    - request:
        # URL could be multiple URLs, separated by space
        url: "https://api.punkapi.com/v2/beers/1 https://api.punkapi.com/v2/beers/2?pong=test"
        # Method is the HTTP method to use, default is GET
        method: GET
        # Timeout is in millisecond, default is 0 (no timeout)
        timeout: 1000
        # Headers is the HTTP headers to use
        headers:
          Accept: application/json
          Content-Type: application/json
          Authorization: Bearer ABCDEFG
        # BasicAuth is the basic auth to use
        basicAuth:
          username: "username"
          password: "password"
      respond:
        # Status to check, default 200
        status: 200
        # Body to check, default empty
        body:
          # Variable hold the variables to be used in the template
          variable:
            # From is the source of the variable
            from:
              # Query get the value from the query string
              query:
              - "pong"
            # Set is the set of variables
            set:
              val1: "abc"
          # Map is the body to be compared give raw map with template, default not check
          # Subset of the body is allowed
          map: |
            - name: {{ .pong }}
          # Raw is the raw body to be compared, default not check
          raw: |-
            Raw body to check

pong test.yaml

With Ansible

Get pong binary in release page add the plugin modules area.

make build

docker run -it --rm -v ${PWD}:/workspace williamyeh/ansible:debian9 /bin/bash

Inside the container

echo localhost ansible_connection=local > /etc/ansible/hosts

mkdir -p /usr/share/ansible/plugins/modules/
cp /workspace/pong /usr/share/ansible/plugins/modules

ansible-playbook /workspace/testdata/ansible/deploy_check.yml

Example of playbook

- name: Check image exists
  pong:
    client:
      rest:
        - concurrent: 1
          check:
            - url: "{% for k,item in yaml_return.ansible_facts.compose.services.items() %} https://hub.docker.com/v2/repositories/{{ item.image.split(':')[0] }}/tags/{{ item.image.split(':')[1] }} {% endfor %}"
              timeout: 1000
  register: http_result
  failed_when: http_result.failed

Development

Run make command to see available commands.

Local generate binary and docker image

goreleaser release --snapshot --rm-dist