BatchReport.Component component = reportReader.readComponent(componentRef);
if (component.getType().equals(Constants.ComponentType.FILE)) {
Iterable<BatchReport.Coverage> coverageList = reportReader.readFileCoverage(componentRef);
- processCoverage(component, coverageList);
+ if (coverageList != null) {
+ processCoverage(component, coverageList);
+ }
}
for (Integer childRef : component.getChildRefList()) {
step.execute(new ComputationContext(new BatchReportReader(reportDir), mock(ComponentDto.class)));
- assertThat(step.getFileSourceData().getLinesList()).isEmpty();
+ assertThat(step.getFileSourceData()).isNull();
}
@Test
import com.google.protobuf.Parser;
import java.io.*;
-import java.util.Iterator;
-import java.util.NoSuchElementException;
public class ProtobufUtil {
private ProtobufUtil() {
}
}
- public static <M extends Message> Iterable<M> readFileMessages(final File file, final Parser<M> parser) {
- return new Iterable<M>() {
- @Override
- public Iterator<M> iterator() {
- try {
- return new Iterator<M>() {
- final InputStream inputStream = new BufferedInputStream(new FileInputStream(file));
-
- private M currentMessage;
-
- @Override
- public boolean hasNext() {
- if (currentMessage == null) {
- try {
- currentMessage = parser.parseDelimitedFrom(inputStream);
- if (currentMessage == null) {
- inputStream.close();
- }
- } catch (InvalidProtocolBufferException e) {
- throw new IllegalStateException("Failed to read input stream", e);
- } catch (IOException e) {
- throw new IllegalStateException("Failed to close input stream", e);
- }
- }
- return currentMessage != null;
- }
-
- @Override
- public M next() {
- if (!hasNext()) {
- throw new NoSuchElementException();
- }
- M messageToReturn = currentMessage;
- currentMessage = null;
- return messageToReturn;
- }
+ static <T extends Message> T readInputStream(InputStream inputStream, Parser<T> parser) {
+ try {
+ return parser.parseDelimitedFrom(inputStream);
+ } catch (InvalidProtocolBufferException e) {
+ throw new IllegalStateException("Failed to read input stream", e);
+ }
+ }
- @Override
- public void remove() {
- throw new UnsupportedOperationException();
- }
- };
- } catch (FileNotFoundException e) {
- throw new IllegalStateException("Unable to find file " + file, e);
- }
- }
- };
+ static InputStream createInputStream(File file) {
+ try {
+ return new BufferedInputStream(new FileInputStream(file));
+ } catch (FileNotFoundException e) {
+ throw new IllegalStateException("Unable to find file " + file, e);
+ }
}
public static void writeToFile(Message message, File toFile) {
--- /dev/null
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+package org.sonar.batch.protocol;
+
+import com.google.protobuf.Message;
+import com.google.protobuf.Parser;
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+/**
+ * An object to iterate over protobuf messages in a file.
+ * A ReportStream is opened upon creation and is closed by invoking the close method.
+ *
+ * Warning, while it extends Iterable, it is not a general-purpose Iterable as it supports only a single Iterator;
+ * invoking the iterator method to obtain a second or subsequent iterator throws IllegalStateException.
+ *
+ * Inspired by {@link java.nio.file.DirectoryStream}
+ */
+public class ReportStream<R extends Message> implements Closeable, Iterable<R> {
+
+ private final Parser<R> parser;
+ private InputStream inputStream;
+ private ReportIterator<R> iterator;
+
+ public ReportStream(File file, Parser<R> parser) {
+ this.parser = parser;
+ this.inputStream = ProtobufUtil.createInputStream(file);
+ }
+
+ @Override
+ public Iterator<R> iterator() {
+ if (this.iterator != null) {
+ throw new IllegalStateException("Iterator already obtained");
+ } else {
+ this.iterator = new ReportIterator<>(inputStream, parser);
+ return this.iterator;
+ }
+ }
+
+ @Override
+ public void close() throws IOException {
+ inputStream.close();
+ }
+
+ public static class ReportIterator<R extends Message> implements Iterator<R> {
+
+ private final Parser<R> parser;
+ private InputStream inputStream;
+ private R currentMessage;
+
+ public ReportIterator(InputStream inputStream, Parser<R> parser) {
+ this.inputStream = inputStream;
+ this.parser = parser;
+ }
+
+ @Override
+ public boolean hasNext() {
+ if (currentMessage == null) {
+ currentMessage = ProtobufUtil.readInputStream(inputStream, parser);
+ }
+ return currentMessage != null;
+ }
+
+ @Override
+ public R next() {
+ if (!hasNext()) {
+ throw new NoSuchElementException();
+ }
+ R messageToReturn = currentMessage;
+ currentMessage = null;
+ return messageToReturn;
+ }
+
+ @Override
+ public void remove() {
+ throw new UnsupportedOperationException();
+ }
+ }
+}
package org.sonar.batch.protocol.output;
import org.sonar.batch.protocol.ProtobufUtil;
+import org.sonar.batch.protocol.ReportStream;
import org.sonar.batch.protocol.output.BatchReport.Issues;
import javax.annotation.CheckForNull;
return Collections.emptyList();
}
- public Iterable<BatchReport.Coverage> readFileCoverage(int fileRef) {
+ @CheckForNull
+ public ReportStream<BatchReport.Coverage> readFileCoverage(int fileRef) {
File file = fileStructure.fileFor(FileStructure.Domain.COVERAGE, fileRef);
if (doesFileExists(file)) {
- return ProtobufUtil.readFileMessages(file, BatchReport.Coverage.PARSER);
+ return new ReportStream<>(file, BatchReport.Coverage.PARSER);
}
- return Collections.emptyList();
+ return null;
}
private boolean doesFileExists(File file) {
private final File dir;
- FileStructure(File dir) {
+ public FileStructure(File dir) {
if (!dir.exists() || !dir.isDirectory()) {
throw new IllegalArgumentException("Directory of analysis report does not exist: " + dir);
}
--- /dev/null
+/*
+ * SonarQube, open source software quality management tool.
+ * Copyright (C) 2008-2014 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * SonarQube is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * SonarQube is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+package org.sonar.batch.protocol;
+
+import org.apache.commons.io.IOUtils;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.sonar.batch.protocol.output.BatchReport;
+import org.sonar.batch.protocol.output.BatchReportWriter;
+import org.sonar.batch.protocol.output.FileStructure;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ReportStreamTest {
+
+ @Rule
+ public TemporaryFolder temp = new TemporaryFolder();
+
+ File file;
+
+ ReportStream<BatchReport.Coverage> sut;
+
+ @Before
+ public void setUp() throws Exception {
+ File dir = temp.newFolder();
+ BatchReportWriter writer = new BatchReportWriter(dir);
+
+ writer.writeFileCoverage(1, Arrays.asList(
+ BatchReport.Coverage.newBuilder()
+ .setLine(1)
+ .build()
+ ));
+
+ file = new FileStructure(dir).fileFor(FileStructure.Domain.COVERAGE, 1);
+ }
+
+ @After
+ public void tearDown() throws Exception {
+ IOUtils.closeQuietly(sut);
+ }
+
+ @Test
+ public void read_report() throws Exception {
+ sut = new ReportStream<>(file, BatchReport.Coverage.PARSER);
+ assertThat(sut).hasSize(1);
+ sut.close();
+ }
+
+ @Test(expected = IllegalStateException.class)
+ public void fail_to_get_iterator_twice() throws Exception {
+ sut = new ReportStream<>(file, BatchReport.Coverage.PARSER);
+ sut.iterator();
+
+ // Fail !
+ sut.iterator();
+ }
+
+ @Test(expected = NoSuchElementException.class)
+ public void fail_to_get_next_when_no_next() throws Exception {
+ sut = new ReportStream<>(file, BatchReport.Coverage.PARSER);
+ Iterator<BatchReport.Coverage> iterator = sut.iterator();
+ // Get first element
+ iterator.next();
+
+ // Fail !
+ iterator.next();
+ }
+
+ @Test(expected = UnsupportedOperationException.class)
+ public void fail_to_remove() throws Exception {
+ sut = new ReportStream<>(file, BatchReport.Coverage.PARSER);
+ Iterator<BatchReport.Coverage> iterator = sut.iterator();
+
+ // Fail !
+ iterator.remove();
+ }
+
+}
}
@Test
- public void empty_list_if_no_coverage_found() throws Exception {
- assertThat(sut.readFileCoverage(123)).isEmpty();
+ public void return_null_if_no_coverage_found() throws Exception {
+ assertThat(sut.readFileCoverage(123)).isNull();
}
/**
package org.sonar.batch.protocol.output;
import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.IOUtils;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.sonar.batch.protocol.Constants;
import org.sonar.batch.protocol.ProtobufUtil;
+import org.sonar.batch.protocol.ReportStream;
import org.sonar.batch.protocol.output.BatchReport.Range;
import java.io.File;
.setItCoveredConditions(5)
.setOverallCoveredConditions(5)
.build()
- ));
+ ));
assertThat(writer.hasComponentData(FileStructure.Domain.COVERAGE, 1)).isTrue();
- List<BatchReport.Coverage> coverageList = newArrayList(new BatchReportReader(dir).readFileCoverage(1));
- assertThat(coverageList).hasSize(2);
-
- BatchReport.Coverage coverage = coverageList.get(0);
- assertThat(coverage.getLine()).isEqualTo(1);
- assertThat(coverage.getConditions()).isEqualTo(1);
- assertThat(coverage.getUtHits()).isTrue();
- assertThat(coverage.getItHits()).isFalse();
- assertThat(coverage.getUtCoveredConditions()).isEqualTo(1);
- assertThat(coverage.getItCoveredConditions()).isEqualTo(1);
- assertThat(coverage.getOverallCoveredConditions()).isEqualTo(1);
-
- coverage = coverageList.get(1);
- assertThat(coverage.getLine()).isEqualTo(2);
- assertThat(coverage.getConditions()).isEqualTo(5);
- assertThat(coverage.getUtHits()).isFalse();
- assertThat(coverage.getItHits()).isFalse();
- assertThat(coverage.getUtCoveredConditions()).isEqualTo(4);
- assertThat(coverage.getItCoveredConditions()).isEqualTo(5);
- assertThat(coverage.getOverallCoveredConditions()).isEqualTo(5);
+ ReportStream coverageReportStream = null;
+ try {
+ coverageReportStream = new BatchReportReader(dir).readFileCoverage(1);
+ List<BatchReport.Coverage> coverageList = newArrayList(coverageReportStream);
+ assertThat(coverageList).hasSize(2);
+
+ BatchReport.Coverage coverage = coverageList.get(0);
+ assertThat(coverage.getLine()).isEqualTo(1);
+ assertThat(coverage.getConditions()).isEqualTo(1);
+ assertThat(coverage.getUtHits()).isTrue();
+ assertThat(coverage.getItHits()).isFalse();
+ assertThat(coverage.getUtCoveredConditions()).isEqualTo(1);
+ assertThat(coverage.getItCoveredConditions()).isEqualTo(1);
+ assertThat(coverage.getOverallCoveredConditions()).isEqualTo(1);
+
+ coverage = coverageList.get(1);
+ assertThat(coverage.getLine()).isEqualTo(2);
+ assertThat(coverage.getConditions()).isEqualTo(5);
+ assertThat(coverage.getUtHits()).isFalse();
+ assertThat(coverage.getItHits()).isFalse();
+ assertThat(coverage.getUtCoveredConditions()).isEqualTo(4);
+ assertThat(coverage.getItCoveredConditions()).isEqualTo(5);
+ assertThat(coverage.getOverallCoveredConditions()).isEqualTo(5);
+ } finally {
+ IOUtils.closeQuietly(coverageReportStream);
+ }
}
}
projects / sonarqube.git / commitdiff