This is a Slack Bot for interacting with Victorops. It's built on the Slack-Ruby-Bot framework. It also has Docker integration so running in a container is very easy.
After you've registered your bot in Slack, to test the Victorbot, you'll need to copy the .env.example file to .env and update the variables for your preferences. For local testing, it's easiest to use Docker Compose to build and run the container.
If you want to just run the bot outside of a container, you can use Foreman
$ bundle exec foreman start
The following environment variables are required for SlackVictorbot to work:
| Variable | Description |
|---|---|
| SLACK_API_TOKEN | Token for interacting with the Slack API |
| VICTOROPS_API_ID | Your Victorops user's API ID |
| VICTOROPS_API_KEY | Your Victorops user's API key |
| VICTOROPS_API_URL | The URL of the Victorops API |
| VICTOROPS_USER | Your Victorops username |
| VICTOROPS_TEAM | Default Victorops team to escalate incidents to |
SlackVictorbot uses a test harness wired with RSpec, VCR, and Webmock. The use of VCR and Webmock means that the first time the specs are run, they'll save a cassette to spec/fixtures/vcr_cassettes and then subsequent requests will be mocked and use that fixture file. If there is any sensitive data that needs to be sanitized from the fixture file, add that to the VCR.configure block in spec/spec_helper.rb.
To run the specs, you can either run them directly from your machine, or use Docker.
# Install the dependencies
$ bundle Install
# Run the specs
$ bundle exec rspec specs
# Build the image
$ docker-compose build
# Run the specs in a one-off container
$ docker-compose run web bundle exec rspec
# Keep container running to run the specs more than once
$ docker-compose run web /bin/bash
root@4ae327290864:/usr/src/app# bundle exec rspec spec
SlackVictorbot can be deployed as a normal Ruby application or in a containerized environment. The biggest thing to ensure is that the environment variables listed above are available when the application or container is started.