def test_returns_directory_contents_if_path_points_to_a_directory(self, mocker):
mock_path_get = mocker.patch("pythonanywhere.api.files_api.Files.path_get")
mock_path_get.return_value = self.default_home_dir_files
result = PAPath(self.home_dir_path).contents
assert result == self.default_home_dir_files
def test_make_sharing_url_contains_pa_site_address(self, mocker):
mock_urljoin = mocker.patch("pythonanywhere.files.urljoin")
pa_path = PAPath("path")
pa_path._make_sharing_url("rest")
assert mock_urljoin.call_args == call(pa_path.api.base_url.split("api")[0], "rest")
def test_instantiates_correctly(self, mocker):
mock_standarize_path = mocker.patch("pythonanywhere.files.PAPath._standarize_path")
pa_path = PAPath("path")
assert pa_path.path == mock_standarize_path.return_value
assert type(pa_path.api) == Files
def test_returns_file_contents_as_string_if_path_points_to_a_file(self, mocker):
path = f"{self.home_dir_path}README.txt"
mock_path_get = mocker.patch("pythonanywhere.api.files_api.Files.path_get")
mock_path_get.return_value = self.readme_contents
result = PAPath(path).contents
assert mock_path_get.call_args == call(path)
assert result == self.readme_contents.decode()
def test_returns_list_of_regular_dirs_and_files(self, mocker):
mock_tree_get = mocker.patch("pythonanywhere.api.files_api.Files.tree_get")
path = "/home/user"
tree = [f"{path}/README.txt"]
mock_tree_get.return_value = tree
result = PAPath(path).tree
assert result == tree
assert mock_tree_get.call_args == call(path)
def test_warns_when_path_unavailable(self, mocker):
mock_path_get = mocker.patch("pythonanywhere.api.files_api.Files.path_get")
mock_path_get.side_effect = Exception("error msg")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
result = PAPath("/home/different_user").contents
assert mock_snake.call_args == call("error msg")
assert mock_warning.call_args == call(mock_snake.return_value)
assert result is None
def test_warns_about_failed_deletion(self, mocker):
mock_delete = mocker.patch("pythonanywhere.api.files_api.Files.path_delete")
mock_delete.side_effect = Exception("error msg")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
undeletable_path = "/home/"
PAPath(undeletable_path).delete()
assert mock_snake.call_args == call("error msg")
assert mock_warning.call_args == call(mock_snake.return_value)
def test_informes_about_successful_file_deletion(self, mocker):
mock_delete = mocker.patch("pythonanywhere.api.files_api.Files.path_delete")
mock_delete.return_value.status_code = 204
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
path = "/valid/path"
PAPath(path).delete()
assert mock_delete.call_args == call(path)
assert mock_snake.call_args == call(f"{path} deleted!")
assert mock_info.call_args == call(mock_snake.return_value)
def test_returns_empty_string_when_file_not_shared(self, mocker):
mock_sharing_get = mocker.patch("pythonanywhere.api.files_api.Files.sharing_get")
mock_sharing_get.return_value = ""
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
query_path = "/pa/path/to/a/file"
result = PAPath(query_path).get_sharing_url()
assert mock_sharing_get.call_args == call(query_path)
assert mock_snake.call_args == call(f"{query_path} has not been shared")
assert mock_info.call_args == call(mock_snake.return_value)
assert result == ""
def test_warns_if_fetching_of_tree_unsuccessful(self, mocker):
mock_tree_get = mocker.patch("pythonanywhere.api.files_api.Files.tree_get")
mock_tree_get.side_effect = Exception("failed")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
path = "/home/another_user"
result = PAPath(path).tree
assert result is None
assert mock_tree_get.call_args == call(path)
assert mock_snake.call_args == call("failed")
assert mock_warning.call_args == call(mock_snake.return_value)
def test_warns_if_share_fails(self, mocker):
mock_sharing_post = mocker.patch("pythonanywhere.api.files_api.Files.sharing_post")
mock_sharing_post.side_effect = Exception("failed")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
path_to_share = "/invalid/path"
result = PAPath(path_to_share).share()
assert mock_sharing_post.call_args == call(path_to_share)
assert mock_snake.call_args == call("failed")
assert mock_warning.call_args == call(mock_snake.return_value)
assert result == ""
def test_informs_about_successful_update_of_existing_file_with_provided_stream(self, mocker):
mock_post = mocker.patch("pythonanywhere.api.files_api.Files.path_post")
mock_post.return_value = 200
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
destination_path = "/home/user/"
content = "content".encode()
result = PAPath(destination_path).upload(content)
assert mock_post.call_args == call(destination_path, content)
assert mock_snake.call_args == call(f"{destination_path} successfully updated!")
assert mock_info.call_args == call(mock_snake.return_value)
assert result is True
def test_warns_when_file_has_not_been_uploaded(self, mocker):
mock_post = mocker.patch("pythonanywhere.api.files_api.Files.path_post")
mock_post.side_effect = Exception("sth went wrong")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
destination_path = "wrong/path"
content = "content".encode()
result = PAPath(destination_path).upload(content)
assert mock_post.call_args == call(destination_path, content)
assert mock_snake.call_args == call("sth went wrong")
assert mock_warning.call_args == call(mock_snake.return_value)
assert result is False
def test_returns_full_url_for_shared_file(self, mocker):
mock_sharing_get = mocker.patch("pythonanywhere.api.files_api.Files.sharing_get")
mock_sharing_get.return_value = "url"
mock_make_url = mocker.patch("pythonanywhere.files.PAPath._make_sharing_url")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
query_path = "/pa/path/to/a/file"
result = PAPath(query_path).get_sharing_url()
assert mock_sharing_get.call_args == call(query_path)
assert mock_snake.call_args == call(f"{query_path} is shared at {mock_make_url.return_value}")
assert mock_info.call_args == call(mock_snake.return_value)
assert result.endswith("url")
def test_path_successfully_shared(self, mocker):
mock_sharing_post = mocker.patch("pythonanywhere.api.files_api.Files.sharing_post")
mock_sharing_post.return_value = (201, "url")
mock_make_url = mocker.patch("pythonanywhere.files.PAPath._make_sharing_url")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
path_to_share = "/pa/path/to/a/file"
result = PAPath(path_to_share).share()
assert mock_sharing_post.call_args == call(path_to_share)
assert mock_snake.call_args == call(f"{path_to_share} successfully shared at {mock_make_url.return_value}")
assert mock_info.call_args == call(mock_snake.return_value)
assert mock_make_url.call_args == call("url")
assert result == mock_make_url.return_value
def test_warns_if_unshare_not_successful(self, mocker):
mock_sharing_get = mocker.patch("pythonanywhere.api.files_api.Files.sharing_get")
mock_sharing_get.return_value = "url"
mock_sharing_delete = mocker.patch("pythonanywhere.api.files_api.Files.sharing_delete")
mock_sharing_delete.return_value = 999
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_warning = mocker.patch("pythonanywhere.files.logger.warning")
path_to_shared_file = "/pa/path/to/a/file"
result = PAPath(path_to_shared_file).unshare()
assert mock_sharing_get.call_args == call(path_to_shared_file)
assert mock_sharing_delete.call_args == call(path_to_shared_file)
assert mock_snake.call_args == call(f"Could not unshare {path_to_shared_file}... :(")
assert mock_warning.call_args == call(mock_snake.return_value)
assert result is False
def test_path_successfully_unshared(self, mocker):
mock_sharing_get = mocker.patch("pythonanywhere.api.files_api.Files.sharing_get")
mock_sharing_get.return_value = "url"
mock_sharing_delete = mocker.patch("pythonanywhere.api.files_api.Files.sharing_delete")
mock_sharing_delete.return_value = 204
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
path_to_shared_file = "/pa/path/to/a/file"
result = PAPath(path_to_shared_file).unshare()
assert mock_sharing_get.call_args == call(path_to_shared_file)
assert mock_sharing_delete.call_args == call(path_to_shared_file)
assert mock_snake.call_args == call(f"{path_to_shared_file} is no longer shared!")
assert mock_info.call_args == call(mock_snake.return_value)
assert result is True
def test_path_is_not_shared_so_cannot_be_unshared(self, mocker):
mock_sharing_get = mocker.patch("pythonanywhere.api.files_api.Files.sharing_get")
mock_sharing_get.return_value = ""
mock_sharing_delete = mocker.patch("pythonanywhere.api.files_api.Files.sharing_delete")
mock_snake = mocker.patch("pythonanywhere.files.snakesay")
mock_info = mocker.patch("pythonanywhere.files.logger.info")
path_to_unshare = "/pa/path/to/a/file"
result = PAPath(path_to_unshare).unshare()
assert mock_sharing_get.call_args == call(path_to_unshare)
assert mock_sharing_delete.call_count == 0
assert mock_snake.call_args == call(
f"{path_to_unshare} is not being shared, no need to stop sharing..."
)
assert mock_info.call_args == call(mock_snake.return_value)
assert result is True
def test_sanitizes_path(self):
pa_path = PAPath("~")
assert pa_path.path == f"/home/{getuser()}"
def test_url_property_contains_correct_pythonanywhere_resource_url_for_instantiated_path(self):
path = self.home_dir_path
url = PAPath(path).__repr__()
assert url == f"{self.base_url.replace('/api/v0', '')}{path[1:]}"
def setup(path: str, quiet: bool) -> PAPath:
logger = get_logger(set_info=True)
if quiet:
logger.disabled = True
return PAPath(path)
def test_repr_returns_url_property_value(self, mocker):
mock_url = mocker.patch("pythonanywhere.files.PAPath.url")
assert PAPath("path").__repr__() == mock_url