org.sonarsource.sonarlint.core.container.storage.SonarQubeActiveRulesProvider Maven / Gradle / Ivy

/*
 * SonarLint Core - Implementation
 * Copyright (C) 2016-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.sonarsource.sonarlint.core.container.storage;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Map;
import org.picocontainer.injectors.ProviderAdapter;
import org.sonar.api.batch.rule.ActiveRules;
import org.sonar.api.resources.Languages;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonarsource.sonarlint.core.client.api.connected.ConnectedAnalysisConfiguration;
import org.sonarsource.sonarlint.core.client.api.exceptions.StorageException;
import org.sonarsource.sonarlint.core.container.analysis.SonarLintRules;
import org.sonarsource.sonarlint.core.container.global.DefaultActiveRules;
import org.sonarsource.sonarlint.core.proto.Sonarlint;
import org.sonarsource.sonarlint.core.proto.Sonarlint.ActiveRules.ActiveRule;
import org.sonarsource.sonarlint.core.proto.Sonarlint.QProfiles.QProfile;

public class SonarQubeActiveRulesProvider extends ProviderAdapter {

  private static final Logger LOG = Loggers.get(SonarQubeActiveRulesProvider.class);

  private ActiveRules activeRules;

  public ActiveRules provide(Sonarlint.Rules storageRules, Sonarlint.QProfiles qProfiles, StorageReader storageReader, SonarLintRules rules,
    ConnectedAnalysisConfiguration analysisConfiguration, Languages languages) {
    if (activeRules == null) {

      Map qProfilesByLanguage = loadQualityProfilesFromStorage(qProfiles, storageReader, analysisConfiguration);

      Collection activeRulesList = new ArrayList<>();
      for (Map.Entry entry : qProfilesByLanguage.entrySet()) {
        String language = entry.getKey();
        if (languages.get(language) == null) {
          continue;
        }

        String qProfileKey = entry.getValue();
        QProfile qProfile = qProfiles.getQprofilesByKeyOrThrow(qProfileKey);

        if (qProfile.getActiveRuleCount() == 0) {
          LOG.debug("  * {}: '{}' (0 rules)", language, qProfile.getName());
          continue;
        }

        Sonarlint.ActiveRules activeRulesFromStorage = storageReader.readActiveRules(qProfileKey);

        LOG.debug("  * {}: '{}' ({} rules)", language, qProfile.getName(), activeRulesFromStorage.getActiveRulesByKeyMap().size());

        for (ActiveRule activeRule : activeRulesFromStorage.getActiveRulesByKeyMap().values()) {
          activeRulesList.add(createNewActiveRule(activeRule, storageRules));
        }
      }

      activeRules = new DefaultActiveRules(activeRulesList);
    }
    return activeRules;
  }

  private static org.sonar.api.batch.rule.ActiveRule createNewActiveRule(ActiveRule activeRule, Sonarlint.Rules storageRules) {
    RuleKey ruleKey = RuleKey.of(activeRule.getRepo(), activeRule.getKey());
    Sonarlint.Rules.Rule storageRule;
    try {
      storageRule = storageRules.getRulesByKeyOrThrow(ruleKey.toString());
    } catch (IllegalArgumentException e) {
      throw new StorageException("Unknown active rule in the quality profile of the project. Please update the SonarQube server binding.", e);
    }

    return new StorageActiveRuleAdapter(activeRule, storageRule);
  }

  private static Map loadQualityProfilesFromStorage(Sonarlint.QProfiles qProfiles, StorageReader storageReader,
    ConnectedAnalysisConfiguration analysisConfiguration) {
    Map qProfilesByLanguage;
    if (analysisConfiguration.projectKey() == null) {
      LOG.debug("Use default quality profiles:");
      qProfilesByLanguage = qProfiles.getDefaultQProfilesByLanguageMap();
    } else {
      LOG.debug("Quality profiles:");
      qProfilesByLanguage = storageReader.readProjectConfig(analysisConfiguration.projectKey()).getQprofilePerLanguageMap();
    }
    return qProfilesByLanguage;
  }

}