Changeset 83415 in vbox

Timestamp:

Mar 25, 2020 4:27:11 PM (5 years ago)

Author:

vboxsync

Message:

TestManager/webui: Hooked up the partial database dumper to the WUI so it isn't necessary to have SSH access to the server to get at the data.

Location:

trunk/src/VBox/ValidationKit/testmanager

Files:

• config.py (modified) (2 diffs)
• webui/wuiadmin.py (modified) (6 diffs)
• webui/wuiadminsystemdbdump.py (added)

trunk/src/VBox/ValidationKit/testmanager/config.py

@@ -90 +90 @@
 ## File on the build binary share that can be used to check that it's mounted.
 g_ksBuildBinRootFile    = 'builds.txt'
+## Template for paratial database dump files.  One argument: UID
+g_ksTmDbDumpFileTemplate = '/var/tmp/tm-partial-db-dump-for-%u.zip'
 ## @}
 
@@ -142 +144 @@
 g_kcMaxUploads          = 256;
 ## @}
+
+
+## @name Partial Database Dump
+## @{
+
+## Minimum number of day.  Set higher than g_kcTmDbDumpMaxDays to disable.
+g_kcTmDbDumpMinDays     = 1;
+## Maximum number of day.  Keep low - consider space and runtime.
+g_kcTmDbDumpMaxDays     = 31;
+## The default number of days.
+g_kcTmDbDumpDefaultDays = 14;
+## @}
+
 
 ## @name Debug Features

trunk/src/VBox/ValidationKit/testmanager/webui/wuiadmin.py

@@ -35 +35 @@
 
 # Validation Kit imports.
-from common                                    import webutils
+from common                                    import utils, webutils;
 from testmanager                               import config;
 from testmanager.webui.wuibase                 import WuiDispatcherBase, WuiException
@@ -55 +55 @@
     ksActionSystemLogList           = 'SystemLogList'
     ksActionSystemChangelogList     = 'SystemChangelogList'
+    ksActionSystemDbDump            = 'SystemDbDump'
+    ksActionSystemDbDumpDownload    = 'SystemDbDumpDownload'
 
     ksActionUserList                = 'UserList'
@@ -167 +169 @@
 
         #
-        # System Log actions.
+        # System actions.
         #
         self._dDispatch[self.ksActionSystemChangelogList]       = self._actionSystemChangelogList;
         self._dDispatch[self.ksActionSystemLogList]             = self._actionSystemLogList;
+        self._dDispatch[self.ksActionSystemDbDump]              = self._actionSystemDbDump;
+        self._dDispatch[self.ksActionSystemDbDumpDownload]      = self._actionSystemDbDumpDownload;
 
         #
@@ -345 +349 @@
                     [ 'Changelog',              self._sActionUrlBase + self.ksActionSystemChangelogList,    False ],
                     [ 'System log',             self._sActionUrlBase + self.ksActionSystemLogList,          False ],
+                    [ 'Partial DB Dump',        self._sActionUrlBase + self.ksActionSystemDbDump,           False ],
                     [ 'User accounts',          self._sActionUrlBase + self.ksActionUserList,               False ],
                     [ 'New user',               self._sActionUrlBase + self.ksActionUserAdd,                True  ],
@@ -423 +428 @@
 
     def _actionSystemChangelogList(self):
-        """ Action wrapper. """
+        """ Action handler. """
         from testmanager.core.systemchangelog          import SystemChangelogLogic;
         from testmanager.webui.wuiadminsystemchangelog import WuiAdminSystemChangelogList;
@@ -447 +452 @@
         from testmanager.webui.wuiadminsystemlog       import WuiAdminSystemLogList;
         return self._actionGenericListing(SystemLogLogic, WuiAdminSystemLogList)
+
+    def _actionSystemDbDump(self):
+        """ Action handler. """
+        from testmanager.webui.wuiadminsystemdbdump    import WuiAdminSystemDbDumpForm;
+
+        cDaysBack = self.getIntParam(self.ksParamDaysBack, iMin = config.g_kcTmDbDumpMinDays,
+                                     iMax = config.g_kcTmDbDumpMaxDays, iDefault = config.g_kcTmDbDumpDefaultDays);
+        self._checkForUnknownParameters();
+
+        oContent = WuiAdminSystemDbDumpForm(cDaysBack, oDisp = self);
+        (self._sPageTitle, self._sPageBody) = oContent.showForm();
+        return True;
+
+    def _actionSystemDbDumpDownload(self):
+        """ Action handler. """
+        import datetime;
+        import os;
+
+        cDaysBack = self.getIntParam(self.ksParamDaysBack, iMin = config.g_kcTmDbDumpMinDays,
+                                     iMax = config.g_kcTmDbDumpMaxDays, iDefault = config.g_kcTmDbDumpDefaultDays);
+        self._checkForUnknownParameters();
+
+        #
+        # Generate the dump.
+        #
+        # We generate a file name that's unique to a user is smart enough to only
+        # issue one of these requests at the time.  This also makes sure we  won't
+        #  waste too much space should this code get interrupted and rerun.
+        #
+        oFile    = None;
+        oNow     = datetime.datetime.utcnow();
+        sTmpFile = config.g_ksTmDbDumpFileTemplate % (self._oCurUser.uid,);
+        sScript  = os.path.join(config.g_ksTestManagerDir, 'db', 'partial-db-dump.py');
+        try:
+            (iExitCode, sStdOut, sStdErr) = utils.processOutputUnchecked([sScript, '--days-to-dump', str(cDaysBack),
+                                                                          '-f', sTmpFile,]);
+            if iExitCode != 0:
+                raise Exception('iExitCode=%s\n--- stderr ---\n%s\n--- stdout ---\n%s' % (iExitCode, sStdOut, sStdErr,));
+
+            #
+            # Open and send the dump.
+            #
+            oFile = open(sTmpFile, 'rb');
+            cbFile = os.fstat(oFile.fileno()).st_size;
+
+            self._oSrvGlue.setHeaderField('Content-Type', 'application/zip');
+            self._oSrvGlue.setHeaderField('Content-Disposition',
+                                          oNow.strftime('attachment; filename="partial-db-dump-%Y-%m-%dT%H-%M-%S.zip"'));
+            self._oSrvGlue.setHeaderField('Content-Length', str(cbFile));
+
+            while True:
+                abChunk = oFile.read(262144);
+                if not abChunk:
+                    break;
+                self._oSrvGlue.writeRaw(abChunk);
+
+        finally:
+            # Delete the file to save space.
+            if oFile:
+                try:    oFile.close();
+                except: pass;
+            utils.noxcptDeleteFile(sTmpFile);
+        return self.ksDispatchRcAllDone;
+
 
     # User Account actions.