bcb-0012

# BigCodeBench/12

Implement a file **`solution.py`** that completes the function below. Keep the given name and signature; define `task_func` at module level.

Allowed libraries: `subprocess`, `datetime`, `json`, `os`.

```python
import subprocess
import os
import json
from datetime import datetime


def task_func(script_name='backup.sh', log_file='/home/user/backup_log.json'):
    """
    Runs the provided backup shell script and logs the start time, end time, and exit status 
    in a specified JSON log file.
    
    Parameters:
    - script_name (str): The name of the shell script to run. Default is 'backup.sh'.
    - log_file (str): The path to the JSON log file where the execution details will be recorded. Default is '/home/user/backup_log.json'.
    
    Returns:
    dict: A dictionary containing:
        - 'start_time': The start time of the script execution in the format '%Y-%m-%d %H:%M:%S'.
        - 'end_time': The end time of the script execution in the format '%Y-%m-%d %H:%M:%S'.
        - 'exit_status': The exit status of the script execution (0 for success, other values indicate an error).
    
    Raises:
    - FileNotFoundError: If the script file does not exist.
    - RuntimeError: If there is an error executing the script.
        
    Requirements:
    - subprocess
    - os
    - datetime
    - json
    
    Example:
    >>> task_func()
    {'start_time': '2023-09-19 14:30:00', 'end_time': '2023-09-19 14:35:00', 'exit_status': 0}
    """
```

<!-- imported from BigCodeBench (BigCodeBench/12) -->

# Auto-generated from BigCodeBench BigCodeBench/12. Do not edit by hand.
import pathlib as _pathlib
exec(_pathlib.Path(__file__).with_name("solution.py").read_text(), globals())

import unittest
from unittest.mock import patch, mock_open
class TestCases(unittest.TestCase):
    
    @patch("os.path.isfile", return_value=True)
    @patch("subprocess.call", return_value=0)
    @patch("builtins.open", new_callable=mock_open, read_data="{}")
    def test_default_values_successful_script(self, mock_file, mock_subprocess, mock_os):
        """Test the function with default parameters and successful execution"""
        result = task_func()
        self.assertIn('start_time', result)
        self.assertIn('end_time', result)
        self.assertEqual(result['exit_status'], 0)
    @patch("os.path.isfile", return_value=False)
    def test_script_does_not_exist(self, mock_os):
        """Test the function raising FileNotFoundError when the script file does not exist"""
        with self.assertRaises(FileNotFoundError):
            task_func()
    @patch("os.path.isfile", return_value=True)
    @patch("subprocess.call", side_effect=Exception("Script failed"))
    def test_script_execution_failure(self, mock_subprocess, mock_os):
        """Test the function raising RuntimeError on script execution failure"""
        with self.assertRaises(RuntimeError):
            task_func()
    @patch("os.path.isfile", return_value=True)
    @patch("subprocess.call", return_value=0)
    @patch("builtins.open", new_callable=mock_open, read_data="{}")
    def test_custom_values_successful_script(self, mock_file, mock_subprocess, mock_os):
        """Test the function with custom script name and log file with successful execution"""
        script_name = "custom_backup.sh"
        log_file = "/home/user/custom_backup_log.json"
        result = task_func(script_name, log_file)
        self.assertIn('start_time', result)
        self.assertIn('end_time', result)
        self.assertEqual(result['exit_status'], 0)
    @patch("os.path.isfile", return_value=True)
    @patch("subprocess.call", return_value=0)
    @patch("builtins.open", new_callable=mock_open, read_data="{}")
    def test_log_data_format(self, mock_file, mock_subprocess, mock_os):
        """Test that the timestamps are in the correct format"""
        result = task_func()
        self.assertTrue(result['start_time'].count(":") == 2)
        self.assertTrue(result['end_time'].count(":") == 2)
    @patch("os.path.isfile", return_value=True)
    @patch("subprocess.call", return_value=1)
    @patch("builtins.open", new_callable=mock_open, read_data="{}")
    def test_non_zero_exit_status(self, mock_file, mock_subprocess, mock_os):
        """Test the function with a non-zero exit status"""
        result = task_func()
        self.assertEqual(result['exit_status'], 1)

