1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
|
# -*- coding: utf-8 -*-
# Copyright (C) 2018 Linaro Limited
#
# Author: Milosz Wasilewski <milosz.wasilewski@linaro.org>
#
# This file is part of LAVA.
#
# LAVA is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License version 3
# as published by the Free Software Foundation
#
# LAVA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with LAVA. If not, see <http://www.gnu.org/licenses/>.
import json
import pytest
import tap
import yaml
from django.urls import reverse
from django.contrib.auth.models import User
from rest_framework.test import APIClient
from lava_scheduler_app.models import TestJob, DeviceType, Device
from lava_results_app import models as result_models
from linaro_django_xmlrpc.models import AuthToken
from . import versions
EXAMPLE_JOB = """
job_name: test
visibility: public
timeouts:
job:
minutes: 10
action:
minutes: 5
actions: []
protocols: {}
"""
LOG_FILE = """
- {"dt": "2018-10-03T16:28:28.199903", "lvl": "info", "msg": "lava-dispatcher, installed at version: 2018.7-1+stretch"}
- {"dt": "2018-10-03T16:28:28.200807", "lvl": "info", "msg": "start: 0 validate"}
"""
class TestRestApi:
@pytest.fixture(autouse=True)
def setUp(self, db):
self.version = versions.versions[-1] # use latest version by default
# create users
self.admin = User.objects.create(username="admin", is_superuser=True)
self.user = User.objects.create(username="user1")
self.user_pwd = "supersecret"
self.user.set_password(self.user_pwd)
self.user.save()
self.user_no_token_pwd = "secret"
self.user_no_token = User.objects.create(username="user2")
self.user_no_token.set_password(self.user_no_token_pwd)
self.user_no_token.save()
admintoken = AuthToken.objects.create( # nosec - unit test support
user=self.admin, secret="adminkey"
)
self.usertoken = AuthToken.objects.create( # nosec - unit test support
user=self.user, secret="userkey"
)
# create second token to check whether authentication still works
AuthToken.objects.create(user=self.user, secret="userkey2") # nosec - unittest
self.userclient = APIClient()
self.userclient.credentials(HTTP_AUTHORIZATION="Token " + self.usertoken.secret)
self.userclient_no_token = APIClient()
self.adminclient = APIClient()
self.adminclient.credentials(HTTP_AUTHORIZATION="Token " + admintoken.secret)
# create devicetypes
self.public_device_type1 = DeviceType.objects.create(name="public_device_type1")
self.invisible_device_type1 = DeviceType.objects.create(
name="invisible_device_type1", display=False
)
self.private_device_type1 = DeviceType.objects.create(
name="private_device_type1", owners_only=True
)
# create devices
self.public_device1 = Device.objects.create(
hostname="public01", device_type=self.public_device_type1
)
self.private_device1 = Device.objects.create(
hostname="private01",
user=self.admin,
is_public=False,
device_type=self.private_device_type1,
)
self.retired_device1 = Device.objects.create(
hostname="retired01",
device_type=self.public_device_type1,
health=Device.HEALTH_RETIRED,
)
# create testjobs
self.public_testjob1 = TestJob.objects.create(
definition=yaml.safe_dump(EXAMPLE_JOB),
submitter=self.user,
user=self.user,
requested_device_type=self.public_device_type1,
is_public=True,
visibility=TestJob.VISIBLE_PUBLIC,
)
self.private_testjob1 = TestJob.objects.create(
definition=yaml.safe_dump(EXAMPLE_JOB),
submitter=self.admin,
user=self.admin,
requested_device_type=self.public_device_type1,
is_public=False,
visibility=TestJob.VISIBLE_PERSONAL,
)
# create logs
# create results for testjobs
self.public_lava_suite = result_models.TestSuite.objects.create(
name="lava", job=self.public_testjob1
)
self.public_test_case1 = result_models.TestCase.objects.create(
name="foo",
suite=self.public_lava_suite,
result=result_models.TestCase.RESULT_FAIL,
)
self.public_test_case2 = result_models.TestCase.objects.create(
name="bar",
suite=self.public_lava_suite,
result=result_models.TestCase.RESULT_PASS,
)
self.private_lava_suite = result_models.TestSuite.objects.create(
name="lava", job=self.private_testjob1
)
self.private_test_case1 = result_models.TestCase.objects.create(
name="foo",
suite=self.private_lava_suite,
result=result_models.TestCase.RESULT_FAIL,
)
self.private_test_case2 = result_models.TestCase.objects.create(
name="bar",
suite=self.private_lava_suite,
result=result_models.TestCase.RESULT_PASS,
)
def hit(self, client, url):
response = client.get(url)
assert response.status_code == 200 # nosec - unit test support
if hasattr(response, "content"):
text = response.content.decode("utf-8")
if response["Content-Type"] == "application/json":
return json.loads(text)
return text
return ""
def test_root(self):
self.hit(self.userclient, reverse("api-root", args=[self.version]))
def test_token(self):
auth_dict = {
"username": "%s" % self.user_no_token.get_username(),
"password": self.user_no_token_pwd,
}
response = self.userclient_no_token.post(
reverse("api-root", args=[self.version]) + "token/", auth_dict
)
assert response.status_code == 200 # nosec - unit test support
text = response.content.decode("utf-8")
assert "token" in json.loads(text).keys() # nosec - unit test support
def test_token_retrieval(self):
auth_dict = {
"username": "%s" % self.user.get_username(),
"password": self.user_pwd,
}
response = self.userclient_no_token.post(
reverse("api-root", args=[self.version]) + "token/", auth_dict
)
assert response.status_code == 200 # nosec - unit test support
# response shouldn't cause exception. Below lines are just
# additional check
text = response.content.decode("utf-8")
assert "token" in json.loads(text).keys() # nosec - unit test support
def test_testjobs(self):
data = self.hit(
self.userclient, reverse("api-root", args=[self.version]) + "jobs/"
)
# only public test jobs should be available without logging in
assert len(data["results"]) == 1 # nosec - unit test support
def test_testjobs_admin(self):
data = self.hit(
self.adminclient, reverse("api-root", args=[self.version]) + "jobs/"
)
assert len(data["results"]) == 2 # nosec - unit test support
def test_testjob_item(self):
self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/" % self.public_testjob1.id,
)
def test_testjob_logs(self, monkeypatch, tmpdir):
(tmpdir / "output.yaml").write_text(LOG_FILE, encoding="utf-8")
monkeypatch.setattr(TestJob, "output_dir", str(tmpdir))
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/logs/" % self.public_testjob1.id,
)
def test_testjob_logs_offset(self, monkeypatch, tmpdir):
(tmpdir / "output.yaml").write_text(LOG_FILE, encoding="utf-8")
monkeypatch.setattr(TestJob, "output_dir", str(tmpdir))
# use start=2 as log lines count start from 1
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/logs/?start=2" % self.public_testjob1.id,
)
# the value below depends on the log fragment used
# be careful when changing either the value below or the log fragment
assert len(data) == 82 # nosec - unit test support
def test_testjob_logs_offset_end(self, monkeypatch, tmpdir):
(tmpdir / "output.yaml").write_text(LOG_FILE, encoding="utf-8")
monkeypatch.setattr(TestJob, "output_dir", str(tmpdir))
# use start=2 as log lines count start from 1
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/logs/?start=1&end=2" % self.public_testjob1.id,
)
# the value below depends on the log fragment used
# be careful when changing either the value below or the log fragment
assert len(data) == 120 # nosec - unit test support
def test_testjob_logs_bad_offset(self, monkeypatch, tmpdir):
(tmpdir / "output.yaml").write_text(LOG_FILE, encoding="utf-8")
monkeypatch.setattr(TestJob, "output_dir", str(tmpdir))
# use start=2 as log lines count start from 1
response = self.userclient.get(
reverse("api-root", args=[self.version])
+ "jobs/%s/logs/?start=2&end=1" % self.public_testjob1.id
)
assert response.status_code == 404 # nosec - unit test support
def test_testjob_nologs(self):
response = self.userclient.get(
reverse("api-root", args=[self.version])
+ "jobs/%s/logs/" % self.public_testjob1.id
)
assert response.status_code == 404 # nosec - unit test support
def test_testjob_suites(self):
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/suites/" % self.public_testjob1.id,
)
assert len(data["results"]) == 1 # nosec - unit test support
def test_testjob_tests(self):
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/tests/" % self.public_testjob1.id,
)
assert len(data["results"]) == 2 # nosec - unit test support
def test_testjob_tap13(self):
data = self.hit(
self.userclient,
reverse("api-root", args=[self.version])
+ "jobs/%s/tap13/" % self.public_testjob1.id,
)
if hasattr(tap.tracker.Tracker, "set_plan"):
assert (
data
== """TAP version 13
1..2
# TAP results for lava
not ok 1 foo
ok 2 bar
"""
)
else:
assert (
data
== """# TAP results for lava
not ok 1 - foo
ok 2 - bar
"""
)
def test_devicetypes(self):
data = self.hit(
self.userclient, reverse("api-root", args=[self.version]) + "devicetypes/"
)
# only public device types should be available without logging in
assert len(data["results"]) == 1 # nosec - unit test support
def test_devices(self):
data = self.hit(
self.userclient, reverse("api-root", args=[self.version]) + "devices/"
)
# only public devices should be available without logging in
assert len(data["results"]) == 1 # nosec - unit test support
def test_devicetypes_admin(self):
data = self.hit(
self.adminclient, reverse("api-root", args=[self.version]) + "devicetypes/"
)
assert len(data["results"]) == 2 # nosec - unit test support
def test_devices_admin(self):
data = self.hit(
self.adminclient, reverse("api-root", args=[self.version]) + "devices/"
)
assert len(data["results"]) == 2 # nosec - unit test support
|