Bug 699607

Summary: TCMS - nitrate xmlrpc - TestCaseRun.create: unable to set comments
Product: [Other] TCMS Reporter: Max Benenson <mbenenso>
Component: ApplicationAssignee: Yuguang Wang <yuwang>
Status: CLOSED WONTFIX QA Contact: tools-bugs <tools-bugs>
Severity: medium Docs Contact:
Priority: unspecified    
Version: 3.4CC: ctang, junzhang, llim, nli, vchen, yawli
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-05-25 07:57:24 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Max Benenson 2011-04-26 07:24:54 UTC
Description of problem:
Please expose an option to set comments when creating new TestCaseRun using nitrate xmlrpc. Currently it's possible to set notes only.

Comment 1 Yuguang Wang 2011-05-05 10:37:08 UTC
TestCaseRun could be created via WebUI, and there's no options for setting comments via WebUI.
We didn't expose 'adding comments' while create new tcr using rpc to ensure the consistency.

If you need to set comment for TestCaseRun, there's TestCaseRun.add_comment(https://tcms.engineering.redhat.com/xmlrpc/#testcaserun.add_comment)

Comments could be added after TestCaseRun is created.

What's your opinion for this?

Comment 2 Max Benenson 2011-05-05 11:16:25 UTC
(In reply to comment #1)
> TestCaseRun could be created via WebUI, and there's no options for setting
> comments via WebUI.
> We didn't expose 'adding comments' while create new tcr using rpc to ensure the
> consistency.
> 
> If you need to set comment for TestCaseRun, there's
> TestCaseRun.add_comment(https://tcms.engineering.redhat.com/xmlrpc/#testcaserun.add_comment)
> 
> Comments could be added after TestCaseRun is created.
> 
> What's your opinion for this?

Consistency is good and I can live with your solution, but generally APIs provide more flexible and powerful way to operate application so IMHO TestCaseRun.create verb may have such parameter 'comments' instead of calling an additional verb after that.

Comment 3 Yuguang Wang 2011-06-08 01:54:18 UTC
> APIs
> provide more flexible and powerful way to operate application

Indeed. Will fix it in 3.5

Comment 4 Chaobin Tang 2012-05-25 07:57:24 UTC
In designing API, keeping API atomic is more preferred. It allows us to keep the API more consistent which is very important for all users.

Plus, comment of a TestCase is not a natural attribute of itself, it is semantically confusing to add comment in TestCaseRun.create() call.

This hence will not be resolved.