Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/loadrunner
GitHub Webhook Server and Event Simulator
https://github.com/dannyben/loadrunner
gem github-webhooks ruby
Last synced: 3 months ago
JSON representation
GitHub Webhook Server and Event Simulator
- Host: GitHub
- URL: https://github.com/dannyben/loadrunner
- Owner: DannyBen
- License: mit
- Created: 2017-08-12T12:08:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T17:37:11.000Z (10 months ago)
- Last Synced: 2024-10-06T05:19:51.041Z (3 months ago)
- Topics: gem, github-webhooks, ruby
- Language: Ruby
- Size: 116 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Loadrunner - GitHub Webhook Server and Event Simulator
======================================================
[](https://badge.fury.io/rb/loadrunner)
[](https://github.com/DannyBen/loadrunner/actions?query=workflow%3ATest)
[](https://codeclimate.com/github/DannyBen/loadrunner/maintainability)
---
Loadrunner is a multi-purpose utility for working with GitHub webhooks and
statuses.
It provides these features:
- A web server that responds to GitHub webhook events and can run any
arbitrary script written in any language.
- A command line utility for testing your webhook server configuration by
sending simulated events.
- A command line utility for sending status updates to pull requests.
---
Install
--------------------------------------------------
```
$ gem install loadrunner
```
Getting Started
--------------------------------------------------
1. Download the [hooks](hooks) directory from this repository, as an
example. This directory contains several hook examples.
2. Make sure that all files within that folder are executable.
3. Start the server (from the `hooks` **parent** directory):
`loadrunner server`
4. In another terminal, send a sample webhook event:
`loadrunner event localhost:3000 myrepo push master`
The server should respond with a detailed JSON response, specifying what
hooks were executed (`executed_hooks`) and what hooks *could have
been* executed, if they were defined in the hooks folder
(`matching_hooks`).
For more options, see the [documentation][1] or run
```shell
$ loadrunner --help
```
Building Hooks
--------------------------------------------------
When running the server, it will look for hooks (executable scripts) in
the `./hooks` directory, using one of these format:
hooks/global
hooks//global
hooks//
hooks//@branch=
hooks//@tag=
hooks//@tag
For example:
hooks/global
hooks/myrepo/global
hooks/myrepo/push
hooks/myrepo/push@branch=master
hooks/myrepo/push@tag=release
hooks/myrepo/push@tag
When none of the hooks are found, Loadrunner will respond with a list of
hooks it was looking for, so you can use this response to figure out what
it needs.
The hooks can be written in any language, and should simply be executable.
### Environment Variables
These environment variables are available to your hooks:
- `LOADRUNNER_REPO`
- `LOADRUNNER_OWNER`
- `LOADRUNNER_EVENT`
- `LOADRUNNER_BRANCH`
- `LOADRUNNER_COMMIT`
- `LOADRUNNER_REF`
- `LOADRUNNER_TAG`
Using as a Rack or Sinatra mount
--------------------------------------------------
If you wish to mount the Loadrunner server under another Rack or Sinatra
application, use the `Loadrunner::Server` as the handler.
```ruby
# config.ru
require "loadrunner/server"
map "/github" do
run Loadrunner::Server
end
run YourOwnApp
```
Sending Pull Request status from Ruby code
--------------------------------------------------
You may use the `Loadrunner::Status` class to update the status of a
GitHub pull request.
First, make sure that your GitHub API access token is set in the environment
variable `GITHUB_ACCESS_TOKEN`.
```ruby
require 'loadrunner/status'
response = Loadrunner::Status.update repo: 'user/repo',
sha: 'commit sha string',
state: :pending, # :pending :success :failure :error
context: "My Hooks Server",
description: "Jobs have not started yet",
url: "http://example.com"
```
Only `repo`, `sha` and `state` are required, the rest arguments are optional.
Running with Docker
--------------------------------------------------
You can run both the server and the client using Docker.
```shell
# Server
$ docker run -p3000:3000 dannyben/loadrunner server
# Client
$ docker run dannyben/loadrunner event http://webhook.server.com repo push
```
If you wish to connect the client to the server you are running through Docker,
you can do something like this:
```shell
$ docker run --network host dannyben/loadrunner event http://localhost:3000 repo push
```
See also: The [docker-compose file](docker-compose.yml).
[1]: http://www.rubydoc.info/gems/loadrunner