Changeset 5018

Timestamp:

Feb 11, 2008, 4:45:53 PM (17 years ago)

Author:

ole

Message:

Made an ANUGA specific wrapper for data_audit and added some more comments.
Data audit is still disabled from test_all.py until we decide how to invoke it.
However, create_distribution.py is using it.

Files:

• anuga_core/source/anuga/utilities/data_audit.py (modified) (10 diffs)
• anuga_core/source/anuga/utilities/data_audit_config.py (deleted)
• anuga_core/source/anuga/utilities/data_audit_wrapper.py (added)
• anuga_core/test_all.py (modified) (4 diffs)
• create_distribution.py (modified) (2 diffs)

anuga_core/source/anuga/utilities/data_audit.py

@@ -1 @@
-"""Track IP of data files included in this distribution. 
+"""Track IP of data files in an entire directory tree.
+See docstring for the public function IP_verified()
+for details.
 """
 
@@ -7 +9 @@
 from anuga.utilities.xml_tools import xml2object, XML_element
 from anuga.utilities.system_tools import compute_checksum
-
-from data_audit_config import extensions_to_ignore, directories_to_ignore, files_to_ignore
-
 
 
@@ -25 +24 @@
                     WrongTags)
 
-def IP_verified(directory, verbose=False):
+
+def IP_verified(directory,
+                extensions_to_ignore=None,
+                directories_to_ignore=None,
+                files_to_ignore=None,
+                verbose=False):
     """Find and audit potential data files that might violate IP
 
@@ -41 +45 @@
     If verbose is False, only diagnostics about failed audits will appear.
     All files that check OK will pass silently.
-    
-
+
+    Optional arguments extensions_to_ignore, directories_to_ignore, and
+    files_to_ignore are lists of things to skip.
+
+    Examples are:
+    extensions_to_ignore = ['.py','.c','.h', '.f'] # Ignore source code
+    files_to_ignore = ['README.txt']
+    directories_to_ignore = ['.svn', 'misc']
+
+    None is also OK for these parameters.
+    
     """
 
@@ -51 +64 @@
     first_time = True
     all_files_accounted_for = True
-    for dirpath, datafile in identify_datafiles(directory):
+    for dirpath, datafile in identify_datafiles(directory,
+                                                extensions_to_ignore,
+                                                directories_to_ignore,
+                                                files_to_ignore):
         
         filename = join(dirpath, datafile)
@@ -99 +115 @@
 
 
-def identify_datafiles(root):
+
+#------------------
+# Private functions
+#------------------
+def identify_datafiles(root,
+                       extensions_to_ignore=None,
+                       directories_to_ignore=None,
+                       files_to_ignore=None):
     """ Identify files that might contain data
+
+    See function IP_verified() for details about optinoal parmeters
     """
 
@@ -109 +134 @@
                 dirnames.remove(ignore)  # don't visit ignored directories
 
-        #print 'Searching dir', dirpath
-        
 
         for filename in filenames:
@@ -129 +152 @@
 
 def license_file_is_valid(fid, dirpath='.', verbose=False):
-    """Check that XML license file is valid
+    """Check that XML license file is valid.
+
+    Check for each datafile listed that
+
+    * Datafile tags are there
+    * Fields are non empty
+    * Datafile exists
+    * Checksum is correct
+    * Datafile is flagged as publishable
+
+    If anything is violated an appropriate exception is raised.
+    If everything is honky dory the function will return True.
     """
 
@@ -149 +183 @@
 
     # Validate elements: metadata, datafile, datafile, ...
+    # FIXME (Ole): I'd like this to verified by the parser
+    # using a proper DTD template one day....
+    # For not, let's check the main ones.
     elements = doc['ga_license_file']
     if not elements.has_key('metadata'):
@@ -174 +211 @@
     author = metadata['author']
     if verbose: print 'Author:   ', author
+    if author == '':
+        msg = 'Missing author'
+        raise Exception, msg                
     
     #svn_keywords = metadata['svn_keywords']

anuga_core/test_all.py

@@ -1 @@
-from anuga.utilities.data_audit import IP_verified
+from anuga.utilities.data_audit_wrapper import IP_verified
 from tempfile import mktemp
 
@@ -14 +14 @@
 
 
+print
+print '************************** NOTE *************************************'
+print 'If all unit tests passed you should run the suite of validation tests'
+print 'Go to the directory anuga_validation/automated_validation_tests'
+print 'and run'
+print '    python validate_all.py'
+print
+print 'These tests will take a few hours and will verify that ANUGA'
+print 'produces the physical results expected.'
+print '*********************************************************************'
+
+
+
 # Temporary bail out
 import sys; sys.exit() 
@@ -23 +36 @@
 
 # Create temporary area for svn to export source files
+# FIXME (Ole): It would be good to make sure these files
+# are exactly the same as those walked over by the
+# release script: create_distribution.
+#
+# Come to think of it - this is probably not the best
+# place for this check. It may have to move up one level.
+# What do you all think?
+
+
+
 temp_dir = mktemp()
 
 print 'Temp dir', temp_dir
 os.mkdir(temp_dir)
-
 
 # Get the ANUGA core source files
@@ -42 +64 @@
 
 
-print
-print '************************** NOTE *************************************'
-print 'If all unit tests passed you should run the suite of validation tests'
-print 'Go to the directory anuga_validation/automated_validation_tests'
-print 'and run'
-print '    python validate_all.py'
-print
-print 'These tests will take a few hours and will verify that ANUGA'
-print 'produces the physical results expected.'
-print '*********************************************************************'
+
 
     

create_distribution.py

@@ -18 +18 @@
    it depends on still work for that revision.
 
-   This script works only on Linux
+   This script works only on Linux!
 """
 
@@ -30 +30 @@
 from anuga.config import major_revision
 
-from anuga.utilities.data_audit import IP_verified
+from anuga.utilities.data_audit_wrapper import IP_verified
 
 if platform == 'win32':