import java.io.IOException;
import java.io.InputStream;
import java.util.Optional;
+import org.apache.commons.io.FileUtils;
import org.sonar.api.utils.MessageException;
import org.sonar.api.utils.TempFolder;
import org.sonar.api.utils.ZipUtils;
+import org.sonar.api.utils.log.Logger;
+import org.sonar.api.utils.log.Loggers;
import org.sonar.ce.task.CeTask;
import org.sonar.ce.task.projectanalysis.batch.MutableBatchReportDirectoryHolder;
import org.sonar.ce.task.step.ComputationStep;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.ce.CeTaskInputDao;
+import org.sonar.process.FileUtils2;
/**
* Extracts the content zip file of the {@link CeTask} to a temp directory and adds a {@link File}
*/
public class ExtractReportStep implements ComputationStep {
+ private static final Logger LOGGER = Loggers.get(ExtractReportStep.class);
+
private final DbClient dbClient;
private final CeTask task;
private final TempFolder tempFolder;
throw new IllegalStateException("Fail to extract report " + task.getUuid() + " from database", e);
}
reportDirectoryHolder.setDirectory(unzippedDir);
+ if (LOGGER.isDebugEnabled()) {
+ // size is not added to context statistics because computation
+ // can take time. It's enabled only if log level is DEBUG.
+ try {
+ String dirSize = FileUtils.byteCountToDisplaySize(FileUtils2.sizeOf(unzippedDir.toPath()));
+ LOGGER.debug("Analysis report is {} uncompressed", dirSize);
+ } catch (IOException e) {
+ LOGGER.warn("Fail to compute size of directory " + unzippedDir, e);
+ }
+ }
+
} else {
throw MessageException.of("Analysis report " + task.getUuid() + " is missing in database");
}
public JUnitTempFolder tempFolder = new JUnitTempFolder();
@Rule
- public LogTester logTester = new LogTester().setLevel(LoggerLevel.INFO);
+ public LogTester logTester = new LogTester();
@Rule
public ExpectedException expectedException = ExpectedException.none();
@Test
public void unzip_report() throws Exception {
+ logTester.setLevel(LoggerLevel.DEBUG);
File reportFile = generateReport();
try (InputStream input = FileUtils.openInputStream(reportFile)) {
dbTester.getDbClient().ceTaskInputDao().insert(dbTester.getSession(), TASK_UUID, input);
assertThat(unzippedDir).isDirectory().exists();
assertThat(unzippedDir.listFiles()).hasSize(1);
assertThat(new File(unzippedDir, "metadata.pb")).hasContent("{metadata}");
+
+ assertThat(logTester.logs(LoggerLevel.DEBUG)).anyMatch(log -> log.matches("Analysis report is \\d+ bytes uncompressed"));
}
private File generateReport() throws IOException {
}
}
+ /**
+ * Size of file or directory, in bytes. In case of a directory,
+ * the size is the sum of the sizes of all files recursively traversed.
+ *
+ * This implementation is recommended over commons-io
+ * {@code FileUtils#sizeOf(File)} which suffers from slow usage of Java IO.
+ *
+ * @throws IOException if files can't be traversed or size attribute is not present
+ * @see BasicFileAttributes#size()
+ */
+ public static long sizeOf(Path path) throws IOException {
+ SizeVisitor visitor = new SizeVisitor();
+ Files.walkFileTree(path, visitor);
+ return visitor.size;
+ }
+
private static void cleanDirectoryImpl(Path path) throws IOException {
if (!path.toFile().isDirectory()) {
throw new IllegalArgumentException(format("'%s' is not a directory", path));
return FileVisitResult.CONTINUE;
}
}
+
+ private static final class SizeVisitor extends SimpleFileVisitor<Path> {
+ private long size = 0;
+
+ @Override
+ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
+ size += attrs.size();
+ return FileVisitResult.CONTINUE;
+ }
+ }
}
import java.nio.file.Path;
import java.nio.file.attribute.BasicFileAttributes;
import javax.annotation.CheckForNull;
+import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.SystemUtils;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
+import static java.nio.charset.StandardCharsets.UTF_8;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assume.assumeTrue;
assertThat(childDir2).doesNotExist();
}
+ @Test
+ public void sizeOf_sums_sizes_of_all_files_in_directory() throws IOException {
+ File dir = temporaryFolder.newFolder();
+ File child = new File(dir, "child.txt");
+ File grandChild1 = new File(dir, "grand/child1.txt");
+ File grandChild2 = new File(dir, "grand/child2.txt");
+ FileUtils.write(child, "foo", UTF_8);
+ FileUtils.write(grandChild1, "bar", UTF_8);
+ FileUtils.write(grandChild2, "baz", UTF_8);
+
+ long childSize = FileUtils2.sizeOf(child.toPath());
+ assertThat(childSize).isPositive();
+ long grandChild1Size = FileUtils2.sizeOf(grandChild1.toPath());
+ assertThat(grandChild1Size).isPositive();
+ long grandChild2Size = FileUtils2.sizeOf(grandChild2.toPath());
+ assertThat(grandChild2Size).isPositive();
+
+ assertThat(FileUtils2.sizeOf(dir.toPath()))
+ .isEqualTo(childSize + grandChild1Size + grandChild2Size);
+
+ // sanity check by comparing commons-io
+ assertThat(FileUtils2.sizeOf(dir.toPath()))
+ .isEqualTo(FileUtils.sizeOfDirectory(dir));
+ }
+
+ @Test
+ public void sizeOf_is_zero_on_empty_files() throws IOException {
+ File file = temporaryFolder.newFile();
+
+ assertThat(FileUtils2.sizeOf(file.toPath())).isEqualTo(0);
+ }
+
+ @Test
+ public void sizeOf_throws_IOE_if_path_does_not_exist() throws IOException {
+ Path path = temporaryFolder.newFile().toPath();
+ Files.delete(path);
+
+ expectedException.expect(IOException.class);
+
+ FileUtils2.sizeOf(path);
+ }
+
private void expectDirectoryCanNotBeNullNPE() {
expectedException.expect(NullPointerException.class);
expectedException.expectMessage("Directory can not be null");