Skip to content

Add deleteTestCase and deleteTestSuite XML-RPC endpoints #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dogkeeper886 merged 1 commit into from
Apr 9, 2026
Merged

Add deleteTestCase and deleteTestSuite XML-RPC endpoints #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions cicd/tests/testcases/e2e/TC-E2E-001.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,28 @@ steps:
expectPatterns:
- "CI Smoke Test"

- name: Delete test case via API
command: |
curl -sf -X POST http://localhost:8090/lib/api/xmlrpc/v1/xmlrpc.php \
-H "Content-Type: text/xml" \
-d '<?xml version="1.0"?><methodCall><methodName>tl.deleteTestCase</methodName><params><param><value><struct>
<member><name>devKey</name><value><string>a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4</string></value></member>
<member><name>testcaseexternalid</name><value><string>CIT-1</string></value></member>
</struct></value></param></params></methodCall>'
expectPatterns:
- "Success|status.*1|true"

- name: Delete test suite via API
command: |
curl -sf -X POST http://localhost:8090/lib/api/xmlrpc/v1/xmlrpc.php \
-H "Content-Type: text/xml" \
-d '<?xml version="1.0"?><methodCall><methodName>tl.deleteTestSuite</methodName><params><param><value><struct>
<member><name>devKey</name><value><string>a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4</string></value></member>
<member><name>testsuiteid</name><value><int>2</int></value></member>
</struct></value></param></params></methodCall>'
expectPatterns:
- "Success|status.*1|true"

- name: Tear down CI environment
command: bash ./cicd/scripts/ci-down.sh
timeout: 30000
Expand All @@ -75,4 +97,6 @@ criteria: |
- Create a test suite under the project
- Create a test case in the suite
- Retrieve and verify the test case
- Delete the test case via tl.deleteTestCase
- Delete the test suite via tl.deleteTestSuite
- Clean up the environment
100 changes: 100 additions & 0 deletions lib/api/xmlrpc/v1/xmlrpc.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8190,6 +8190,104 @@ public function deleteTestProject($args) {
return $status_ok ? $resultInfo : $this->errors;
}

/**
* deleteTestCase
*
* Delete a test case identified by internal ID or external ID.
*
* @param struct $args
* @param string $args["devKey"]
* @param int $args["testcaseid"] - optional, internal ID
* @param string $args["testcaseexternalid"] - optional, external ID (e.g. "CIT-1")
*
* @return mixed $resultInfo
* [status] => true/false of success
* [id] => test case id
* [message] => optional message for error message string
* @access public
*/
public function deleteTestCase($args) {
$resultInfo = array();
$operation = __FUNCTION__;
$msg_prefix = "({$operation}) - ";

$this->_setArgs( $args );
$resultInfo[0]["status"] = false;

$checkFunctions = array(
'authenticate',
'checkTestCaseIdentity'
);
$status_ok = $this->_runChecks( $checkFunctions, $msg_prefix );

if($status_ok) {
$status_ok = $this->userHasRight( "mgt_modify_tc", self::CHECK_PUBLIC_PRIVATE_ATTR );
if(!$status_ok) {
$this->errors[] = new IXR_Error( INSUFFICIENT_RIGHTS, $msg_prefix . INSUFFICIENT_RIGHTS_STR );
}
}

if($status_ok) {
$tcaseID = $this->args[self::$testCaseIDParamName];
$this->tcaseMgr->delete( $tcaseID );
$resultInfo[0]["status"] = true;
$resultInfo[0]["id"] = $tcaseID;
$resultInfo[0]["message"] = GENERAL_SUCCESS_STR;
$resultInfo[0]["operation"] = $operation;
}

return $status_ok ? $resultInfo : $this->errors;
}

/**
* deleteTestSuite
*
* Delete a test suite and all its contents (child test cases and sub-suites).
*
* @param struct $args
* @param string $args["devKey"]
* @param int $args["testsuiteid"]
*
* @return mixed $resultInfo
* [status] => true/false of success
* [id] => test suite id
* [message] => optional message for error message string
* @access public
*/
public function deleteTestSuite($args) {
$resultInfo = array();
$operation = __FUNCTION__;
$msg_prefix = "({$operation}) - ";

$this->_setArgs( $args );
$resultInfo[0]["status"] = false;

$checkFunctions = array(
'authenticate',
'checkTestSuiteID'
);
$status_ok = $this->_runChecks( $checkFunctions, $msg_prefix );

if($status_ok) {
$status_ok = $this->userHasRight( "mgt_modify_tc", self::CHECK_PUBLIC_PRIVATE_ATTR );
if(!$status_ok) {
$this->errors[] = new IXR_Error( INSUFFICIENT_RIGHTS, $msg_prefix . INSUFFICIENT_RIGHTS_STR );
}
}

if($status_ok) {
$tsuiteID = $this->args[self::$testSuiteIDParamName];
$tsuiteMgr = new testsuite( $this->dbObj );
$tsuiteMgr->delete_deep( $tsuiteID );
$resultInfo[0]["status"] = true;
$resultInfo[0]["id"] = $tsuiteID;
$resultInfo[0]["message"] = GENERAL_SUCCESS_STR;
$resultInfo[0]["operation"] = $operation;
}

return $status_ok ? $resultInfo : $this->errors;
}

/**
* Update value of Custom Field with scope='design'
* for a given Test Suite
Expand Down Expand Up @@ -9119,9 +9217,11 @@ function initMethodYellowPages() {
'tl.createTestPlan' => 'this:createTestPlan',
'tl.createTestProject' => 'this:createTestProject',
'tl.createTestSuite' => 'this:createTestSuite',
'tl.deleteTestCase' => 'this:deleteTestCase',
'tl.deleteTestCaseSteps' => 'this:deleteTestCaseSteps',
'tl.deleteTestPlan' => 'this:deleteTestPlan',
'tl.deleteTestProject' => 'this:deleteTestProject',
'tl.deleteTestSuite' => 'this:deleteTestSuite',
'tl.uploadExecutionAttachment' => 'this:uploadExecutionAttachment',
'tl.uploadRequirementSpecificationAttachment' => 'this:uploadRequirementSpecificationAttachment',
'tl.uploadRequirementAttachment' => 'this:uploadRequirementAttachment',
Expand Down
Loading