removes hardcoded filenames and test data, imports config and test data in the test rather than inserting them in to globals

Author: codersquid

dvn_client/src/dvn_client.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+
 # DVN client for SWORD API
 # Prereqs: Python, sword2 Module (available using easy_install)
 # Adapted from: https://bitbucket.org/beno/python-sword2/wiki/Quickstart
@@ -31,16 +33,19 @@ def parse_arguments():
 #    parser.add_argument('-u','--username', default=None, help='Description for foo argument')
 #    parser.add_argument('-p','--password', default=None, help='Description for bar argument')
 
-    parser.add_argument('--runTests', action="store", help='Path to a file with test definitions.')
-    parser.add_argument('--config', action="store", help="Path to a file that contains configuration information.")
+    parser.add_argument('--runTests', action="store", default='tests.py',
+            help='Path to a file with test definitions. (default: tests.py)')
+    parser.add_argument('--config', action="store", default='config.py',
+            help="Path to a file that contains configuration information. (default: config.py)")
     return parser.parse_args()
 
 def main():
     # Get the command line arguments.
     args = parse_arguments()
-    
-    if args.runTests and args.config:
+
+    if args.config:
         execfile(args.config, globals())
+    if args.runTests:
         execfile(args.runTests, globals())
 
     dv = None #declare outside so except clause has access
@@ -63,7 +68,7 @@ def main():
         print "RELEASED: ", dv.is_released()
 
         #s = Study.CreateStudyFromDict(PICS_OF_CATS_STUDY)
-        s = Study.CreateStudyFromAtomEntryXmlFile("/home/vagrant/dvn_client/resources/atom-entry-study.xml")
+        s = Study.CreateStudyFromAtomEntryXmlFile(ATOM_STUDY)
         dv.add_study(s)
         #s.add_files([INGEST_FILES])
         print s.get_citation()

dvn_client/src/dvn_test.py

@@ -4,46 +4,44 @@
 __author__="peterbull"
 __date__ ="$Aug 21, 2013 2:56:25 PM$"
 
-from operator import eq
 import os
 import sys
 from time import sleep
 import unittest
+import zipfile
 
 import logging
 logging.basicConfig(level=logging.ERROR)
 
 #local modules
+import config
+import tests as testdata
 from study import Study
 from connection import DvnConnection
-    
+
+
 class TestStudyOperations(unittest.TestCase):
+
     @classmethod
     def setUpClass(self):
-        # LOAD TEST DATA
-        
-        print "Loading test data."
-        testModulePath = os.path.dirname(__file__)
-        execfile(os.path.join(testModulePath, "config.py"), globals())    #CREDS - This file is not committed.
-        execfile(os.path.join(testModulePath, "tests.py"), globals())     #TEST DATA
-        
+
+        print "Verifying test data."
+        assert zipfile.is_zipfile(testdata.INGEST_FILES), 'Invalid tests configuration. %s is not a zipfile' % testdata.INGEST_FILES
+        assert os.path.isfile(testdata.PIC_OF_CAT), 'Invalid tests configuration. %s is not a file' % testdata.PIC_OF_CAT
+        assert os.path.isfile(testdata.ATOM_STUDY), 'Invalid tests configuration. %s is not a file' % testdata.ATOM_STUDY
+
         print "Connecting to DVN."
-        self.dvc = DvnConnection(username=DEFAULT_USERNAME,
-                        password=DEFAULT_PASSWORD, 
-                        host=DEFAULT_HOST, 
-                        cert=DEFAULT_CERT)
-                        
+        self.dvc = DvnConnection(username=config.DEFAULT_USERNAME,
+                        password=config.DEFAULT_PASSWORD, 
+                        host=config.DEFAULT_HOST, 
+                        cert=config.DEFAULT_CERT)
+
         print "Getting Dataverse"
         self.dv = self.dvc.get_dataverses()[0]
-        
-        print "Removing any existing studies."
-        self.dv.delete_all_studies(ignoreExceptions=True)
-        
+
     def setUp(self):
