elharo commented on code in PR #60: URL: https://github.com/apache/maven-clean-plugin/pull/60#discussion_r1834878667
########## src/test/java/org/apache/maven/plugins/clean/CleanerTest.java: ########## @@ -0,0 +1,173 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.plugins.clean; + +import java.io.IOException; +import java.nio.file.AccessDeniedException; +import java.nio.file.DirectoryNotEmptyException; +import java.nio.file.FileSystems; +import java.nio.file.Path; +import java.nio.file.attribute.PosixFilePermission; +import java.nio.file.attribute.PosixFilePermissions; +import java.util.Set; + +import org.apache.maven.plugin.logging.Log; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import org.mockito.ArgumentCaptor; +import org.mockito.InOrder; + +import static java.nio.file.Files.createDirectory; +import static java.nio.file.Files.createFile; +import static java.nio.file.Files.exists; +import static java.nio.file.Files.getPosixFilePermissions; +import static java.nio.file.Files.setPosixFilePermissions; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assumptions.assumeTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.inOrder; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +class CleanerTest { + + private static final boolean POSIX_COMPLIANT = + FileSystems.getDefault().supportedFileAttributeViews().contains("posix"); + + private final Log log = mock(); + + @Test + void deleteSucceedsDeeply(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + final Path file = createFile(basedir.resolve("file")); + final Cleaner cleaner = new Cleaner(null, log, false, null, null); + cleaner.delete(basedir.toFile(), null, false, true, false); + assertFalse(exists(basedir)); + assertFalse(exists(file)); + } + + @Test + void deleteFailsWithoutRetryWhenNoPermission(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + when(log.isWarnEnabled()).thenReturn(true); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + createFile(basedir.resolve("file")); + final Set<PosixFilePermission> initialPermissions = getPosixFilePermissions(basedir); + final String rwxrwxr_x = PosixFilePermissions.toString(initialPermissions); + // Prevent directory listing, which will result in a DirectoryNotEmptyException. + final String rw_rw_r__ = rwxrwxr_x.replace('x', '-'); + final Set<PosixFilePermission> permissions = PosixFilePermissions.fromString(rw_rw_r__); + setPosixFilePermissions(basedir, permissions); + try { + final Cleaner cleaner = new Cleaner(null, log, false, null, null); + final IOException exception = + assertThrows(IOException.class, () -> cleaner.delete(basedir.toFile(), null, false, true, false)); + verify(log, never()).warn(any(CharSequence.class), any(Throwable.class)); + assertEquals("Failed to delete " + basedir, exception.getMessage()); + final DirectoryNotEmptyException cause = + assertInstanceOf(DirectoryNotEmptyException.class, exception.getCause()); + assertEquals(basedir.toString(), cause.getMessage()); + } finally { + // Allow the tempDir to be cleared by the @TempDir extension. + setPosixFilePermissions(basedir, initialPermissions); + } + } + + @Test + void deleteFailsAfterRetryWhenNoPermission(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + createFile(basedir.resolve("file")); + final Set<PosixFilePermission> initialPermissions = getPosixFilePermissions(basedir); + final String rwxrwxr_x = PosixFilePermissions.toString(initialPermissions); + // Prevent directory listing, which will result in a DirectoryNotEmptyException. + final String rw_rw_r__ = rwxrwxr_x.replace('x', '-'); Review Comment: This feels too clever by half. Let's just make it a string literal. ########## src/test/java/org/apache/maven/plugins/clean/CleanerTest.java: ########## @@ -0,0 +1,156 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.maven.plugins.clean; + +import java.io.IOException; +import java.nio.file.AccessDeniedException; +import java.nio.file.DirectoryNotEmptyException; +import java.nio.file.FileSystems; +import java.nio.file.Path; +import java.nio.file.attribute.PosixFilePermission; +import java.nio.file.attribute.PosixFilePermissions; +import java.util.Set; + +import org.apache.maven.plugin.logging.Log; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; +import org.mockito.ArgumentCaptor; +import org.mockito.InOrder; + +import static java.nio.file.Files.createDirectory; +import static java.nio.file.Files.createFile; +import static java.nio.file.Files.exists; +import static java.nio.file.Files.getPosixFilePermissions; +import static java.nio.file.Files.setPosixFilePermissions; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assumptions.assumeTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.inOrder; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +class CleanerTest { + + private static final boolean POSIX_COMPLIANT = + FileSystems.getDefault().supportedFileAttributeViews().contains("posix"); + + private final Log log = mock(); + + @Test + void deleteSucceedsDeeply(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + final Path file = createFile(basedir.resolve("file")); + final Cleaner cleaner = new Cleaner(null, log, false, null, null); + cleaner.delete(basedir.toFile(), null, false, true, false); + assertFalse(exists(basedir)); + assertFalse(exists(file)); + } + + @Test + void deleteFailsWithoutRetryWhenNoPermission(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + when(log.isWarnEnabled()).thenReturn(true); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + createFile(basedir.resolve("file")); + final Set<PosixFilePermission> initialPermissions = getPosixFilePermissions(basedir); + final String rwxrwxr_x = PosixFilePermissions.toString(initialPermissions); + // Remove the executable flag to prevent directory listing, which will result in a DirectoryNotEmptyException. + final String rw_rw_r__ = rwxrwxr_x.replace('x', '-'); + final Set<PosixFilePermission> permissions = PosixFilePermissions.fromString(rw_rw_r__); + setPosixFilePermissions(basedir, permissions); + final Cleaner cleaner = new Cleaner(null, log, false, null, null); + final IOException exception = + assertThrows(IOException.class, () -> cleaner.delete(basedir.toFile(), null, false, true, false)); + verify(log, never()).warn(any(CharSequence.class), any(Throwable.class)); + assertEquals("Failed to delete " + basedir, exception.getMessage()); + final DirectoryNotEmptyException cause = + assertInstanceOf(DirectoryNotEmptyException.class, exception.getCause()); + assertEquals(basedir.toString(), cause.getMessage()); + } + + @Test + void deleteFailsAfterRetryWhenNoPermission(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + createFile(basedir.resolve("file")); + final Set<PosixFilePermission> initialPermissions = getPosixFilePermissions(basedir); + final String rwxrwxr_x = PosixFilePermissions.toString(initialPermissions); + // Remove the executable flag to prevent directory listing, which will result in a DirectoryNotEmptyException. + final String rw_rw_r__ = rwxrwxr_x.replace('x', '-'); + final Set<PosixFilePermission> permissions = PosixFilePermissions.fromString(rw_rw_r__); + setPosixFilePermissions(basedir, permissions); + final Cleaner cleaner = new Cleaner(null, log, false, null, null); + final IOException exception = + assertThrows(IOException.class, () -> cleaner.delete(basedir.toFile(), null, false, true, true)); + assertEquals("Failed to delete " + basedir, exception.getMessage()); + final DirectoryNotEmptyException cause = + assertInstanceOf(DirectoryNotEmptyException.class, exception.getCause()); + assertEquals(basedir.toString(), cause.getMessage()); + } + + @Test + void deleteLogsWarningWithoutRetryWhenNoPermission(@TempDir Path tempDir) throws Exception { + assumeTrue(POSIX_COMPLIANT); + when(log.isWarnEnabled()).thenReturn(true); + final Path basedir = createDirectory(tempDir.resolve("target")).toRealPath(); + final Path file = createFile(basedir.resolve("file")); + final Set<PosixFilePermission> initialPermissions = getPosixFilePermissions(basedir); + final String rwxrwxr_x = PosixFilePermissions.toString(initialPermissions); + // Remove the writable flag to prevent deletion of the file, which will result in a AccessDeniedException. Review Comment: in a --> in an -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