You are an expert programmer. Solve the task exactly as specified. Output your solution as fenced code blocks using the required file name(s) and the exact function/type signatures requested. Prefer correctness; do not include prose outside code unless asked.

```python
import subprocess
import os
import json
from datetime import datetime


def task_func(script_name='backup.sh', log_file='/home/user/backup_log.json'):
    """
    Runs the provided backup shell script and logs the start time, end time, and exit status 
    in a specified JSON log file.
    
    Parameters:
    - script_name (str): The name of the shell script to run. Default is 'backup.sh'.
    - log_file (str): The path to the JSON log file where the execution details will be recorded. Default is '/home/user/backup_log.json'.
    
    Returns:
    dict: A dictionary containing:
        - 'start_time': The start time of the script execution in the format '%Y-%m-%d %H:%M:%S'.
        - 'end_time': The end time of the script execution in the format '%Y-%m-%d %H:%M:%S'.
        - 'exit_status': The exit status of the script execution (0 for success, other values indicate an error).
    
    Raises:
    - FileNotFoundError: If the script file does not exist.
    - RuntimeError: If there is an error executing the script.
        
    Requirements:
    - subprocess
    - os
    - datetime
    - json
    
    Example:
    >>> task_func()
    {'start_time': '2023-09-19 14:30:00', 'end_time': '2023-09-19 14:35:00', 'exit_status': 0}
    """
    # Check if the script file exists
    if not os.path.exists(script_name):
        raise FileNotFoundError(f"Script file '{script_name}' not found.")
    
    # Record the start time
    start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    
    try:
        # Execute the script using subprocess
        result = subprocess.run(
            script_name,
            shell=True,
            check=True,
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE
        )
        exit_status = result.returncode
    except subprocess.CalledProcessError as e:
        # If the script returns a non-zero exit code, raise RuntimeError
        raise RuntimeError(f"Script execution failed with exit status {e.returncode}.") from e
    except Exception as e:
        # Catch any other exceptions during execution
        raise RuntimeError(f"An error occurred while executing the script: {e}") from e
    
    # Record the end time
    end_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
    
    # Prepare the log entry
    log_entry = {
        'start_time': start_time,
        'end_time': end_time,
        'exit_status': exit_status
    }
    
    # Write the log entry to the JSON file
    try:
        with open(log_file, 'w') as f:
            json.dump(log_entry, f, indent=4)
    except Exception as e:
        # If logging fails, it's not critical for the return value but good to be aware
        print(f"Warning: Could not write to log file {log_file}: {e}")
    
    return log_entry
```

