Changeset 6873

Timestamp:

Apr 22, 2009, 11:19:26 AM (15 years ago)

Author:

rwilson

Message:

Made copy_code_files() copy any number of files, plus testcase.

Location:

anuga_core/source/anuga/shallow_water

Files:

• data_manager.py (modified) (2 diffs)
• test_data_manager.py (modified) (3 diffs)

anuga_core/source/anuga/shallow_water/data_manager.py

@@ -6675 +6675 @@
 
 
-# FIXME (DSG): Add unit test, make general, not just 2 files,
-# but any number of files.
 ##
 # @brief Copy a file to a directory, and optionally append another file to it.
@@ -6682 +6680 @@
 # @param filename Path to file to copy to directory 'dir_name'.
 # @param filename2 Optional path to file to append to copied file.
-def copy_code_files(dir_name, filename1, filename2=None):
+# @param verbose True if this function is to be verbose.
+# @note Allow filenames to be either a string or sequence of strings.
+def copy_code_files(dir_name, filename1, filename2=None, verbose=False):
     """Copies "filename1" and "filename2" to "dir_name".
-    Very useful for information management
-    filename1 and filename2 are both absolute pathnames
-    """
-
+
+    Each 'filename' may be a string or list of filename strings.
+
+    Filenames must be absolute pathnames
+    """
+
+    ##
+    # @brief copies a file or sequence to destination directory.
+    # @param dest The destination directory to copy to.
+    # @param file A filename string or sequence of filename strings.
+    def copy_file_or_sequence(dest, file):
+        if hasattr(file, '__iter__'):
+            for f in file:
+                shutil.copy(f, dir_name)
+                if verbose:
+                    print 'File %s copied' % (f)
+        else:
+            shutil.copy(file, dir_name)
+            if verbose:
+                print 'File %s copied' % (file)
+
+    # check we have a destination directory, create if necessary
     if access(dir_name, F_OK) == 0:
-        print 'Make directory %s' % dir_name
-        mkdir (dir_name,0777)
-
-    shutil.copy(filename1, dir_name + sep + basename(filename1))
-
-    if filename2 != None:
-        shutil.copy(filename2, dir_name + sep + basename(filename2))
-        print 'Files %s and %s copied' %(filename1, filename2)
-    else:
-        print 'File %s copied' %(filename1)
+        mkdir(dir_name, 0777)
+
+    copy_file_or_sequence(dir_name, filename1)
+
+    if not filename2 is None:
+        copy_file_or_sequence(dir_name, filename2)
 
 

anuga_core/source/anuga/shallow_water/test_data_manager.py

@@ -15 +15 @@
 from struct import pack, unpack
 from sets import ImmutableSet
+import shutil
 
 from anuga.shallow_water import *
@@ -11627 +11628 @@
 
             
+    def test_copy_code_files(self):
+        '''test that the copy_code_files() function is sane.'''
+
+        def create_file(f):
+            fd = open(f, 'w')
+            fd.write('%s\n' % f)
+            fd.close()
+
+        # create working directories and test files
+        work_dir = tempfile.mkdtemp()
+        dst_dir = tempfile.mkdtemp(dir=work_dir)
+        src_dir = tempfile.mkdtemp(dir=work_dir)
+
+        f1 = 'file1'        
+        filename1 = os.path.join(src_dir, f1)
+        create_file(filename1)
+        f2 = 'file2'        
+        filename2 = os.path.join(src_dir, f2)
+        create_file(filename2)
+        f3 = 'file3'        
+        filename3 = os.path.join(src_dir, f3)
+        create_file(filename3)
+        f4 = 'file4'        
+        filename4 = os.path.join(src_dir, f4)
+        create_file(filename4)
+        f5 = 'file5'        
+        filename5 = os.path.join(src_dir, f5)
+        create_file(filename5)
+
+        # exercise the copy function
+        copy_code_files(dst_dir, filename1)
+        copy_code_files(dst_dir, filename1, filename2)
+        copy_code_files(dst_dir, (filename4, filename5, filename3))
+
+        # test that files were actually copied
+        self.failUnless(access(os.path.join(dst_dir, f1), F_OK))
+        self.failUnless(access(os.path.join(dst_dir, f2), F_OK))
+        self.failUnless(access(os.path.join(dst_dir, f3), F_OK))
+        self.failUnless(access(os.path.join(dst_dir, f4), F_OK))
+        self.failUnless(access(os.path.join(dst_dir, f5), F_OK))
+
+        # clean up
+        shutil.rmtree(work_dir)
             
 #-------------------------------------------------------------
@@ -11632 +11676 @@
 
     suite = unittest.makeSuite(Test_Data_Manager,'test')
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_file_boundary_sts')
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_get_flow_through_cross_section_with_geo')
-    #suite = unittest.makeSuite(Test_Data_Manager,'covered_')
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_urs2sts_individual_sources')
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_urs2sts_ordering_different_sources')
-
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_read_mux_platform_problem3')
-    #suite = unittest.makeSuite(Test_Data_Manager,'test_file_boundary_stsIV')
-
     
     if len(sys.argv) > 1 and sys.argv[1][0].upper() == 'V':