Quality Rules
Quality Rules serve as the guidelines utilized for conducting static code analysis.
Navigate to
Rules->Quality Rules
Details include -
Name- Name of the ruleLanguage- Language for which the rule is applicable. E.g.: Mule, APISeverity- Severity of the rule. Value can be one of -CRITICAL
BLOCKER
MAJOR
MINOR
INFO
Category- Category of the rule. Value can be one of -BUG
CODE SMELL
VULNERABILITY
SECURITY HOTSPOT
Click on
Activate Ruleaction to activate the rule in any of the Quality Profile
Rule Descriptions
Every built-in rule has a description in Markdown, shown when you open the rule and in the IDE plugins:
What the rule checks and why it matters, including what it deliberately does not report.
Examples: a Non Compliant and a Compliant code example. AWS rules show the equivalent template JSON, or the setting to change in the AWS Console where the issue is fixed there.
References: links to the official documentation behind the rule. Security rules link the OWASP Top 10 2021 and CWE entries they map to.
Rules that offer auto-fix also describe what the fix changes.
Rule Tags
Every built-in rule carries one to five short, lower-case tags, which are shown in the Tags column. Type a tag in Search Rule to list the rules that carry it, and use tags in the Rule filter.
For example:
AWS rules:
aws, the service (such asaws-lambda,sqsorelb), the area and the topic, for exampleaws,aws-lambda,security,encryptionJava rules: the area and topics, plus the OWASP Top 10 category for security rules, for example
security,spring-boot,owasp-a05Python PEP 8 rules:
pep8and the matchingpycodestylecode, for examplepep8,whitespace,e225
How Built-in Rules Are Classified
Built-in rules are assigned a severity and category consistently:
Vulnerability - a definite, exploitable flaw. An end-of-life engine or runtime (for example a deprecated Lambda runtime) is a Critical Vulnerability.
Security Hotspot - security-sensitive code or configuration that needs review. Security Hotspots are rated Major or Minor only.
Bug - code or configuration that will not behave as intended.
Code Smell - maintainability and style issues. Rules that only report scan coverage or inventory are Info Code Smells.
Built-in and Custom Rules
Built-in rules are delivered and updated with IZ Suite. New and revised built-in rules are applied automatically by the seed data process after an upgrade.
Custom rules are created with
Add Ruleor by cloning a built-in rule.
See Also
Last updated
Was this helpful?

