Polish "Improve handling of non-existent path in disk space health check"

See gh-20580

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/system/DiskSpaceHealthIndicatorProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/system/DiskSpaceHealthContributorAutoConfigurationTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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,8 +16,6 @@
 
 package org.springframework.boot.actuate.autoconfigure.system;
 
-import java.util.UUID;
-
 import org.junit.jupiter.api.Test;
 
 import org.springframework.boot.actuate.autoconfigure.health.HealthContributorAutoConfiguration;
@@ -61,9 +59,8 @@ void thresholdCanBeCustomized() {
 	}
 
 	@Test
-	void pathIsNotRequiredToExist() {
-		String randomPath = "IDoNOTeXiST" + UUID.randomUUID().toString();
-		this.contextRunner.withPropertyValues("management.health.diskspace.path=" + randomPath)
+	void runWhenPathDoesNotExistShouldCreateIndicator() {
+		this.contextRunner.withPropertyValues("management.health.diskspace.path=does/not/exist")
 				.run((context) -> assertThat(context).hasSingleBean(DiskSpaceHealthIndicator.class));
 	}
 

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/system/DiskSpaceHealthIndicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -59,9 +59,7 @@ public DiskSpaceHealthIndicator(File path, DataSize threshold) {
 	@Override
 	protected void doHealthCheck(Health.Builder builder) throws Exception {
 		long diskFreeInBytes = this.path.getUsableSpace();
-		// return value of 0L means "the abstract pathname does not name a
-		// partition" which for our purposes means it's not usable i.e DOWN
-		if (diskFreeInBytes >= this.threshold.toBytes() && diskFreeInBytes != 0L) {
+		if (diskFreeInBytes >= this.threshold.toBytes()) {
 			builder.up();
 		}
 		else {
@@ -70,9 +68,7 @@ protected void doHealthCheck(Health.Builder builder) throws Exception {
 			builder.down();
 		}
 		builder.withDetail("total", this.path.getTotalSpace()).withDetail("free", diskFreeInBytes)
-				.withDetail("threshold", this.threshold.toBytes()).withDetail("exists", this.path.exists())
-				.withDetail("canRead", this.path.canRead()).withDetail("canWrite", this.path.canWrite())
-				.withDetail("canExecute", this.path.canExecute());
+				.withDetail("threshold", this.threshold.toBytes()).withDetail("exists", this.path.exists());
 	}
 
 }

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/system/DiskSpaceHealthIndicatorPathTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2019 the original author or authors.
+ * Copyright 2012-2020 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.
@@ -52,9 +52,6 @@ class DiskSpaceHealthIndicatorTests {
 	void setUp() {
 		MockitoAnnotations.initMocks(this);
 		given(this.fileMock.exists()).willReturn(true);
-		given(this.fileMock.canRead()).willReturn(true);
-		given(this.fileMock.canWrite()).willReturn(true);
-		given(this.fileMock.canExecute()).willReturn(true);
 		this.healthIndicator = new DiskSpaceHealthIndicator(this.fileMock, THRESHOLD);
 	}
 
@@ -69,9 +66,6 @@ void diskSpaceIsUp() {
 		assertThat(health.getDetails().get("free")).isEqualTo(freeSpace);
 		assertThat(health.getDetails().get("total")).isEqualTo(TOTAL_SPACE.toBytes());
 		assertThat(health.getDetails().get("exists")).isEqualTo(true);
-		assertThat(health.getDetails().get("canRead")).isEqualTo(true);
-		assertThat(health.getDetails().get("canWrite")).isEqualTo(true);
-		assertThat(health.getDetails().get("canExecute")).isEqualTo(true);
 	}
 
 	@Test
@@ -85,9 +79,15 @@ void diskSpaceIsDown() {
 		assertThat(health.getDetails().get("free")).isEqualTo(freeSpace);
 		assertThat(health.getDetails().get("total")).isEqualTo(TOTAL_SPACE.toBytes());
 		assertThat(health.getDetails().get("exists")).isEqualTo(true);
-		assertThat(health.getDetails().get("canRead")).isEqualTo(true);
-		assertThat(health.getDetails().get("canWrite")).isEqualTo(true);
-		assertThat(health.getDetails().get("canExecute")).isEqualTo(true);
+	}
+
+	@Test
+	void whenPathDoesNotExistDiskSpaceIsDown() {
+		Health health = new DiskSpaceHealthIndicator(new File("does/not/exist"), THRESHOLD).health();
+		assertThat(health.getStatus()).isEqualTo(Status.DOWN);
+		assertThat(health.getDetails().get("free")).isEqualTo(0L);
+		assertThat(health.getDetails().get("total")).isEqualTo(0L);
+		assertThat(health.getDetails().get("exists")).isEqualTo(false);
 	}
 
 }