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 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
|
# -*- coding: utf-8 -*-
# Copyright (C) 2015-2018 Linaro Limited
#
# Author: Stevan Radakovic <stevan.radakovic@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/>.
"""
Database models of the LAVA Results
results/<job-ID>/<lava-suite-name>/<lava-test-set>/<lava-test-case>
results/<job-ID>/<lava-suite-name>/<lava-test-case>
TestSuite is based on the test definition
TestSet can be enabled within a test definition run step
TestCase is a single lava-test-case record or Action result.
"""
from datetime import timedelta
import logging
from nose.tools import nottest
from urllib.parse import quote
import yaml
import contextlib
from django.conf import settings
from django.contrib.admin.models import LogEntry, ADDITION
from django.contrib.auth.models import User, Group
from django.contrib.contenttypes import fields
from django.contrib.contenttypes.models import ContentType
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models, connection, transaction
from django.db.models import Q, Lookup
from django.db.models.fields import Field
from django.db.models.signals import pre_save
from django.dispatch import receiver
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone
from lava.utils.managers import MaterializedView
from lava_scheduler_app.models import TestJob, Device
from lava_scheduler_app.managers import (
RestrictedTestJobQuerySet,
RestrictedTestCaseQuerySet,
RestrictedTestSuiteQuerySet,
)
from lava_results_app.utils import help_max_length
class InvalidConditionsError(Exception):
""" Raise when querying by URL has incorrect condition arguments. """
class InvalidContentTypeError(Exception):
""" Raise when querying by URL content type (table name). """
class QueryUpdatedError(Exception):
""" Error raised if query is updating or recently updated. """
class RefreshLiveQueryError(Exception):
""" Error raised if refreshing the live query is attempted. """
class Queryable:
"""All Queryable objects should inherit this."""
def get_passfail_results(self):
raise NotImplementedError("Should have implemented this")
def get_measurement_results(self):
raise NotImplementedError("Should have implemented this")
def get_attribute_results(self, attributes):
raise NotImplementedError("Should have implemented this")
def get_end_datetime(self):
raise NotImplementedError("Should have implemented this")
def get_xaxis_attribute(self):
raise NotImplementedError("Should have implemented this")
@Field.register_lookup
class NotEqual(Lookup):
# Class for __ne field lookup.
lookup_name = "ne"
def as_sql(self, compiler, connection):
lhs, lhs_params = self.process_lhs(compiler, connection)
rhs, rhs_params = self.process_rhs(compiler, connection)
params = lhs_params + rhs_params
return "%s <> %s" % (lhs, rhs), params
class QueryMaterializedView(MaterializedView):
class Meta:
abstract = True
CREATE_VIEW = "CREATE MATERIALIZED VIEW %s%s AS %s;"
DROP_VIEW = "DROP MATERIALIZED VIEW IF EXISTS %s%s;"
REFRESH_VIEW = "REFRESH MATERIALIZED VIEW %s%s;"
VIEW_EXISTS = "SELECT EXISTS(SELECT * FROM pg_class WHERE relname='%s%s');"
QUERY_VIEW_PREFIX = "query_"
@classmethod
def create(cls, query):
# Check if view for this query exists.
cursor = connection.cursor()
if not cls.view_exists(query.id): # create view
sql, params = Query.get_queryset(
query.content_type, query.querycondition_set.all(), query.limit
).query.sql_with_params()
sql = sql.replace("%s", "'%s'")
query_str = sql % params
# TODO: handle potential exceptions here. what to do if query
# view is not created? - new field update_status?
query_str = cls.CREATE_VIEW % (cls.QUERY_VIEW_PREFIX, query.id, query_str)
cursor.execute(query_str)
@classmethod
def refresh(cls, query_id):
refresh_sql = cls.REFRESH_VIEW % (cls.QUERY_VIEW_PREFIX, query_id)
cursor = connection.cursor()
cursor.execute(refresh_sql)
@classmethod
def drop(cls, query_id):
drop_sql = cls.DROP_VIEW % (cls.QUERY_VIEW_PREFIX, query_id)
cursor = connection.cursor()
cursor.execute(drop_sql)
@classmethod
def view_exists(cls, query_id):
cursor = connection.cursor()
cursor.execute(cls.VIEW_EXISTS % (cls.QUERY_VIEW_PREFIX, query_id))
return cursor.fetchone()[0]
def get_queryset(self):
return QueryMaterializedView.objects.all()
class BugLink(models.Model):
class Meta:
unique_together = ("object_id", "url", "content_type")
url = models.URLField(
max_length=1024, blank=False, null=False, verbose_name=_(u"Bug Link URL")
)
content_type = models.ForeignKey(ContentType)
object_id = models.PositiveIntegerField()
content_object = fields.GenericForeignKey("content_type", "object_id")
def log_admin_entry(self, user, reason):
buglink_ct = ContentType.objects.get_for_model(BugLink)
LogEntry.objects.log_action(
user_id=user.id,
content_type_id=buglink_ct.pk,
object_id=self.pk,
object_repr=str(self),
action_flag=ADDITION,
change_message=reason,
)
@nottest
class TestSuite(models.Model, Queryable):
"""
Result suite of a pipeline job.
Top level grouping of results from a job.
Directly linked to a single TestJob, the job can have multiple TestSets.
"""
objects = models.Manager.from_queryset(RestrictedTestSuiteQuerySet)()
job = models.ForeignKey(TestJob)
name = models.CharField(
verbose_name=u"Suite name", blank=True, null=True, default=None, max_length=200
)
def testcase_count(self, value):
return self.testcase_set.filter(result=TestCase.RESULT_MAP[value]).count()
def get_passfail_results(self):
# Get pass fail results per lava_results_app.testsuite.
return {
self.name: {
"pass": self.testcase_count("pass"),
"fail": self.testcase_count("fail"),
"skip": self.testcase_count("skip"),
"unknown": self.testcase_count("unknown"),
}
}
def get_measurement_results(self):
# Get measurement values per lava_results_app.testcase.
results = {}
for testcase in self.testcase_set.all():
results[testcase.name] = {}
results[testcase.name]["measurement"] = testcase.measurement
results[testcase.name]["fail"] = testcase.result != TestCase.RESULT_PASS
return results
def get_attribute_results(self, attributes):
# Get attribute values per lava_results_app.testsuite.
results = {}
attributes = [x.strip() for x in attributes.split(",")]
for testcase in self.testcase_set.all():
if testcase.action_metadata:
for key in testcase.action_metadata:
if key in attributes and key not in results:
# Use only the metadata from the first testcase atm.
results[key] = {}
results[key]["fail"] = testcase.result != TestCase.RESULT_PASS
try:
results[key]["value"] = float(testcase.action_metadata[key])
except ValueError:
# Ignore non-float metadata.
del results[key]
return results
def get_end_datetime(self):
return self.job.end_time
def get_xaxis_attribute(self, xaxis_attribute=None):
return self.job.get_xaxis_attribute(xaxis_attribute)
@models.permalink
def get_absolute_url(self):
"""
Web friendly name for the test suite
"""
return ("lava.results.suite", [self.job.id, self.name])
def __str__(self):
"""
Human friendly name for the test suite
"""
return _(u"Test Suite {0}/{1}").format(self.job.id, self.name)
@nottest
class TestSet(models.Model):
"""
Sets collate result cases under an arbitrary text label.
Not all cases have a TestSet
"""
id = models.AutoField(primary_key=True)
name = models.CharField(
verbose_name=u"Suite name", blank=True, null=True, default=None, max_length=200
)
suite = models.ForeignKey(TestSuite, related_name="test_sets")
def get_absolute_url(self):
return quote(
"/results/%s/%s/%s" % (self.suite.job.id, self.suite.name, self.name)
)
def __str__(self):
return _(u"Test Set {0}/{1}/{2}").format(
self.suite.job.id, self.suite.name, self.name
)
@nottest
class TestCase(models.Model, Queryable):
"""
Result of an individual test case.
lava-test-case or action result
"""
objects = models.Manager.from_queryset(RestrictedTestCaseQuerySet)()
RESULT_PASS = 0
RESULT_FAIL = 1
RESULT_SKIP = 2
RESULT_UNKNOWN = 3
RESULT_REVERSE = {
RESULT_PASS: "pass",
RESULT_FAIL: "fail",
RESULT_SKIP: "skip",
RESULT_UNKNOWN: "unknown",
}
RESULT_MAP = {
"pass": RESULT_PASS,
"fail": RESULT_FAIL,
"skip": RESULT_SKIP,
"unknown": RESULT_UNKNOWN,
}
RESULT_CHOICES = (
(RESULT_PASS, _(u"Test passed")),
(RESULT_FAIL, _(u"Test failed")),
(RESULT_SKIP, _(u"Test skipped")),
(RESULT_UNKNOWN, _(u"Unknown outcome")),
)
name = models.TextField(
blank=True, help_text=help_max_length(100), verbose_name=_(u"Name")
)
units = models.TextField(
blank=True,
help_text=(
_(
"""Units in which measurement value should be
interpreted, for example <q>ms</q>, <q>MB/s</q> etc.
There is no semantic meaning inferred from the value of
this field, free form text is allowed. <br/>"""
)
+ help_max_length(100)
),
verbose_name=_(u"Units"),
)
result = models.PositiveSmallIntegerField(
verbose_name=_(u"Result"),
help_text=_(u"Result classification to pass/fail group"),
choices=RESULT_CHOICES,
db_index=True,
)
measurement = models.DecimalField(
decimal_places=10,
max_digits=30,
blank=True,
help_text=_(u"Arbitrary value that was measured as a part of this test."),
null=True,
verbose_name=_(u"Measurement"),
)
metadata = models.CharField(
blank=True,
max_length=4096,
help_text=_(u"Metadata collected by the pipeline action, stored as YAML."),
null=True,
verbose_name=_(u"Action meta data as a YAML string"),
)
suite = models.ForeignKey(TestSuite)
# Store start and end of the TestCase in the log file
# We are countaing the lines
start_log_line = models.PositiveIntegerField(blank=True, null=True, editable=False)
end_log_line = models.PositiveIntegerField(blank=True, null=True, editable=False)
test_set = models.ForeignKey(
TestSet, related_name="test_cases", null=True, blank=True, default=None
)
logged = models.DateTimeField(auto_now=True)
buglinks = fields.GenericRelation(BugLink)
@property
def action_metadata(self):
if not self.metadata:
return None
try:
ret = yaml.load(self.metadata, Loader=yaml.CLoader)
except yaml.YAMLError:
return None
return ret
@property
def action_data(self):
action_data = ActionData.objects.filter(testcase=self)
if not action_data:
return None
return action_data[0]
def get_passfail_results(self):
# Pass/fail charts for testcases do not make sense.
pass
def get_measurement_results(self):
# Get measurement values per lava_results_app.testcase.
results = {}
results[self.name] = {}
results[self.name]["measurement"] = self.measurement
results[self.name]["fail"] = self.result != self.RESULT_PASS
return results
def get_attribute_results(self, attributes):
# Get attribute values per lava_results_app.testcase.
results = {}
attributes = [x.strip() for x in attributes.split(",")]
if self.action_metadata:
for key in self.action_metadata:
if key in attributes:
results[key] = {}
results[key]["fail"] = self.result != self.RESULT_PASS
try:
results[key]["value"] = float(self.action_metadata[key])
except ValueError:
# Ignore non-float metadata.
del results[key]
return results
def get_end_datetime(self):
return self.logged
def get_xaxis_attribute(self, xaxis_attribute=None):
return self.suite.job.get_xaxis_attribute(xaxis_attribute)
@models.permalink
def get_absolute_url(self):
return ("lava.results.testcase", [self.id])
def _get_value(self):
if self.measurement:
value = "%s" % self.measurement
if self.units:
value = "%s%s" % (self.measurement, self.units)
elif self.metadata:
value = self.metadata
else:
value = self.RESULT_REVERSE[self.result]
return value
def __str__(self):
"""
results/<job-ID>/<lava-suite-name>/<lava-test-set>/<lava-test-case>
results/<job-ID>/<lava-suite-name>/<lava-test-case>
:return: a name acting as a mimic of the URL
"""
value = self._get_value()
if self.test_set:
# the set already includes the job & suite in the set name
return _(u"Test Case {0}/{1}/{2}/{3} {4}").format(
self.suite.job.id, self.suite.name, self.test_set.name, self.name, value
)
return _(u"Test Case {0}/{1}/{2} {3}").format(
self.suite.job.id, self.suite.name, self.name, value
)
@property
def result_code(self):
"""
Stable textual result code that does not depend on locale
"""
return self.RESULT_REVERSE[self.result]
class MetaType(models.Model):
"""
name will be a label, like a deployment type (NFS) or a boot type (bootz)
for test metadata, the MetaType is just the section_name.
"""
DEPLOY_TYPE = 0
BOOT_TYPE = 1
TEST_TYPE = 2
DIAGNOSTIC_TYPE = 3
FINALIZE_TYPE = 4
UNKNOWN_TYPE = 5
TYPE_CHOICES = {
DEPLOY_TYPE: "deploy",
BOOT_TYPE: "boot",
TEST_TYPE: "test",
DIAGNOSTIC_TYPE: "diagnostic",
FINALIZE_TYPE: "finalize",
UNKNOWN_TYPE: "unknown",
}
TYPE_MAP = {
"deploy": DEPLOY_TYPE,
"boot": BOOT_TYPE,
"test": TEST_TYPE,
"diagnostic": DIAGNOSTIC_TYPE,
"finalize": FINALIZE_TYPE,
"unknown": UNKNOWN_TYPE,
}
name = models.CharField(max_length=256)
metatype = models.PositiveIntegerField(
verbose_name=_(u"Type"),
help_text=_(u"metadata action type"),
choices=(
(DEPLOY_TYPE, _(u"deploy")),
(BOOT_TYPE, _(u"boot")),
(TEST_TYPE, _(u"test")),
(DIAGNOSTIC_TYPE, _(u"diagnostic")),
(FINALIZE_TYPE, _(u"finalize")),
(UNKNOWN_TYPE, _(u"unknown type")),
),
)
def __str__(self):
return _(u"Name: {0} Type: {1}").format(
self.name, self.TYPE_CHOICES[self.metatype]
)
@classmethod
def get_section(cls, section):
if section not in MetaType.TYPE_MAP:
return None
return MetaType.TYPE_MAP[section]
@classmethod
def get_section_type(cls, name, section):
section_type = MetaType.TYPE_MAP[section]
if section_type == MetaType.DEPLOY_TYPE:
return "to"
elif section_type == MetaType.BOOT_TYPE:
return "method"
elif section_type == MetaType.TEST_TYPE:
if name == "lava-test-monitor":
return "monitors"
else:
return "definitions"
else:
return None
@classmethod
def get_type_name(cls, action_data, definition):
"""
Return the section_name to lookup metadata for the associated action.
"""
logger = logging.getLogger("lava-master")
section = action_data["section"]
level = action_data["level"].split(".")[0]
name = action_data["name"]
if level.isdigit():
level = int(level) - 1 # levels start at one.
else:
# should be a logical error
logger.warning("get_type_name: unrecognised level %s", level)
return None
retval = None
data = [action for action in definition["actions"] if section in action]
if not data:
logger.debug("get_type_name: skipping %s" % section)
return None
if (
level >= len(definition["actions"])
or section not in definition["actions"][level]
):
logger.warning(
"get_type_name: unrecognised level %s for section %s", level, section
)
return None
data = definition["actions"][level][section]
if section in MetaType.TYPE_MAP:
section_type = MetaType.get_section_type(name, section)
if section_type and section_type in data:
retval = data[section_type]
if isinstance(retval, list):
return section_type
return retval
class NamedTestAttribute(models.Model):
"""
Model for adding named test attributes to arbitrary other model instances.
Example:
class Foo(Model):
attributes = fields.GenericRelation(NamedTestAttribute)
"""
name = models.TextField()
value = models.TextField()
# Content type plumbing
content_type = models.ForeignKey(ContentType)
object_id = models.PositiveIntegerField()
content_object = fields.GenericForeignKey("content_type", "object_id")
def __str__(self):
return _(u"{name}: {value}").format(name=self.name, value=self.value)
class Meta:
unique_together = ("object_id", "name", "content_type")
verbose_name = "metadata"
@nottest
class TestData(models.Model):
"""
Static metadata gathered from the test definition and device dictionary
Maps data from the definition and the test job logs into database fields.
metadata is created between job submission and job scheduling, so is
available for result processing when the job is running.
"""
testjob = models.ForeignKey(TestJob)
# Attributes
attributes = fields.GenericRelation(NamedTestAttribute)
def __str__(self):
return _(u"TestJob {0}").format(self.testjob.id)
class ActionData(models.Model):
"""
Each Action in the pipeline has Data tracked in this model.
One TestData object can relate to multiple ActionData objects.
When TestData creates a new item, the level and name
of that item are created and referenced.
Other actions are ignored.
Avoid storing the description or definition here, use a
viewer and pass the action_level and description_line.
This class forms the basis of the log file viewer as well as tying
the submission yaml to the pipeline description to the metadata and the results.
"""
action_name = models.CharField(max_length=100, blank=False, null=False)
action_level = models.CharField(max_length=32, blank=False, null=False)
action_summary = models.CharField(max_length=100, blank=False, null=False)
action_description = models.CharField(max_length=200, blank=False, null=False)
# each actionlevel points at a single MetaType, then to a single TestData and TestJob
meta_type = models.ForeignKey(MetaType, related_name="actionlevels")
testdata = models.ForeignKey(
TestData, blank=True, null=True, related_name="actionlevels"
)
yaml_line = models.PositiveIntegerField(blank=True, null=True)
description_line = models.PositiveIntegerField(blank=True, null=True)
# direct pointer to the section of the complete log.
log_section = models.CharField(max_length=50, blank=True, null=True)
# action.duration - actual amount of time taken
duration = models.DecimalField(
decimal_places=2,
max_digits=8, # enough for just over 11 days, 9 would be 115 days
blank=True,
null=True,
)
# timeout.duration - amount of time allowed before timeout
timeout = models.PositiveIntegerField(blank=True, null=True)
# maps a TestCase back to the Job metadata and description
testcase = models.ForeignKey(
TestCase, blank=True, null=True, related_name="actionlevels"
)
# only retry actions set a count or max_retries
count = models.PositiveIntegerField(blank=True, null=True)
max_retries = models.PositiveIntegerField(blank=True, null=True)
def __str__(self):
return _(u"{0} {1} Level {2}, Meta {3}").format(
self.testdata, self.action_name, self.action_level, self.meta_type
)
class QueryGroup(models.Model):
name = models.SlugField(max_length=1024, unique=True)
def __str__(self):
return self.name
def TestJobViewFactory(query):
class TestJobMaterializedView(QueryMaterializedView, TestJob):
objects = models.Manager.from_queryset(RestrictedTestJobQuerySet)()
class Meta(QueryMaterializedView.Meta):
db_table = "%s%s" % (QueryMaterializedView.QUERY_VIEW_PREFIX, query.id)
return TestJobMaterializedView()
def TestCaseViewFactory(query):
class TestCaseMaterializedView(QueryMaterializedView, TestCase):
objects = models.Manager.from_queryset(RestrictedTestCaseQuerySet)()
class Meta(QueryMaterializedView.Meta):
db_table = "%s%s" % (QueryMaterializedView.QUERY_VIEW_PREFIX, query.id)
return TestCaseMaterializedView()
def TestSuiteViewFactory(query):
class TestSuiteMaterializedView(QueryMaterializedView, TestSuite):
objects = models.Manager.from_queryset(RestrictedTestSuiteQuerySet)()
class Meta(QueryMaterializedView.Meta):
db_table = "%s%s" % (QueryMaterializedView.QUERY_VIEW_PREFIX, query.id)
return TestSuiteMaterializedView()
class Query(models.Model):
owner = models.ForeignKey(User)
group = models.ForeignKey(
Group, default=None, null=True, blank=True, on_delete=models.SET_NULL
)
name = models.SlugField(
max_length=1024,
help_text=(
"The <b>name</b> of a query is used to refer to it in the " "web UI."
),
)
description = models.TextField(blank=True, null=True)
query_group = models.ForeignKey(
QueryGroup, default=None, null=True, blank=True, on_delete=models.CASCADE
)
limit = models.PositiveIntegerField(
default=200, validators=[MinValueValidator(20)], verbose_name="Results limit"
)
content_type = models.ForeignKey(
ContentType,
limit_choices_to=Q(model__in=["testsuite", "testjob"])
| (Q(app_label="lava_results_app") & Q(model="testcase")),
verbose_name="Query object set",
)
CONDITIONS_SEPARATOR = ","
CONDITION_DIVIDER = "__"
@property
def owner_name(self):
return "~%s/%s" % (self.owner.username, self.name)
class Meta:
unique_together = ("owner", "name")
verbose_name = "query"
verbose_name_plural = "queries"
is_published = models.BooleanField(default=False, verbose_name="Published")
is_live = models.BooleanField(default=False, verbose_name="Live query")
is_changed = models.BooleanField(
default=False, verbose_name="Conditions have changed"
)
is_updating = models.BooleanField(
default=False, editable=False, verbose_name="Query is currently updating"
)
last_updated = models.DateTimeField(blank=True, null=True)
group_by_attribute = models.CharField(
blank=True, null=True, max_length=20, verbose_name="group by attribute"
)
target_goal = models.DecimalField(
blank=True,
decimal_places=5,
max_digits=10,
null=True,
verbose_name="Target goal",
)
is_archived = models.BooleanField(default=False, verbose_name="Archived")
def __str__(self):
return "<Query ~%s/%s>" % (self.owner.username, self.name)
def has_view(self):
return QueryMaterializedView.view_exists(self.id)
def get_results(self, user, order_by=["-id"]):
""" Used to get query results for persistant queries. """
omitted_list = QueryOmitResult.objects.filter(query=self).values_list(
"object_id", flat=True
)
if self.is_live:
return (
Query.get_queryset(
self.content_type, self.querycondition_set.all(), order_by=order_by
)
.exclude(id__in=omitted_list)
.visible_by_user(user)
)
else:
if self.content_type.model_class() == TestJob:
view = TestJobViewFactory(self)
elif self.content_type.model_class() == TestCase:
view = TestCaseViewFactory(self)
elif self.content_type.model_class() == TestSuite:
view = TestSuiteViewFactory(self)
return (
view.__class__.objects.all()
.exclude(id__in=omitted_list)
.order_by(*order_by)
.visible_by_user(user)
)
@classmethod
def get_queryset(cls, content_type, conditions, limit=None, order_by=["-id"]):
""" Return list of QuerySet objects for class 'content_type'.
Be mindful when using this method directly as it does not apply the
visibility rules.
This method is used for custom and live queries since they are do not
have corresponding materialized views.
Mind that if you need to further modify the queryset (as we do in table
views), omit the limit parameter as this is not supported in django.
"""
logger = logging.getLogger("lava_results_app")
filters = {}
for condition in conditions:
try:
relation_string = QueryCondition.RELATION_MAP[
content_type.model_class()
][condition.table.model_class()]
except KeyError:
logger.info(
"mapping unsupported for content types %s and %s!"
% (content_type.model_class(), condition.table.model_class())
)
raise
if condition.table.model_class() == NamedTestAttribute:
# For custom attributes, need two filters since
# we're comparing the key(name) and the value.
filter_key_name = "{0}__name".format(relation_string)
filter_key_value = "{0}__value".format(relation_string)
filter_key_value = "{0}__{1}".format(
filter_key_value, condition.operator
)
filters[filter_key_name] = condition.field
filters[filter_key_value] = condition.value
else:
if condition.table == content_type:
filter_key = condition.field
else:
filter_key = "{0}__{1}".format(relation_string, condition.field)
# Handle conditions through relations.
fk_model = _get_foreign_key_model(
condition.table.model_class(), condition.field
)
# FIXME: There might be some other related models which don't
# have 'name' as the default search field.
if fk_model:
if fk_model == User:
filter_key = "{0}__username".format(filter_key)
elif fk_model == Device:
filter_key = "{0}__hostname".format(filter_key)
else:
filter_key = "{0}__name".format(filter_key)
# Handle conditions with choice fields.
condition_field_obj = condition.table.model_class()._meta.get_field(
condition.field
)
if condition_field_obj.choices:
choices_reverse = dict(
(value, key)
for key, value in dict(condition_field_obj.choices).items()
)
try:
condition.value = choices_reverse[condition.value]
except KeyError:
logger.error(
'Invalid choice supported for field "%s". Available choices are: "%s"'
% (condition.field, ", ".join(choices_reverse.keys()))
)
condition.value = -1
# Handle boolean conditions.
if condition_field_obj.__class__ == models.BooleanField:
if condition.value == "False":
condition.value = False
else:
condition.value = True
# Add operator.
filter_key = "{0}__{1}".format(filter_key, condition.operator)
filters[filter_key] = condition.value
query_results = (
content_type.model_class()
.objects.filter(**filters)
.distinct()
.order_by(*order_by)
.extra(
select={
"%s_ptr_id"
% content_type.model: "%s.id"
% content_type.model_class()._meta.db_table
}
)[:limit]
)
return query_results
def refresh_view(self):
if self.is_live:
raise RefreshLiveQueryError("Refreshing live query not permitted.")
hour_ago = timezone.now() - timedelta(hours=1)
with transaction.atomic():
# Lock the selected row until the end of transaction.
query = Query.objects.select_for_update().get(pk=self.id)
if query.is_updating:
raise QueryUpdatedError("query is currently updating")
# TODO: commented out because of testing purposes.
# elif query.last_updated and query.last_updated > hour_ago:
# raise QueryUpdatedError("query was recently updated (less then hour ago)")
else:
query.is_updating = True
query.save()
try:
if not self.has_view():
QueryMaterializedView.create(self)
elif self.is_changed:
QueryMaterializedView.drop(self.id)
QueryMaterializedView.create(self)
else:
QueryMaterializedView.refresh(self.id)
self.last_updated = timezone.now()
self.is_changed = False
finally:
self.is_updating = False
self.save()
@classmethod
def parse_conditions(cls, content_type, conditions):
# Parse conditions from text representation.
if not conditions:
return []
conditions_objects = []
for condition_str in conditions.split(cls.CONDITIONS_SEPARATOR):
condition = QueryCondition()
condition_fields = condition_str.split(cls.CONDITION_DIVIDER)
if len(condition_fields) == 2:
condition.table = content_type
condition.field = condition_fields[0]
condition.operator = QueryCondition.EXACT
condition.value = condition_fields[1]
elif len(condition_fields) == 3:
condition.table = content_type
condition.field = condition_fields[0]
condition.operator = condition_fields[1]
condition.value = condition_fields[2]
elif len(condition_fields) == 4:
try:
content_type = Query.get_content_type(condition_fields[0])
except ContentType.DoesNotExist:
raise InvalidContentTypeError(
"Wrong table name in conditions parameter. "
+ "Please refer to query docs."
)
condition.table = content_type
condition.field = condition_fields[1]
condition.operator = condition_fields[2]
condition.value = condition_fields[3]
else:
# TODO: more validation for conditions?.
raise InvalidConditionsError(
"Conditions URL incorrect. Please " "refer to query docs."
)
conditions_objects.append(condition)
return conditions_objects
@classmethod
def serialize_conditions(cls, conditions):
# Serialize conditions into string.
conditions_list = []
for condition in conditions:
conditions_list.append(
"%s%s%s%s%s%s%s"
% (
condition.table.model,
cls.CONDITION_DIVIDER,
condition.field,
cls.CONDITION_DIVIDER,
condition.operator,
cls.CONDITION_DIVIDER,
condition.value,
)
)
return cls.CONDITIONS_SEPARATOR.join(conditions_list)
@classmethod
def get_content_type(cls, model_name):
# Need this check because there are multiple models named 'TestCase'
# in different apps now.
if model_name == ContentType.objects.get_for_model(TestCase).model:
return ContentType.objects.get_for_model(TestCase)
content_types = ContentType.objects.filter(model=model_name)
if not content_types:
raise InvalidContentTypeError(
"Wrong table name in entity param. Please refer to query docs."
)
else:
return ContentType.objects.filter(model=model_name)[0]
@classmethod
def validate_custom_query(cls, model_name, conditions):
"""Validate custom query content type and conditions.
:param model_name: Content type name (entity).
:type model_name: str
:param conditions: Query conditions, fields and values.
:type conditions: dict
:raise InvalidContentTypeError model_name is not recognized.
:raise InvalidConditionsError conditions do not have correct format.
:return Nothing
"""
content_type = cls.get_content_type(model_name)
if content_type.model_class() not in QueryCondition.RELATION_MAP:
raise InvalidContentTypeError(
"Wrong table name in entity param. Please refer to query doc."
)
condition_list = []
for key in conditions:
condition_list.append(
"%s%s%s" % (key, cls.CONDITION_DIVIDER, conditions[key])
)
conditions = cls.CONDITIONS_SEPARATOR.join(condition_list)
cls.parse_conditions(content_type, conditions)
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
if self.is_live:
# Drop the view.
QueryMaterializedView.drop(self.id)
def delete(self, *args, **kwargs):
if not self.is_live:
# Drop the view.
QueryMaterializedView.drop(self.id)
super().delete(*args, **kwargs)
def is_accessible_by(self, user):
if user.is_superuser or self.owner == user or self.group in user.groups.all():
return True
return False
@models.permalink
def get_absolute_url(self):
return ("lava.results.query_display", [self.owner.username, self.name])
@receiver(pre_save, sender=Query)
def limit_update_signal(sender, instance, **kwargs):
# If the object does not exists, this is a new query: ignore
with contextlib.suppress(sender.DoesNotExist):
query = sender.objects.get(pk=instance.pk)
if not query.limit == instance.limit: # Field has changed
instance.is_changed = True
class QueryCondition(models.Model):
table = models.ForeignKey(
ContentType,
limit_choices_to=Q(model__in=["testsuite", "testjob", "namedtestattribute"])
| (Q(app_label="lava_results_app") & Q(model="testcase")),
verbose_name="Condition model",
)
# Map the relationship spanning.
RELATION_MAP = {
TestJob: {
TestJob: None,
TestSuite: "testsuite",
TestCase: "testsuite__testcase",
NamedTestAttribute: "testdata__attributes",
},
TestSuite: {
TestJob: "job",
TestCase: "testcase",
TestSuite: None,
NamedTestAttribute: "job__testdata__attributes",
},
TestCase: {
TestCase: None,
TestJob: "suite__job",
TestSuite: "suite",
NamedTestAttribute: "suite__job__testdata__attributes",
},
}
# Allowed fields for condition entities.
FIELD_CHOICES = {
TestJob: [
"submitter",
"start_time",
"end_time",
"state",
"health",
"actual_device",
"requested_device_type",
"health_check",
"user",
"group",
"priority",
"description",
],
TestSuite: ["name"],
TestCase: ["name", "result", "measurement"],
NamedTestAttribute: [],
}
query = models.ForeignKey(Query)
field = models.CharField(max_length=50, verbose_name="Field name")
EXACT = "exact"
NOTEQUAL = "ne"
IEXACT = "iexact"
ICONTAINS = "icontains"
GT = "gt"
LT = "lt"
OPERATOR_CHOICES = (
(EXACT, u"Exact match"),
(IEXACT, u"Case-insensitive match"),
(NOTEQUAL, u"Not equal to"),
(ICONTAINS, u"Contains"),
(GT, u"Greater than"),
(LT, u"Less than"),
)
operator = models.CharField(
blank=False,
default=EXACT,
verbose_name=_(u"Operator"),
max_length=20,
choices=OPERATOR_CHOICES,
)
value = models.CharField(max_length=40, verbose_name="Field value")
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
if not self.query.is_live:
self.query.is_changed = True
self.query.save()
def delete(self, *args, **kwargs):
super().delete(*args, **kwargs)
if not self.query.is_live:
self.query.is_changed = True
self.query.save()
@classmethod
def get_condition_choices(cls, job=None):
# Create a dict with all possible operators based on the all available
# field types, used for validation.
# If job is supplied, return available metadata field names as well.
condition_choices = {}
for model in cls.FIELD_CHOICES:
condition_choice = {}
condition_choice["fields"] = {}
content_type = ContentType.objects.get_for_model(model)
if job and model == NamedTestAttribute:
testdata = TestData.objects.filter(testjob=job).first()
if testdata:
for attribute in NamedTestAttribute.objects.filter(
object_id=testdata.id,
content_type=ContentType.objects.get_for_model(TestData),
):
condition_choice["fields"][attribute.name] = {}
else:
for field_name in cls.FIELD_CHOICES[model]:
field = {}
field_object = content_type.model_class()._meta.get_field(
field_name
)
field["operators"] = cls._get_operators_for_field_type(field_object)
field["type"] = field_object.__class__.__name__
if field_object.choices:
field["choices"] = [
str(x) for x in dict(field_object.choices).values()
]
condition_choice["fields"][field_name] = field
condition_choices[content_type.id] = condition_choice
condition_choices["date_format"] = settings.DATETIME_INPUT_FORMATS[0]
return condition_choices
@classmethod
def get_similar_job_content_types(cls):
# Create a dict with all available content types.
available_content_types = {}
for model in [TestJob, NamedTestAttribute]:
content_type = ContentType.objects.get_for_model(model)
available_content_types[content_type.id] = content_type.name
return available_content_types
@classmethod
def _get_operators_for_field_type(cls, field_object):
# Determine available operators depending on the field type.
operator_dict = dict(cls.OPERATOR_CHOICES)
if field_object.choices:
operator_keys = [cls.EXACT, cls.NOTEQUAL, cls.ICONTAINS]
elif isinstance(field_object, models.DateTimeField):
operator_keys = [cls.GT]
elif isinstance(field_object, models.ForeignKey):
operator_keys = [cls.EXACT, cls.IEXACT, cls.NOTEQUAL, cls.ICONTAINS]
elif isinstance(field_object, models.BooleanField):
operator_keys = [cls.EXACT, cls.NOTEQUAL]
elif isinstance(field_object, models.IntegerField):
operator_keys = [cls.EXACT, cls.NOTEQUAL, cls.ICONTAINS, cls.GT, cls.LT]
elif isinstance(field_object, models.CharField):
operator_keys = [cls.EXACT, cls.IEXACT, cls.NOTEQUAL, cls.ICONTAINS]
elif isinstance(field_object, models.TextField):
operator_keys = [cls.EXACT, cls.IEXACT, cls.NOTEQUAL, cls.ICONTAINS]
else: # Show all.
operator_keys = [
cls.EXACT,
cls.IEXACT,
cls.NOTEQUAL,
cls.ICONTAINS,
cls.GT,
cls.LT,
]
operators = dict(
[(i, operator_dict[i]) for i in operator_keys if i in operator_dict]
)
return operators
def _get_foreign_key_model(model, fieldname):
""" Returns model if field is a foreign key, otherwise None. """
field_object = model._meta.get_field(fieldname)
direct = not field_object.auto_created or field_object.concrete
if (
not field_object.many_to_many
and direct
and isinstance(field_object, models.ForeignKey)
):
return field_object.rel.to
return None
class QueryOmitResult(models.Model):
query = models.ForeignKey(Query, on_delete=models.CASCADE)
content_type = models.ForeignKey(ContentType)
object_id = models.PositiveIntegerField()
content_object = fields.GenericForeignKey("content_type", "object_id")
class Meta:
unique_together = ("object_id", "query", "content_type")
class ChartGroup(models.Model):
name = models.SlugField(max_length=1024, unique=True)
def __str__(self):
return self.name
# Chart types
CHART_TYPES = (
(r"pass/fail", "Pass/Fail"),
(r"measurement", "Measurement"),
(r"attributes", "Attributes"),
)
# Chart representation
REPRESENTATION_TYPES = ((r"lines", "Lines"), (r"bars", "Bars"))
# Chart visibility
CHART_VISIBILITY = (
(r"chart", "Chart only"),
(r"table", "Result table only"),
(r"both", "Both"),
)
class Chart(models.Model):
name = models.SlugField(max_length=1024, unique=True)
chart_group = models.ForeignKey(
ChartGroup, default=None, null=True, on_delete=models.CASCADE
)
owner = models.ForeignKey(User, default=None, on_delete=models.CASCADE)
group = models.ForeignKey(Group, default=None, null=True, on_delete=models.SET_NULL)
description = models.TextField(blank=True, null=True)
is_published = models.BooleanField(default=False, verbose_name="Published")
queries = models.ManyToManyField(Query, through="ChartQuery", blank=True)
def __str__(self):
return self.name
@models.permalink
def get_absolute_url(self):
return ("lava.results.chart_display", (), dict(name=self.name))
def can_admin(self, user):
return (
user.is_superuser
or self.owner == user
or (self.group and user in self.group.user_set.all())
)
# Chart types
CHART_TYPES = (
(r"pass/fail", "Pass/Fail"),
(r"measurement", "Measurement"),
(r"attributes", "Attributes"),
)
# Chart representation
REPRESENTATION_TYPES = ((r"lines", "Lines"), (r"bars", "Bars"))
# Chart visibility
CHART_VISIBILITY = (
(r"chart", "Chart only"),
(r"table", "Result table only"),
(r"both", "Both"),
)
class ChartQuery(models.Model):
class Meta:
ordering = ["relative_index"]
chart = models.ForeignKey(Chart, on_delete=models.CASCADE)
query = models.ForeignKey(Query, on_delete=models.CASCADE)
chart_type = models.CharField(
max_length=20,
choices=CHART_TYPES,
verbose_name="Chart type",
blank=False,
default="pass/fail",
)
target_goal = models.DecimalField(
blank=True,
decimal_places=5,
max_digits=10,
null=True,
verbose_name="Target goal",
)
chart_height = models.PositiveIntegerField(
default=300,
validators=[MinValueValidator(200), MaxValueValidator(400)],
verbose_name="Chart height",
)
is_percentage = models.BooleanField(default=False, verbose_name="Percentage")
chart_visibility = models.CharField(
max_length=20,
choices=CHART_VISIBILITY,
verbose_name="Chart visibility",
blank=False,
default="chart",
)
xaxis_attribute = models.CharField(
blank=True, null=True, max_length=100, verbose_name="X-axis attribute"
)
representation = models.CharField(
max_length=20,
choices=REPRESENTATION_TYPES,
verbose_name="Representation",
blank=False,
default="lines",
)
relative_index = models.PositiveIntegerField(
default=0, verbose_name="Order in the chart"
)
attributes = models.CharField(
blank=True, null=True, max_length=200, verbose_name="Chart attributes"
)
ORDER_BY_MAP = {TestJob: "end_time", TestCase: "logged", TestSuite: "job__end_time"}
DATE_FORMAT = "%d/%m/%Y %H:%M"
def get_data(self, user, content_type=None, conditions=None):
"""
Pack data from filter to json format based on Chart options.
content_type and conditions are only mandatory if this is a custom
Chart.
"""
chart_data = {}
chart_data["basic"] = self.get_basic_chart_data()
chart_data["user"] = self.get_user_chart_data(user)
# TODO: order by attribute if attribute is used for x-axis.
if hasattr(self, "query"):
results = self.query.get_results(user).order_by(
self.ORDER_BY_MAP[self.query.content_type.model_class()]
)
# TODO: order by attribute if attribute is used for x-axis.
else:
results = Query.get_queryset(
content_type,
conditions,
order_by=[self.ORDER_BY_MAP[content_type.model_class()]],
).visible_by_user(user)
if self.chart_type == "pass/fail":
chart_data["data"] = self.get_chart_passfail_data(user, results)
elif self.chart_type == "measurement":
# TODO: In case of job or suite, do avg measurement, and later add
# option to do min/max/other.
chart_data["data"] = self.get_chart_measurement_data(user, results)
elif self.chart_type == "attributes":
chart_data["data"] = self.get_chart_attributes_data(user, results)
return chart_data
def get_basic_chart_data(self):
data = {}
fields = [
"id",
"chart_type",
"target_goal",
"chart_height",
"is_percentage",
"chart_visibility",
"xaxis_attribute",
"representation",
]
for field in fields:
data[field] = getattr(self, field)
data["chart_name"] = self.chart.name
if hasattr(self, "query"):
data["query_name"] = self.query.name
data["query_link"] = self.query.get_absolute_url()
data["query_description"] = self.query.description
data["query_live"] = self.query.is_live
if self.query.last_updated is not None:
data["query_updated"] = self.query.last_updated.strftime(
settings.DATETIME_INPUT_FORMATS[0]
)
data["entity"] = self.query.content_type.model
data["conditions"] = Query.serialize_conditions(
self.query.querycondition_set.all()
)
data["has_omitted"] = QueryOmitResult.objects.filter(
query=self.query
).exists()
return data
def get_user_chart_data(self, user):
data = {}
try:
chart_user = ChartQueryUser.objects.get(chart_query=self, user=user)
data["start_date"] = chart_user.start_date
data["is_legend_visible"] = chart_user.is_legend_visible
data["is_delta"] = chart_user.is_delta
except ChartQueryUser.DoesNotExist:
# Leave an empty dict.
pass
return data
def get_chart_passfail_data(self, user, query_results):
data = []
for item in query_results:
# Set attribute based on xaxis_attribute.
attribute = item.get_xaxis_attribute(self.xaxis_attribute)
# If xaxis attribute is set and this query item does not have
# this specific attribute, ignore it.
if self.xaxis_attribute and not attribute:
continue
date = str(item.get_end_datetime())
attribute = attribute if attribute is not None else date
passfail_results = item.get_passfail_results()
for result in passfail_results:
if result:
chart_item = {
"id": result,
"pk": item.id,
"link": item.get_absolute_url(),
"date": date,
"attribute": attribute,
"pass": passfail_results[result]["fail"] == 0,
"passes": passfail_results[result]["pass"],
"failures": passfail_results[result]["fail"],
"skip": passfail_results[result]["skip"],
"unknown": passfail_results[result]["unknown"],
"total": (
passfail_results[result]["pass"]
+ passfail_results[result]["fail"]
+ passfail_results[result]["unknown"]
+ passfail_results[result]["skip"]
),
}
data.append(chart_item)
return data
def get_chart_measurement_data(self, user, query_results):
data = []
for item in query_results:
# Set attribute based on xaxis_attribute.
attribute = item.get_xaxis_attribute(self.xaxis_attribute)
# If xaxis attribute is set and this query item does not have
# this specific attribute, ignore it.
if self.xaxis_attribute and not attribute:
continue
date = str(item.get_end_datetime())
attribute = attribute if attribute is not None else date
measurement_results = item.get_measurement_results()
for result in measurement_results:
if result:
chart_item = {
"id": result,
"pk": item.id,
"link": item.get_absolute_url(),
"date": date,
"attribute": attribute,
"pass": measurement_results[result]["fail"] == 0,
"measurement": measurement_results[result]["measurement"],
}
data.append(chart_item)
return data
def get_chart_attributes_data(self, user, query_results):
data = []
for item in query_results:
attribute_results = item.get_attribute_results(self.attributes)
for result in attribute_results:
if result:
chart_item = {
"id": result,
"pk": item.id,
"attribute": str(item.get_end_datetime()),
"link": item.get_absolute_url(),
"date": str(item.get_end_datetime()),
"pass": attribute_results[result]["fail"] == 0,
"attr_value": attribute_results[result]["value"],
}
data.append(chart_item)
return data
def __str__(self):
return self.name
@models.permalink
def get_absolute_url(self):
return (
"lava.results.chart_query_edit",
(),
dict(name=self.chart.name, id=self.id),
)
class ChartQueryUser(models.Model):
class Meta:
unique_together = ("chart_query", "user")
chart_query = models.ForeignKey(ChartQuery, null=False, on_delete=models.CASCADE)
user = models.ForeignKey(User, null=False, on_delete=models.CASCADE)
# Start date can actually also be start build number, ergo char, not date.
# Also, we do not store end date(build number) since user's only want
# to see the latest data.
start_date = models.CharField(max_length=20)
is_legend_visible = models.BooleanField(default=True, verbose_name="Toggle legend")
is_delta = models.BooleanField(default=False, verbose_name="Delta reporting")
|