import json
|
|
|
|
from hc.api.models import Channel, Check
|
|
from hc.test import BaseTestCase
|
|
|
|
|
|
class CreateCheckTestCase(BaseTestCase):
|
|
URL = "/api/v1/checks/"
|
|
|
|
def post(self, data, expected_error=None, expected_fragment=None):
|
|
r = self.client.post(self.URL, data, content_type="application/json")
|
|
|
|
if expected_error:
|
|
self.assertEqual(r.status_code, 400)
|
|
self.assertEqual(r.json()["error"], expected_error)
|
|
|
|
if expected_fragment:
|
|
self.assertEqual(r.status_code, 400)
|
|
self.assertIn(expected_fragment, r.json()["error"])
|
|
|
|
return r
|
|
|
|
def test_it_works(self):
|
|
r = self.post(
|
|
{
|
|
"api_key": "X" * 32,
|
|
"name": "Foo",
|
|
"tags": "bar,baz",
|
|
"timeout": 3600,
|
|
"grace": 60,
|
|
}
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
self.assertEqual(r["Access-Control-Allow-Origin"], "*")
|
|
|
|
doc = r.json()
|
|
assert "ping_url" in doc
|
|
self.assertEqual(doc["name"], "Foo")
|
|
self.assertEqual(doc["tags"], "bar,baz")
|
|
self.assertEqual(doc["last_ping"], None)
|
|
self.assertEqual(doc["n_pings"], 0)
|
|
|
|
self.assertTrue("schedule" not in doc)
|
|
self.assertTrue("tz" not in doc)
|
|
|
|
check = Check.objects.get()
|
|
self.assertEqual(check.name, "Foo")
|
|
self.assertEqual(check.tags, "bar,baz")
|
|
self.assertEqual(check.timeout.total_seconds(), 3600)
|
|
self.assertEqual(check.grace.total_seconds(), 60)
|
|
self.assertEqual(check.project, self.project)
|
|
|
|
def test_it_handles_options(self):
|
|
r = self.client.options(self.URL)
|
|
self.assertEqual(r.status_code, 204)
|
|
self.assertIn("POST", r["Access-Control-Allow-Methods"])
|
|
|
|
def test_30_days_works(self):
|
|
r = self.post(
|
|
{"api_key": "X" * 32, "name": "Foo", "timeout": 2592000, "grace": 2592000}
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
|
|
check = Check.objects.get()
|
|
self.assertEqual(check.timeout.total_seconds(), 2592000)
|
|
self.assertEqual(check.grace.total_seconds(), 2592000)
|
|
|
|
def test_it_accepts_api_key_in_header(self):
|
|
payload = json.dumps({"name": "Foo"})
|
|
r = self.client.post(
|
|
self.URL, payload, content_type="application/json", HTTP_X_API_KEY="X" * 32
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
|
|
def test_it_assigns_channels(self):
|
|
channel = Channel.objects.create(project=self.project)
|
|
|
|
r = self.post({"api_key": "X" * 32, "channels": "*"})
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
check = Check.objects.get()
|
|
self.assertEqual(check.channel_set.get(), channel)
|
|
|
|
def test_it_rejects_bad_channel_code(self):
|
|
r = self.post({"api_key": "X" * 32, "channels": "abc"})
|
|
self.assertEqual(r.status_code, 400)
|
|
self.assertEqual(r.json()["error"], "invalid channel identifier: abc")
|
|
|
|
# The check should not have been saved
|
|
self.assertFalse(Check.objects.exists())
|
|
|
|
def test_it_supports_unique(self):
|
|
Check.objects.create(project=self.project, name="Foo")
|
|
|
|
r = self.post({"api_key": "X" * 32, "name": "Foo", "unique": ["name"]})
|
|
|
|
# Expect 200 instead of 201
|
|
self.assertEqual(r.status_code, 200)
|
|
|
|
# And there should be only one check in the database:
|
|
self.assertEqual(Check.objects.count(), 1)
|
|
|
|
def test_it_handles_missing_request_body(self):
|
|
r = self.client.post(self.URL, content_type="application/json")
|
|
self.assertEqual(r.status_code, 401)
|
|
self.assertEqual(r.json()["error"], "missing api key")
|
|
|
|
def test_it_handles_invalid_json(self):
|
|
r = self.client.post(
|
|
self.URL, "this is not json", content_type="application/json"
|
|
)
|
|
self.assertEqual(r.status_code, 400)
|
|
self.assertEqual(r.json()["error"], "could not parse request body")
|
|
|
|
def test_it_rejects_wrong_api_key(self):
|
|
r = self.post({"api_key": "Y" * 32})
|
|
self.assertEqual(r.status_code, 401)
|
|
|
|
def test_it_rejects_small_timeout(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "timeout": 0},
|
|
expected_fragment="timeout is too small",
|
|
)
|
|
|
|
def test_it_rejects_large_timeout(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "timeout": 2592001},
|
|
expected_fragment="timeout is too large",
|
|
)
|
|
|
|
def test_it_rejects_non_number_timeout(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "timeout": "oops"},
|
|
expected_fragment="timeout is not a number",
|
|
)
|
|
|
|
def test_it_rejects_non_string_name(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "name": False},
|
|
expected_fragment="name is not a string",
|
|
)
|
|
|
|
def test_it_rejects_long_name(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "name": "01234567890" * 20},
|
|
expected_fragment="name is too long",
|
|
)
|
|
|
|
def test_unique_accepts_only_whitelisted_values(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "name": "Foo", "unique": ["status"]},
|
|
expected_fragment="unexpected value",
|
|
)
|
|
|
|
def test_it_rejects_bad_unique_values(self):
|
|
self.post(
|
|
{"api_key": "X" * 32, "name": "Foo", "unique": "not a list"},
|
|
expected_fragment="not an array",
|
|
)
|
|
|
|
def test_it_supports_cron_syntax(self):
|
|
r = self.post(
|
|
{
|
|
"api_key": "X" * 32,
|
|
"schedule": "5 * * * *",
|
|
"tz": "Europe/Riga",
|
|
"grace": 60,
|
|
}
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
|
|
doc = r.json()
|
|
self.assertEqual(doc["schedule"], "5 * * * *")
|
|
self.assertEqual(doc["tz"], "Europe/Riga")
|
|
self.assertEqual(doc["grace"], 60)
|
|
|
|
self.assertTrue("timeout" not in doc)
|
|
|
|
def test_it_validates_cron_expression(self):
|
|
r = self.post(
|
|
{
|
|
"api_key": "X" * 32,
|
|
"schedule": "not-a-cron-expression",
|
|
"tz": "Europe/Riga",
|
|
"grace": 60,
|
|
}
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 400)
|
|
|
|
def test_it_validates_timezone(self):
|
|
r = self.post(
|
|
{
|
|
"api_key": "X" * 32,
|
|
"schedule": "* * * * *",
|
|
"tz": "not-a-timezone",
|
|
"grace": 60,
|
|
}
|
|
)
|
|
|
|
self.assertEqual(r.status_code, 400)
|
|
|
|
def test_it_sets_default_timeout(self):
|
|
r = self.post({"api_key": "X" * 32})
|
|
|
|
self.assertEqual(r.status_code, 201)
|
|
|
|
doc = r.json()
|
|
self.assertEqual(doc["timeout"], 86400)
|
|
|
|
def test_it_obeys_check_limit(self):
|
|
self.profile.check_limit = 0
|
|
self.profile.save()
|
|
|
|
r = self.post({"api_key": "X" * 32})
|
|
self.assertEqual(r.status_code, 403)
|
|
|
|
def test_readonly_key_does_not_work(self):
|
|
self.project.api_key_readonly = "R" * 32
|
|
self.project.save()
|
|
|
|
r = self.post({"api_key": "R" * 32, "name": "Foo"})
|
|
self.assertEqual(r.status_code, 401)
|