source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2017 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.qualityprofile;
  21
  22 import java.util.Arrays;
  23 import org.junit.Rule;
  24 import org.junit.Test;
  25 import org.junit.rules.ExpectedException;
  26 import org.sonar.api.profiles.RulesProfile;
  27 import org.sonar.api.rules.ActiveRule;
  28 import org.sonar.api.rules.RulePriority;
  29 import org.sonar.api.utils.System2;
  30 import org.sonar.api.utils.internal.AlwaysIncreasingSystem2;
  31 import org.sonar.api.utils.log.LogTester;
  32 import org.sonar.core.util.UuidFactoryFast;
  33 import org.sonar.db.DbClient;
  34 import org.sonar.db.DbTester;
  35 import org.sonar.db.qualityprofile.ActiveRuleDto;
  36 import org.sonar.db.qualityprofile.RulesProfileDto;
  37 import org.sonar.db.rule.RuleDefinitionDto;
  38 import org.sonar.server.qualityprofile.index.ActiveRuleIndexer;
  39 import org.sonar.server.rule.index.RuleIndex;
  40 import org.sonar.server.tester.UserSessionRule;
  41 import org.sonar.server.util.TypeValidations;
  42
  43 import static org.apache.commons.lang.RandomStringUtils.randomAlphanumeric;
  44 import static org.apache.commons.lang.math.RandomUtils.nextLong;
  45 import static org.mockito.Mockito.mock;
  46 import static org.mockito.Mockito.verify;
  47 import static org.mockito.Mockito.verifyZeroInteractions;
  48 import static org.sonar.api.rules.Rule.create;
  49 import static org.sonar.api.rules.RulePriority.MAJOR;
  50 import static org.sonar.db.qualityprofile.QualityProfileTesting.newRuleProfileDto;
  51 import static org.sonar.server.language.LanguageTesting.newLanguage;
  52
  53 public class RegisterQualityProfilesNotificationTest {
  54
  55   private System2 system2 = new AlwaysIncreasingSystem2();
  56   @Rule
  57   public DbTester db = DbTester.create(system2);
  58   @Rule
  59   public UserSessionRule userSessionRule = UserSessionRule.standalone();
  60   @Rule
  61   public ExpectedException expectedException = ExpectedException.none();
  62   @Rule
  63   public BuiltInQProfileRepositoryRule builtInQProfileRepositoryRule = new BuiltInQProfileRepositoryRule();
  64   @Rule
  65   public LogTester logTester = new LogTester();
  66
  67   private DbClient dbClient = db.getDbClient();
  68   private TypeValidations typeValidations = mock(TypeValidations.class);
  69   private ActiveRuleIndexer activeRuleIndexer = mock(ActiveRuleIndexer.class);
  70   private BuiltInQProfileInsert builtInQProfileInsert = new BuiltInQProfileInsertImpl(dbClient, system2, UuidFactoryFast.getInstance(), typeValidations, activeRuleIndexer);
  71   private RuleActivator ruleActivator = new RuleActivator(system2, dbClient, mock(RuleIndex.class), new RuleActivatorContextFactory(dbClient), typeValidations, activeRuleIndexer,
  72     userSessionRule);
  73   private BuiltInQProfileUpdate builtInQProfileUpdate = new BuiltInQProfileUpdateImpl(dbClient, ruleActivator, activeRuleIndexer);
  74   private BuiltInQualityProfilesNotification builtInQualityProfilesNotification = mock(BuiltInQualityProfilesNotification.class);
  75   private RegisterQualityProfiles underTest = new RegisterQualityProfiles(builtInQProfileRepositoryRule, dbClient,
  76     builtInQProfileInsert, builtInQProfileUpdate, builtInQualityProfilesNotification);
  77
  78   @Test
  79   public void does_not_send_notification_on_new_profile() {
  80     String language = newLanguageKey();
  81     builtInQProfileRepositoryRule.add(newLanguage(language), "Sonar way");
  82     builtInQProfileRepositoryRule.initialize();
  83
  84     underTest.start();
  85
  86     verifyZeroInteractions(builtInQualityProfilesNotification);
  87   }
  88
  89   @Test
  90   public void does_not_send_notification_when_built_in_profile_is_not_updated() {
  91     String language = newLanguageKey();
  92     RuleDefinitionDto dbRule = db.rules().insert(r -> r.setLanguage(language));
  93     RulesProfileDto dbProfile = insertBuiltInProfile(language);
  94     activateRuleInDb(dbProfile, dbRule, MAJOR);
  95     addPluginProfile(dbProfile, dbRule);
  96     builtInQProfileRepositoryRule.initialize();
  97
  98     underTest.start();
  99
 100     verifyZeroInteractions(builtInQualityProfilesNotification);
 101   }
 102
 103   @Test
 104   public void send_notification_when_built_in_profile_contains_new_rule() {
 105     String language = newLanguageKey();
 106     RuleDefinitionDto existingRule = db.rules().insert(r -> r.setLanguage(language));
 107     RulesProfileDto dbProfile = insertBuiltInProfile(language);
 108     activateRuleInDb(dbProfile, existingRule, MAJOR);
 109     RuleDefinitionDto newRule = db.rules().insert(r -> r.setLanguage(language));
 110     addPluginProfile(dbProfile, existingRule, newRule);
 111     builtInQProfileRepositoryRule.initialize();
 112
 113     underTest.start();
 114
 115     verify(builtInQualityProfilesNotification).send();
 116   }
 117
 118   @Test
 119   public void only_send_one_notification_when_several_built_in_profiles_contain_new_rules() {
 120     String language = newLanguageKey();
 121     RuleDefinitionDto existingRule = db.rules().insert(r -> r.setLanguage(language));
 122     RuleDefinitionDto newRule = db.rules().insert(r -> r.setLanguage(language));
 123
 124     RulesProfileDto dbProfile1 = insertBuiltInProfile(language);
 125     activateRuleInDb(dbProfile1, existingRule, MAJOR);
 126     addPluginProfile(dbProfile1, existingRule, newRule);
 127
 128     RulesProfileDto dbProfile2 = insertBuiltInProfile(language);
 129     activateRuleInDb(dbProfile2, existingRule, MAJOR);
 130     addPluginProfile(dbProfile2, existingRule, newRule);
 131     builtInQProfileRepositoryRule.initialize();
 132
 133     underTest.start();
 134
 135     verify(builtInQualityProfilesNotification).send();
 136   }
 137
 138   private void addPluginProfile(RulesProfileDto dbProfile, RuleDefinitionDto... dbRules) {
 139     RulesProfile pluginProfile = RulesProfile.create(dbProfile.getName(), dbProfile.getLanguage());
 140     Arrays.stream(dbRules).forEach(dbRule -> pluginProfile.activateRule(create(dbRule.getRepositoryKey(), dbRule.getRuleKey()), MAJOR));
 141     builtInQProfileRepositoryRule.add(newLanguage(dbProfile.getLanguage()), dbProfile.getName(), false, pluginProfile.getActiveRules().toArray(new ActiveRule[0]));
 142   }
 143
 144   private RulesProfileDto insertBuiltInProfile(String language) {
 145     RulesProfileDto ruleProfileDto = newRuleProfileDto(rp -> rp.setIsBuiltIn(true).setLanguage(language));
 146     db.getDbClient().qualityProfileDao().insert(db.getSession(), ruleProfileDto);
 147     db.commit();
 148     return ruleProfileDto;
 149   }
 150
 151   private void activateRuleInDb(RulesProfileDto profile, RuleDefinitionDto rule, RulePriority severity) {
 152     ActiveRuleDto dto = new ActiveRuleDto()
 153       .setProfileId(profile.getId())
 154       .setSeverity(severity.name())
 155       .setRuleId(rule.getId())
 156       .setCreatedAt(nextLong())
 157       .setUpdatedAt(nextLong());
 158     db.getDbClient().activeRuleDao().insert(db.getSession(), dto);
 159     db.commit();
 160   }
 161
 162   private static String newLanguageKey() {
 163     return randomAlphanumeric(20).toLowerCase();
 164   }
 165 }