Use Files.delete() for better error reporting

Signed-off-by: Elimelec Burghelea <[email protected]>

Author: elimelec

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/support/AbstractFileItemWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2023 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import java.nio.channels.FileChannel;
 import java.nio.charset.StandardCharsets;
 import java.nio.charset.UnsupportedCharsetException;
+import java.nio.file.Files;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -61,6 +62,7 @@
  * @author Mahmoud Ben Hassine
  * @author Glenn Renfro
  * @author Remi Kaeffer
+ * @author Elimelec Burghelea
  * @since 4.1
  */
 public abstract class AbstractFileItemWriter<T> extends AbstractItemStreamItemWriter<T>
@@ -268,11 +270,9 @@ public void close() {
 				state.close();
 				if (state.linesWritten == 0 && shouldDeleteIfEmpty) {
 					try {
-						if (!resource.getFile().delete()) {
-							throw new ItemStreamException("Failed to delete empty file on close");
-						}
+						Files.delete(resource.getFile().toPath());
 					}
-					catch (IOException e) {
+					catch (IOException | SecurityException e) {
 						throw new ItemStreamException("Failed to delete empty file on close", e);
 					}
 				}

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/util/FileUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2024 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
 
 import org.springframework.batch.item.ItemStreamException;
 import org.springframework.util.Assert;
@@ -28,6 +29,7 @@
  * @author Peter Zozom
  * @author Mahmoud Ben Hassine
  * @author Taeik Lim
+ * @author Elimelec Burghelea
  */
 public abstract class FileUtils {
 
@@ -57,8 +59,11 @@ public static void setUpOutputFile(File file, boolean restarted, boolean append,
 						if (!overwriteOutputFile) {
 							throw new ItemStreamException("File already exists: [" + file.getAbsolutePath() + "]");
 						}
-						if (!file.delete()) {
-							throw new IOException("Could not delete file: " + file);
+						try {
+							Files.delete(file.toPath());
+						}
+						catch (IOException | SecurityException e) {
+							throw new IOException("Could not delete file: " + file, e);
 						}
 					}
 

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/xml/StaxEventItemWriter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2023 the original author or authors.
+ * Copyright 2006-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 import java.io.UnsupportedEncodingException;
 import java.io.Writer;
 import java.nio.channels.FileChannel;
+import java.nio.file.Files;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -75,6 +76,7 @@
  * @author Michael Minella
  * @author Parikshit Dutta
  * @author Mahmoud Ben Hassine
+ * @author Elimelec Burghelea
  */
 public class StaxEventItemWriter<T> extends AbstractItemStreamItemWriter<T>
 		implements ResourceAwareItemWriterItemStream<T>, InitializingBean {
@@ -726,11 +728,9 @@ public void close() {
 			}
 			if (currentRecordCount == 0 && shouldDeleteIfEmpty) {
 				try {
-					if (!resource.getFile().delete()) {
-						throw new ItemStreamException("Failed to delete empty file on close");
-					}
+					Files.delete(resource.getFile().toPath());
 				}
-				catch (IOException e) {
+				catch (IOException | SecurityException e) {
 					throw new ItemStreamException("Failed to delete empty file on close", e);
 				}
 			}

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/AbstractFileItemWriterTest.java

@@ -17,7 +17,7 @@
 package org.springframework.batch.item.support;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.Mockito.when;
 
@@ -55,8 +55,7 @@ void testFailedFileDeletionThrowsException() {
 				"Expected exception when file deletion fails");
 
 		assertEquals("Failed to delete empty file on close", exception.getMessage(), "Wrong exception message");
-		// FIXME: update after fix, because we will have a reason
-		assertNull(exception.getCause(), "Exception should not have a cause");
+		assertNotNull(exception.getCause(), "Exception should have a cause");
 	}
 
 	private static class TestFileItemWriter extends AbstractFileItemWriter<String> {

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/util/FileUtilsTests.java

@@ -27,8 +27,8 @@
 import org.springframework.batch.item.ItemStreamException;
 import org.springframework.util.Assert;
 
-import static org.junit.Assert.assertNull;
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.junit.jupiter.api.Assertions.fail;
@@ -210,8 +210,7 @@ public boolean delete() {
 			assertTrue(message.startsWith("Unable to create file"), "Wrong message: " + message);
 			assertTrue(ex.getCause() instanceof IOException);
 			assertTrue(ex.getCause().getMessage().startsWith("Could not delete file"), "Wrong message: " + message);
-			// FIXME: update after fix, because we will have a reason
-			assertNull(ex.getCause().getCause());
+			assertNotNull(ex.getCause().getCause(), "Exception should have a cause");
 		}
 		finally {
 			file.delete();

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/xml/StaxEventItemWriterTests.java

@@ -48,7 +48,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.Mockito.mock;
@@ -852,8 +852,7 @@ void testFailedFileDeletionThrowsException() throws IOException {
 				"Expected exception when file deletion fails");
 
 		assertEquals("Failed to delete empty file on close", exception.getMessage(), "Wrong exception message");
-		// FIXME: update after fix, because we will have a reason
-		assertNull(exception.getCause(), "Exception should not have a cause");
+		assertNotNull(exception.getCause(), "Exception should have a cause");
 	}
 
 	private void initWriterForSimpleCallbackTests() throws Exception {