Merge branch 'master' of https://github.com/sleuthkit/autopsy

Testing/script/regression.py

@@ -11,19 +11,22 @@ import xml
 from xml.dom.minidom import parse, parseString
 
 
-#  Last modified 7/17/12 @5pm
+#  Last modified 7/23/12 @3:00pm
-#  Usage: ./regression.py [-s FILE] OR [-l CONFIG]  [OPTIONS]
+#  Usage: ./regression.py [-f FILE] OR [-l CONFIG]  [OPTIONS]
 #  Run the RegressionTest.java file, and compare the result with a gold standard
-#  When the -i flag is set, this script only tests the image given by FILE.
+#  When the -f flag is set, this script only tests the image given by FILE.
 #  An indexed NSRL database is expected at ./input/nsrl.txt-md5.idx,
 #  and an indexed notable hash database at ./input/notablehashes.txt-md5.idx
 #  In addition, any keywords to search for must be in ./input/notablekeywords.xml
 #  When the -l flag is set, the script looks for a config.xml file of the given name 
-#  where images are stored. For usage notes please see the example "config.xml" in
+#  where images are stored. The above input files can be outsourced to different locations
+#  from the config.xml. For usage notes please see the example "config.xml" in
 #  the /script folder.
 #    Options: 
 #    -r, --rebuild      Rebuild the gold standards from the test results for each image
-#    -i, --ignore       Ignores unallocated space when ingesting. Faster, but less accurate results.
+#    -i, --ignore       Ignores the ./input directory when searching for files
+#    -u, --unallocated  Ignores unallocated space when ingesting. Faster, but less accurate results.
+#    -d, --delete       Disables the deletion of Solr indexing directory generated by Ingest. Uses more disk space..
   
 
 hadErrors = False # If any of the tests failed
@@ -119,8 +122,8 @@ def getImageSize(inFile, list):
         filename = os.path.splitext(files)[0]
         if filename == name:
             filepath = os.path.join(path, files)
-        if not os.path.samefile(filepath, inFile):
+            if not os.path.samefile(filepath, inFile):
-            size += os.path.getsize(filepath)
+                size += os.path.getsize(filepath)
     size += os.path.getsize(inFile)
   return size
 
@@ -235,6 +238,17 @@ def copyReportToGold(inFile, ignoreUnalloc, list):
   else:
     shutil.copy(testReport, goldReport)
     
+def deleteKeywordFiles(inFile, ignoreUnalloc, list):
+    print "------------------------------------------------"
+    print "Deleting Keyword Search files"
+    inFile = imageName(inFile)
+    if ignoreUnalloc:
+        inFile += "-u"
+    if list:
+        inFile += "-l"
+    cwd = wgetcwd()
+    shutil.rmtree(os.path.join("./", outDir, inFile, "AutopsyTestCase", "KeywordSearch"))
+
 def testCompareReports(inFile, ignoreUnalloc, list):
   print "------------------------------------------------"
   print "Comparing report to golden report."
@@ -342,6 +356,8 @@ def wabspath(inFile):
         out,err = proc.communicate()
     return out.rstrip()
     
+
+
 def copyLogs(inFile, ignoreUnalloc, list):
   name = imageName(inFile)
   if ignoreUnalloc:
@@ -351,7 +367,7 @@ def copyLogs(inFile, ignoreUnalloc, list):
   logDir = os.path.join("..","build","test","qa-functional","work","userdir0","var","log")
   shutil.copytree(logDir,os.path.join(outDir,name,"logs"))
 
-def testFile(image, rebuild, ignoreUnalloc, list):
+def testFile(image, rebuild, ignoreUnalloc, list, delete):
   if imageType(image) != ImgType.UNKNOWN:
     testAddImageIngest(image, ignoreUnalloc, list)
     copyLogs(image, ignoreUnalloc, list)
@@ -359,25 +375,31 @@ def testFile(image, rebuild, ignoreUnalloc, list):
       clearGoldDir(image, ignoreUnalloc, list)
       copyTestToGold(image, ignoreUnalloc, list)
       copyReportToGold(image, ignoreUnalloc, list)
