Custom Code Rules Deep Dive

Transcription

1 Custom Code Rules Deep Dive IDz/RDz Software Analyzer Jon Gellin, Senior Software Engineer 24 October 2017

2 What we will not be talking about What is IDz/RDz? What are code rules? Why would I want to use code rules? Why would I want to write my own code rules? How do I run code rules? 2

3 What we will not be talking about What is IDz/RDz? What are code rules? Why would I want to use code rules? Why would I want to write my own code rules? How do I run code rules? Assumption: If you are here, you know what custom code rules are and want to write them. 3

4 What we will be talking about How to write/debug/deploy custom code rules

5 Custom Code Rule Architecture IDz/RDz is built on Eclipse IDz/RDz made up of Eclipse plug-ins ABC Corp. Custom Code Rules Custom code rules are also Eclipse plug-ins that make use of extension points defined by IDz/RDz plug-ins IDz/RDz Eclipse Framework

6 Custom Code Rule Extension Point Custom categories and rules defined in a plug-in s plugin.xml file <analysiscategory> defines custom categories <analysisrule> defines custom rules

7 Custom Code Rule Extension Point The custom rule wizard does all that registry stuff for you

8 Custom Code Rule Extension Point including COBOL defining plug-in dependencies. PL/I

9 Writing a custom code rule: steps 1. Create a new plug-in 2. Use the custom code rule template in the wizard to register a new rule and generate the Java class where the rule will be implemented 3. Complete the Java implementation 4. Test/debug 5. Repeat steps 2-4 for as many rules as you are implementing 6. Deploy Assumptions: You understand the requirement. You have the requisite Java and host language skills.

10 New Custom Code Rule Plug-in Launch Plug-in Project wizard Set plug-in name and properties on first wizard pages On Templates page choose Custom COBOL Code Review Rule or Custom PL/I Code Review Rule The wizard generates: The plug-in project Dependencies for custom code rule support Custom code rule extensions Custom code rule java class skeleton 10

11 Add a Rule to Existing Plug-in You can access that same custom code rule wizard on the Extensions tab of the Plug-in Manifest editor.

12 Implementation The generated Java class is set up so that you only have to implement the performrule method

13 Implementation The performrule method takes an abstract syntax tree model of the source program being analyzed as an argument and returns a list of syntax tree nodes. The returned nodes represent the portions of the program that violate the rule being implemented.

14 Implementation The generated Java class sets up a visitor with a visit method for any language elements selected in the wizard. Tip: Google visitor pattern to learn how this works.

15 Implementation The visitor pattern makes it easy to find all of the instances of a certain type in a model.

16 Find What You re Looking For in the Model The Javadoc describes all of the interfaces in the COBOL and PL/I Application Models

17 Find What You re Looking For in the Model The package page for each model features a mini-tutorial on how to use the model COBOL PL/I

18 Find What You re Looking For in the Model The names of Java objects (in most cases) matches the corresponding language element as described in the language reference

19 Test/Debug Run > Debug Configurations Create an Eclipse Application configuration Press Debug When the new workbench appears, test your rule Set breakpoints in your code to debug

20 Deploy Standard Eclipse stuff 1. Create a feature that includes the plug-in(s) containing your rule implementations 2. Export that feature as a p2 update site 3. Publish the update site where deploy targets can find it 4. Run p2 installation update on IDz/RDz clients to pick up custom code rule plug-ins Good step-by-step documentation in the Knowledge Center bol.doc/topics/cac_customrule_installplugin.html 20

21 Demo Implement the rule Every numeric field must be signed 77 MY-ITEM PIC MY-ITEM PIC S99.

22 22 Thank You