aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-deprecated/src/test/java/org/sonar/api/rules/RuleAnnotationUtilsTest.java
blob: 98d05bbd1f4e31e3efa657e58279546c522d9ec7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2009 SonarSource SA
 * 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.api.rules;

import org.hamcrest.core.Is;
import org.junit.Test;

import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.core.Is.is;
import static org.hamcrest.core.IsNot.not;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;

public class RuleAnnotationUtilsTest {

  @Test
  public void readAnnotatedClassWithoutParameters() {
    Rule rule = RuleAnnotationUtils.readAnnotatedClass(AnnotatedCheck.class);
    assertNotNull(rule);
    assertThat(rule.getKey(), is(AnnotatedCheck.class.getName()));
    assertThat(rule.getName(), is("Annotated Check"));
    assertThat(rule.getConfigKey(), nullValue());
    assertThat(rule.getParams().size(), is(0));
    assertThat(rule.getDescription(), is("Description"));
    assertThat(rule.getCardinality(), Is.is(Rule.Cardinality.SINGLE));
    assertThat(rule.getRulesCategory().getName(), Is.is(Iso9126RulesCategories.RELIABILITY.getName()));
  }

  @Test
  public void ruleKeyCanBeOverridden() {
    Rule rule = RuleAnnotationUtils.readAnnotatedClass(AnnotatedCheckWithParameters.class);
    assertNotNull(rule);
    assertThat(rule.getKey(), is("overriden_key"));
  }
  @Test
  public void readAnnotatedClassWithParameters() {
    Rule rule = RuleAnnotationUtils.readAnnotatedClass(AnnotatedCheckWithParameters.class);
    assertNotNull(rule);
    assertThat(rule.getParams().size(), is(2));
    assertThat(rule.getParam("max"), not(nullValue()));
    assertThat(rule.getParam("max").getDescription(), is("Maximum value"));

    assertThat(rule.getParam("min"), nullValue());
    assertThat(rule.getParam("overidden_min"), not(nullValue()));
    assertThat(rule.getParam("overidden_min").getDescription(), is("Minimum value"));
  }
}