Add Checkly (#2520)

* Add Checkly Terraform config

* add deployment workflow

* use pagerduty instead of email for notifications

* use terraform cloud backend

* update variable declaration

* rename checkly check group

* update syntax

* test trigger

* Revert "test trigger"

This reverts commit 333e82beac.

* run a single job at a time

Co-authored-by: Cenk Kücük <c@cenk.me>
This commit is contained in:
Uku Taht 2023-01-05 21:25:54 +02:00 committed by GitHub
parent 51fc9c0945
commit 1772ddff17
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 257 additions and 0 deletions

88
.github/workflows/terraform-e2e.yml vendored Normal file
View File

@ -0,0 +1,88 @@
name: "Terraform E2E Tests"
on:
push:
branches:
- master
paths:
- 'test/e2e/**.tf'
pull_request:
branches:
- master
paths:
- 'test/e2e/**.tf'
jobs:
terraform:
concurrency: terraform_checkly
defaults:
run:
working-directory: test/e2e
env:
TF_CLOUD_ORGANIZATION : ${{ secrets.TF_CLOUD_ORGANIZATION }}
name: "Terraform"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Terraform
uses: hashicorp/setup-terraform@v2
with:
cli_config_credentials_token: ${{ secrets.TF_CLOUD_CHECKLY_API_TOKEN }}
- name: Terraform Format
id: fmt
run: terraform fmt -check
- name: Terraform Init
id: init
run: terraform init
- name: Terraform Validate
id: validate
run: terraform validate -no-color
- name: Terraform Plan
id: plan
if: github.event_name == 'pull_request'
run: terraform plan -no-color
continue-on-error: true
- uses: actions/github-script@v6
if: github.event_name == 'pull_request'
env:
PLAN: "terraform\n${{ steps.plan.outputs.stdout }}"
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
script: |
const output = `#### Terraform Format and Style 🖌\`${{ steps.fmt.outcome }}\`
#### Terraform Initialization ⚙️\`${{ steps.init.outcome }}\`
#### Terraform Validation 🤖\`${{ steps.validate.outcome }}\`
#### Terraform Plan 📖\`${{ steps.plan.outcome }}\`
<details><summary>Show Plan</summary>
\`\`\`\n
${process.env.PLAN}
\`\`\`
</details>
*Pusher: @${{ github.actor }}, Action: \`${{ github.event_name }}\`*`;
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: output
})
- name: Terraform Plan Status
if: steps.plan.outcome == 'failure'
run: exit 1
- name: Terraform Apply
if: github.ref == 'refs/heads/master' && github.event_name == 'push'
run: terraform apply -auto-approve

169
test/e2e/main.tf Normal file
View File

@ -0,0 +1,169 @@
terraform {
required_providers {
checkly = {
source = "checkly/checkly"
version = "~> 1.0"
}
}
cloud {
workspaces {
name = "checkly-e2e"
}
}
}
variable "checkly_api_key" {
sensitive = true
}
variable "checkly_account_id" {
sensitive = true
}
variable "checkly_alert_channel_pagerduty_service_key" {
sensitive = true
}
provider "checkly" {
api_key = var.checkly_api_key
account_id = var.checkly_account_id
}
resource "checkly_check" "plausible-io-api-health" {
name = "Check plausible.io/api/health"
type = "API"
activated = true
frequency = 1
double_check = true
group_id = checkly_check_group.reachability.id
request {
url = "https://plausible.io/api/health"
follow_redirects = false
skip_ssl = false
assertion {
source = "JSON_BODY"
property = "$.clickhouse"
comparison = "EQUALS"
target = "ok"
}
assertion {
source = "JSON_BODY"
property = "$.postgres"
comparison = "EQUALS"
target = "ok"
}
assertion {
source = "JSON_BODY"
property = "$.sites_cache"
comparison = "EQUALS"
target = "ok"
}
}
}
resource "checkly_check" "plausible-io-ingestion" {
name = "Check plausible.io/api/event"
type = "API"
activated = true
frequency = 1
double_check = true
group_id = checkly_check_group.reachability.id
request {
url = "https://plausible.io/api/event"
follow_redirects = false
skip_ssl = false
method = "POST"
headers = {
User-Agent = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.121 Safari/537.36 OPR/71.0.3770.284"
}
body_type = "JSON"
body = <<EOT
{
"name": "pageview",
"url": "https://internal--checkly.com/",
"domain": "internal--checkly.com",
"width": 1666
}
EOT
assertion {
source = "STATUS_CODE"
comparison = "EQUALS"
target = 202
}
assertion {
source = "TEXT_BODY"
comparison = "EQUALS"
target = "ok"
}
assertion {
source = "HEADERS"
property = "x-plausible-dropped"
comparison = "IS_EMPTY"
}
}
}
resource "checkly_check" "plausible-io-tracker-script" {
name = "Check plausible.io/js/script.js"
type = "API"
activated = true
frequency = 1
double_check = true
group_id = checkly_check_group.reachability.id
request {
url = "https://plausible.io/js/script.js"
follow_redirects = false
skip_ssl = false
assertion {
source = "STATUS_CODE"
comparison = "EQUALS"
target = "200"
}
assertion {
source = "TEXT_BODY"
comparison = "CONTAINS"
target = "window.plausible"
}
}
}
resource "checkly_check_group" "reachability" {
name = "Reachability probes - via automation"
activated = true
muted = true
tags = ["terraform"]
locations = [
"us-east-1",
"us-west-1",
"eu-central-1",
"eu-west-2",
"eu-north-1",
"eu-south-1",
"ap-southeast-2"
]
concurrency = 3
double_check = true
use_global_alert_settings = false
alert_channel_subscription {
channel_id = checkly_alert_channel.pagerduty.id
activated = true
}
}
resource "checkly_alert_channel" "pagerduty" {
pagerduty {
account = "plausible"
service_key = var.checkly_alert_channel_pagerduty_service_key
service_name = "Plausible application"
}
}