Skip to content

Keywords Assign to Test Cases

Jump to bottom
github-actions[bot] edited this page Oct 9, 2026 · 4 revisions

Assign Keywords to Test Cases (keywordsAssign) — Wiki

The modernized Assign Keywords to Test Cases screen replaces the legacy lib/keywords/keywordsAssign.php option-transfer page. It attaches or detaches keywords on the latest active version of a single test case (replace semantics, exactly like 1.9.20 setKeywords) or applies add / remove / remove-all operations to every test case inside a test suite subtree.

Path: Test Specification > Assign Keywords URL: gui/templates/keywords/keywordsAssign.html?tproject_id=<id> (optional legacy deep-link: &id=<node_id>&edit=testcase|testsuite — see §9) BFF API: api/keywords/assign.php (REST: /context, /suites, /tcases, /keywords, /locate, POST /case, POST /suite) Prerequisite: keyword_assignment right on the test project

Case mode

Table of Contents

  1. Screen Layout
  2. Test Case Mode
  3. Test Suite Mode
  4. Executed-Version Guard
  5. Rights Model
  6. REST API Reference
  7. i18n Keys
  8. Legacy Deep Links (id / edit)
  9. Testing

1. Screen Layout

  • Teal Dashio header with title + subtitle and the locale switcher.
  • Dark toolbar with the project context, the Target level selector (Test Case / Test Suite) and the action buttons for the active level.
  • Picker row: Test Suite dropdown (+ scope radio in suite mode) or Test Case cascading dropdown; subtitle mirrors the legacy keyword_assignment_subtitle (Test Case :: <name>).
  • Dual listbox (option transfer): Available Keywords on the left, Assigned/Selected Keywords on the right with > >> << < buttons.

2. Test Case Mode

  1. Pick a suite, then a case — cases are listed deep (nested suites included).
  2. The right box loads the keywords assigned to the latest active version (legacy get_keywords_map + ORDER BY keyword).
  3. Move keywords and press Save: the full right-box set replaces the assignment (testcase::setKeywords, same contract as legacy).
  4. A badge marks executed versions; Save is disabled when blocked (see §4).

3. Test Suite Mode

Choose a suite and one scope:

  • entire subtree — legacy get_testcases_deep
  • only direct children — legacy get_children_testcases

The right box is the operation payload (legacy option-transfer semantics):

Button Effect
Add to Test Cases addKeywords(right box) on every case in scope
Remove from Test Cases deleteKeywords(right box) on every case in scope
Remove All clears every keyword from every case in scope, ignores the right box

Cases whose latest active version has been executed are skipped unless your role allows editing them; the toast reports how many were skipped.

An empty suite (no test cases in the selected scope) shows the localized kwa.emptySuite message and disables the three action buttons — mirroring the legacy keyword_assignment_empty_tsuite state (can_do = 0).

Suite mode

Empty suite

4. Executed-Version Guard

Same rule as 1.9.20: when the latest active version has execution rows, keyword changes are blocked unless the user holds testproject_add_remove_keywords_executed_tcversions or testproject_edit_executed_testcases. Blocked state shows an executed badge plus an explanatory note and disables Save.

Executed guard

5. Rights Model

  • Screen access / all write endpoints require keyword_assignment; without it the screen renders an explanatory note and hides pickers, boxes and buttons.
  • Executed-version editing requires one of the two rights above (admins have it).

6. REST API Reference

Route Method Purpose
/api/keywords/assign.php/context GET project info + canAssign + canEditExecuted
/api/keywords/assign.php/suites GET flat dotted-path suite list
/api/keywords/assign.php/tcases?tsuite_id&scope=deep|direct GET case id/name list
/api/keywords/assign.php/keywords?tcase_id= GET available + assigned maps + hasBeenExecuted
/api/keywords/assign.php/locate?tcase_id= GET {parent_id} — suite owning a test case (deep-link resolution)
/api/keywords/assign.php/case POST {tcase_id, keywords[]} replace set (executed-guard enforced)
/api/keywords/assign.php/suite POST {tsuite_id, scope, mode:add|remove|removeall, keywords[]} bulk op with executed skip counters

All routes are session-authenticated and return JSON ({status:"ok"|...}); insufficient rights yield HTTP 403.

7. i18n Keys

30 keys under kwa.* exist in all ten locale bundles (en de es fr it ja pt ro ru zh). No hardcoded strings remain on screen; toasts use parameterized messages (%d counts). The deep-link producer adds tspec.assignKeywords (test-spec context menu) to all ten bundles.

8. Legacy Deep Links (id / edit) — restored (#1107)

1.9.20 accepted keywordsAssign.php?id=<node_id>&edit=testcase|testsuite, used by the test-spec tree and suite view to jump straight to a target. The modern screen now honours the same contract:

Param Behaviour
edit=testcase + id=<tcase_id> resolves the owning suite via /locate, selects the suite + case, loads state
edit=testsuite + id=<tsuite_id> switches the target level to Test Suite, selects that suite (deep scope default)
missing / malformed / id<=0 / edit=testproject falls back to the normal picker (project-wide assignment has no level)
  • Producer (modern): test-spec tree right-click → Assign Keywords (testSpec.html, grant keyword_assignment) opens keywordsAssign.html?tproject_id=<p>&id=<node>&edit=testcase|testsuite.
  • Producer (legacy shim): lib/testcases/listTestCases.php?feature=keywordsAssign forwards id/edit (scalar-guarded, see #1720).
  • Robustness: malformed/non-numeric id is rejected (NaN guard) and array-shaped id/edit are ignored by the shim (is_scalar()), so no path leaks Array into the URL or raises an E_WARNING.

Before — deep link ignored

Test-spec context menu → Assign Keywords

Deep link to a test case

Deep link to a test suite

9. Testing

Suite 43 (Suite ID: 50) in TLU_Test_Cases.md covers both levels, replace vs bulk semantics, deep/direct scope, the executed guard for a restricted role, the no-rights path and i18n validity across bundles.

SCREEN-COMPARE regression suite KWA-1105 (18 TCs, TLU_Test_Cases.md, Refs #1105) re-verifies the parity pass on seeded fixtures (project 1 "KWA Demo Project", users kwanr no-rights / kwadesign restricted, plan+build+execution on Case A2): deep case listing, replace-save, executed badge + blocked Save (POST /case → {status:"blocked", reason:"executed"}), suite bulk add/remove/ remove-all with executed skip counters, no-rights 403 + UI note, all 400/404 error contracts, empty-keyword project card, Română locale switch, Event Viewer cleanliness, php -l + console. Gaps found: #1106 useFilteredSet assign-to-filtered-set dropped · #1108 cleanup (delete legacy keywordsAssign). Fixed during the pass: #1109 empty-suite state (BFF {status:"empty"} + kwa.emptySuite in all 10 bundles + disabled action buttons) · #1110 keyword_assignment right now enforced on all non-/context routes + shared CSRF same-origin guard mounted.

#1107 legacy id/edit deep-link params — implemented: /locate endpoint, applyDeepLink() in the screen, deep-link forwarding shim, the test-spec Assign Keywords context-menu producer and the i18n key tspec.assignKeywords (all 10 bundles). Post-review hardening: refreshAvailable invokes its callback on failure too (picker still renders if /keywords fails), pendingCaseId is reset on empty/failed case loads, and malformed id/array-shaped id/edit are rejected. Verified in the addendum suite ## Task — Issue #1107 (addendum) (TC-1107-15..21, 7/7 PASS).

Clone this wiki locally