Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rename FileChannelDataBlock to FileDataBlock

Browse Source 
Rename the internal `FileChannelDataBlock` to `FileDataBlock` since we
want to fallback to a `RandomAccessFile` when a thread is interrupted.

See gh-40096
This commit is contained in:
Phillip Webb
2024-04-16 11:18:48 -07:00
parent 778c528281
commit 4203e1f2fa
7 changed files with 67 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/AssertFileChannelDataBlocksClosed.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 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,8 +25,8 @@ import java.lang.annotation.Target;
import org.junit.jupiter.api.extension.ExtendWith;
/**
* Annotation that can be added to tests to assert that {@link FileChannelDataBlock} files
* are not left open.
* Annotation that can be added to tests to assert that {@link FileDataBlock} files are
* not left open.
*
* @author Phillip Webb
*/

6
spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/AssertFileChannelDataBlocksClosedExtension.java
View File

@@ -31,7 +31,7 @@ import org.junit.jupiter.api.extension.BeforeEachCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.springframework.boot.loader.ref.DefaultCleanerTracking;
import org.springframework.boot.loader.zip.FileChannelDataBlock.Tracker;
import org.springframework.boot.loader.zip.FileDataBlock.Tracker;
import static org.assertj.core.api.Assertions.assertThat;
@@ -45,14 +45,14 @@ class AssertFileChannelDataBlocksClosedExtension implements BeforeEachCallback,
@Override
public void beforeEach(ExtensionContext context) throws Exception {
tracker.clear();
FileChannelDataBlock.tracker = tracker;
FileDataBlock.tracker = tracker;
DefaultCleanerTracking.set(tracker::addedCleanable);
}
@Override
public void afterEach(ExtensionContext context) throws Exception {
tracker.assertAllClosed();
FileChannelDataBlock.tracker = null;
FileDataBlock.tracker = null;
}
private static final class OpenFilesTracker implements Tracker {

6
spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/FileChannelDataBlockManagedFileChannel.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 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.
@@ -16,7 +16,7 @@
package org.springframework.boot.loader.zip;
import org.springframework.boot.loader.zip.FileChannelDataBlock.ManagedFileChannel;
import org.springframework.boot.loader.zip.FileDataBlock.ManagedFileChannel;
/**
* Test access to {@link ManagedFileChannel} details.
@@ -28,6 +28,6 @@ public final class FileChannelDataBlockManagedFileChannel {
private FileChannelDataBlockManagedFileChannel() {
}
public static int BUFFER_SIZE = FileChannelDataBlock.ManagedFileChannel.BUFFER_SIZE;
public static int BUFFER_SIZE = FileDataBlock.ManagedFileChannel.BUFFER_SIZE;
}

51
spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/FileChannelDataBlockTests.java → spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/FileDataBlockTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 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.
@@ -28,17 +28,17 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.springframework.boot.loader.zip.FileChannelDataBlock.Tracker;
import org.springframework.boot.loader.zip.FileDataBlock.Tracker;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
/**
* Tests for {@link FileChannelDataBlock}.
* Tests for {@link FileDataBlock}.
*
* @author Phillip Webb
*/
class FileChannelDataBlockTests {
class FileDataBlockTests {
private static final byte[] CONTENT = new byte[] { 0x00, 0x01, 0x02, 0x03, 0x04, 0x05 };
@@ -55,19 +55,19 @@ class FileChannelDataBlockTests {
@AfterEach
void resetTracker() {
FileChannelDataBlock.tracker = null;
FileDataBlock.tracker = null;
}
@Test
void sizeReturnsFileSize() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
assertThat(block.size()).isEqualTo(CONTENT.length);
}
}
@Test
void readReadsFile() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
assertThat(block.read(buffer, 0)).isEqualTo(6);
assertThat(buffer.array()).containsExactly(CONTENT);
@@ -76,7 +76,8 @@ class FileChannelDataBlockTests {
@Test
void readReadsFileWhenThreadHasBeenInterrupted() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
Files.write(this.tempFile.toPath(), CONTENT);
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
Thread.currentThread().interrupt();
assertThat(block.read(buffer, 0)).isEqualTo(6);
@@ -89,7 +90,7 @@ class FileChannelDataBlockTests {
@Test
void readDoesNotReadPastEndOfFile() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
assertThat(block.read(buffer, 2)).isEqualTo(4);
assertThat(buffer.array()).containsExactly(0x02, 0x03, 0x04, 0x05, 0x0, 0x0);
@@ -98,7 +99,7 @@ class FileChannelDataBlockTests {
@Test
void readWhenPosAtSizeReturnsMinusOne() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
assertThat(block.read(buffer, 6)).isEqualTo(-1);
}
@@ -106,7 +107,7 @@ class FileChannelDataBlockTests {
@Test
void readWhenPosOverSizeReturnsMinusOne() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
assertThat(block.read(buffer, 7)).isEqualTo(-1);
}
@@ -114,7 +115,7 @@ class FileChannelDataBlockTests {
@Test
void readWhenPosIsNegativeThrowsException() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
ByteBuffer buffer = ByteBuffer.allocate(CONTENT.length);
assertThatIllegalArgumentException().isThrownBy(() -> block.read(buffer, -1));
}
@@ -122,7 +123,7 @@ class FileChannelDataBlockTests {
@Test
void sliceWhenOffsetIsNegativeThrowsException() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
assertThatIllegalArgumentException().isThrownBy(() -> block.slice(-1, 0))
.withMessage("Offset must not be negative");
}
@@ -130,7 +131,7 @@ class FileChannelDataBlockTests {
@Test
void sliceWhenSizeIsNegativeThrowsException() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
assertThatIllegalArgumentException().isThrownBy(() -> block.slice(0, -1))
.withMessage("Size must not be negative and must be within bounds");
}
@@ -138,7 +139,7 @@ class FileChannelDataBlockTests {
@Test
void sliceWhenSizeIsOutOfBoundsThrowsException() throws IOException {
try (FileChannelDataBlock block = createAndOpenBlock()) {
try (FileDataBlock block = createAndOpenBlock()) {
assertThatIllegalArgumentException().isThrownBy(() -> block.slice(2, 5))
.withMessage("Size must not be negative and must be within bounds");
}
@@ -146,7 +147,7 @@ class FileChannelDataBlockTests {
@Test
void sliceReturnsSlice() throws IOException {
try (FileChannelDataBlock slice = createAndOpenBlock().slice(1, 4)) {
try (FileDataBlock slice = createAndOpenBlock().slice(1, 4)) {
assertThat(slice.size()).isEqualTo(4);
ByteBuffer buffer = ByteBuffer.allocate(4);
assertThat(slice.read(buffer, 0)).isEqualTo(4);
@@ -157,8 +158,8 @@ class FileChannelDataBlockTests {
@Test
void openAndCloseHandleReferenceCounting() throws IOException {
TestTracker tracker = new TestTracker();
FileChannelDataBlock.tracker = tracker;
FileChannelDataBlock block = createBlock();
FileDataBlock.tracker = tracker;
FileDataBlock block = createBlock();
assertThat(block).extracting("channel.referenceCount").isEqualTo(0);
tracker.assertOpenCloseCounts(0, 0);
block.open();
@@ -184,9 +185,9 @@ class FileChannelDataBlockTests {
@Test
void openAndCloseSliceHandleReferenceCounting() throws IOException {
TestTracker tracker = new TestTracker();
FileChannelDataBlock.tracker = tracker;
FileChannelDataBlock block = createBlock();
FileChannelDataBlock slice = block.slice(1, 4);
FileDataBlock.tracker = tracker;
FileDataBlock block = createBlock();
FileDataBlock slice = block.slice(1, 4);
assertThat(block).extracting("channel.referenceCount").isEqualTo(0);
tracker.assertOpenCloseCounts(0, 0);
block.open();
@@ -215,14 +216,14 @@ class FileChannelDataBlockTests {
tracker.assertOpenCloseCounts(2, 2);
}
private FileChannelDataBlock createAndOpenBlock() throws IOException {
FileChannelDataBlock block = createBlock();
private FileDataBlock createAndOpenBlock() throws IOException {
FileDataBlock block = createBlock();
block.open();
return block;
}
private FileChannelDataBlock createBlock() throws IOException {
return new FileChannelDataBlock(this.tempFile.toPath());
private FileDataBlock createBlock() throws IOException {
return new FileDataBlock(this.tempFile.toPath());
}
static class TestTracker implements Tracker {

4
spring-boot-project/spring-boot-tools/spring-boot-loader/src/test/java/org/springframework/boot/loader/zip/VirtualZipDataBlockTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 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.
@@ -58,7 +58,7 @@ class VirtualZipDataBlockTests {
@Test
void createContainsValidZipContent() throws IOException {
FileChannelDataBlock data = new FileChannelDataBlock(this.file.toPath());
FileDataBlock data = new FileDataBlock(this.file.toPath());
data.open();
List<ZipCentralDirectoryFileHeaderRecord> centralRecords = new ArrayList<>();
List<Long> centralRecordPositions = new ArrayList<>();