larshp / abapopenchecks

Open source checks for SAP Code Inspector / ABAP Test Cockpit

abapOpenChecks

Open source checks for SAP Code Inspector / ABAP Test Cockpit (SCI/ATC)

• For running Continuous Integration outside the ABAP platform see https://abaplint.org
• For Steampunk installations see https://github.com/abapOpenChecks/abapOpenChecks-Steampunk

Installation

• install via abapGit (make sure you are using the latest version) using the online or offline option
• activate checks in SCI (depending on release)
  • Goto -> Management of -> Tests
  • Code Inspector -> Management of -> Tests
  • Code Inspector -> Management of -> Checks
• configure check variant
• run inspection

Updating

• Recommend backing up variants before updating abapOpenChecks, use upDOWNci
• Pull latest changes via abapGit

Design goals

• try and see if it works out
• performance not high priority
• unit testable without creating new objects in customer system
• only english supported

Version requirement: v740sp02 or higher

Documentation

abapopenchecks's Issues

IF can easily be changed to CASE

Unit test assert not in test class, or assert in test class

cl_abap_unit_assert should be used in abap unit test classes, not ASSERT

number of sequential blank lines

always specify JOIN type in SELECT(INNER, OUTER, LEFT)

Same constants defined multiple places in program

comment spell checking

IF lx_exception IS INITIAL

wrong use of exceptions

'X' or '' that can be replaced with abap_true or abap_false

space colon, WRITE : 'foo'.

Use new operators, =, <>, <, >, <=, >=, instead

Check indentation

eg.

IF foo = bar
    AND moo = boo.
    MOVE ...

IF foo = bar
AND moo = boo.
    MOVE ...

IF foo = bar
            AND moo = boo.
    MOVE ...

  IF foo = bar
AND moo = boo.

Constants only used once

no guard for division by zero

max one statement per line

check program headers exists

show number of codelines scanned

IS INITIAL or NOT IS INITIAL that can be replaced with abap_true or abap_false

for boolean/flags use abap_true/abap_false and not IS INITIAL

OpenSQL LIKE wildcards * vs %

no DATA definitions in MODULE

type C without LENGTH, no implicit typing, always specify "TYPE c"

CASE without OTHERS

identical code blocks

use icon_* constants

no empty newlines when using COLON operator

spaces that are tabs, eg when copying signature

late read of sy-tabix in LOOP

Inactive objects list

unused parameter in class method(dynamic references? redefined method, interfaces?)

double spaces, CONCATENATE foo bar INTO result.

Last statement is RETURN in method/form

space dot, WRITE 'foo' .

clear directly after definition of local variable

clear after definition is not needed

Clearance program

domain not in use(statically referenced)
data element
transaction not in any roles

all branches of IF/CASE ends with same code

always specify SORT order(ASCENDING, DESCENDING)

macro naming standard

no update of standard SAP tables

comments on single lines starting with " that can be replaced with *

allows for better pretty printing in old editor

empty IF statement/branch

pseudo comments vs pragmas, ABAP_SLIN_PRAGMAS

only show errors that are part of whats been changed in open transport

IS REQUESTED is obsolete

use of sy-ucomm, unless fcode in selection screen

commented code(Standard check doesnt work very well)

quantity + uom / amount + currency in same structure

MESSAGEs should be defined in SE91

REFRESH is obsolete

CHECK used outside of loops

Last statement is CLEAR local variable in method/form

or last statement is RETURN

indexes active and exists in db for Z and Y tables