refine docstring and testcases

data/raw/f_1014_zhihan.py

@@ -1,37 +1,29 @@
 import configparser
 import os
-import sys
 import shutil
 
-# Constants
-ARCHIVE_DIR = '/home/user/archive'
 
-def f_1014(config_file_path):
+def f_1014(config_file_path, archieve_dir ='/home/user/archive'):
  """
- Archive a specified project directory into a ZIP file.
+ Archive a specified project directory into a ZIP file based on the configuration specified in a config file.
 
- This function reads a configuration file to get the project directory and then archives this directory
- into a ZIP file. The name of the ZIP archive will be the same as the 
- project directory's basename, and it will be stored in a predefined archive directory.
+ This function reads a configuration file to determine the project directory and archives this directory into a ZIP file.
+ The ZIP file's name will be the project directory's basename, stored in the specified archive directory.
 
  Configuration File Format:
  [Project]
  directory=path_to_project_directory
 
- Input:
- - config_file_path (str): Path to the configuration file.
+ Parameters:
+ - config_file_path (str): Path to the configuration file. The file must exist and be readable.
+ - archive_dir (str, optional): Path to the directory where the ZIP archive will be stored. Defaults to '/home/user/archive'.
 
- Output:
- - Returns True if the ZIP archive is successfully created, otherwise raises an exception.
+ Returns:
+ - bool: True if the ZIP archive is successfully created, otherwise an exception is raised.
 
- Requirements:
- - configparser
- - os
- - sys
- - shutil
-
- Constants:
- - ARCHIVE_DIR: Directory where the ZIP archive will be stored.
+ Raises:
+ - FileNotFoundError: If the `config_file_path` does not exist or the specified project directory does not exist.
+ - Exception: If the ZIP archive cannot be created.
 
  Example:
  >>> f_1014("/path/to/config.ini")
@@ -43,9 +35,9 @@ def f_1014(config_file_path):
  project_dir = config.get('Project', 'directory')
 
  if not os.path.isdir(project_dir):
- raise Exception(f'Directory {project_dir} does not exist.')
+ raise FileNotFoundError(f'Directory {project_dir} does not exist.')
 
- archive_file = f'{ARCHIVE_DIR}/{os.path.basename(project_dir)}.zip'
+ archive_file = f'{archieve_dir}/{os.path.basename(project_dir)}.zip'
 
  # Using shutil to create the zip archive
  shutil.make_archive(base_name=os.path.splitext(archive_file)[0], format='zip', root_dir=project_dir)
@@ -56,66 +48,65 @@ def f_1014(config_file_path):
  return True
 
 import unittest
+import tempfile
+import shutil
 import os
-import sys
+import configparser
 
-class TestF962Function(unittest.TestCase):
+class TestCases(unittest.TestCase):
 
  def setUp(self):
- # Path to the test data directory
- self.test_data_dir = "/mnt/data/test_data"
+ # Setup a temporary directory for the configuration files and another for the archive output
+ self.test_data_dir = tempfile.mkdtemp()
+ self.archive_dir = tempfile.mkdtemp()
+
+ # Example valid configuration file setup
+ self.valid_config_path = os.path.join(self.test_data_dir, "valid_config.ini")
+ config = configparser.ConfigParser()
+ config['Project'] = {'directory': self.test_data_dir}
+ with open(self.valid_config_path, 'w') as configfile:
+ config.write(configfile)
+
+ # Invalid directory config
+ self.invalid_config_path = os.path.join(self.test_data_dir, "invalid_config.ini")
+ config['Project'] = {'directory': '/path/to/nonexistent/directory'}
+ with open(self.invalid_config_path, 'w') as configfile:
+ config.write(configfile)
+
+ def tearDown(self):
+ # Remove temporary directories after each test
+ shutil.rmtree(self.test_data_dir)
+ shutil.rmtree(self.archive_dir)
 
  def test_valid_project_directory(self):
- # Set CONFIG_FILE to point to a valid config file
- refined_function.CONFIG_FILE = os.path.join(self.test_data_dir, "valid_config.ini")
-
- # Asserting that the function returns True (archive is successfully created)
- self.assertTrue(f_1014())
+ # Testing with a valid project directory
+ result = f_1014(self.valid_config_path, self.archive_dir)
+ self.assertTrue(result)
 
  def test_invalid_project_directory(self):
- # Set CONFIG_FILE to point to an invalid config file (non-existent project directory)
- refined_function.CONFIG_FILE = os.path.join(self.test_data_dir, "invalid_dir_config.ini")
-
- # Asserting that the function raises an exception due to the invalid directory
- with self.assertRaises(Exception) as context:
- f_1014()
- self.assertIn("Directory", str(context.exception))
-
- def test_empty_project_directory(self):
- # Set CONFIG_FILE to point to an empty config file (empty project directory path)
- refined_function.CONFIG_FILE = os.path.join(self.test_data_dir, "empty_config.ini")
-
- # Asserting that the function raises an exception due to the empty directory path
- with self.assertRaises(Exception) as context:
- f_1014()
- self.assertIn("Directory", str(context.exception))
-
+ # Testing with a non-existent project directory
+ with self.assertRaises(FileNotFoundError):
+ f_1014(self.invalid_config_path, self.archive_dir)
+
  def test_archive_creation(self):
- # Set CONFIG_FILE to point to a valid config file
- refined_function.CONFIG_FILE = os.path.join(self.test_data_dir, "valid_config.ini")
-
  # Run the function to create the archive
- f_1014()
-
- # Asserting that the archive file is created
- archive_file = os.path.join(refined_function.ARCHIVE_DIR, "sample_project_1.zip")
+ f_1014(self.valid_config_path, self.archive_dir)
+ archive_file = os.path.join(self.archive_dir, os.path.basename(self.test_data_dir) + '.zip')
  self.assertTrue(os.path.isfile(archive_file))
 
  def test_archive_content(self):
- # Set CONFIG_FILE to point to a valid config file
- refined_function.CONFIG_FILE = os.path.join(self.test_data_dir, "valid_config.ini")
-
- # Run the function to create the archive
- f_1014()
-
- # Asserting that the archive file contains the expected content
- archive_file = os.path.join(refined_function.ARCHIVE_DIR, "sample_project_1.zip")
+ # Adding a sample file to the project directory to check archive contents later
+ sample_file_path = os.path.join(self.test_data_dir, "sample_file.txt")
+ with open(sample_file_path, 'w') as f:
+ f.write("Hello, world!")
+ f_1014(self.valid_config_path, self.archive_dir)
+ archive_file = os.path.join(self.archive_dir, os.path.basename(self.test_data_dir) + '.zip')
  content = os.popen(f"unzip -l {archive_file}").read()
  self.assertIn("sample_file.txt", content)
 
 def run_tests():
  suite = unittest.TestSuite()
- suite.addTest(unittest.makeSuite(TestF962Function))
+ suite.addTest(unittest.makeSuite(TestCases))
  runner = unittest.TextTestRunner()
  runner.run(suite)
 if __name__ == "__main__":