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.FilePredicates;
023import org.sonar.api.batch.fs.FileSystem;
024import org.sonar.api.batch.fs.InputFile;
025import org.sonar.api.batch.fs.InputFile.Type;
026import org.sonar.api.batch.rule.ActiveRule;
027import org.sonar.api.batch.sensor.Sensor;
028import org.sonar.api.batch.sensor.SensorContext;
029import org.sonar.api.batch.sensor.SensorDescriptor;
030import org.sonar.xoo.Xoo;
031
032public class CreateIssueByInternalKeySensor implements Sensor {
033
034  private static final String INTERNAL_KEY_PROPERTY = "sonar.xoo.internalKey";
035
036  @Override
037  public void describe(SensorDescriptor descriptor) {
038    descriptor
039      .name("CreateIssueByInternalKeySensor")
040      .onlyOnLanguages(Xoo.KEY)
041      .createIssuesForRuleRepositories(XooRulesDefinition.XOO_REPOSITORY);
042  }
043
044  @Override
045  public void execute(SensorContext context) {
046    FileSystem fs = context.fileSystem();
047    FilePredicates p = fs.predicates();
048    for (InputFile file : fs.inputFiles(p.and(p.hasLanguages(Xoo.KEY), p.hasType(Type.MAIN)))) {
049      createIssues(file, context);
050    }
051  }
052
053  private void createIssues(InputFile file, SensorContext context) {
054    ActiveRule rule = context.activeRules().findByInternalKey(XooRulesDefinition.XOO_REPOSITORY,
055      context.settings().getString(INTERNAL_KEY_PROPERTY));
056    if (rule != null) {
057      context.newIssue()
058        .forRule(rule.ruleKey())
059        .onFile(file)
060        .message("This issue is generated on each file")
061        .save();
062    }
063  }
064}