Code Inspector - How to create a new check

[Peter_Inotai]

Introduction

I always felt excited when I read about new ABAP related tools. One of the first such tool I fell in love was the Code Inspector. Around in 2001-2002 we were on 46C, and in one for the Code inspector presentation I saw a note about, that there is a down port for 46C with some limitation. I got green light from my manager to import it to our development system and I could play around with this tool ... and fun begun.

I found very useful to perform static checks on the code. From that point I always used Code Inspector instead of the Extended syntax check.

About the Code inspector framework

The Code Inspector is a tool for the static analysis of ABAP programs and other SAP repository objects. It’s available as of basis release 6.10 as part of SAP standard delivery and a down port is available for 46C with some limitations.

Code inspector is a framework, where all the categories and checks are based on ABAP classes. SAP continuously delivers new build-in checks for new tools (e.g.: ABAP Unit) and new objects (e.g.: BSP Applications).

It’s also possible to add customer-built checks within this framework.

Main steps for creating a new check

• Create new category
• Create new check
• Create documentation
• Activate new category/check

In this example we will build a very simple check for searching string ‘SDN’. This example is based on SAP standard check CL_CI_TEST_FREE_SEARCH.

I believe standard checks are covers most of the customer needs, however new checks can be useful for checking customer specific programming conventions.

The goal of this example is to show how the code inspector checks are built.

Creating a new category

Copy CL_CI_CATEGORY_TEMPLATE to ZCL_CI_CATEGORY_SDN.

Select the package in the popup (e.g.: $TMP)

Change the CONSTRUCTOR method to the following:

METHOD constructor .  super->constructor( ).  description = 'New Category for SDN'(000).  category    = 'CL_CI_CATEGORY_TOP'(001).  position    = '999'.ENDMETHOD.

Create the text elements and activate your class.

This method sets the attributes of this category in the code inspector check tree.

Creating a new check

Copy CL_CI_TEST_SCAN_TEMPLATE to ZCL_CI_SCAN_SDN.

Select the package in the popup (e.g.: $TMP)

Add the following attributes to the class:

C_MY_NAME  Constant  Private  Type  SEOCLSNAME  'ZCL_CI_SCAN_SDN'

C_PROGRAM  Constant  Private  Type  SCI_ERRC  Code Inspector: ID for Message Code  'PROG'

C_SDN  Constant  Private  Type  CHAR03  Three-digit character field for Idocs  'SDN'

Method constructor sets the attributes of this check in the code inspector check tree.

METHOD constructor .  super->constructor( ).  description    = 'Seach for SDN'(001).       "required  category       = 'ZCL_CI_CATEGORY_SDN'.      "required  version        = '000'.                      "required  has_attributes = c_false.                    "optional  attributes_ok  = c_false.                    "optionalENDMETHOD.                    "CONSTRUCTOR

Method run to search for string SDN and pass the parameters to method INFORM

METHOD run .* Based on CL_CI_TEST_FREE_SEARCH->RUN  DATA:    l_include        TYPE sobj_name,    l_line           TYPE token_row,    l_column         TYPE token_col,    l_tokennr        LIKE statement_wa-from,    l_errcnt         TYPE sci_errcnt,    l_code           TYPE sci_errc,    l_position       TYPE i,    l_param_1        TYPE string.* Get a scan  IF ref_scan IS INITIAL.    CHECK get( ) = 'X'.  ENDIF.  CHECK ref_scan->subrc = 0.  l_errcnt = 0.* Loop at all tokens  LOOP AT ref_scan->statements INTO statement_wa.    CHECK statement_wa-from <= statement_wa-to.    l_position = sy-tabix.    LOOP AT ref_scan->tokens INTO token_wa           FROM statement_wa-from TO statement_wa-to.      l_tokennr = sy-tabix.*     Search for SDN string      IF token_wa-str CS c_sdn.        l_include = get_include( ).        l_line    = get_line_abs( l_tokennr ).        l_column  = get_column_abs( l_tokennr ).        l_errcnt  = l_errcnt + 1.        l_code    = '0001'.        l_param_1 = l_line.*       Inform        inform( p_sub_obj_type = c_type_include                p_sub_obj_name = l_include                p_position     = l_position                p_line         = l_line                p_column       = l_column                p_errcnt       = l_errcnt                p_kind         = c_note                p_test         = c_my_name                p_code         = l_code                p_suppress     = '"#EC CI_SDN'                p_param_1      = l_param_1 ).        EXIT.      ENDIF.    ENDLOOP.  ENDLOOP.ENDMETHOD.                    "run

Method get_message_text is to generate explanation text in the check tree.

METHOD get_message_text .  DATA:    l_code TYPE sci_errc.  IF p_test <> myname.    super->get_message_text(                EXPORTING p_test = p_test p_code = p_code                IMPORTING p_text = p_text ).    RETURN.  ENDIF.  l_code = p_code.  SHIFT l_code LEFT DELETING LEADING space.  CONCATENATE 'String'(100) c_sdn 'was found in line &1'(101)    INTO p_text SEPARATED BY space.ENDMETHOD.                    "GET_MESSAGE_TEXT

Documentation

Via transaction SE61 you can add documentation to the categories/checks.

Create the follwing documentations:

ZCL_CI_CATEGORY_SDN/000       New Category for SDN

ZCL_CI_SCAN_SDN/000     Search for SDN

Activate new categories and checks

Start transaction SCI. Navigate to Goto-> Test Administration in the menu. Set the flag for the new category and check in order to make them available in the framework.

Testing our new check

Create a simple test program containing string ‘SDN’.

Start transaction SCII, where you can test the code without saving the inspection.

In the Object selection block set Single, select Program and enter program name.

In the Check variant block select Temporary Definition and make sure that you flag ‘New Category for SDN’ category and ‘Seach for SDN’ check. Remember, these texts were defined in the constructors.

Press execute and when you got the message ‘The inspection was carried out successfully’ go to the results.

Remarks

·        There are some changes between releases in the mentioned menu path and also in the available techniques.

·        This example was created on a SAP R/3 Enterprise 4.70x200 /WAS 6.20/ system.

·        Although suppress message is possible via method INFORM parameter p_suppress, somehow I couldn’t manage to make it work.

·        If you import the package in 46C, you can expect some extra work during the next upgrade SPAU, however all of these object can be reset to SAP standard

Reference documents

OSS note 543359        Code Inspector for SAP R/3 Release 4.6C

Improving the Quality of Your ABAP Code Using the Code Inspector

Evaluating the Quality of Your ABAP Programs and Other Repository Objects with the Code Inspector

ABAP Troubleshooting