<artifactId>sonar-gsoc-duplications</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
+ <!-- For ResourcePersister and database access -->
+ <dependency>
+ <groupId>org.codehaus.sonar</groupId>
+ <artifactId>sonar-batch</artifactId>
+ <version>${project.version}</version>
+ <scope>provided</scope>
+ </dependency>
<dependency>
<groupId>org.codehaus.sonar</groupId>
import java.util.Set;
import org.sonar.api.batch.SensorContext;
+import org.sonar.api.database.DatabaseSession;
+import org.sonar.api.database.model.ResourceModel;
+import org.sonar.api.database.model.Snapshot;
import org.sonar.api.measures.CoreMetrics;
import org.sonar.api.measures.Measure;
import org.sonar.api.resources.InputFile;
import org.sonar.api.resources.Language;
import org.sonar.api.resources.Project;
import org.sonar.api.resources.Resource;
+import org.sonar.api.utils.Logs;
+import org.sonar.batch.index.ResourcePersister;
import org.sonar.duplications.block.Block;
import org.sonar.duplications.block.BlockChunker;
import org.sonar.duplications.detector.original.OriginalCloneDetectionAlgorithm;
import org.sonar.duplications.statement.StatementChunker;
import org.sonar.duplications.token.TokenChunker;
import org.sonar.duplications.token.TokenQueue;
+import org.sonar.plugins.cpd.index.CombinedCloneIndex;
+import org.sonar.plugins.cpd.index.DbCloneIndex;
import com.google.common.collect.Lists;
private static final int BLOCK_SIZE = 13;
+ private final ResourcePersister resourcePersister;
+ private final DatabaseSession dbSession;
+
+ public SonarEngine(ResourcePersister resourcePersister, DatabaseSession dbSession) {
+ this.resourcePersister = resourcePersister;
+ this.dbSession = dbSession;
+ }
+
public boolean isLanguageSupported(Language language) {
return Java.INSTANCE.equals(language);
}
+ private static boolean isCrossProject(Project project) {
+ return project.getConfiguration().getBoolean("sonar.cpd.cross_project", false);
+ }
+
+ private static String getFullKey(Project project, Resource resource) {
+ return new StringBuilder(ResourceModel.KEY_SIZE)
+ .append(project.getKey())
+ .append(':')
+ .append(resource.getKey())
+ .toString();
+ }
+
public void analyse(Project project, SensorContext context) {
List<InputFile> inputFiles = project.getFileSystem().mainFiles(project.getLanguageKey());
if (inputFiles.isEmpty()) {
// Create index
CloneIndex index = new PackedMemoryCloneIndex();
+ if (isCrossProject(project)) {
+ Logs.INFO.info("Enabled cross-project analysis");
+ Snapshot currentSnapshot = resourcePersister.getSnapshot(project);
+ Snapshot lastSnapshot = resourcePersister.getLastSnapshot(currentSnapshot, false);
+ DbCloneIndex db = new DbCloneIndex(dbSession, currentSnapshot.getId(), lastSnapshot == null ? null : lastSnapshot.getId());
+ index = new CombinedCloneIndex(index, db);
+ }
TokenChunker tokenChunker = JavaTokenProducer.build();
StatementChunker statementChunker = JavaStatementBuilder.build();
TokenQueue tokenQueue = tokenChunker.chunk(file);
List<Statement> statements = statementChunker.chunk(tokenQueue);
Resource resource = getResource(inputFile);
- List<Block> blocks = blockChunker.chunk(resource.getKey(), statements);
+ List<Block> blocks = blockChunker.chunk(getFullKey(project, resource), statements);
for (Block block : blocks) {
index.insert(block);
}
for (InputFile inputFile : inputFiles) {
Resource resource = getResource(inputFile);
- List<Block> fileBlocks = Lists.newArrayList(index.getByResourceId(resource.getKey()));
+ List<Block> fileBlocks = Lists.newArrayList(index.getByResourceId(getFullKey(project, resource)));
List<CloneGroup> clones = OriginalCloneDetectionAlgorithm.detect(index, fileBlocks);
if (!clones.isEmpty()) {
// Save
--- /dev/null
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+ */
+package org.sonar.plugins.cpd.index;
+
+import java.util.Collection;
+import java.util.List;
+
+import org.sonar.duplications.block.Block;
+import org.sonar.duplications.block.ByteArray;
+import org.sonar.duplications.index.AbstractCloneIndex;
+import org.sonar.duplications.index.CloneIndex;
+
+import com.google.common.collect.Lists;
+
+public class CombinedCloneIndex extends AbstractCloneIndex {
+
+ private final CloneIndex mem;
+ private final DbCloneIndex db;
+
+ public CombinedCloneIndex(CloneIndex mem, DbCloneIndex db) {
+ this.mem = mem;
+ this.db = db;
+ }
+
+ public Collection<Block> getByResourceId(String resourceId) {
+ db.prepareCache(resourceId);
+ return mem.getByResourceId(resourceId);
+ }
+
+ public Collection<Block> getBySequenceHash(ByteArray hash) {
+ List<Block> result = Lists.newArrayList();
+ result.addAll(mem.getBySequenceHash(hash));
+ result.addAll(db.getBySequenceHash(hash));
+ return result;
+ }
+
+ public void insert(Block block) {
+ mem.insert(block);
+ db.insert(block);
+ }
+
+}
--- /dev/null
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+ */
+package org.sonar.plugins.cpd.index;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+import org.sonar.api.database.DatabaseSession;
+import org.sonar.duplications.block.Block;
+import org.sonar.duplications.block.ByteArray;
+import org.sonar.duplications.index.AbstractCloneIndex;
+import org.sonar.jpa.entity.CloneBlock;
+
+import com.google.common.collect.Lists;
+import com.google.common.collect.Maps;
+
+public class DbCloneIndex extends AbstractCloneIndex {
+
+ private final Map<ByteArray, List<Block>> cache = Maps.newHashMap();
+
+ private DatabaseSession session;
+ private int currentSnapshotId;
+ private Integer lastSnapshotId;
+
+ public DbCloneIndex(DatabaseSession session, Integer currentSnapshotId, Integer lastSnapshotId) {
+ this.session = session;
+ this.currentSnapshotId = currentSnapshotId;
+ this.lastSnapshotId = lastSnapshotId;
+ }
+
+ public void prepareCache(String resourceKey) {
+ String sql = "SELECT block.id, hash, block.snapshot_id, resource_key, index_in_file, start_line, end_line FROM clone_blocks AS block, snapshots AS snapshot" +
+ " WHERE block.snapshot_id=snapshot.id AND snapshot.islast=true" +
+ " AND hash IN ( SELECT hash FROM clone_blocks WHERE resource_key = :resource_key AND snapshot_id = :current_snapshot_id )";
+ if (lastSnapshotId != null) {
+ // Filter for blocks from previous snapshot of current project
+ sql += " AND snapshot.id != " + lastSnapshotId;
+ }
+ List<CloneBlock> blocks = session.getEntityManager()
+ .createNativeQuery(sql, CloneBlock.class)
+ .setParameter("resource_key", resourceKey)
+ .setParameter("current_snapshot_id", currentSnapshotId)
+ .getResultList();
+
+ cache.clear();
+ for (CloneBlock dbBlock : blocks) {
+ Block block = new Block(dbBlock.getResourceKey(), new ByteArray(dbBlock.getHash()), dbBlock.getIndexInFile(), dbBlock.getStartLine(), dbBlock.getEndLine());
+
+ List<Block> sameHash = cache.get(block.getBlockHash());
+ if (sameHash == null) {
+ sameHash = Lists.newArrayList();
+ cache.put(block.getBlockHash(), sameHash);
+ }
+ sameHash.add(block);
+ }
+ }
+
+ public Collection<Block> getByResourceId(String resourceId) {
+ throw new UnsupportedOperationException();
+ }
+
+ public Collection<Block> getBySequenceHash(ByteArray sequenceHash) {
+ List<Block> result = cache.get(sequenceHash);
+ if (result != null) {
+ return result;
+ } else {
+ // not in cache
+ return Collections.emptyList();
+ }
+ }
+
+ public void insert(Block block) {
+ CloneBlock dbBlock = new CloneBlock(currentSnapshotId,
+ block.getBlockHash().toString(),
+ block.getResourceId(),
+ block.getIndexInFile(),
+ block.getFirstLineNumber(),
+ block.getLastLineNumber());
+ session.save(dbBlock);
+ }
+
+}
Project project = createJavaProject().setConfiguration(conf);
- CpdSensor sensor = new CpdSensor(new SonarEngine(), new PmdEngine(new CpdMapping[0]));
+ CpdSensor sensor = new CpdSensor(new SonarEngine(null, null), new PmdEngine(new CpdMapping[0]));
assertTrue(sensor.isSkipped(project));
}
public void doNotSkipByDefault() {
Project project = createJavaProject().setConfiguration(new PropertiesConfiguration());
- CpdSensor sensor = new CpdSensor(new SonarEngine(), new PmdEngine(new CpdMapping[0]));
+ CpdSensor sensor = new CpdSensor(new SonarEngine(null, null), new PmdEngine(new CpdMapping[0]));
assertFalse(sensor.isSkipped(project));
}
Project phpProject = createPhpProject().setConfiguration(conf);
Project javaProject = createJavaProject().setConfiguration(conf);
- CpdSensor sensor = new CpdSensor(new SonarEngine(), new PmdEngine(new CpdMapping[0]));
+ CpdSensor sensor = new CpdSensor(new SonarEngine(null, null), new PmdEngine(new CpdMapping[0]));
assertTrue(sensor.isSkipped(phpProject));
assertFalse(sensor.isSkipped(javaProject));
}
--- /dev/null
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+ */
+package org.sonar.plugins.cpd.index;
+
+import static org.hamcrest.Matchers.is;
+import static org.junit.Assert.assertThat;
+
+import java.util.Collection;
+import java.util.Iterator;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.sonar.duplications.block.Block;
+import org.sonar.duplications.block.ByteArray;
+import org.sonar.jpa.test.AbstractDbUnitTestCase;
+
+public class DbCloneIndexTest extends AbstractDbUnitTestCase {
+
+ private DbCloneIndex index;
+
+ @Before
+ public void setUp() {
+ index = new DbCloneIndex(getSession(), 5, 4);
+ }
+
+ @Test(expected = UnsupportedOperationException.class)
+ public void shouldNotGetByResource() {
+ index.getByResourceId("foo");
+ }
+
+ @Test
+ public void shouldGetByHash() {
+ setupData("fixture");
+
+ index.prepareCache("foo");
+ Collection<Block> blocks = index.getBySequenceHash(new ByteArray("aa"));
+ Iterator<Block> blocksIterator = blocks.iterator();
+
+ assertThat(blocks.size(), is(1));
+
+ Block block = blocksIterator.next();
+ assertThat(block.getResourceId(), is("bar-last"));
+ }
+
+ @Test
+ public void shouldInsert() {
+ setupData("fixture");
+
+ index.insert(new Block("baz", new ByteArray("bb"), 0, 0, 1));
+
+ checkTables("shouldInsert", "clone_blocks");
+ }
+
+}
--- /dev/null
+<dataset>
+
+ <snapshots id="1" status="P" islast="false" />
+ <snapshots id="2" status="P" islast="true" />
+
+ <snapshots id="3" status="P" islast="false" />
+ <snapshots id="4" status="P" islast="true" />
+ <snapshots id="5" status="U" islast="false" />
+
+ <!-- Old snapshot of another project -->
+ <clone_blocks id="1" snapshot_id="1" hash="aa" resource_key="bar-old" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Last snapshot of another project -->
+ <clone_blocks id="2" snapshot_id="2" hash="aa" resource_key="bar-last" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Old snapshot of current project -->
+ <clone_blocks id="3" snapshot_id="3" hash="aa" resource_key="foo-old" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Last snapshot of current project -->
+ <clone_blocks id="4" snapshot_id="4" hash="aa" resource_key="foo-last" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- New snapshot of current project -->
+ <clone_blocks id="5" snapshot_id="5" hash="aa" resource_key="foo" index_in_file="0" start_line="0" end_line="1" />
+
+</dataset>
--- /dev/null
+<dataset>
+
+ <snapshots id="1" status="P" islast="false" />
+ <snapshots id="2" status="P" islast="true" />
+
+ <snapshots id="3" status="P" islast="false" />
+ <snapshots id="4" status="P" islast="true" />
+ <snapshots id="5" status="U" islast="false" />
+
+ <!-- Old snapshot of another project -->
+ <clone_blocks id="1" snapshot_id="1" hash="aa" resource_key="bar-old" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Last snapshot of another project -->
+ <clone_blocks id="2" snapshot_id="2" hash="aa" resource_key="bar-last" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Old snapshot of current project -->
+ <clone_blocks id="3" snapshot_id="3" hash="aa" resource_key="foo-old" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- Last snapshot of current project -->
+ <clone_blocks id="4" snapshot_id="4" hash="aa" resource_key="foo-last" index_in_file="0" start_line="0" end_line="1" />
+
+ <!-- New snapshot of current project -->
+ <clone_blocks id="5" snapshot_id="5" hash="aa" resource_key="foo" index_in_file="0" start_line="0" end_line="1" />
+
+ <clone_blocks id="6" snapshot_id="5" hash="bb" resource_key="baz" index_in_file="0" start_line="0" end_line="1" />
+
+</dataset>
--- /dev/null
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2008-2011 SonarSource
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+ */
+package org.sonar.jpa.entity;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+import javax.persistence.Table;
+
+import org.sonar.api.database.model.ResourceModel;
+
+/**
+ * @since 2.11
+ */
+@Entity
+@Table(name = "clone_blocks")
+public class CloneBlock {
+
+ public static final int BLOCK_HASH_SIZE = 50;
+
+ @Id
+ @Column(name = "id")
+ @GeneratedValue
+ private Integer id;
+
+ @Column(name = "snapshot_id", updatable = false, nullable = false)
+ private Integer snapshotId;
+
+ @Column(name = "hash", updatable = false, nullable = false, length = BLOCK_HASH_SIZE)
+ private String hash;
+
+ @Column(name = "resource_key", updatable = false, nullable = false, length = ResourceModel.KEY_SIZE)
+ private String resourceKey;
+
+ @Column(name = "index_in_file", updatable = false, nullable = false)
+ private Integer indexInFile;
+
+ @Column(name = "start_line", updatable = false, nullable = false)
+ private Integer startLine;
+
+ @Column(name = "end_line", updatable = false, nullable = false)
+ private Integer endLine;
+
+ public CloneBlock() {
+ }
+
+ public CloneBlock(Integer snapshotId, String hash, String resourceKey, Integer indexInFile, Integer startLine, Integer endLine) {
+ this.snapshotId = snapshotId;
+ this.hash = hash;
+ this.indexInFile = indexInFile;
+ this.resourceKey = resourceKey;
+ this.startLine = startLine;
+ this.endLine = endLine;
+ }
+
+ public Integer getId() {
+ return id;
+ }
+
+ public Integer getSnapshotId() {
+ return snapshotId;
+ }
+
+ public String getResourceKey() {
+ return resourceKey;
+ }
+
+ public String getHash() {
+ return hash;
+ }
+
+ public Integer getIndexInFile() {
+ return indexInFile;
+ }
+
+ public Integer getStartLine() {
+ return startLine;
+ }
+
+ public Integer getEndLine() {
+ return endLine;
+ }
+
+}
- complete the Derby DDL file used for unit tests : sonar-testing-harness/src/main/resources/org/sonar/test/persistence/sonar-test.ddl
*/
- public static final int LAST_VERSION = 216;
+ public static final int LAST_VERSION = 217;
public final static String TABLE_NAME = "schema_migrations";
<class>org.sonar.api.rules.ActiveRuleParamChange</class>
<class>org.sonar.jpa.entity.Review</class>
<class>org.sonar.jpa.entity.NotificationQueueElement</class>
+ <class>org.sonar.jpa.entity.CloneBlock</class>
<properties>
<property name="hibernate.current_session_context_class" value="thread"/>
--- /dev/null
+#
+# Sonar, entreprise quality control tool.
+# Copyright (C) 2008-2011 SonarSource
+# mailto:contact AT sonarsource DOT com
+#
+# Sonar 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.
+#
+# Sonar 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 Sonar; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
+#
+
+#
+# Sonar 2.11
+#
+class CreateCloneBlocks < ActiveRecord::Migration
+
+ def self.up
+ create_table :clone_blocks do |t|
+ t.column :snapshot_id, :integer, :null => false
+ t.column :hash, :string, :null => false, :limit => 50
+ t.column :resource_key, :string, :null => false, :limit => 400
+ t.column :index_in_file, :integer, :null => false
+ t.column :start_line, :integer, :null => false
+ t.column :end_line, :integer, :null => false
+ end
+
+ add_index :clone_blocks, :hash, :name => 'clone_blocks_hash'
+ add_index :clone_blocks, [:snapshot_id, :resource_key], :name => 'clone_blocks_resource'
+ end
+
+end
REVIEW_TEXT CLOB(2147483647),
primary key (id)
);
+
+CREATE TABLE CLONE_BLOCKS (
+ SNAPSHOT_ID INTEGER,
+ HASH VARCHAR(50),
+ RESOURCE_KEY VARCHAR(400),
+ INDEX_IN_FILE INTEGER NOT NULL,
+ START_LINE INTEGER NOT NULL,
+ END_LINE INTEGER NOT NULL
+);
+CREATE INDEX CLONE_BLOCKS_HASH ON CLONE_BLOCKS (HASH);
+CREATE INDEX CLONE_BLOCKS_RESOURCE ON CLONE_BLOCKS (SNAPSHOT_ID, RESOURCE_KEY);