001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2014 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.xoo.rule;
021
022import org.sonar.api.batch.fs.InputFile;
023import org.sonar.api.batch.rule.ActiveRule;
024import org.sonar.api.batch.sensor.Sensor;
025import org.sonar.api.batch.sensor.SensorContext;
026import org.sonar.api.batch.sensor.SensorDescriptor;
027import org.sonar.xoo.Xoo;
028
029public class CreateIssueByInternalKeySensor implements Sensor {
030
031  private static final String INTERNAL_KEY_PROPERTY = "sonar.xoo.internalKey";
032
033  @Override
034  public void describe(SensorDescriptor descriptor) {
035    descriptor
036      .name("CreateIssueByInternalKeySensor")
037      .workOnLanguages(Xoo.KEY)
038      .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY)
039      .workOnFileTypes(InputFile.Type.MAIN, InputFile.Type.TEST);
040  }
041
042  @Override
043  public void execute(SensorContext context) {
044    for (InputFile file : context.fileSystem().inputFiles(context.fileSystem().predicates().hasLanguages(Xoo.KEY))) {
045      createIssues(file, context);
046    }
047  }
048
049  private void createIssues(InputFile file, SensorContext context) {
050    ActiveRule rule = context.activeRules().findByInternalKey(XooRulesDefinition.XOO_REPOSITORY,
051      context.settings().getString(INTERNAL_KEY_PROPERTY));
052    if (rule != null) {
053      context.addIssue(context.issueBuilder()
054        .ruleKey(rule.ruleKey())
055        .onFile(file)
056        .message("This issue is generated on each file")
057        .build());
058    }
059  }
060}