diff options
author | Julien HENRY <julien.henry@sonarsource.com> | 2014-07-24 17:16:41 +0200 |
---|---|---|
committer | Julien HENRY <julien.henry@sonarsource.com> | 2014-07-24 17:25:10 +0200 |
commit | 2a510a2f76d2f384deba2eec2ca6a9297c0ebc63 (patch) | |
tree | bef0154a601465671ce3a2f074da3a4d09140b37 /sonar-batch/src | |
parent | ecea6110fad63f12345422d0e868f9b89ec6dc70 (diff) | |
download | sonarqube-2a510a2f76d2f384deba2eec2ca6a9297c0ebc63.tar.gz sonarqube-2a510a2f76d2f384deba2eec2ca6a9297c0ebc63.zip |
SONAR-5389 Port symbolizable API to new batch API
Diffstat (limited to 'sonar-batch/src')
18 files changed, 477 insertions, 174 deletions
diff --git a/sonar-batch/src/main/java/org/sonar/batch/mediumtest/BatchMediumTester.java b/sonar-batch/src/main/java/org/sonar/batch/mediumtest/BatchMediumTester.java index e30d48256a1..c305474b7f2 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/mediumtest/BatchMediumTester.java +++ b/sonar-batch/src/main/java/org/sonar/batch/mediumtest/BatchMediumTester.java @@ -32,6 +32,7 @@ import org.sonar.api.batch.fs.internal.DefaultInputFile; import org.sonar.api.batch.sensor.highlighting.HighlightingBuilder; import org.sonar.api.batch.sensor.issue.Issue; import org.sonar.api.batch.sensor.measure.Measure; +import org.sonar.api.batch.sensor.symbol.Symbol; import org.sonar.api.config.Settings; import org.sonar.api.measures.CoreMetrics; import org.sonar.api.measures.Metric; @@ -54,6 +55,7 @@ import org.sonar.batch.scan2.AnalyzerMeasureCache; import org.sonar.batch.scan2.ProjectScanContainer; import org.sonar.batch.scan2.ScanTaskObserver; import org.sonar.batch.settings.SettingsReferential; +import org.sonar.batch.symbol.SymbolData; import org.sonar.core.plugins.DefaultPluginMetadata; import org.sonar.core.plugins.RemotePlugin; import org.sonar.core.source.SnapshotDataTypes; @@ -69,6 +71,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Properties; +import java.util.Set; public class BatchMediumTester { @@ -218,6 +221,7 @@ public class BatchMediumTester { private List<InputFile> inputFiles = new ArrayList<InputFile>(); private List<InputDir> inputDirs = new ArrayList<InputDir>(); private Map<InputFile, SyntaxHighlightingData> highlightingPerFile = new HashMap<InputFile, SyntaxHighlightingData>(); + private Map<InputFile, SymbolData> symbolTablePerFile = new HashMap<InputFile, SymbolData>(); @Override public void scanTaskCompleted(ProjectScanContainer container) { @@ -245,6 +249,10 @@ public class BatchMediumTester { if (highlighting != null) { highlightingPerFile.put(file, highlighting); } + SymbolData symbolTable = componentDataCache.getData(((DefaultInputFile) file).key(), SnapshotDataTypes.SYMBOL_HIGHLIGHTING); + if (symbolTable != null) { + symbolTablePerFile.put(file, symbolTable); + } } } @@ -270,14 +278,37 @@ public class BatchMediumTester { * @param charIndex 0-based offset in file */ @CheckForNull - public HighlightingBuilder.TypeOfText highlightingTypeAt(InputFile file, int charIndex) { - for (SyntaxHighlightingRule sortedRule : highlightingPerFile.get(file).syntaxHighlightingRuleSet()) { + public HighlightingBuilder.TypeOfText highlightingTypeFor(InputFile file, int charIndex) { + SyntaxHighlightingData syntaxHighlightingData = highlightingPerFile.get(file); + if (syntaxHighlightingData == null) { + return null; + } + for (SyntaxHighlightingRule sortedRule : syntaxHighlightingData.syntaxHighlightingRuleSet()) { if (sortedRule.getStartPosition() <= charIndex && sortedRule.getEndPosition() > charIndex) { return HighlightingBuilder.TypeOfText.forCssClass(sortedRule.getTextType()); } } return null; } + + /** + * Get list of all positions of a symbol in an inputfile + * @param symbolStartOffset 0-based start offset for the symbol in file + * @param symbolEndOffset 0-based end offset for the symbol in file + */ + @CheckForNull + public Set<Integer> symbolReferencesFor(InputFile file, int symbolStartOffset, int symbolEndOffset) { + SymbolData data = symbolTablePerFile.get(file); + if (data == null) { + return null; + } + for (Symbol symbol : data.referencesBySymbol().keySet()) { + if (symbol.getDeclarationStartOffset() == symbolStartOffset && symbol.getDeclarationEndOffset() == symbolEndOffset) { + return data.referencesBySymbol().get(symbol); + } + } + return null; + } } private static class FakeGlobalReferentialsLoader implements GlobalReferentialsLoader { diff --git a/sonar-batch/src/main/java/org/sonar/batch/scan/SensorContextAdaptor.java b/sonar-batch/src/main/java/org/sonar/batch/scan/SensorContextAdaptor.java index f99db295e35..1de8fd7201c 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/scan/SensorContextAdaptor.java +++ b/sonar-batch/src/main/java/org/sonar/batch/scan/SensorContextAdaptor.java @@ -34,6 +34,7 @@ import org.sonar.api.batch.sensor.issue.internal.DefaultIssueBuilder; import org.sonar.api.batch.sensor.measure.Measure; import org.sonar.api.batch.sensor.measure.MeasureBuilder; import org.sonar.api.batch.sensor.measure.internal.DefaultMeasureBuilder; +import org.sonar.api.batch.sensor.symbol.SymbolTableBuilder; import org.sonar.api.component.ResourcePerspectives; import org.sonar.api.config.Settings; import org.sonar.api.issue.Issuable; @@ -50,6 +51,7 @@ import org.sonar.api.resources.Scopes; import org.sonar.api.rule.RuleKey; import org.sonar.batch.highlighting.DefaultHighlightingBuilder; import org.sonar.batch.index.ComponentDataCache; +import org.sonar.batch.symbol.DefaultSymbolTableBuilder; import java.io.Serializable; @@ -247,4 +249,9 @@ public class SensorContextAdaptor implements SensorContext { return new DefaultHighlightingBuilder(((DefaultInputFile) inputFile).key(), componentDataCache); } + @Override + public SymbolTableBuilder symbolTableBuilder(InputFile inputFile) { + return new DefaultSymbolTableBuilder(((DefaultInputFile) inputFile).key(), componentDataCache); + } + } diff --git a/sonar-batch/src/main/java/org/sonar/batch/scan2/AnalysisPublisher.java b/sonar-batch/src/main/java/org/sonar/batch/scan2/AnalysisPublisher.java index b10ac5524dd..7fb7dacf375 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/scan2/AnalysisPublisher.java +++ b/sonar-batch/src/main/java/org/sonar/batch/scan2/AnalysisPublisher.java @@ -44,9 +44,11 @@ public final class AnalysisPublisher { private final FileSystem fs; private final AnalyzerMeasureCache measureCache; private final ProjectDefinition def; - private AnalyzerIssueCache issueCache; + private final AnalyzerIssueCache issueCache; - public AnalysisPublisher(ProjectDefinition def, Settings settings, FileSystem fs, AnalyzerMeasureCache measureCache, AnalyzerIssueCache analyzerIssueCache) { + public AnalysisPublisher(ProjectDefinition def, Settings settings, FileSystem fs, + AnalyzerMeasureCache measureCache, + AnalyzerIssueCache analyzerIssueCache) { this.def = def; this.settings = settings; this.fs = fs; diff --git a/sonar-batch/src/main/java/org/sonar/batch/scan2/DefaultSensorContext.java b/sonar-batch/src/main/java/org/sonar/batch/scan2/DefaultSensorContext.java index d5178e21eeb..dcd6efd1ca4 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/scan2/DefaultSensorContext.java +++ b/sonar-batch/src/main/java/org/sonar/batch/scan2/DefaultSensorContext.java @@ -37,6 +37,7 @@ import org.sonar.api.batch.sensor.measure.Measure; import org.sonar.api.batch.sensor.measure.MeasureBuilder; import org.sonar.api.batch.sensor.measure.internal.DefaultMeasure; import org.sonar.api.batch.sensor.measure.internal.DefaultMeasureBuilder; +import org.sonar.api.batch.sensor.symbol.SymbolTableBuilder; import org.sonar.api.config.Settings; import org.sonar.api.rule.RuleKey; import org.sonar.api.utils.MessageException; @@ -44,6 +45,7 @@ import org.sonar.batch.highlighting.DefaultHighlightingBuilder; import org.sonar.batch.index.ComponentDataCache; import org.sonar.batch.issue.IssueFilters; import org.sonar.batch.scan.SensorContextAdaptor; +import org.sonar.batch.symbol.DefaultSymbolTableBuilder; import org.sonar.core.component.ComponentKeys; import java.io.Serializable; @@ -168,4 +170,9 @@ public class DefaultSensorContext implements SensorContext { return new DefaultHighlightingBuilder(((DefaultInputFile) inputFile).key(), componentDataCache); } + @Override + public SymbolTableBuilder symbolTableBuilder(InputFile inputFile) { + return new DefaultSymbolTableBuilder(((DefaultInputFile) inputFile).key(), componentDataCache); + } + } diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultHighlightable.java b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultHighlightable.java index 79c38ad20ce..5b15a3abcd8 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultHighlightable.java +++ b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultHighlightable.java @@ -27,7 +27,7 @@ import org.sonar.core.source.SnapshotDataTypes; /** * @since 3.6 - * @deprecated no more used in batch 2.0 + * @deprecated since 4.5 no more used in batch 2.0 */ @Deprecated public class DefaultHighlightable implements Highlightable { diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbol.java b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbol.java deleted file mode 100644 index 629633a05de..00000000000 --- a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbol.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * 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.source; - -import com.google.common.base.Objects; -import org.sonar.api.source.Symbol; - -public class DefaultSymbol implements Symbol { - - private final int declarationStartOffset; - private final int declarationEndOffset; - - public DefaultSymbol(int startOffset, int endOffset) { - this.declarationStartOffset = startOffset; - this.declarationEndOffset = endOffset; - } - - public int getDeclarationStartOffset() { - return declarationStartOffset; - } - - public int getDeclarationEndOffset() { - return declarationEndOffset; - } - - public String getFullyQualifiedName() { - return null; - } - - @Override - public String toString() { - return Objects.toStringHelper("Symbol") - .add("offset", String.format("%d-%d", declarationStartOffset, declarationEndOffset)) - .toString(); - } -} diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolTable.java b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolTable.java index 0d66c31b8f1..ee8997c259c 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolTable.java +++ b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolTable.java @@ -20,35 +20,35 @@ package org.sonar.batch.source; -import com.google.common.collect.Multimap; +import com.google.common.collect.SortedSetMultimap; import com.google.common.collect.TreeMultimap; +import org.sonar.api.batch.sensor.symbol.internal.DefaultSymbol; import org.sonar.api.source.Symbol; import org.sonar.api.source.Symbolizable; +import org.sonar.batch.symbol.DefaultSymbolTableBuilder; -import java.io.Serializable; import java.util.ArrayList; -import java.util.Comparator; import java.util.List; public class DefaultSymbolTable implements Symbolizable.SymbolTable { - private Multimap<Symbol, Integer> referencesBySymbol; + private SortedSetMultimap<org.sonar.api.batch.sensor.symbol.Symbol, Integer> referencesBySymbol; - private DefaultSymbolTable(Multimap<Symbol, Integer> referencesBySymbol) { + private DefaultSymbolTable(SortedSetMultimap<org.sonar.api.batch.sensor.symbol.Symbol, Integer> referencesBySymbol) { this.referencesBySymbol = referencesBySymbol; } - public static Builder builder() { - return new Builder(); - } - - public Multimap<Symbol, Integer> getReferencesBySymbol() { + public SortedSetMultimap<org.sonar.api.batch.sensor.symbol.Symbol, Integer> getReferencesBySymbol() { return referencesBySymbol; } @Override public List<Symbol> symbols() { - return new ArrayList<Symbol>(referencesBySymbol.keySet()); + List<Symbol> result = new ArrayList<Symbol>(); + for (org.sonar.api.batch.sensor.symbol.Symbol symbol : referencesBySymbol.keySet()) { + result.add((Symbol) symbol); + } + return result; } @Override @@ -58,15 +58,17 @@ public class DefaultSymbolTable implements Symbolizable.SymbolTable { public static class Builder implements Symbolizable.SymbolTableBuilder { - private final Multimap<Symbol, Integer> referencesBySymbol; + private final SortedSetMultimap<org.sonar.api.batch.sensor.symbol.Symbol, Integer> referencesBySymbol; + private final String componentKey; - public Builder() { - referencesBySymbol = TreeMultimap.create(new SymbolComparator(), new ReferenceComparator()); + public Builder(String componentKey) { + this.componentKey = componentKey; + referencesBySymbol = TreeMultimap.create(new DefaultSymbolTableBuilder.SymbolComparator(), new DefaultSymbolTableBuilder.ReferenceComparator()); } @Override public Symbol newSymbol(int fromOffset, int toOffset) { - Symbol symbol = new DefaultSymbol(fromOffset, toOffset); + Symbol symbol = new DefaultSymbol(componentKey, fromOffset, toOffset); referencesBySymbol.put(symbol, symbol.getDeclarationStartOffset()); return symbol; } @@ -84,24 +86,5 @@ public class DefaultSymbolTable implements Symbolizable.SymbolTable { return new DefaultSymbolTable(referencesBySymbol); } - private static class SymbolComparator implements Comparator<Symbol>, Serializable { - @Override - public int compare(Symbol left, Symbol right) { - return left.getDeclarationStartOffset() - right.getDeclarationStartOffset(); - } - } - - private static class ReferenceComparator implements Comparator<Integer>, Serializable { - @Override - public int compare(Integer left, Integer right) { - int result; - if (left != null & right != null) { - result = left - right; - } else { - result = left == null ? -1 : 1; - } - return result; - } - } } } diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolizable.java b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolizable.java index 1e3b33d939e..de073e50629 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolizable.java +++ b/sonar-batch/src/main/java/org/sonar/batch/source/DefaultSymbolizable.java @@ -23,6 +23,7 @@ package org.sonar.batch.source; import org.sonar.api.component.Component; import org.sonar.api.source.Symbolizable; import org.sonar.batch.index.ComponentDataCache; +import org.sonar.batch.symbol.SymbolData; import org.sonar.core.source.SnapshotDataTypes; public class DefaultSymbolizable implements Symbolizable { @@ -42,12 +43,12 @@ public class DefaultSymbolizable implements Symbolizable { @Override public SymbolTableBuilder newSymbolTableBuilder() { - return new DefaultSymbolTable.Builder(); + return new DefaultSymbolTable.Builder(component.key()); } @Override public void setSymbolTable(SymbolTable symbolTable) { - SymbolData symbolData = new SymbolData(symbolTable); + SymbolData symbolData = new SymbolData(((DefaultSymbolTable) symbolTable).getReferencesBySymbol()); cache.setStringData(component().key(), SnapshotDataTypes.SYMBOL_HIGHLIGHTING, symbolData.writeString()); } } diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/HighlightableBuilder.java b/sonar-batch/src/main/java/org/sonar/batch/source/HighlightableBuilder.java index a73989aa75f..d20fbebb147 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/source/HighlightableBuilder.java +++ b/sonar-batch/src/main/java/org/sonar/batch/source/HighlightableBuilder.java @@ -33,7 +33,7 @@ import java.util.Set; /** * @since 3.6 - * @deprecated no more used in batch 2.0 + * @deprecated since 4.5 no more used in batch 2.0 */ @Deprecated public class HighlightableBuilder extends PerspectiveBuilder<Highlightable> { diff --git a/sonar-batch/src/main/java/org/sonar/batch/symbol/DefaultSymbolTableBuilder.java b/sonar-batch/src/main/java/org/sonar/batch/symbol/DefaultSymbolTableBuilder.java new file mode 100644 index 00000000000..ed347e60bd0 --- /dev/null +++ b/sonar-batch/src/main/java/org/sonar/batch/symbol/DefaultSymbolTableBuilder.java @@ -0,0 +1,90 @@ +/* + * 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.symbol; + +import com.google.common.collect.SortedSetMultimap; +import com.google.common.collect.TreeMultimap; +import org.sonar.api.batch.sensor.symbol.Symbol; +import org.sonar.api.batch.sensor.symbol.SymbolTableBuilder; +import org.sonar.api.batch.sensor.symbol.internal.DefaultSymbol; +import org.sonar.batch.index.ComponentDataCache; +import org.sonar.core.source.SnapshotDataTypes; + +import java.io.Serializable; +import java.util.Comparator; + +public class DefaultSymbolTableBuilder implements SymbolTableBuilder { + + private final String componentKey; + private final ComponentDataCache cache; + private final SortedSetMultimap<Symbol, Integer> referencesBySymbol; + + public DefaultSymbolTableBuilder(String componentKey, ComponentDataCache cache) { + this.componentKey = componentKey; + this.cache = cache; + this.referencesBySymbol = TreeMultimap.create(new SymbolComparator(), new ReferenceComparator()); + } + + @Override + public Symbol newSymbol(int fromOffset, int toOffset) { + Symbol symbol = new DefaultSymbol(componentKey, fromOffset, toOffset); + referencesBySymbol.put(symbol, symbol.getDeclarationStartOffset()); + return symbol; + } + + @Override + public void newReference(Symbol symbol, int fromOffset) { + String otherComponentKey = ((DefaultSymbol) symbol).componentKey(); + if (!otherComponentKey.equals(componentKey)) { + throw new UnsupportedOperationException("Cannot add reference from (" + componentKey + ") to another file (" + otherComponentKey + ")"); + } + if (fromOffset >= symbol.getDeclarationStartOffset() && fromOffset < symbol.getDeclarationEndOffset()) { + throw new UnsupportedOperationException("Cannot add reference (" + fromOffset + ") overlapping " + symbol); + } + referencesBySymbol.put(symbol, fromOffset); + } + + @Override + public void done() { + SymbolData symbolData = new SymbolData(referencesBySymbol); + cache.setData(componentKey, SnapshotDataTypes.SYMBOL_HIGHLIGHTING, symbolData); + } + + public static class SymbolComparator implements Comparator<Symbol>, Serializable { + @Override + public int compare(Symbol left, Symbol right) { + return left.getDeclarationStartOffset() - right.getDeclarationStartOffset(); + } + } + + public static class ReferenceComparator implements Comparator<Integer>, Serializable { + @Override + public int compare(Integer left, Integer right) { + int result; + if (left != null & right != null) { + result = left - right; + } else { + result = left == null ? -1 : 1; + } + return result; + } + } +} diff --git a/sonar-batch/src/main/java/org/sonar/batch/source/SymbolData.java b/sonar-batch/src/main/java/org/sonar/batch/symbol/SymbolData.java index 08df9471ca7..11ab5cca7e5 100644 --- a/sonar-batch/src/main/java/org/sonar/batch/source/SymbolData.java +++ b/sonar-batch/src/main/java/org/sonar/batch/symbol/SymbolData.java @@ -18,11 +18,10 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -package org.sonar.batch.source; +package org.sonar.batch.symbol; -import com.google.common.collect.Multimap; -import org.sonar.api.source.Symbol; -import org.sonar.api.source.Symbolizable; +import com.google.common.collect.SortedSetMultimap; +import org.sonar.api.batch.sensor.symbol.Symbol; import org.sonar.batch.index.Data; import java.util.Collection; @@ -32,19 +31,21 @@ public class SymbolData implements Data { private static final String FIELD_SEPARATOR = ","; private static final String SYMBOL_SEPARATOR = ";"; - private final Symbolizable.SymbolTable symbolTable; + private final SortedSetMultimap<Symbol, Integer> referencesBySymbol; - public SymbolData(Symbolizable.SymbolTable symbolTable) { - this.symbolTable = symbolTable; + public SymbolData(SortedSetMultimap<Symbol, Integer> referencesBySymbol) { + this.referencesBySymbol = referencesBySymbol; + } + + public SortedSetMultimap<Symbol, Integer> referencesBySymbol() { + return referencesBySymbol; } @Override public String writeString() { StringBuilder sb = new StringBuilder(); - Multimap<Symbol, Integer> referencesBySymbol = ((DefaultSymbolTable) symbolTable).getReferencesBySymbol(); - - for (Symbol symbol : ((DefaultSymbolTable) symbolTable).getReferencesBySymbol().keySet()) { + for (Symbol symbol : referencesBySymbol.keySet()) { sb.append(symbol.getDeclarationStartOffset()) .append(FIELD_SEPARATOR) diff --git a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/highlighting/HighlightingMediumTest.java b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/highlighting/HighlightingMediumTest.java index ab8e526fe68..259b2ffcec0 100644 --- a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/highlighting/HighlightingMediumTest.java +++ b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/highlighting/HighlightingMediumTest.java @@ -82,10 +82,10 @@ public class HighlightingMediumTest { .start(); InputFile file = result.inputFiles().get(0); - assertThat(result.highlightingTypeAt(file, 0)).isEqualTo(HighlightingBuilder.TypeOfText.STRING); - assertThat(result.highlightingTypeAt(file, 9)).isEqualTo(HighlightingBuilder.TypeOfText.STRING); - assertThat(result.highlightingTypeAt(file, 10)).isNull(); - assertThat(result.highlightingTypeAt(file, 11)).isEqualTo(HighlightingBuilder.TypeOfText.KEYWORD); + assertThat(result.highlightingTypeFor(file, 0)).isEqualTo(HighlightingBuilder.TypeOfText.STRING); + assertThat(result.highlightingTypeFor(file, 9)).isEqualTo(HighlightingBuilder.TypeOfText.STRING); + assertThat(result.highlightingTypeFor(file, 10)).isNull(); + assertThat(result.highlightingTypeFor(file, 11)).isEqualTo(HighlightingBuilder.TypeOfText.KEYWORD); } diff --git a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/symbol/SymbolMediumTest.java b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/symbol/SymbolMediumTest.java new file mode 100644 index 00000000000..c3875c625f3 --- /dev/null +++ b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/symbol/SymbolMediumTest.java @@ -0,0 +1,87 @@ +/* + * 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.mediumtest.symbol; + +import com.google.common.collect.ImmutableMap; +import org.apache.commons.io.FileUtils; +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; +import org.sonar.api.batch.fs.InputFile; +import org.sonar.batch.mediumtest.BatchMediumTester; +import org.sonar.batch.mediumtest.BatchMediumTester.TaskResult; +import org.sonar.batch.mediumtest.xoo.plugin.XooPlugin; + +import java.io.File; +import java.io.IOException; + +import static org.fest.assertions.Assertions.assertThat; + +public class SymbolMediumTest { + + @org.junit.Rule + public TemporaryFolder temp = new TemporaryFolder(); + + public BatchMediumTester tester = BatchMediumTester.builder() + .registerPlugin("xoo", new XooPlugin()) + .addDefaultQProfile("xoo", "Sonar Way") + .bootstrapProperties(ImmutableMap.of("sonar.analysis.mode", "sensor")) + .build(); + + @Before + public void prepare() { + tester.start(); + } + + @After + public void stop() { + tester.stop(); + } + + @Test + public void computeSyntaxHighlightingOnTempProject() throws IOException { + + File baseDir = temp.newFolder(); + File srcDir = new File(baseDir, "src"); + srcDir.mkdir(); + + File xooFile = new File(srcDir, "sample.xoo"); + File xooSymbolFile = new File(srcDir, "sample.xoo.symbol"); + FileUtils.write(xooFile, "Sample xoo\ncontent\nanother xoo"); + FileUtils.write(xooSymbolFile, "7,10,27"); + + TaskResult result = tester.newTask() + .properties(ImmutableMap.<String, String>builder() + .put("sonar.task", "scan") + .put("sonar.projectBaseDir", baseDir.getAbsolutePath()) + .put("sonar.projectKey", "com.foo.project") + .put("sonar.projectName", "Foo Project") + .put("sonar.projectVersion", "1.0-SNAPSHOT") + .put("sonar.projectDescription", "Description of Foo Project") + .put("sonar.sources", "src") + .build()) + .start(); + + InputFile file = result.inputFiles().get(0); + assertThat(result.symbolReferencesFor(file, 7, 10)).containsOnly(7, 27); + } + +} diff --git a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/XooPlugin.java b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/XooPlugin.java index 43e4c4a04b6..78718da3682 100644 --- a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/XooPlugin.java +++ b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/XooPlugin.java @@ -23,6 +23,7 @@ import org.sonar.api.SonarPlugin; import org.sonar.batch.mediumtest.xoo.plugin.base.Xoo; import org.sonar.batch.mediumtest.xoo.plugin.lang.MeasureSensor; import org.sonar.batch.mediumtest.xoo.plugin.lang.ScmActivitySensor; +import org.sonar.batch.mediumtest.xoo.plugin.lang.SymbolReferencesSensor; import org.sonar.batch.mediumtest.xoo.plugin.lang.SyntaxHighlightingSensor; import org.sonar.batch.mediumtest.xoo.plugin.rule.CreateIssueByInternalKeySensor; import org.sonar.batch.mediumtest.xoo.plugin.rule.OneIssueOnDirPerFileSensor; @@ -40,6 +41,7 @@ public final class XooPlugin extends SonarPlugin { MeasureSensor.class, ScmActivitySensor.class, SyntaxHighlightingSensor.class, + SymbolReferencesSensor.class, Xoo.class, // sensors diff --git a/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/lang/SymbolReferencesSensor.java b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/lang/SymbolReferencesSensor.java new file mode 100644 index 00000000000..91fa61e5c78 --- /dev/null +++ b/sonar-batch/src/test/java/org/sonar/batch/mediumtest/xoo/plugin/lang/SymbolReferencesSensor.java @@ -0,0 +1,98 @@ +/* + * 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.mediumtest.xoo.plugin.lang; + +import com.google.common.base.Splitter; +import org.apache.commons.io.FileUtils; +import org.apache.commons.lang.StringUtils; +import org.sonar.api.batch.fs.InputFile; +import org.sonar.api.batch.sensor.Sensor; +import org.sonar.api.batch.sensor.SensorContext; +import org.sonar.api.batch.sensor.SensorDescriptor; +import org.sonar.api.batch.sensor.symbol.Symbol; +import org.sonar.api.batch.sensor.symbol.SymbolTableBuilder; +import org.sonar.api.measures.CoreMetrics; +import org.sonar.batch.mediumtest.xoo.plugin.base.Xoo; +import org.sonar.batch.mediumtest.xoo.plugin.base.XooConstants; + +import java.io.File; +import java.io.IOException; +import java.util.Iterator; +import java.util.List; + +/** + * Parse files *.xoo.symbol + */ +public class SymbolReferencesSensor implements Sensor { + + private static final String SYMBOL_EXTENSION = ".symbol"; + + private void processFileHighlighting(InputFile inputFile, SensorContext context) { + File ioFile = inputFile.file(); + File symbolFile = new File(ioFile.getParentFile(), ioFile.getName() + SYMBOL_EXTENSION); + if (symbolFile.exists()) { + XooConstants.LOG.debug("Processing " + symbolFile.getAbsolutePath()); + try { + List<String> lines = FileUtils.readLines(symbolFile, context.fileSystem().encoding().name()); + int lineNumber = 0; + SymbolTableBuilder symbolTableBuilder = context.symbolTableBuilder(inputFile); + for (String line : lines) { + lineNumber++; + if (StringUtils.isBlank(line)) { + continue; + } + if (line.startsWith("#")) { + continue; + } + try { + Iterator<String> split = Splitter.on(",").split(line).iterator(); + int startOffset = Integer.parseInt(split.next()); + int endOffset = Integer.parseInt(split.next()); + Symbol s = symbolTableBuilder.newSymbol(startOffset, endOffset); + while (split.hasNext()) { + symbolTableBuilder.newReference(s, Integer.parseInt(split.next())); + } + } catch (Exception e) { + throw new IllegalStateException("Error processing line " + lineNumber + " of file " + symbolFile.getAbsolutePath(), e); + } + } + symbolTableBuilder.done(); + } catch (IOException e) { + throw new RuntimeException(e); + } + } + } + + @Override + public void describe(SensorDescriptor descriptor) { + descriptor + .name("Xoo Highlighting Sensor") + .provides(CoreMetrics.LINES) + .workOnLanguages(Xoo.KEY) + .workOnFileTypes(InputFile.Type.MAIN, InputFile.Type.TEST); + } + + @Override + public void execute(SensorContext context) { + for (InputFile file : context.fileSystem().inputFiles(context.fileSystem().predicates().hasLanguages(Xoo.KEY))) { + processFileHighlighting(file, context); + } + } +} diff --git a/sonar-batch/src/test/java/org/sonar/batch/source/DefaultSymbolTableTest.java b/sonar-batch/src/test/java/org/sonar/batch/source/DefaultSymbolTableTest.java index 2e65c12473b..a1058b27d64 100644 --- a/sonar-batch/src/test/java/org/sonar/batch/source/DefaultSymbolTableTest.java +++ b/sonar-batch/src/test/java/org/sonar/batch/source/DefaultSymbolTableTest.java @@ -35,7 +35,7 @@ public class DefaultSymbolTableTest { @Test public void should_order_symbol_and_references() throws Exception { - Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder(); + Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder("foo"); Symbol firstSymbol = symbolTableBuilder.newSymbol(10, 20); symbolTableBuilder.newReference(firstSymbol, 32); Symbol secondSymbol = symbolTableBuilder.newSymbol(84, 92); @@ -54,16 +54,16 @@ public class DefaultSymbolTableTest { public void should_reject_reference_conflicting_with_declaration() throws Exception { throwable.expect(UnsupportedOperationException.class); - Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder(); + Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder("foo"); Symbol symbol = symbolTableBuilder.newSymbol(10, 20); symbolTableBuilder.newReference(symbol, 15); } @Test public void test_toString() throws Exception { - Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder(); + Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder("foo"); Symbol symbol = symbolTableBuilder.newSymbol(10, 20); - assertThat(symbol.toString()).isEqualTo("Symbol{offset=10-20}"); + assertThat(symbol.toString()).isEqualTo("Symbol{component=foo, offset=10-20}"); } } diff --git a/sonar-batch/src/test/java/org/sonar/batch/source/SymbolDataTest.java b/sonar-batch/src/test/java/org/sonar/batch/source/SymbolDataTest.java deleted file mode 100644 index 8dfdd1cccd5..00000000000 --- a/sonar-batch/src/test/java/org/sonar/batch/source/SymbolDataTest.java +++ /dev/null @@ -1,60 +0,0 @@ -/* - * 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.source; - -import org.junit.Test; -import org.sonar.api.source.Symbol; -import org.sonar.api.source.Symbolizable; - -import static org.fest.assertions.Assertions.assertThat; - -public class SymbolDataTest { - - @Test - public void should_serialize_symbols_in_natural_order() throws Exception { - - Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder(); - Symbol firstSymbol = symbolTableBuilder.newSymbol(10, 20); - symbolTableBuilder.newReference(firstSymbol, 32); - Symbol secondSymbol = symbolTableBuilder.newSymbol(84, 92); - symbolTableBuilder.newReference(secondSymbol, 124); - Symbol thirdSymbol = symbolTableBuilder.newSymbol(55, 62); - symbolTableBuilder.newReference(thirdSymbol, 70); - Symbolizable.SymbolTable symbolTable = symbolTableBuilder.build(); - - SymbolData dataRepository = new SymbolData(symbolTable); - String serializedSymbolData = dataRepository.writeString(); - - assertThat(serializedSymbolData).isEqualTo("10,20,10,32;55,62,55,70;84,92,84,124;"); - } - - @Test - public void should_serialize_unused_symbol() throws Exception { - - Symbolizable.SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTable.Builder(); - symbolTableBuilder.newSymbol(10, 20); - - SymbolData dataRepository = new SymbolData(symbolTableBuilder.build()); - String serializedSymbolData = dataRepository.writeString(); - - assertThat(serializedSymbolData).isEqualTo("10,20,10;"); - } -} diff --git a/sonar-batch/src/test/java/org/sonar/batch/symbol/DefaultSymbolTableBuilderTest.java b/sonar-batch/src/test/java/org/sonar/batch/symbol/DefaultSymbolTableBuilderTest.java new file mode 100644 index 00000000000..c661da30af1 --- /dev/null +++ b/sonar-batch/src/test/java/org/sonar/batch/symbol/DefaultSymbolTableBuilderTest.java @@ -0,0 +1,108 @@ +/* + * 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.symbol; + +import com.google.common.collect.SortedSetMultimap; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.ExpectedException; +import org.mockito.ArgumentCaptor; +import org.sonar.api.batch.sensor.symbol.Symbol; +import org.sonar.api.batch.sensor.symbol.SymbolTableBuilder; +import org.sonar.batch.index.ComponentDataCache; +import org.sonar.core.source.SnapshotDataTypes; + +import java.util.ArrayList; + +import static org.fest.assertions.Assertions.assertThat; +import static org.mockito.Matchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; + +public class DefaultSymbolTableBuilderTest { + + @Rule + public ExpectedException throwable = ExpectedException.none(); + + @Test + public void should_order_symbol_and_references() throws Exception { + ComponentDataCache componentDataCache = mock(ComponentDataCache.class); + SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTableBuilder("foo", componentDataCache); + Symbol firstSymbol = symbolTableBuilder.newSymbol(10, 20); + symbolTableBuilder.newReference(firstSymbol, 32); + Symbol secondSymbol = symbolTableBuilder.newSymbol(84, 92); + symbolTableBuilder.newReference(secondSymbol, 124); + Symbol thirdSymbol = symbolTableBuilder.newSymbol(55, 62); + symbolTableBuilder.newReference(thirdSymbol, 70); + symbolTableBuilder.done(); + + ArgumentCaptor<SymbolData> argCaptor = ArgumentCaptor.forClass(SymbolData.class); + verify(componentDataCache).setData(eq("foo"), eq(SnapshotDataTypes.SYMBOL_HIGHLIGHTING), argCaptor.capture()); + + SortedSetMultimap<Symbol, Integer> referencesBySymbol = argCaptor.getValue().referencesBySymbol(); + + assertThat(new ArrayList<Symbol>(referencesBySymbol.keySet())).containsExactly(firstSymbol, thirdSymbol, secondSymbol); + assertThat(new ArrayList<Integer>(referencesBySymbol.get(firstSymbol))).containsExactly(10, 32); + assertThat(new ArrayList<Integer>(referencesBySymbol.get(secondSymbol))).containsExactly(84, 124); + assertThat(new ArrayList<Integer>(referencesBySymbol.get(thirdSymbol))).containsExactly(55, 70); + + assertThat(argCaptor.getValue().writeString()).isEqualTo("10,20,10,32;55,62,55,70;84,92,84,124;"); + } + + @Test + public void should_serialize_unused_symbol() throws Exception { + + ComponentDataCache componentDataCache = mock(ComponentDataCache.class); + SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTableBuilder("foo", componentDataCache); + symbolTableBuilder.newSymbol(10, 20); + symbolTableBuilder.done(); + + ArgumentCaptor<SymbolData> argCaptor = ArgumentCaptor.forClass(SymbolData.class); + verify(componentDataCache).setData(eq("foo"), eq(SnapshotDataTypes.SYMBOL_HIGHLIGHTING), argCaptor.capture()); + + assertThat(argCaptor.getValue().writeString()).isEqualTo("10,20,10;"); + } + + @Test + public void should_reject_reference_conflicting_with_declaration() throws Exception { + throwable.expect(UnsupportedOperationException.class); + + ComponentDataCache componentDataCache = mock(ComponentDataCache.class); + SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTableBuilder("foo", componentDataCache); + Symbol symbol = symbolTableBuilder.newSymbol(10, 20); + symbolTableBuilder.newReference(symbol, 15); + } + + @Test + public void should_reject_reference_from_another_file() throws Exception { + throwable.expect(UnsupportedOperationException.class); + + ComponentDataCache componentDataCache = mock(ComponentDataCache.class); + SymbolTableBuilder symbolTableBuilder = new DefaultSymbolTableBuilder("foo", componentDataCache); + Symbol symbol = symbolTableBuilder.newSymbol(10, 20); + + SymbolTableBuilder symbolTableBuilder2 = new DefaultSymbolTableBuilder("foo2", componentDataCache); + Symbol symbol2 = symbolTableBuilder2.newSymbol(30, 40); + + symbolTableBuilder.newReference(symbol2, 15); + } + +} |