Scharpen your ABAP Editor for Test-Driven-Development (TDD) – Part II.
How to optimize your Performance by using the new ABAP Editor
[image from http://static.supernifty.com.au/images/comic-mastery.png – copyright Supernifty.com.au]
In my previous Blog (http://scn.sap.com/community/abap/blog/2013/01/05/sharpen-your-abap-editor-for-tdd) I described what is necessary for sharpen your ABAP Editor to use successful TDD. In this Blog I will show you:
- my own Templates
- what kind of Philosophy is behind some created templates
For following commands we will create Templates:
- local Classes
- local Test-Classes
- Testmethod definition
- Method implementation
- assert_equals Statements
- fail Statements
so, let us begin…
First you have to verify if you use the New Front-End Editor. Call the Transaction SE80, and then choose the Menu Utilities->Settings.
Go to the ABAP Editor Tab and check that the New Editor is activated:
If the displayed Dialog looks a littlte diffrent in your System, don´t worry maybe you have an newer System then I used (Trial-Version NW7.00) for this Blog 😉
Now it is possible to go into the Object-Navigator (Transaction SE80), open an ABAP Report and Click on the
to open the Front-End Editor Options click the Button on the lower right side.
The Options Dialog opens. Here is the starting Point to create your own Templates. Select on the left-hand side the Entry “Code Templates”
By clicking on the Add... Button, you can add your own Code-Templates. These Templates are only available for your currsten SAP-User.
In the now opend Dialog-Box you enter in the Name-Form the Keyboard-Shortcut you will create and in the Description-Form a short Description what this Template will offer:
I use the Prefix ‘#‘ for all my Keyboard-Shortcuts. So it´s easy for me to know what are SAP-Standard-Templates and what are my Customn-Templates.
Shortcut-Name: #lcl Description: local Class Creation
class %local Classname% definition.
class %local Classname% implementation.
With the Button Insert Tag... you got some little helpers:
It is possible to insert some Variables this happens with the Percent-Sign.
The Pattern is: %<any_kind_of_useful_text>%
After Saving your Entry you can choose your Code-Templates in the ABAP Editor:
When you Type the Shortcut #lcl The Autocompletion suggest you the new created Template.
Hit CTRL + SPACE and you got the Template-Parameter Dialog to enter your local Classname:
And here is the result:
SAP suggest to name your normal local Tesclasses with the Prefix LTC_
Shortcut-Name: #ltc Description: local Testclass till NW 7.00
class ltc_%local Test-Classname% definition for testing.
“#AU Risk_Level Harmless
“#AU Duration Short
class ltc_%local Test-Classname% implementation.
Please remember, that if you have an System above NetWeaver 7.00 your Testclass Definition will look a little diffrent:
Shortcut-Name: #ltc Description: local Testclass above NW 7.00
class ltc_%local Test-Classname% definition for testing
risk level harmless duration short.
class ltc_%local Test-Classname% implementation.
Again, after filling the Input-Parameter the Code is generated.
Naming Conventions in every programming language is a philosophy of his own.
I recommand that you should use one style in your Company/Team.
I like the Standard which Roy Osherove explains on his homepage http://osherove.com/blog/2005/4/3/naming-standards-for-unit-tests.html .
The Point is, that I could easiliy understand the purpose of my written Tests if I described the intention in the Testmethodname by using the Pattern [MethodName_StateUnderTest_ExpectedBehavior]
Shortcut-Name: #tmdl Description: Testmethod Definition long Version with Pattern [MethodName_StateUnderTest_ExpectedBehavior]
%MethodName%_%StateUnderTest%_%ExpectedBehavior% for testing.
I think, now you are familiar with creating own Code-Templates. The following statements will only display my own used Templates 😉
If you create an Template for normal Methods or Testmethods it looks the same. So I use a more general Template for Implementing Methods:
Shortcut-Name: #mi Description: Implementation-Part of a Method
method %Method Name%.
The Problem in ABAP is that you have only can name your Objects (local classes, Testmethods, Fields) with a maximum length of 30 characters.
I found it useful when naming the objects to have an info how much characters are left till 30.
So I also created an Template for this:
Shortcut-Name: #line Description: Displays 30 Char length
Please remember, that if you have an System above NetWeaver 7.00 SAP suggest to use the new Assertion-Class: CL_ABAP_UNIT_ASSERT.
Shortcut-Name: #ae Description: Assert_Equals Statement
exp = exp
act = act ).
Shortcut-Name: #aem Description: Assert_Equals with Message
exp = exp
act = act
msg = msg ).
Shortcut-Name: #fail Description: ABAP Unit fail Statement
msg = ” ).
It took some time to figure out, which templates are working for me.
As a programmer you have your style, and every programming style is a little diffrent…
Try out other templates / commands. Look if it speed up your work.
What is your experience with using the above Templates?
What was good and what could be implemented better?
Have you something diffrent that works for you?
Editors in the ABAP World
- new ABAP Editor
- ABAP in Eclipse Integration http://scn.sap.com/community/abap/eclipse
- CT-Software http://www.ct-software.de/add-ons.htm
Blogs in this Series:
- Sharpen your ABAP Editor for TDD Part I. (http://scn.sap.com/community/abap/blog/2013/01/05/sharpen-your-abap-editor-for-tdd)
- Sharpen your ABAP Editor for TDD Part II. (http://scn.sap.com/community/abap/blog/2013/01/23/sharpen-your-abap-editor-for-tdd–part-ii )
- Sharpen your ABAP Editor for TDD Part III. (http://scn.sap.com/community/abap/blog/2013/01/29/sharpen-your-abap-editor-for-tdd–part-iii)
- Sharpen your ABAP Editor for TDD Part IV. ( http://scn.sap.com/community/abap/blog/2014/06/25/sharpen-your-abap-editor-for-tdd–part-iv )