assertThat(ruleDto.getId()).isEqualTo(1);
assertThat(ruleDto.getName()).isEqualTo("Avoid Null");
assertThat(ruleDto.getDescription()).isEqualTo("Should avoid NULL");
+ assertThat(ruleDto.getDescriptionFormat()).isEqualTo("HTML");
assertThat(ruleDto.getStatus()).isEqualTo(RuleStatus.READY);
assertThat(ruleDto.getRepositoryKey()).isEqualTo("checkstyle");
assertThat(ruleDto.getNoteData()).isEqualTo("Rule note with accents \u00e9\u00e8\u00e0");
assertThat(ruleDto.getId()).isEqualTo(1);
assertThat(ruleDto.getName()).isEqualTo("Avoid Null");
assertThat(ruleDto.getDescription()).isEqualTo("Should avoid NULL");
+ assertThat(ruleDto.getDescriptionFormat()).isEqualTo("HTML");
assertThat(ruleDto.getStatus()).isEqualTo(RuleStatus.READY);
assertThat(ruleDto.getRepositoryKey()).isEqualTo("checkstyle");
assertThat(ruleDto.getNoteData()).isEqualTo("Rule note with accents \u00e9\u00e8\u00e0");
assertThat(ruleDto.getId()).isEqualTo(2);
assertThat(ruleDto.getName()).isEqualTo("Avoid Null");
assertThat(ruleDto.getDescription()).isEqualTo("Should avoid NULL");
+ assertThat(ruleDto.getDescriptionFormat()).isEqualTo("HTML");
assertThat(ruleDto.getStatus()).isEqualTo(RuleStatus.READY);
assertThat(ruleDto.getRepositoryKey()).isEqualTo("checkstyle");
}
.setRepositoryKey("plugin")
.setName("new name")
.setDescription("new description")
+ .setDescriptionFormat("MARKDOWN")
.setStatus(RuleStatus.DEPRECATED)
.setConfigKey("NewConfigKey")
.setSeverity(Severity.INFO)
.setRepositoryKey("plugin")
.setName("new name")
.setDescription("new description")
+ .setDescriptionFormat("MARKDOWN")
.setStatus(RuleStatus.DEPRECATED)
.setConfigKey("NewConfigKey")
.setSeverity(Severity.INFO)
.setRepositoryKey("plugin")
.setName("new name")
.setDescription("new description")
+ .setDescriptionFormat("HTML")
.setStatus(RuleStatus.DEPRECATED)
.setConfigKey("NewConfigKey")
.setSeverity(Severity.INFO)
.setRepositoryKey("plugin2")
.setName("new name2")
.setDescription("new description2")
+ .setDescriptionFormat("MARKDOWN")
.setStatus(RuleStatus.BETA)
.setConfigKey("NewConfigKey2")
.setSeverity(Severity.MAJOR)
remediation_function="LINEAR" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="1h" default_remediation_coeff="5d"
remediation_offset="5min" default_remediation_offset="10h"
- effort_to_fix_description="squid.S115.effortToFix"
+ effort_to_fix_description="squid.S115.effortToFix" description_format="MARKDOWN"
/>
</dataset>
remediation_function="LINEAR" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="1h" default_remediation_coeff="5d"
remediation_offset="5min" default_remediation_offset="10h"
- effort_to_fix_description="squid.S115.effortToFix"
+ effort_to_fix_description="squid.S115.effortToFix" description_format="HTML"
/>
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="NewRuleKey2" plugin_name="plugin2" name="new name2" description="new description2" status="BETA"
remediation_function="LINEAR_OFFSET" default_remediation_function="LINEAR"
remediation_coeff="5d" default_remediation_coeff="1h"
remediation_offset="10h" default_remediation_offset="5min"
- effort_to_fix_description="squid.S115.effortToFix2"
+ effort_to_fix_description="squid.S115.effortToFix2" description_format="MARKDOWN"
/>
</dataset>
<dataset>
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"
- note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25"
+ note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25" description_format="HTML"
characteristic_id="100" default_characteristic_id="101"
remediation_function="linear" default_remediation_function="linear_offset"
remediation_coeff="1h" default_remediation_coeff="5d"
<dataset>
- <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY"/>
- <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"/>
+ <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY" description_format="HTML"/>
+ <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY" description_format="HTML"/>
</dataset>
<dataset>
- <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"/>
- <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="manual" name="Manual Rule" description="Should not appear" status="READY"/>
+ <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY" description_format="HTML"/>
+ <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="manual" name="Manual Rule" description="Should not appear" status="READY" description_format="HTML"/>
</dataset>
<dataset>
- <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY"/>
- <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"/>
+ <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY" description_format="HTML"/>
+ <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY" description_format="HTML"/>
</dataset>
<dataset>
- <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY"/>
- <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"/>
+ <rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidComparison" plugin_name="checkstyle" name="Avoid Comparison" description="Should avoid ==" status="READY" description_format="HTML"/>
+ <rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY" description_format="HTML"/>
</dataset>
<dataset>
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"
- note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25"
+ note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25" description_format="HTML"
characteristic_id="100" default_characteristic_id="101"
remediation_function="LINEAR" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="1h" default_remediation_coeff="5d"
effort_to_fix_description="squid.S115.effortToFix"/>
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="squid" name="Avoid Null" description="Should avoid NULL" status="REMOVED"
- note_data="[null]" note_user_login="[null]" note_created_at="[null]"
+ note_data="[null]" note_user_login="[null]" note_created_at="[null]" description_format="HTML"
characteristic_id="[null]" default_characteristic_id="[null]"
remediation_function="[null]" default_remediation_function="[null]"
remediation_coeff="[null]" default_remediation_coeff="[null]"
effort_to_fix_description="[null]"/>
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="AvoidNull" plugin_name="manual" name="Manual Rule" description="Should not appear" status="READY"
- note_data="[null]" note_user_login="[null]" note_created_at="[null]"
+ note_data="[null]" note_user_login="[null]" note_created_at="[null]" description_format="HTML"
characteristic_id="[null]" default_characteristic_id="[null]"
remediation_function="[null]" default_remediation_function="[null]"
remediation_coeff="[null]" default_remediation_coeff="[null]"
remediation_function="LINEAR" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="1h" default_remediation_coeff="5d"
remediation_offset="5min" default_remediation_offset="10h"
- effort_to_fix_description="squid.S115.effortToFix"
+ effort_to_fix_description="squid.S115.effortToFix" description_format="MARKDOWN"
/>
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="Parent1" plugin_name="checkstyle" name="Parent Rule 1" description="Parent Rule 1" status="READY"
plugin_config_key="Parent1" priority="2" is_template="[false]" language="golo" created_at="1981-10-24 15:20:00" updated_at="[null]" template_id="[null]"
- note_created_at="[null]" note_data="[null]" note_updated_at="[null]" note_user_login="[null]"/>
+ note_created_at="[null]" note_data="[null]" note_updated_at="[null]" note_user_login="[null]" description_format="HTML"/>
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="Parent2" plugin_name="checkstyle" name="Parent Rule 2" description="Parent Rule 2" status="READY"
plugin_config_key="Parent2" priority="2" is_template="[false]" language="dart" created_at="1982-12-14 03:15:00" updated_at="[null]" template_id="[null]"
- note_created_at="[null]" note_data="[null]" note_updated_at="[null]" note_user_login="[null]"/>
+ note_created_at="[null]" note_data="[null]" note_updated_at="[null]" note_user_login="[null]" description_format="HTML"/>
</dataset>
<dataset>
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"
- plugin_config_key="AvoidNull" priority="2" is_template="[false]" language="golo" created_at="2011-04-25 01:05:00" template_id="2"/>
+ plugin_config_key="AvoidNull" priority="2" is_template="[false]" language="golo" created_at="2011-04-25 01:05:00" template_id="2" description_format="HTML"/>
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="Parent1" plugin_name="checkstyle" name="Parent Rule 1" description="Parent Rule 1" status="READY"
- plugin_config_key="Parent1" priority="2" is_template="[false]" language="golo" created_at="1981-10-24 15:20:00" />
+ plugin_config_key="Parent1" priority="2" is_template="[false]" language="golo" created_at="1981-10-24 15:20:00" description_format="HTML"/>
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="Parent2" plugin_name="checkstyle" name="Parent Rule 2" description="Parent Rule 2" status="READY"
- plugin_config_key="Parent2" priority="2" is_template="[false]" language="dart" created_at="1982-12-14 03:15:00" />
+ plugin_config_key="Parent2" priority="2" is_template="[false]" language="dart" created_at="1982-12-14 03:15:00" description_format="HTML"/>
</dataset>
<!-- Constant/issue with coefficient -> Update rule to Constant/issue with offset -->
<rules id="1" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]"
<!-- Constant/issue with coefficient and offset -> Update rule to Constant/issue with only offset -->
<rules id="2" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]"
<!-- Constant/issue with coefficient but having same value as default -> No update -->
<rules id="3" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="CONSTANT_ISSUE"
remediation_coeff="[null]" default_remediation_coeff="[null]"
remediation_offset="[null]" default_remediation_offset="5min"
<!-- Constant/issue with coefficient -> Update rule to Constant/issue with offset -->
<rules id="1" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="10" default_characteristic_id="10"
+ characteristic_id="10" default_characteristic_id="10" description_format="HTML"
remediation_function="CONSTANT_ISSUE" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="20min" default_remediation_offset="[null]"
<!-- Constant/issue with coefficient and offset -> Update rule to Constant/issue with only offset -->
<rules id="2" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="10" default_characteristic_id="10"
+ characteristic_id="10" default_characteristic_id="10" description_format="HTML"
remediation_function="CONSTANT_ISSUE" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="30min" default_remediation_offset="[null]"
<!-- Constant/issue with coefficient but having same value as default -> No update -->
<rules id="3" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="CONSTANT_ISSUE"
remediation_coeff="[null]" default_remediation_coeff="[null]"
remediation_offset="[null]" default_remediation_offset="5min"
<!-- Rule not linked to a requirement -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="UselessImportCheck" plugin_name="squid" name="UselessImportCheck" description="Useless imports should be removed" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to a disabled requirement -> Update rule to disable characteristic -->
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="LeftCurlyBraceStartLineCheck" plugin_name="squid" name="LeftCurlyBraceStartLineCheck" description="Left curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Removed rule linked to a disabled requirement -> Do nothing -->
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="CallToFileDeleteOnExitMethod" plugin_name="squid" name="CallToFileDeleteOnExitMethod" description="CallToFileDeleteOnExitMethod" status="REMOVED"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with same value of debt -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="4" plugin_rule_key="ObjectFinalizeOverridenCallsSuperFinalizeCheck" plugin_name="squid" name="ObjectFinalizeOverridenCallsSuperFinalizeCheck" description="super.finalize() should be called at the end of Object.finalize() implementations" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5min"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="5" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Constant per issue function (with a coefficient of 0d -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="6" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0min -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="7" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear with offset function (with a offset of 0h -> should be replaced by 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="8" plugin_rule_key="ClassVariableVisibilityCheck" plugin_name="squid" name="ClassVariableVisibilityCheck" description="ClassVariableVisibilityCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0d -> should keep 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="9" plugin_rule_key="SwitchLastCaseIsDefaultCheck" plugin_name="squid" name="SwitchLastCaseIsDefaultCheck" description="SwitchLastCaseIsDefaultCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule not linked to a requirement -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="UselessImportCheck" plugin_name="squid" name="UselessImportCheck" description="Useless imports should be removed" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to a disabled requirements -> Update rule to disable characteristic -->
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="LeftCurlyBraceStartLineCheck" plugin_name="squid" name="LeftCurlyBraceStartLineCheck" description="Left curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="-1" default_characteristic_id="10"
+ characteristic_id="-1" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-03-13"
<!-- Removed rule linked to a disabled requirement -> Do nothing -->
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="CallToFileDeleteOnExitMethod" plugin_name="squid" name="CallToFileDeleteOnExitMethod" description="CallToFileDeleteOnExitMethod" status="REMOVED"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement, with same value of debt -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="4" plugin_rule_key="ObjectFinalizeOverridenCallsSuperFinalizeCheck" plugin_name="squid" name="ObjectFinalizeOverridenCallsSuperFinalizeCheck" description="super.finalize() should be called at the end of Object.finalize() implementations" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5min"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement, with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="5" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="10" default_characteristic_id="20"
+ characteristic_id="10" default_characteristic_id="20" description_format="HTML"
remediation_function="LINEAR_OFFSET" default_remediation_function="LINEAR"
remediation_coeff="20min" default_remediation_coeff="5d"
remediation_offset="30h" default_remediation_offset="[null]" updated_at="2014-03-13"
<!-- Rule linked to one enable requirement on Constant per issue function (with a coefficient of 0d -> to be replaced by null), with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="6" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="10" default_characteristic_id="20"
+ characteristic_id="10" default_characteristic_id="20" description_format="HTML"
remediation_function="CONSTANT_ISSUE" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="15min" default_remediation_offset="[null]" updated_at="2014-03-13"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0min -> to be replaced by null), with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="7" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="10" default_characteristic_id="20"
+ characteristic_id="10" default_characteristic_id="20" description_format="HTML"
remediation_function="LINEAR" default_remediation_function="LINEAR"
remediation_coeff="0min" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-03-13"
<!-- Rule linked to one enable requirement on Linear with offset function (with a offset of 0h -> should keep 0h), with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="8" plugin_rule_key="ClassVariableVisibilityCheck" plugin_name="squid" name="ClassVariableVisibilityCheck" description="ClassVariableVisibilityCheck" status="READY"
- characteristic_id="10" default_characteristic_id="20"
+ characteristic_id="10" default_characteristic_id="20" description_format="HTML"
remediation_function="LINEAR_OFFSET" default_remediation_function="LINEAR"
remediation_coeff="5d" default_remediation_coeff="5d"
remediation_offset="0h" default_remediation_offset="[null" updated_at="2014-03-13"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0d -> should keep 0d), with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="9" plugin_rule_key="SwitchLastCaseIsDefaultCheck" plugin_name="squid" name="SwitchLastCaseIsDefaultCheck" description="SwitchLastCaseIsDefaultCheck" status="READY"
- characteristic_id="10" default_characteristic_id="20"
+ characteristic_id="10" default_characteristic_id="20" description_format="HTML"
remediation_function="LINEAR" default_remediation_function="LINEAR"
remediation_coeff="0d" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-03-13"
<!-- Rule not linked to a requirement -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="UselessImportCheck" plugin_name="squid" name="UselessImportCheck" description="Useless imports should be removed" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to a disabled requirement -> Update rule to disable characteristic -->
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="LeftCurlyBraceStartLineCheck" plugin_name="squid" name="LeftCurlyBraceStartLineCheck" description="Left curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Removed rule linked to a disabled requirement -> Do nothing -->
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="CallToFileDeleteOnExitMethod" plugin_name="squid" name="CallToFileDeleteOnExitMethod" description="CallToFileDeleteOnExitMethod" status="REMOVED"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with same value of debt -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="4" plugin_rule_key="ObjectFinalizeOverridenCallsSuperFinalizeCheck" plugin_name="squid" name="ObjectFinalizeOverridenCallsSuperFinalizeCheck" description="super.finalize() should be called at the end of Object.finalize() implementations" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5min"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="5" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Constant per issue function (with a coefficient of 0d -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="6" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0min -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="7" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear with offset function (with a offset of 0h -> should be replaced by 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="8" plugin_rule_key="ClassVariableVisibilityCheck" plugin_name="squid" name="ClassVariableVisibilityCheck" description="ClassVariableVisibilityCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0d -> should keep 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="9" plugin_rule_key="SwitchLastCaseIsDefaultCheck" plugin_name="squid" name="SwitchLastCaseIsDefaultCheck" description="SwitchLastCaseIsDefaultCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule not linked to a requirement -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="UselessImportCheck" plugin_name="squid" name="UselessImportCheck" description="Useless imports should be removed" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to a disabled requirement -> Update rule to disable characteristic -->
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="LeftCurlyBraceStartLineCheck" plugin_name="squid" name="LeftCurlyBraceStartLineCheck" description="Left curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Removed rule linked to a disabled requirement -> Do nothing -->
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="CallToFileDeleteOnExitMethod" plugin_name="squid" name="CallToFileDeleteOnExitMethod" description="CallToFileDeleteOnExitMethod" status="REMOVED"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with same value of debt -> Nothing to do -->
<rules tags="[null]" system_tags="[null]" id="4" plugin_rule_key="ObjectFinalizeOverridenCallsSuperFinalizeCheck" plugin_name="squid" name="ObjectFinalizeOverridenCallsSuperFinalizeCheck" description="super.finalize() should be called at the end of Object.finalize() implementations" status="READY"
- characteristic_id="[null]" default_characteristic_id="10"
+ characteristic_id="[null]" default_characteristic_id="10" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="[null]" default_remediation_coeff="5min"
remediation_offset="[null]" default_remediation_offset="10h" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="5" plugin_rule_key="RightCurlyBraceStartLineCheck" plugin_name="squid" name="RightCurlyBraceStartLineCheck" description="Right curly braces should be located at the beginning of lines of code" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Constant per issue function (with a coefficient of 0d -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="6" plugin_rule_key="HiddenFieldCheck" plugin_name="squid" name="HiddenFieldCheck" description="HiddenFieldCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0min -> to be replaced by null)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="7" plugin_rule_key="ForLoopCounterChangedCheck" plugin_name="squid" name="ForLoopCounterChangedCheck" description="ForLoopCounterChangedCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear with offset function (with a offset of 0h -> should be replaced by 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="8" plugin_rule_key="ClassVariableVisibilityCheck" plugin_name="squid" name="ClassVariableVisibilityCheck" description="ClassVariableVisibilityCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null" updated_at="2014-02-19"
<!-- Rule linked to one enable requirement on Linear function (with a coefficient of 0d -> should keep 0d)="[null]" with different value of debt -> Update rule -->
<rules tags="[null]" system_tags="[null]" id="9" plugin_rule_key="SwitchLastCaseIsDefaultCheck" plugin_name="squid" name="SwitchLastCaseIsDefaultCheck" description="SwitchLastCaseIsDefaultCheck" status="READY"
- characteristic_id="[null]" default_characteristic_id="20"
+ characteristic_id="[null]" default_characteristic_id="20" description_format="HTML"
remediation_function="[null]" default_remediation_function="LINEAR"
remediation_coeff="[null]" default_remediation_coeff="5d"
remediation_offset="[null]" default_remediation_offset="[null]" updated_at="2014-02-19"
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
-import java.util.Arrays;
-import java.util.Date;
-import java.util.HashSet;
-import java.util.Set;
-import java.util.TreeSet;
+
+import java.util.*;
public final class RuleDto extends Dto<RuleKey> {
private String repositoryKey;
private String ruleKey;
private String description;
+ private String descriptionFormat;
private RuleStatus status;
private String name;
private String configKey;
return this;
}
+ public String getDescriptionFormat() {
+ return descriptionFormat;
+ }
+
+ public RuleDto setDescriptionFormat(String descriptionFormat) {
+ this.descriptionFormat = descriptionFormat;
+ return this;
+ }
+
public RuleStatus getStatus() {
return status;
}
r.plugin_rule_key as "ruleKey",
r.plugin_name as "repositoryKey",
r.description,
+ r.description_format as "descriptionFormat",
r.status,
r.name,
r.plugin_config_key as "configKey",
plugin_rule_key=#{ruleKey},
plugin_name=#{repositoryKey},
description=#{description},
+ description_format=#{descriptionFormat},
status=#{status},
name=#{name},
plugin_config_key=#{configKey},
</update>
<sql id="insertColumns">
- (plugin_rule_key, plugin_name, description, status, name, plugin_config_key, priority, is_template, language, template_id,
+ (plugin_rule_key, plugin_name, description, description_format, status, name, plugin_config_key, priority, is_template, language, template_id,
characteristic_id, default_characteristic_id, remediation_function, default_remediation_function,
remediation_coeff, default_remediation_coeff, remediation_offset, default_remediation_offset,
effort_to_fix_description, tags, system_tags, note_data, note_user_login, note_created_at, note_updated_at,
<insert id="insert" parameterType="Rule" keyColumn="id" useGeneratedKeys="true" keyProperty="id">
insert into rules <include refid="insertColumns"/>
- values (#{ruleKey}, #{repositoryKey}, #{description}, #{status}, #{name}, #{configKey},
+ values (#{ruleKey}, #{repositoryKey}, #{description}, #{descriptionFormat}, #{status}, #{name}, #{configKey},
#{severity}, #{isTemplate}, #{language}, #{templateId},
#{subCharacteristicId}, #{defaultSubCharacteristicId}, #{remediationFunction}, #{defaultRemediationFunction},
#{remediationCoefficient}, #{defaultRemediationCoefficient}, #{remediationOffset}, #{defaultRemediationOffset},
<insert id="batchInsert" parameterType="Rule" useGeneratedKeys="false">
insert into rules <include refid="insertColumns"/>
- values (#{ruleKey}, #{repositoryKey}, #{description}, #{status}, #{name}, #{configKey},
+ values (#{ruleKey}, #{repositoryKey}, #{description}, #{descriptionFormat}, #{status}, #{name}, #{configKey},
#{severity}, #{isTemplate}, #{language}, #{templateId},
#{subCharacteristicId}, #{defaultSubCharacteristicId}, #{remediationFunction}, #{defaultRemediationFunction},
#{remediationCoefficient}, #{defaultRemediationCoefficient}, #{remediationOffset}, #{defaultRemediationOffset},
assertThat(ruleDto.getId()).isEqualTo(1);
assertThat(ruleDto.getName()).isEqualTo("Avoid Null");
assertThat(ruleDto.getDescription()).isEqualTo("Should avoid NULL");
+ assertThat(ruleDto.getDescriptionFormat()).isEqualTo("HTML");
assertThat(ruleDto.getStatus()).isEqualTo(RuleStatus.READY);
assertThat(ruleDto.getRepositoryKey()).isEqualTo("checkstyle");
assertThat(ruleDto.getNoteData()).isEqualTo("Rule note with accents \u00e9\u00e8\u00e0");
<dataset>
<rules tags="[null]" system_tags="[null]" id="1" plugin_rule_key="AvoidNull" plugin_name="checkstyle" name="Avoid Null" description="Should avoid NULL" status="READY"
- note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25"
+ note_data="Rule note with accents éèà" note_user_login="polop.palap" note_created_at="2013-12-25" description_format="HTML"
characteristic_id="100" default_characteristic_id="101"
remediation_function="LINEAR" default_remediation_function="LINEAR_OFFSET"
remediation_coeff="1h" default_remediation_coeff="5d"
effort_to_fix_description="squid.S115.effortToFix"/>
<rules tags="[null]" system_tags="[null]" id="2" plugin_rule_key="AvoidNull" plugin_name="squid" name="Avoid Null" description="Should avoid NULL" status="REMOVED"
- note_data="[null]" note_user_login="[null]" note_created_at="[null]"
+ note_data="[null]" note_user_login="[null]" note_created_at="[null]" description_format="HTML"
characteristic_id="[null]" default_characteristic_id="[null]"
remediation_function="[null]" default_remediation_function="[null]"
remediation_coeff="[null]" default_remediation_coeff="[null]"
effort_to_fix_description="[null]"/>
<rules tags="[null]" system_tags="[null]" id="3" plugin_rule_key="AvoidNull" plugin_name="manual" name="Manual Rule" description="Should not appear" status="READY"
- note_data="[null]" note_user_login="[null]" note_created_at="[null]"
+ note_data="[null]" note_user_login="[null]" note_created_at="[null]" description_format="HTML"
characteristic_id="[null]" default_characteristic_id="[null]"
remediation_function="[null]" default_remediation_function="[null]"
remediation_coeff="[null]" default_remediation_coeff="[null]"