-        #runs before each test method
-        
         #create a study for each test
-        s = Study.CreateStudyFromDict(PICS_OF_CATS_STUDY)
+        s = Study.CreateStudyFromDict(testdata.PICS_OF_CATS_STUDY)
         self.dv.add_study(s)
         id = s.get_id()
         self.s = self.dv.get_study_by_hdl(id)
@@ -57,20 +55,20 @@ def tearDown(self):
             return
 
     def test_create_study_from_xml(self):
-        xmlStudy = Study.CreateStudyFromAtomEntryXmlFile(ATOM_STUDY)
+        xmlStudy = Study.CreateStudyFromAtomEntryXmlFile(testdata.ATOM_STUDY)
         self.dv.add_study(xmlStudy)
         atomStudy = self.dv.get_study_by_string_in_entry("The first study for the New England Journal of Coffee dataverse")
         self.assertTrue(atomStudy)
         self.dv.delete_study(atomStudy)
 
     def test_add_files_to_study(self):
-        expected_files = ["char_r.tab",
-                          "float_new_r.tab",
-                          "int_r.tab",
-                          "min_date_r.tab"]
-        self.s.add_files([INGEST_FILES])
+        zipped_file = zipfile.ZipFile(testdata.INGEST_FILES, 'r')
+        expected_files = [os.path.basename(f) for f in zipped_file.namelist()]
+        self.s.add_files([testdata.INGEST_FILES])
         sleep(3) #wait for ingest
         actual_files = [f.name for f in self.s.get_files()]
+        print 'actual', actual_files
+        print 'expected', expected_files
 
         expected_files.sort()
         actual_files.sort()
@@ -90,21 +88,22 @@ def test_display_study_statement(self):
         self.assertTrue(self.s.get_statement())
 
     def test_delete_a_file(self):
-        self.s.add_file(PIC_OF_CAT)
+        self.s.add_file(testdata.PIC_OF_CAT)
+        test_file = os.path.basename(testdata.PIC_OF_CAT)
 
         #add file and confirm
         files = self.s.get_files()
-        catFile = [f for f in files if f.name == "cat.jpg"]
+        catFile = [f for f in files if f.name == test_file]
         self.assertTrue(len(catFile) == 1)
 
         #delete file and confirm
         self.s.delete_file(catFile[0])
         files = self.s.get_files()
-        catFile = [f for f in files if f.name == "cat.jpg"]
+        catFile = [f for f in files if f.name == test_file]
         self.assertTrue(len(catFile) == 0)
-        
+
     def test_delete_a_study(self):
-        xmlStudy = Study.CreateStudyFromAtomEntryXmlFile(ATOM_STUDY)
+        xmlStudy = Study.CreateStudyFromAtomEntryXmlFile(testdata.ATOM_STUDY)
         self.dv.add_study(xmlStudy)
         atomStudy = self.dv.get_study_by_string_in_entry("The first study for the New England Journal of Coffee dataverse")
         self.assertTrue(atomStudy)
@@ -113,19 +112,19 @@ def test_delete_a_study(self):
         self.assertTrue(startingNumberOfStudies > 0)
         self.dv.delete_study(atomStudy)
         self.assertEqual(len(self.dv.get_studies()), startingNumberOfStudies - 1)
-        
+
     def test_release_study(self):
         self.assertTrue(self.s.get_state() == "DRAFT")
         self.s.release()
         self.assertTrue(self.s.get_state() == "RELEASED")
         self.dv.delete_study(self.s) #this should deaccession
         self.assertTrue(self.s.get_state() == "DEACCESSIONED")
-    
+
     def test_dataverse_released(self):
         self.assertTrue(self.dv.is_released())
-    
+
+
 if __name__ == "__main__":
     __file__ = sys.argv[0]
     suite = unittest.TestLoader().loadTestsFromTestCase(TestStudyOperations)
     unittest.TextTestRunner(verbosity=2).run(suite)
-