Changeset 94123 in vbox for trunk/src/VBox

Timestamp:

Mar 8, 2022 1:51:26 PM (3 years ago)

Author:

vboxsync

Message:

ValKit/utils.py,tests: Move crc32_of_file to common/utils.py as calcCrc32OfFile, no point in having two copies of it. pylint fixes.

Location:

trunk/src/VBox/ValidationKit

Files:

• common/utils.py (modified) (16 diffs)
• tests/storage/tdStorageRawDrive1.py (modified) (4 diffs)
• tests/storage/tdStorageSnapshotMerging1.py (modified) (3 diffs)

trunk/src/VBox/ValidationKit/common/utils.py

@@ -214 +214 @@
         try:
             # try /etc/lsb-release first to distinguish between Debian and Ubuntu
-            oFile = open('/etc/lsb-release');
-            for sLine in oFile:
-                oMatch = re.search(r'(?:DISTRIB_DESCRIPTION\s*=)\s*"*(.*)"', sLine);
-                if oMatch is not None:
-                    sDist = oMatch.group(1).strip();
+            with open('/etc/lsb-release') as oFile:
+                for sLine in oFile:
+                    oMatch = re.search(r'(?:DISTRIB_DESCRIPTION\s*=)\s*"*(.*)"', sLine);
+                    if oMatch is not None:
+                        sDist = oMatch.group(1).strip();
         except:
             pass;
@@ -235 +235 @@
                 if os.path.isfile(sFile):
                     try:
-                        oFile = open(sFile);
-                        sLine = oFile.readline();
-                        oFile.close();
+                        with open(sFile) as oFile:
+                            sLine = oFile.readline();
                     except:
                         continue;
@@ -249 +248 @@
         if os.path.isfile('/etc/release'):
             try:
-                oFile = open('/etc/release');
-                sLast = oFile.readlines()[-1];
-                oFile.close();
+                with open('/etc/release') as oFile:
+                    sLast = oFile.readlines()[-1];
                 sLast = sLast.strip();
                 if sLast:
@@ -364 +362 @@
     uPythonVer = (sys.version_info[0] << 16) | (sys.version_info[1] & 0xffff);
     if uPythonVer >= ((3 << 16) | 4):
-        oFile = open(sFile, sMode);
+        oFile = open(sFile, sMode);                             # pylint: disable=consider-using-with
     else:
         try:
@@ -374 +372 @@
                     offComma = sMode.find(',');
                     if offComma < 0:
-                        return open(sFile, sMode + 'N');
-                    return open(sFile, sMode[:offComma] + 'N' + sMode[offComma:]); # pylint: disable=bad-open-mode
+                        return open(sFile, sMode + 'N');        # pylint: disable=consider-using-with
+                    return open(sFile,                          # pylint: disable=consider-using-with,bad-open-mode
+                                sMode[:offComma] + 'N' + sMode[offComma:]);
 
             # Just in case.
-            return open(sFile, sMode);
-
-        oFile = open(sFile, sMode);
+            return open(sFile, sMode);                          # pylint: disable=consider-using-with
+
+        oFile = open(sFile, sMode);                             # pylint: disable=consider-using-with
         #try:
         fcntl(oFile, F_SETFD, fcntl(oFile, F_GETFD) | FD_CLOEXEC);
@@ -434 +433 @@
             fOpen |= os.O_APPEND;
         if 'b' in sMode or 't' in sMode:
-            fOpen |= os.O_TEXT;                                                                 # pylint: disable=no-member
+            fOpen |= os.O_TEXT;                                         # pylint: disable=no-member
         fdFile = msvcrt.open_osfhandle(hDetachedFile, fOpen);
 
@@ -440 +439 @@
         oFile = os.fdopen(fdFile, sMode);
     else:
-        oFile = open(sFile, sMode);
+        oFile = open(sFile, sMode);                                     # pylint: disable=consider-using-with
 
         # Python 3.4 and later automatically creates non-inherit handles. See PEP-0446.
@@ -446 +445 @@
         if uPythonVer < ((3 << 16) | 4):
             try:
-                from fcntl import FD_CLOEXEC, F_GETFD, F_SETFD, fcntl; # pylint: disable=import-error
+                from fcntl import FD_CLOEXEC, F_GETFD, F_SETFD, fcntl;  # pylint: disable=import-error
             except:
                 pass;