+    if delete:
+        deleteKeywordFiles(image, ignoreUnalloc, list)
     else:
       testCompareToGold(image, ignoreUnalloc, list)
       testCompareReports(image, ignoreUnalloc, list)
       
 def usage():
   usage = "\
-  Usage: ./regression.py [-s FILE] [OPTIONS] \n\n\
+  Usage: ./regression.py [-f FILE] [OPTIONS] \n\n\
   Run the RegressionTest.java file, and compare the result with a gold standard \n\n\
-  When the -i flag is set, this script only tests the image given by FILE.\n\
+  When the -f flag is set, this script only tests the image given by FILE.\n\
   By default, it tests every image in ./input/\n\n\
   An indexed NSRL database is expected at ./input/nsrl.txt-md5.idx,\n\
   and an indexed notable hash database at ./input/notablehashes.txt-md5.idx\n\
   In addition, any keywords to search for must be in ./input/notablekeywords.xml\n\n\
   When the -l flag is set, the script looks for a config.xml file of the given name\n\
-  where images are stored. For usage notes please see the example config.xml in\n\
+  where images are stored. The above input files may be outsources to a different folder\n\
+  via the config file. For usage notes please see the example \"config.xml\" in\n\
   the /script folder.\
     Options:\n\n\
-    -r, --rebuild\t\tRebuild the gold standards from the test results for each image\n\n\
+    -r, --rebuild\t\tRebuild the gold standards from the test results for each image.\n\n\
-    -u, --ignore\t\tIgnore unallocated space while ingesting"
+    -i, --ignore\t\tIgnores the ./input directory when searching for files. ONLY use in combinatin with a config file.\n\n\
+    -u, --unallocated\t\tIgnores unallocated space when ingesting. Faster, but less accurate results.\n\n\
+    -d, --delete\t\tDisables the deletion of Solr indexing directory generated by Ingest. Uses more disk space."
+    
   return usage
 
 def main():
@@ -387,21 +409,21 @@ def main():
   ignoreUnalloc = False
   list = False
   test = True
+  delete = True
   argi = 1
   Config = None   #file pointed to by --list
   imgListB = []   #list of legal images from config
   cwd = wgetcwd()
   while argi < len(sys.argv):
       arg = sys.argv[argi]
-      if arg == "-s" and argi+1 < len(sys.argv): #check for single
+      if arg == "-f" and argi+1 < len(sys.argv): #check for single
           single = True
           test = False
           argi+=1
           image = sys.argv[argi]
           print "Running on single image: " + image
-      if arg == "-l" or arg == "--list":    #check for config file
+      elif arg == "-l" or arg == "--list":    #check for config file
             list = True
-            
             argi+=1
             #check for file in ./
             if(os.path.isfile(os.path.join("./", sys.argv[argi]))):
@@ -416,18 +438,21 @@ def main():
       elif (arg  == "--rebuild") or (arg == "-r"):  #check for rebuild flag
           rebuild = True
           print "Running in REBUILD mode"
-      elif (arg == "-u"):    #check for ignore unallocated space flag
+      elif (arg == "-u") or (arg == "--unallocated"):    #check for ignore unallocated space flag
           ignoreUnalloc = True
           print "Ignoring unallocated space"
       elif (arg == "--ignore") or (arg == "-i"):
           ignoreInput = True
           print "Ignoring /script/input directory"
+      elif (arg == "--delete") or (arg == "-d"):
+          delete = True
+          print "Will not delete keyword search Solr index"
       else:
           test = False
           print usage()
       argi+=1
   if single:
-    testFile(image, rebuild, ignoreUnalloc, list)
+    testFile(image, rebuild, ignoreUnalloc, list, delete)
   if list:
     listImages = []
     errors = 0
@@ -446,14 +471,14 @@ def main():
             errors+=1
     print "Illegal files specified: " + str(errors)
     for image in listImages:
-        testFile(image, rebuild, ignoreUnalloc, list)
+        testFile(image, rebuild, ignoreUnalloc, list, delete)
     if not ignoreInput:
         global inDir
         inDir = os.path.join(cwd, "input")
         test = True
   if test:
     for inFile in os.listdir(inDir):
-      testFile(os.path.join(inDir,inFile), rebuild, ignoreUnalloc, list)
+      testFile(os.path.join(inDir,inFile), rebuild, ignoreUnalloc, list, delete)
 
   if hadErrors == True:
     print "**********************************************"