You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
164 lines
5.5 KiB
164 lines
5.5 KiB
import json
|
|
from datetime import timedelta as td
|
|
from django.utils.timezone import now
|
|
from django.conf import settings
|
|
|
|
from hc.api.models import Channel, Check
|
|
from hc.test import BaseTestCase
|
|
|
|
|
|
class ListChecksTestCase(BaseTestCase):
|
|
def setUp(self):
|
|
super(ListChecksTestCase, self).setUp()
|
|
|
|
self.now = now().replace(microsecond=0)
|
|
|
|
self.a1 = Check(project=self.project, name="Alice 1")
|
|
self.a1.timeout = td(seconds=3600)
|
|
self.a1.grace = td(seconds=900)
|
|
self.a1.n_pings = 0
|
|
self.a1.status = "new"
|
|
self.a1.tags = "a1-tag a1-additional-tag"
|
|
self.a1.desc = "This is description"
|
|
self.a1.save()
|
|
|
|
self.a2 = Check(project=self.project, name="Alice 2")
|
|
self.a2.timeout = td(seconds=86400)
|
|
self.a2.grace = td(seconds=3600)
|
|
self.a2.last_ping = self.now
|
|
self.a2.status = "up"
|
|
self.a2.tags = "a2-tag"
|
|
self.a2.save()
|
|
|
|
self.c1 = Channel.objects.create(project=self.project)
|
|
self.a1.channel_set.add(self.c1)
|
|
|
|
def get(self):
|
|
return self.client.get("/api/v1/checks/", HTTP_X_API_KEY="X" * 32)
|
|
|
|
def test_it_works(self):
|
|
# Expect 3 queries:
|
|
# * check API key
|
|
# * retrieve checks
|
|
# * retrieve channel codes
|
|
with self.assertNumQueries(3):
|
|
r = self.get()
|
|
|
|
self.assertEqual(r.status_code, 200)
|
|
self.assertEqual(r["Access-Control-Allow-Origin"], "*")
|
|
|
|
doc = r.json()
|
|
self.assertEqual(len(doc["checks"]), 2)
|
|
|
|
by_name = {}
|
|
for check in doc["checks"]:
|
|
by_name[check["name"]] = check
|
|
|
|
a1 = by_name["Alice 1"]
|
|
self.assertEqual(a1["timeout"], 3600)
|
|
self.assertEqual(a1["grace"], 900)
|
|
self.assertEqual(a1["ping_url"], self.a1.url())
|
|
self.assertEqual(a1["last_ping"], None)
|
|
self.assertEqual(a1["n_pings"], 0)
|
|
self.assertEqual(a1["status"], "new")
|
|
self.assertEqual(a1["channels"], str(self.c1.code))
|
|
self.assertEqual(a1["desc"], "This is description")
|
|
|
|
update_url = settings.SITE_ROOT + "/api/v1/checks/%s" % self.a1.code
|
|
pause_url = update_url + "/pause"
|
|
self.assertEqual(a1["update_url"], update_url)
|
|
self.assertEqual(a1["pause_url"], pause_url)
|
|
|
|
self.assertEqual(a1["next_ping"], None)
|
|
|
|
a2 = by_name["Alice 2"]
|
|
self.assertEqual(a2["timeout"], 86400)
|
|
self.assertEqual(a2["grace"], 3600)
|
|
self.assertEqual(a2["ping_url"], self.a2.url())
|
|
self.assertEqual(a2["status"], "up")
|
|
next_ping = self.now + td(seconds=86400)
|
|
self.assertEqual(a2["last_ping"], self.now.isoformat())
|
|
self.assertEqual(a2["next_ping"], next_ping.isoformat())
|
|
|
|
def test_it_handles_options(self):
|
|
r = self.client.options("/api/v1/checks/")
|
|
self.assertEqual(r.status_code, 204)
|
|
self.assertIn("GET", r["Access-Control-Allow-Methods"])
|
|
|
|
def test_it_shows_only_users_checks(self):
|
|
Check.objects.create(project=self.bobs_project, name="Bob 1")
|
|
|
|
r = self.get()
|
|
data = r.json()
|
|
self.assertEqual(len(data["checks"]), 2)
|
|
for check in data["checks"]:
|
|
self.assertNotEqual(check["name"], "Bob 1")
|
|
|
|
def test_it_accepts_api_key_from_request_body(self):
|
|
payload = json.dumps({"api_key": "X" * 32})
|
|
r = self.client.generic(
|
|
"GET", "/api/v1/checks/", payload, content_type="application/json"
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 200)
|
|
self.assertContains(r, "Alice")
|
|
|
|
def test_it_works_with_tags_param(self):
|
|
r = self.client.get("/api/v1/checks/?tag=a2-tag", HTTP_X_API_KEY="X" * 32)
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
doc = r.json()
|
|
self.assertTrue("checks" in doc)
|
|
self.assertEqual(len(doc["checks"]), 1)
|
|
|
|
check = doc["checks"][0]
|
|
|
|
self.assertEqual(check["name"], "Alice 2")
|
|
self.assertEqual(check["tags"], "a2-tag")
|
|
|
|
def test_it_filters_with_multiple_tags_param(self):
|
|
r = self.client.get(
|
|
"/api/v1/checks/?tag=a1-tag&tag=a1-additional-tag", HTTP_X_API_KEY="X" * 32
|
|
)
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
doc = r.json()
|
|
self.assertTrue("checks" in doc)
|
|
self.assertEqual(len(doc["checks"]), 1)
|
|
|
|
check = doc["checks"][0]
|
|
|
|
self.assertEqual(check["name"], "Alice 1")
|
|
self.assertEqual(check["tags"], "a1-tag a1-additional-tag")
|
|
|
|
def test_it_does_not_match_tag_partially(self):
|
|
r = self.client.get("/api/v1/checks/?tag=tag", HTTP_X_API_KEY="X" * 32)
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
doc = r.json()
|
|
self.assertTrue("checks" in doc)
|
|
self.assertEqual(len(doc["checks"]), 0)
|
|
|
|
def test_non_existing_tags_filter_returns_empty_result(self):
|
|
r = self.client.get(
|
|
"/api/v1/checks/?tag=non_existing_tag_with_no_checks",
|
|
HTTP_X_API_KEY="X" * 32,
|
|
)
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
doc = r.json()
|
|
self.assertTrue("checks" in doc)
|
|
self.assertEqual(len(doc["checks"]), 0)
|
|
|
|
def test_readonly_key_works(self):
|
|
self.project.api_key_readonly = "R" * 32
|
|
self.project.save()
|
|
|
|
# Expect a query to check the API key, and a query to retrieve checks
|
|
with self.assertNumQueries(2):
|
|
r = self.client.get("/api/v1/checks/", HTTP_X_API_KEY="R" * 32)
|
|
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
# When using readonly keys, the ping URLs should not be exposed:
|
|
self.assertNotContains(r, self.a1.url())
|