Presentation on Quality Assurance with the JDeveloper Auditing Framework, covering: - how to use default auditing framework - creating custom rules and fixes to implement company and project standards - SuppressWarnings JDeveloper extension to suppresswarnings in XML files - ADF Code Guidelines JDeveloper extension - SonarQube plugin for JDeveloper (ojaudit)

1. Quality Assurance
JDeveloper Auditing Framework

2. About Us
Richard Olrichs
MN
www.olrichs.nl
@richardolrichs
Wilfred van der Deijl
The Future Group
www.redheap.com
@wilfreddeijl

3. Agenda
●
●
●
●
●
●
Audit Profiles and Preferences
Audit JDeveloper Extension Project
Creating Custom Rules
Creating Custom Fixes
SuppressWarnings
Automated QA

5. Aborts Compile On Error

14. ● Applies default Fix
● Run analysis with single
(or few) rules
● Example: Generate
unique JSF component ID

15. Custom Rules

16. Custom Rules
● Setting up JDeveloper Extension
Project
● Implementing Custom Rule
● Implementing Custom Fix

17. Setting up JDev Project

18. Setting up JDev Extension Project
● Install Extension SDK (Help>CheckForUpdates)
● File > New > Applications >
Extension Application
● extension.xml and MANIFEST.MF
● Bundled as .ZIP
● Can be distributed through custom JDeveloper
Update Center
(aka network drive or URL)

22. Creating Custom Rules

28. Analyzing Java Code

29. Analyzing XML Files

31. Disables Analyzer for current
construct and all children

33. AuditContext
● Provides Traversal State
● report() for Violations, Metrics,
Suppressions
● Holds State for Analyzer
○ Setting Attributes for Child Constructs
○ Setting Attributes for Parent Construct
○ (Sharing Attributes between Analyzers)

34. ● AuditContext creates Analyzer State Keys
● enter() on root-node (Workspaces) invoked
once, so can initialize keys

35. Creating Custom Fix

39. Transform subclass
● apply(context, construct)
○ applies fix by changing source
○ TransformContext argument contains editor location,
violation, etc
○ Construct is the object with the violation (eg. a
JavaMethod or XMLElement)
● isQueryRequired(context, construct)
and query(context, construct)
○ queries the user for additional info when applying fix

40. Violation Overload

42. Violation Overload
● Even ADF Sample Application from OTN
has 157 issues
● Too many violations cause developers to
ignore all of them

43. Violation Overload

44. SuppressWarnings Java Annotation
@SuppressWarnings annotation introduced in
Java 1.5 and tells Java Compiler to suppress
warnings

45. SuppressWarnings Java Annotation
JDeveloper 12c now also “listens” to annotation
and suppresses warnings itself (not only javac)

46. JDeveloper 12c Suppression Schemes

47. JDeveloper 12c Suppression Scheme
Why not create our own for non-Java (aka XML)?

48. Suppress Warnings in XML

49. Suppress Warnings in XML

52. SuppressWarnings
● JDeveloper 12c natively supports
@SuppressWarning in Java
● JDev extension adds
<!-- SuppressWarning -->
● Extension available today
● JDeveloper 12c only as Suppression
Schemes is new 12c feature

53. Analyzer - Suppressing violations

54. Transform - Creating XML Comment

55. Audit Extension Project

56. Audit Extension Project
● Project standards
● Company standards
● Community standards

57. Audit Extension Project

58. ADF EMG Extension Project

63. ADF Code Guidelines Extension
● JDeveloper extension available today
● ADF Code Guidelines auditing during
development
● Community project at java.net: adfemgauditrules
● Contribute and discuss at ADF EMG
● JDeveloper 12c only
○ at least for now. No reason why this can’t be
backported to JDeveloper 11g

64. Automated QA

65. OJAudit
● Command line auditing
● JDEV_HOME/jdev/bin/ojaudit -help
● Output in XML/text/HTML or custom xsl

67. Automated QA
● Simple solution: Run ojaudit from CI server
and publish output
● Benefit: Same rules during development and
CI QA
● @SuppressWarnings and
<!--SuppressWarning--> keep list of
violations short and actionable

68. Automated QA
SonarQube

70. SonarQube
●
●
●
●
●
●
Tool to manage Code Quality
Rules, Violations, Metrics, Test Coverage, etc
Free Open Source
Initially Java, but now 20+ languages
Historical data, thus trends
Highly extensible through plugins

75. ADF EMG SonarQube plugin
● SonarQube plugin
○ runs ojaudit
○ converts ojaudit output to SonarQube violations
●
●
●
●
www.sonarqube.com for base product
Watch ADF EMG for availability of plugin
Not specific to ADF, but for any JDev project
Tested with JDeveloper 12c, but should work
with any version

76. Further Reading
● www.olrichs.nl
● www.redheap.com
● ADF Enterprise Methodology Group
○ Google Groups
● http://docs.oracle.com
JDeveloper Doc (not ADF documentation)
○ Developing Extensions for JDeveloper
○ Java API Reference for Extension SDK

77. Summary
●
●
●
●
●
●
Audit Profiles and Preferences
Creating Custom Rules
Creating Custom Fixes
SuppressWarnings JDev Extension
ADF Code Guidelines JDev Extension
SonarQube ojaudit plugin