Monday, 10 April 2017

Four different TEST ISOLATION techniques to build your ABAP unit test

As far as I know test isolation is widely used in SAP internal to build unit test code, at least in my team. Test isolation in unit test means that in your production code you make use of some API(class method/Function module) which are developed by other team, and you would not like to really consume them during your unit test, since you would not accept that most red lights in your unit test report are caused by the bugs in those external API,right? Instead, you expect that the call of those external API during your unit test execution will be replaced by some dummy code written by yourself.

I will show you four different ways to achieve that.

The example comes from one productive class in my project. For simplicity reasons I don’t list unrelevant code here. The class is ZCL_DESTRUCTION_IMG_TOOL_S1.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

The main logic is doing a cleanup work: loop every work list item, check whether it has some dependent object. If so, delete it.

 method RUN.
    DATA: lv_social_post_id TYPE string.
    fill_worklist( ).
    LOOP AT mt_worklist INTO lv_social_post_id.
       IF dependent_object_existed( lv_social_post_id ) = abap_false.
          delete( lv_social_post_id ).
       ENDIF.
    ENDLOOP.
  endmethod.

The worklist is just hard-coded:

method FILL_WORKLIST.
     CLEAR: mt_worklist.
     APPEND '20130001' TO mt_worklist.
     APPEND '20130002' TO mt_worklist.
     APPEND '20130003' TO mt_worklist.
  endmethod.

The reason why test isolation is used in our unit test is because in method dependent_object_existed, we call an API provided by another team, and we don’t want that API to be really executed during our unit test execution. For demonstration reason, I use the following code to simulate the production code.

It means during the unit test on this class, the following code is NOT expected to be executed at all.

  method DEPENDENT_OBJECT_EXISTED.
     WRITE: / 'Productive code to check dependent object existence for ID: ' , iv_social_post_id.
  endmethod.

Approach1: test subclass instead


1. Change the visibility of method DEPENDENT_OBJECT_EXISTED from private to protected. The idea is in this approach, we create a sub class ( a local test class) which inherits from ZCL_DESTRUCTION_IMG_TOOL_S1. Since the DEPENDENT_OBJECT_EXISTED is now protected, we have the chance to redefine it in the local test class.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

The mock code is simple like below:

  METHOD dependent_object_existed.
     WRITE: / 'Test mock code to check dependent object existence for ID: ' , iv_social_post_id.
  ENDMETHOD.

And the code for method start:

  method start.
    f_cut = lcl_Destruction_Test=>get_sub_instance( ).
    f_cut->run(  ).
endmethod.

In this approach, actually the class being unit test are not lcl_destruction_test, instead of the original class ZCL_DESTRUCTION_IMG_TOOL_S1.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

when execution comes into run method, since the subclass only redefines the very method dependent_object_existed, so the execution of the left methods are still using the code of ZCL_DESTRUCTION_IMG_TOOL_S1. That means all methods of ZCL_DESTRUCTION_IMG_TOOL_S1 except dependent_object_existed will be covered by unit test.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

And when execution comes into method dependent_object_existed,since currently “me” points to the local test sub class, so the mock code will be executed, which is just what we expected.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

The limitation of this approach is, if the author of class ZCL_DESTRUCTION_IMG_TOOL_S1 insists on that it should be defined as final, it is impossible to define any sub class of it.

Approach2 – interface extraction + optional argument


The idea is to extract the logic written in method dependent_object_existed and put its implementation into method dependent_object_existed of a new interface ZIF_SOC_DEPENDENCY_DETECTOR instead. Via such abstraction, the loose coupling of dependency detection call and its implementation is achieved.

Necessary change on production class ZCL_DESTRUCTION_IMG_TOOL_S2 source code:

1. Private method dependent_object_existed can be removed now.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

2. Create a local class to implement the productive logic of dependency detection as usual:

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

3. Create an optional argument of method run.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

4. In method run, if no reference is passed in for io_dep_obj_detector, the default one for production use will be called (line5).If there is indeed one dependent object detector passed in, use that one. (line7)

Also the previous method dependent_object_existed is removed; the interface method call is used instead.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

5. The unit test class also implements interface method dependent_object_existed.In unit test code, the optional parameter of method run will be filled, so that the redefined dependency detection logic implemented in interface method in unit test code will be called instead ( according to the logic in step4, line 7)

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

Now the possibility is given for consumers to provide their own dependency determination logic by implementing interface and filling the optional parameter of method run; however this is not what we expected in the beginning.

Signature of method run is changed, which is a non-critical change. (Adding a new optional method parameter is not an incompatible change)

In my opinion it could not be regarded as a 100% test isolation solution.

Approach3 – Dynamic detector initialization


Interface extraction is also necessary for this solution.

Necessary change on production class ZCL_DESTRUCTION_IMG_TOOL_S3’s source code:

1. Create a local class to implement the productive logic of dependency detection just the same as approach2.

2. Add a new static member attribute for technical name of dependency class name. Default value is local class name created in step1:

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

3. Initialize the detector instance according to its name maintained in member attribute mv_detector_type_name.

Since its default value is the local class LCL_PROD_DEP_DETECTOR, so in the runtime the productive detection logic will be called.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

4. Define the unit test class as the friend of class ZCL_DESTRUCTION_IMG_TOOL_S3, so that it can alter even the private attribute mv_detector_type_name of ZCL_DESTRUCTION_IMG_TOOL_S3.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

In the unit test code, just add one line( line 62 ). Now the detection logic redefined in unit test class will be called.

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

Approach3 is superior compared with approach2 in that no method signature change is required. Class consumer will have no chance to pass their own detection logic into class in a normal way.
However, a new class member attribute is introduced, which could be not necessary in the next approach 4.

Approach4 – detector reference replacement


Similar with approach 3 to some degree.

Necessary change on production class ZCL_DESTRUCTION_IMG_TOOL_S4 source code:

1. Implement the productive dependency detection logic in local class lcl_prod_dep_detector just the same as approach3.

2. Initialize the productive detector instance in CONSTRUCTOR.

  method CONSTRUCTOR.
    CREATE OBJECT mo_dep_obj_detector TYPE lcl_prod_dep_detector .
  endmethod.

3. Implement the interface method in test class.

4. Define unit test class as friend of ZCL_DESTRUCTION_IMG_TOOL_S4.

5. In unit test code, replace the instance of dependency detector with unit test class reference itself, so that our own logic would be called in unit test:

SAP ABAP Tutorials and Materials, SAP ABAP Guide, SAP ABAP Certifications

No new attribute or method interface change is required in this solution. This solution should be used for test isolation whenever possible.

No comments:

Post a Comment