@@ -469 +468 @@
     Reads the entire file.
     """
-    oFile = open(sFile, sMode);
-    sRet = oFile.read();
-    oFile.close();
+    with open(sFile, sMode) as oFile:
+        sRet = oFile.read();
     return sRet;
 
@@ -675 +673 @@
         if dKeywordArgs.get('creationflags', 0) == 0:
             dKeywordArgs['creationflags'] = subprocess.CREATE_NEW_PROCESS_GROUP;
-    return subprocess.Popen(*aPositionalArgs, **dKeywordArgs);
+    return subprocess.Popen(*aPositionalArgs, **dKeywordArgs);  # pylint: disable=consider-using-with
 
 def processCall(*aPositionalArgs, **dKeywordArgs):
@@ -778 +776 @@
             except:
                 sVersion = '1.7.0';
-            sVersion = sVersion.strip().split('\n')[0];
+            sVersion = sVersion.strip().split('\n', 1)[0];
             sVersion = sVersion.replace('Sudo version', '').strip();
             g_fOldSudo = len(sVersion) >= 4 \
@@ -1039 +1037 @@
         if asPsCmd is not None:
             try:
-                oPs = subprocess.Popen(asPsCmd, stdout=subprocess.PIPE);
+                oPs = subprocess.Popen(asPsCmd, stdout=subprocess.PIPE);    # pylint: disable=consider-using-with
                 sCurName = oPs.communicate()[0];
                 iExitCode = oPs.wait();
@@ -1341 +1339 @@
                 sFull = os.path.join(sDir, sEntry);
                 try:
-                    oFile = open(sFull, 'r');
-                    sFirstLine = oFile.readline();
-                    oFile.close();
+                    with open(sFull, 'r') as oFile:
+                        sFirstLine = oFile.readline();
                 except:
                     continue;
@@ -2127 +2124 @@
 
     # Open it.
-    try: oZipFile = zipfile.ZipFile(sArchive, 'r')
+    try: oZipFile = zipfile.ZipFile(sArchive, 'r');             # pylint: disable=consider-using-with
     except Exception as oXcpt:
         fnError('Error opening "%s" for unpacking into "%s": %s' % (sArchive, sDstDir, oXcpt,));
@@ -2210 +2207 @@
     try:
         if sys.hexversion >= 0x03060000:
-            oTarFile = tarfile.open(sArchive, 'r|*', bufsize = g_cbGoodBufferSize, copybufsize = g_cbGoodBufferSize);
+            oTarFile = tarfile.open(sArchive, 'r|*',                                # pylint: disable=consider-using-with
+                                    bufsize = g_cbGoodBufferSize, copybufsize = g_cbGoodBufferSize);
         else:
-            oTarFile = tarfile.open(sArchive, 'r|*', bufsize = g_cbGoodBufferSize);
+            oTarFile = tarfile.open(sArchive, 'r|*', bufsize = g_cbGoodBufferSize); # pylint: disable=consider-using-with
     except Exception as oXcpt:
         fnError('Error opening "%s" for unpacking into "%s": %s' % (sArchive, sDstDir, oXcpt,));
@@ -2404 +2402 @@
 
 
+def calcCrc32OfFile(sFile):
+    """
+    Simple helper for calculating the CRC32 of a file.
+
+    Throws stuff if the file cannot be opened or read successfully.
+    """
+    import zlib;
+
+    uCrc32 = 0;
+    with open(sFile, 'rb') as oFile:
+        while True:
+            oBuf = oFile.read(1024 * 1024);
+            if not oBuf:
+                break
+            uCrc32 = zlib.crc32(oBuf, uCrc32);
+
+    return uCrc32 % 2**32;
+
+
 #
 # Unit testing.

trunk/src/VBox/ValidationKit/tests/storage/tdStorageRawDrive1.py

@@ -31 +31 @@
 # Standard Python imports.
 import os;
+import re;
 import sys;
-import re;
-import zlib;
 
 # Only the main script needs to modify the path.
@@ -42 +41 @@
 
 # Validation Kit imports.
+from common     import utils;
 from testdriver import reporter;
 from testdriver import base;
@@ -49 +49 @@
 from testdriver import vboxwrappers;
 
-
-def crc32_of_file(filepath):
-    fileobj = open(filepath,'rb');
-    current = 0;
-
-    while True:
-        buf = fileobj.read(1024 * 1024);
-        if not buf:
-            break
-        current = zlib.crc32(buf, current);
-
-    fileobj.close();
-    return current % 2**32;
 
 class tdStorageRawDriveOs(vboxtestvms.BaseTestVm):
@@ -1212 +1199 @@
                                         reporter.error('Download vmdktest-pt.vmdk from guest to host failed');
                                     else:
-                                        uResCrc32 = crc32_of_file(sDstFile);
+                                        uResCrc32 = utils.calcCrc32OfFile(sDstFile);
                                         if uResCrc32 != action['data-crc'][sHdd]:
                                             fRc = reporter.error('vmdktest-pt.vmdk does not match what was expected');

trunk/src/VBox/ValidationKit/tests/storage/tdStorageSnapshotMerging1.py

@@ -43 +43 @@
 
 # Validation Kit imports.
+from common     import utils;
 from testdriver import reporter;
 from testdriver import base;
@@ -52 +53 @@
 if sys.version_info[0] >= 3:
     long = int;     # pylint: disable=redefined-builtin,invalid-name
-
-
-def crc32_of_file(filepath):
-    fileobj = open(filepath,'rb');
-    current = 0;
-
-    while True:
-        buf = fileobj.read(1024 * 1024);
-        if not buf:
-            break
-        current = zlib.crc32(buf, current);
-
-    fileobj.close();
-    return current % 2**32;
 
 
@@ -349 +336 @@
                     uResCrc32 = long(0);
                     if fRc:
-                        uResCrc32 = long(crc32_of_file(sResFilePathRaw));
+                        uResCrc32 = long(utils.calcCrc32OfFile(sResFilePathRaw));
                         if uResCrc32 == uOrigCrc:
                             reporter.log('Snapshot merged successfully. Crc32 is correct');