# -*- coding: utf-8 -*- # $Id: systemchangelog.py $ """ Test Manager - System changelog compilation. """ __copyright__ = \ """ Copyright (C) 2012-2023 Oracle and/or its affiliates. This file is part of VirtualBox base platform packages, as available from https://www.virtualbox.org. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, in version 3 of the License. This program 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 General Public License along with this program; if not, see . The contents of this file may alternatively be used under the terms of the Common Development and Distribution License Version 1.0 (CDDL), a copy of it is provided in the "COPYING.CDDL" file included in the VirtualBox distribution, in which case the provisions of the CDDL are applicable instead of those of the GPL. You may elect to license modified versions of this file under the terms and conditions of either the GPL or the CDDL or both. SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0 """ __version__ = "$Revision: 155244 $" # Validation Kit imports. from testmanager.core.base import ModelLogicBase; from testmanager.core.useraccount import UserAccountLogic; from testmanager.core.systemlog import SystemLogData; class SystemChangelogEntry(object): # pylint: disable=too-many-instance-attributes """ System changelog entry. """ def __init__(self, tsEffective, oAuthor, sEvent, idWhat, sDesc): self.tsEffective = tsEffective; self.oAuthor = oAuthor; self.sEvent = sEvent; self.idWhat = idWhat; self.sDesc = sDesc; class SystemChangelogLogic(ModelLogicBase): """ System changelog compilation logic. """ ## @name What kind of change. ## @{ ksWhat_TestBox = 'chlog::TestBox'; ksWhat_TestCase = 'chlog::TestCase'; ksWhat_Blacklisting = 'chlog::Blacklisting'; ksWhat_Build = 'chlog::Build'; ksWhat_BuildSource = 'chlog::BuildSource'; ksWhat_FailureCategory = 'chlog::FailureCategory'; ksWhat_FailureReason = 'chlog::FailureReason'; ksWhat_GlobalRsrc = 'chlog::GlobalRsrc'; ksWhat_SchedGroup = 'chlog::SchedGroup'; ksWhat_TestGroup = 'chlog::TestGroup'; ksWhat_User = 'chlog::User'; ksWhat_TestResult = 'chlog::TestResult'; ## @} ## Mapping a changelog entry kind to a table, key and clue. kdWhatToTable = dict({ # pylint: disable=star-args ksWhat_TestBox: ( 'TestBoxes', 'idTestBox', None, ), ksWhat_TestCase: ( 'TestCasees', 'idTestCase', None, ), ksWhat_Blacklisting: ( 'Blacklist', 'idBlacklisting', None, ), ksWhat_Build: ( 'Builds', 'idBuild', None, ), ksWhat_BuildSource: ( 'BuildSources', 'idBuildSrc', None, ), ksWhat_FailureCategory: ( 'FailureCategories', 'idFailureCategory', None, ), ksWhat_FailureReason: ( 'FailureReasons', 'idFailureReason', None, ), ksWhat_GlobalRsrc: ( 'GlobalResources', 'idGlobalRsrc', None, ), ksWhat_SchedGroup: ( 'SchedGroups', 'idSchedGroup', None, ), ksWhat_TestGroup: ( 'TestGroups', 'idTestGroup', None, ), ksWhat_User: ( 'Users', 'idUser', None, ), ksWhat_TestResult: ( 'TestResults', 'idTestResult', None, ), }, **{sEvent: ( 'SystemLog', 'tsCreated', 'TimestampId', ) for sEvent in SystemLogData.kasEvents}); ## The table key is the effective timestamp. (Can't be used above for some weird scoping reason.) ksClue_TimestampId = 'TimestampId'; ## @todo move to config.py? ksVSheriffLoginName = 'vsheriff'; ## @name for kaasChangelogTables ## @internal ## @{ ksTweak_None = ''; ksTweak_NotNullAuthor = 'uidAuthorNotNull'; ksTweak_NotNullAuthorOrVSheriff = 'uidAuthorNotNullOrVSheriff'; ## @} ## @internal kaasChangelogTables = ( # [0]: change name, [1]: Table name, [2]: key column, [3]:later, [4]: tweak ( ksWhat_TestBox, 'TestBoxes', 'idTestBox', None, ksTweak_NotNullAuthor, ), ( ksWhat_TestBox, 'TestBoxesInSchedGroups', 'idTestBox', None, ksTweak_None, ), ( ksWhat_TestCase, 'TestCases', 'idTestCase', None, ksTweak_None, ), ( ksWhat_TestCase, 'TestCaseArgs', 'idTestCase', None, ksTweak_None, ), ( ksWhat_TestCase, 'TestCaseDeps', 'idTestCase', None, ksTweak_None, ), ( ksWhat_TestCase, 'TestCaseGlobalRsrcDeps', 'idTestCase', None, ksTweak_None, ), ( ksWhat_Blacklisting, 'BuildBlacklist', 'idBlacklisting', None, ksTweak_None, ), ( ksWhat_Build, 'Builds', 'idBuild', None, ksTweak_NotNullAuthor, ), ( ksWhat_BuildSource, 'BuildSources', 'idBuildSrc', None, ksTweak_None, ), ( ksWhat_FailureCategory, 'FailureCategories', 'idFailureCategory', None, ksTweak_None, ), ( ksWhat_FailureReason, 'FailureReasons', 'idFailureReason', None, ksTweak_None, ), ( ksWhat_GlobalRsrc, 'GlobalResources', 'idGlobalRsrc', None, ksTweak_None, ), ( ksWhat_SchedGroup, 'SchedGroups', 'idSchedGroup', None, ksTweak_None, ), ( ksWhat_SchedGroup, 'SchedGroupMembers', 'idSchedGroup', None, ksTweak_None, ), ( ksWhat_TestGroup, 'TestGroups', 'idTestGroup', None, ksTweak_None, ), ( ksWhat_TestGroup, 'TestGroupMembers', 'idTestGroup', None, ksTweak_None, ), ( ksWhat_User, 'Users', 'uid', None, ksTweak_None, ), ( ksWhat_TestResult, 'TestResultFailures', 'idTestResult', None, ksTweak_NotNullAuthorOrVSheriff, ), ); def __init__(self, oDb): ModelLogicBase.__init__(self, oDb); def fetchForListingEx(self, iStart, cMaxRows, tsNow, cDaysBack, aiSortColumns = None): """ Fetches SystemLog entries. Returns an array (list) of SystemLogData items, empty list if none. Raises exception on error. """ _ = aiSortColumns; # # Construct the query. # oUserAccountLogic = UserAccountLogic(self._oDb); oVSheriff = oUserAccountLogic.tryFetchAccountByLoginName(self.ksVSheriffLoginName); uidVSheriff = oVSheriff.uid if oVSheriff is not None else -1; if tsNow is None: sWhereTime = self._oDb.formatBindArgs(' WHERE tsEffective >= CURRENT_TIMESTAMP - \'%s days\'::interval\n', (cDaysBack,)); else: sWhereTime = self._oDb.formatBindArgs(' WHERE tsEffective >= (%s::timestamptz - \'%s days\'::interval)\n' ' AND tsEffective <= %s\n', (tsNow, cDaysBack, tsNow)); # Special entry for the system log. sQuery = '(\n' sQuery += ' SELECT NULL AS uidAuthor,\n'; sQuery += ' tsCreated AS tsEffective,\n'; sQuery += ' sEvent AS sEvent,\n'; sQuery += ' NULL AS idWhat,\n'; sQuery += ' sLogText AS sDesc\n'; sQuery += ' FROM SystemLog\n'; sQuery += sWhereTime.replace('tsEffective', 'tsCreated'); sQuery += ' ORDER BY tsCreated DESC\n' sQuery += ')' for asEntry in self.kaasChangelogTables: sQuery += ' UNION (\n' sQuery += ' SELECT uidAuthor, tsEffective, \'' + asEntry[0] + '\', ' + asEntry[2] + ', \'\'\n'; sQuery += ' FROM ' + asEntry[1] + '\n' sQuery += sWhereTime; if asEntry[4] == self.ksTweak_NotNullAuthor or asEntry[4] == self.ksTweak_NotNullAuthorOrVSheriff: sQuery += ' AND uidAuthor IS NOT NULL\n'; if asEntry[4] == self.ksTweak_NotNullAuthorOrVSheriff: sQuery += ' AND uidAuthor <> %u\n' % (uidVSheriff,); sQuery += ' ORDER BY tsEffective DESC\n' sQuery += ')'; sQuery += ' ORDER BY 2 DESC\n'; sQuery += ' LIMIT %u OFFSET %u\n' % (cMaxRows, iStart, ); # # Execute the query and construct the return data. # self._oDb.execute(sQuery); aoRows = []; for aoRow in self._oDb.fetchAll(): aoRows.append(SystemChangelogEntry(aoRow[1], oUserAccountLogic.cachedLookup(aoRow[0]), aoRow[2], aoRow[3], aoRow[4])); return aoRows;