Rasko Pjesivac
Katalon Ambassador
01/03/2018

Custom keywords description displayed within test case (like for built in keywords)

Hi,

Is it currently possible to add description for custom keywords that when custom keyword is selected for a test we could get description of that custom keyword and not just keyword signature?

For example if I select Web.Click keyword (built in keyword) and I roll over I could see full description of the call

While for custom keywords I just see this (script and manual view)

We do add comments section above custom keyword implementation (like this) but this does not solve our issue.
/***
* Description of this custom keyword comes here but we don't see it
* @param ro
* @param parmsMap
* @return
*/
@Keyword
def updateServiceCallUrl(RequestObject ro, def parmsMap) {
....
}

We want to add descriptions for our custom keywords so people who didn't develop these keywords would know how to use them and what they are used for. (like it is done for built in keywords)

Can we do this now?

Thanks,
Rasko

Upvote
Quote

Comments

  • Don Welsh
    Katalon Ambassador
    01/03/2018

    This would be very useful.

    Thanks,
    Don

    Upvote
    Quote
  • Liam B
    Katalon Moderator
    01/04/2018

    Hi,

    Is it currently possible to add description for custom keywords that when custom keyword is selected for a test we could get description of that custom keyword and not just keyword signature?

    For example if I select Web.Click keyword (built in keyword) and I roll over I could see full description of the call

    While for custom keywords I just see this (script and manual view)

    We do add comments section above custom keyword implementation (like this) but this does not solve our issue.
    /***
    * Description of this custom keyword comes here but we don't see it
    * @param ro
    * @param parmsMap
    * @return
    */
    @Keyword
    def updateServiceCallUrl(RequestObject ro, def parmsMap) {
    ....
    }

    We want to add descriptions for our custom keywords so people who didn't develop these keywords would know how to use them and what they are used for. (like it is done for built in keywords)

    Can we do this now?

    Thanks,
    Rasko

    Don Welsh said:

    This would be very useful.

    Thanks,
    Don

    Hi Rasko and Don,

    Thanks for the suggestion. Katalon team does have this feature planned in the roadmap and is currently working on it. Stay tuned!

    Please feel free to add any other suggestions. Katalon team very much appreciate the time and effort in providing valuable feedback to make the app better.

    Best,
    Liam

    Upvote
    Quote
  • Rasko Pjesivac
    Katalon Ambassador
    03/13/2018
    Hi Liam, Any update on this feature? Our code is growing and for engineers that didn't implement specific keyword it is getting harder to understand what/how specific keyword works. (they need to look into implementation vs. reading the description)
    Upvote
    Quote
  • Russ Thomas
    Katalon Evangelist
    03/13/2018
    Hi Rasko et al

    As a workaround, if you switch to Script view, you do see the documentation show up.


    Upvote
    Quote
  • Rasko Pjesivac
    Katalon Ambassador
    03/13/2018
    Hi Rasko et al

    As a workaround, if you switch to Script view, you do see the documentation show up.


    Hi Russ,
    In the script view you see only keyword signature and not description of the keyword (look the initial post and the screenshots)
    Thanks,
    Rasko
    Upvote
    Quote
  • Russ Thomas
    Katalon Evangelist
    03/13/2018

    Rasko,  Sorry, my bad.  What I actually do is call them as methods -- I forgot to mention that.

    import static com.mypackage.mykeywordclass.*  // to get the mymethod keyword

    mymethod()

    In Manual view you see

    |Method Call Statement| ... | mymethod() | ... | ...|

    Here's an example for my startBrowser keyword/method:



    HTH!

    Russ

    Upvote
    Quote
  • Rasko Pjesivac
    Katalon Ambassador
    03/14/2018

    Rasko,  Sorry, my bad.  What I actually do is call them as methods -- I forgot to mention that.

    import static com.mypackage.mykeywordclass.*  // to get the mymethod keyword

    mymethod()

    In Manual view you see

    |Method Call Statement| ... | mymethod() | ... | ...|

    Here's an example for my startBrowser keyword/method:



    HTH!

    Russ


    Cool that does work. Thanks for that.

    However, this feature still should support custom keywords as well.. so we can fallow "the best" practices within Katalon Studio. otherwise if we start writing methods instead of keywords (like above) non developers will have equally hard time to find these methods and write tests like when we used java/selenium without Katalon Studio.

    Best regards,
    Rasko
    Upvote
    Quote
  • Bob Jones
    Katalon Ambassador
    05/03/2018
    +1 for this.
    Upvote
    Quote
Sign In or Register to comment.