[
  {
    "total": 6,
    "answer": "```python\nimport subprocess\nimport os\nimport json\nfrom datetime import datetime\n\n\ndef task_func(script_name='backup.sh', log_file='/home/user/backup_log.json'):\n    \"\"\"\n    Runs the provided backup shell script and logs the start time, end time, and exit status \n    in a specified JSON log file.\n    \n    Parameters:\n    - script_name (str): The name of the shell script to run. Default is 'backup.sh'.\n    - log_file (str): The path to the JSON log file where the execution details will be recorded. Default is '/home/user/backup_log.json'.\n    \n    Returns:\n    dict: A dictionary containing:\n        - 'start_time': The start time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'end_time': The end time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'exit_status': The exit status of the script execution (0 for success, other values indicate an error).\n    \n    Raises:\n    - FileNotFoundError: If the script file does not exist.\n    - RuntimeError: If there is an error executing the script.\n        \n    Requirements:\n    - subprocess\n    - os\n    - datetime\n    - json\n    \n    Example:\n    >>> task_func()\n    {'start_time': '2023-09-19 14:30:00', 'end_time': '2023-09-19 14:35:00', 'exit_status': 0}\n    \"\"\"\n    # Check if the script file exists\n    if not os.path.exists(script_name):\n        raise FileNotFoundError(f\"Script file '{script_name}' not found.\")\n    \n    # Record the start time\n    start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    try:\n        # Execute the script using subprocess\n        result = subprocess.run(\n            script_name,\n            shell=True,\n            check=True,\n            stdout=subprocess.PIPE,\n            stderr=subprocess.PIPE\n        )\n        exit_status = result.returncode\n    except subprocess.CalledProcessError as e:\n        # If the script returns a non-zero exit code, raise RuntimeError\n        raise RuntimeError(f\"Script execution failed with exit status {e.returncode}.\") from e\n    except Exception as e:\n        # Catch any other exceptions during execution\n        raise RuntimeError(f\"An error occurred while executing the script: {e}\") from e\n    \n    # Record the end time\n    end_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    # Prepare the log entry\n    log_entry = {\n        'start_time': start_time,\n        'end_time': end_time,\n        'exit_status': exit_status\n    }\n    \n    # Write the log entry to the JSON file\n    try:\n        with open(log_file, 'w') as f:\n            json.dump(log_entry, f, indent=4)\n    except Exception as e:\n        # If logging fails, it's not critical for the return value but good to be aware\n        print(f\"Warning: Could not write to log file {log_file}: {e}\")\n    \n    return log_entry\n```",
    "passed": 1,
    "test_error": " _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\nscript_name = 'backup.sh', log_file = '/home/user/backup_log.json'\n\n>   ???\nE   FileNotFoundError: Script file 'backup.sh' not found.\n\n<string>:38: FileNotFoundError\n_____________________ TestCases.test_non_zero_exit_status ______________________\n\nself = <test_bcb_0012.TestCases testMethod=test_non_zero_exit_status>\nmock_file = <MagicMock name='open' spec='builtin_function_or_method' id='127228045835232'>\nmock_subprocess = <MagicMock name='call' id='127228045832256'>\nmock_os = <MagicMock name='isfile' id='127228045680912'>\n\n    @patch(\"os.path.isfile\", return_value=True)\n    @patch(\"subprocess.call\", return_value=1)\n    @patch(\"builtins.open\", new_callable=mock_open, read_data=\"{}\")\n    def test_non_zero_exit_status(self, mock_file, mock_subprocess, mock_os):\n        \"\"\"Test the function with a non-zero exit status\"\"\"\n>       result = task_func()\n\ntest_bcb_0012.py:53: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\nscript_name = 'backup.sh', log_file = '/home/user/backup_log.json'\n\n>   ???\nE   FileNotFoundError: Script file 'backup.sh' not found.\n\n<string>:38: FileNotFoundError\n___________________ TestCases.test_script_execution_failure ____________________\n\nself = <test_bcb_0012.TestCases testMethod=test_script_execution_failure>\nmock_subprocess = <MagicMock name='call' id='127228045617536'>\nmock_os = <MagicMock name='isfile' id='127228045656560'>\n\n    @patch(\"os.path.isfile\", return_value=True)\n    @patch(\"subprocess.call\", side_effect=Exception(\"Script failed\"))\n    def test_script_execution_failure(self, mock_subprocess, mock_os):\n        \"\"\"Test the function raising RuntimeError on script execution failure\"\"\"\n        with self.assertRaises(RuntimeError):\n>           task_func()\n\ntest_bcb_0012.py:28: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\n>   ???\nE   FileNotFoundError: Script file 'backup.sh' not found.\n\n<string>:38: FileNotFoundError\n=========================== short test summary info ============================\nFAILED test_bcb_0012.py::TestCases::test_custom_values_successful_script - Fi...\nFAILED test_bcb_0012.py::TestCases::test_default_values_successful_script - F...\nFAILED test_bcb_0012.py::TestCases::test_log_data_format - FileNotFoundError:...\nFAILED test_bcb_0012.py::TestCases::test_non_zero_exit_status - FileNotFoundE...\nFAILED test_bcb_0012.py::TestCases::test_script_execution_failure - FileNotFo...\n5 failed, 1 passed in 0.04s"
  },
  {
    "total": 6,
    "answer": "```python\nimport subprocess\nimport os\nimport json\nfrom datetime import datetime\n\n\ndef task_func(script_name='backup.sh', log_file='/home/user/backup_log.json'):\n    \"\"\"\n    Runs the provided backup shell script and logs the start time, end time, and exit status \n    in a specified JSON log file.\n    \n    Parameters:\n    - script_name (str): The name of the shell script to run. Default is 'backup.sh'.\n    - log_file (str): The path to the JSON log file where the execution details will be recorded. Default is '/home/user/backup_log.json'.\n    \n    Returns:\n    dict: A dictionary containing:\n        - 'start_time': The start time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'end_time': The end time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'exit_status': The exit status of the script execution (0 for success, other values indicate an error).\n    \n    Raises:\n    - FileNotFoundError: If the script file does not exist.\n    - RuntimeError: If there is an error executing the script.\n        \n    Requirements:\n    - subprocess\n    - os\n    - datetime\n    - json\n    \n    Example:\n    >>> task_func()\n    {'start_time': '2023-09-19 14:30:00', 'end_time': '2023-09-19 14:35:00', 'exit_status': 0}\n    \"\"\"\n    # Check if the script file exists\n    if not os.path.isfile(script_name):\n        raise FileNotFoundError(f\"Script file '{script_name}' not found.\")\n    \n    # Record the start time\n    start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    try:\n        # Execute the script using subprocess\n        result = subprocess.run(\n            script_name,\n            shell=True,\n            check=True,\n            stdout=subprocess.PIPE,\n            stderr=subprocess.PIPE\n        )\n        exit_status = result.returncode\n    except subprocess.CalledProcessError as e:\n        # If the script returns a non-zero exit code, raise RuntimeError\n        raise RuntimeError(f\"Script execution failed with exit status {e.returncode}.\") from e\n    except Exception as e:\n        # Catch any other exceptions during execution\n        raise RuntimeError(f\"An error occurred while executing the script: {e}\") from e\n    \n    # Record the end time\n    end_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    # Prepare the log entry\n    log_entry = {\n        'start_time': start_time,\n        'end_time': end_time,\n        'exit_status': exit_status\n    }\n    \n    # Write the log entry to the JSON file\n    try:\n        with open(log_file, 'w') as f:\n            json.dump(log_entry, f, indent=4)\n    except Exception as e:\n        # If logging fails, it's not critical for the return value but good to be aware\n        print(f\"Warning: Could not write to log file {log_file}: {e}\")\n    \n    return log_entry\n```",
    "passed": 2,
    "test_error": "ld threads, with the timeout\n                    # being done in a join() on those threads.  communicate()\n                    # _after_ kill() is required to collect that and add it\n                    # to the exception.\n                    exc.stdout, exc.stderr = process.communicate()\n                else:\n                    # POSIX _communicate already populated the output so\n                    # far into the TimeoutExpired exception.\n                    process.wait()\n                raise\n            except:  # Including KeyboardInterrupt, communicate handled that.\n                process.kill()\n                # We don't call process.wait() as .__exit__ does that for us.\n                raise\n            retcode = process.poll()\n            if check and retcode:\n>               raise CalledProcessError(retcode, process.args,\n                                         output=stdout, stderr=stderr)\nE               subprocess.CalledProcessError: Command 'backup.sh' returned non-zero exit status 127.\n\n/home/psc/miniconda3/envs/peakstone-bcb/lib/python3.10/subprocess.py:526: CalledProcessError\n\nThe above exception was the direct cause of the following exception:\n\nself = <test_bcb_0012.TestCases testMethod=test_non_zero_exit_status>\nmock_file = <MagicMock name='open' spec='builtin_function_or_method' id='138053587482512'>\nmock_subprocess = <MagicMock name='call' id='138053587089968'>\nmock_os = <MagicMock name='isfile' id='138053587532288'>\n\n    @patch(\"os.path.isfile\", return_value=True)\n    @patch(\"subprocess.call\", return_value=1)\n    @patch(\"builtins.open\", new_callable=mock_open, read_data=\"{}\")\n    def test_non_zero_exit_status(self, mock_file, mock_subprocess, mock_os):\n        \"\"\"Test the function with a non-zero exit status\"\"\"\n>       result = task_func()\n\ntest_bcb_0012.py:53: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\nscript_name = 'backup.sh', log_file = '/home/user/backup_log.json'\n\n>   ???\nE   RuntimeError: Script execution failed with exit status 127.\n\n<string>:55: RuntimeError\n=========================== short test summary info ============================\nFAILED test_bcb_0012.py::TestCases::test_custom_values_successful_script - Ru...\nFAILED test_bcb_0012.py::TestCases::test_default_values_successful_script - R...\nFAILED test_bcb_0012.py::TestCases::test_log_data_format - RuntimeError: Scri...\nFAILED test_bcb_0012.py::TestCases::test_non_zero_exit_status - RuntimeError:...\n4 failed, 2 passed in 0.08s"
  },
  {
    "total": 6,
    "answer": "```python\nimport subprocess\nimport os\nimport json\nfrom datetime import datetime\n\n\ndef task_func(script_name='backup.sh', log_file='/home/user/backup_log.json'):\n    \"\"\"\n    Runs the provided backup shell script and logs the start time, end time, and exit status \n    in a specified JSON log file.\n    \n    Parameters:\n    - script_name (str): The name of the shell script to run. Default is 'backup.sh'.\n    - log_file (str): The path to the JSON log file where the execution details will be recorded. Default is '/home/user/backup_log.json'.\n    \n    Returns:\n    dict: A dictionary containing:\n        - 'start_time': The start time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'end_time': The end time of the script execution in the format '%Y-%m-%d %H:%M:%S'.\n        - 'exit_status': The exit status of the script execution (0 for success, other values indicate an error).\n    \n    Raises:\n    - FileNotFoundError: If the script file does not exist.\n    - RuntimeError: If there is an error executing the script.\n        \n    Requirements:\n    - subprocess\n    - os\n    - datetime\n    - json\n    \n    Example:\n    >>> task_func()\n    {'start_time': '2023-09-19 14:30:00', 'end_time': '2023-09-19 14:35:00', 'exit_status': 0}\n    \"\"\"\n    # Check if the script file exists\n    if not os.path.isfile(script_name):\n        raise FileNotFoundError(f\"Script file '{script_name}' not found.\")\n    \n    # Record the start time\n    start_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    try:\n        # Execute the script using subprocess\n        result = subprocess.run(\n            script_name,\n            shell=True,\n            check=True,\n            stdout=subprocess.PIPE,\n            stderr=subprocess.PIPE\n        )\n        exit_status = result.returncode\n    except subprocess.CalledProcessError as e:\n        # If the script returns a non-zero exit code, raise RuntimeError\n        raise RuntimeError(f\"Script execution failed with exit status {e.returncode}.\") from e\n    except Exception as e:\n        # Catch any other exceptions during execution\n        raise RuntimeError(f\"An error occurred while executing the script: {e}\") from e\n    \n    # Record the end time\n    end_time = datetime.now().strftime('%Y-%m-%d %H:%M:%S')\n    \n    # Prepare the log entry\n    log_entry = {\n        'start_time': start_time,\n        'end_time': end_time,\n        'exit_status': exit_status\n    }\n    \n    # Write the log entry to the JSON file\n    try:\n        with open(log_file, 'w') as f:\n            json.dump(log_entry, f, indent=4)\n    except Exception as e:\n        # If logging fails, it's not critical for the return value but good to be aware\n        print(f\"Warning: Could not write to log file {log_file}: {e}\")\n    \n    return log_entry\n```",
    "passed": 2,
    "test_error": ""
  }
]