Tags filtering is not returning the expected result through the API #4828

Activity

1. winem commented on Feb 22, 2020

   

   winem

   on Feb 22, 2020

   Last edited by winem

   Contributor

   More actions

   I just verified the bug with

   st2 --version
   st2 3.1.0, on Python 2.7.6
   

   in the st2-docker setup.

   Curl to retrieve an action with a tag:

   curl -H "X-Auth-Token: xxx" -k https://localhost/api/v1/actions?name=marvel_workflow_demo
   [
       {
           "parameters": {
               "environment": {
                   "required": true,
                   "type": "string"
               },
               "component": {
                   "required": true,
                   "type": "string"
               },
               "docker_tag": {
                   "required": true,
                   "type": "string"
               }
           },
           "runner_type": "orquesta",
           "tags": [
               {
                   "name": "marvel-project",
                   "value": "self-service"
               }
           ],
           "description": "A basic workflow that applies the default workflow for docker image updates.",
           "enabled": true,
           "metadata_file": "actions/marvel_workflow_demo.meta.yaml",
           "entry_point": "workflows/marvel_workflow_demo.yaml",
           "notify": {},
           "output_schema": {},
           "uid": "action:cm_demo_pack:marvel_workflow_demo",
           "pack": "cm_demo_pack",
           "ref": "cm_demo_pack.marvel_workflow_demo",
           "id": "5e4c213b90f52c00e35343ea",
           "name": "marvel_workflow_demo"
       }
   

   Curl with the tag filter:

   curl -H "X-Auth-Token: xxx" -k https://localhost/api/v1/actions?tags=marvel-project
   []
   
2. arm4b

   added

   API

   bug

   service: api

   on Feb 22, 2020
3. arm4b commented on Feb 22, 2020

   

   arm4b

   on Feb 22, 2020

   Member

   More actions

   @winem Thanks for checking this issue! I assigned the respective tags, assuming it's verified bug.

   Looks like tag filtering for the actions functionality was added in st2 v2.9 via #4219 contribution.
4. arm4b

   added

   good first issue

   on Feb 22, 2020
5. winem commented on Feb 22, 2020

   

   winem

   on Feb 22, 2020

   Contributor

   More actions

   Ok, I was able to nail it down. The issue is that both tags have the same value as indicator:

   https://github.com/NikosVlagoidis/st2/blob/3132f6ad72ca9188093b1dc067808efcc19e3d66/st2api/st2api/controllers/v1/actions.py#L61-L65

   Therefore, the tag filter just works if the tag value matches the name.

   Example to get the task from above:

   curl -H "X-Auth-Token: xxx" -k 'https://localhost/api/v1/actions?tags=marvel_workflow_demo'
   [
       {
           "parameters": {
               "environment": {
                   "required": true,
                   "type": "string"
               },
               "component": {
                   "required": true,
                   "type": "string"
               },
               "docker_tag": {
                   "required": true,
                   "type": "string"
               }
           },
           "runner_type": "orquesta",
           "tags": [
               {
                   "name": "marvel-project",
                   "value": "self-service"
               }
           ],
           "description": "A basic workflow that applies the default workflow for docker image updates.",
           "enabled": true,
           "metadata_file": "actions/marvel_workflow_demo.meta.yaml",
           "entry_point": "workflows/marvel_workflow_demo.yaml",
           "notify": {},
           "output_schema": {},
           "uid": "action:cm_demo_pack:marvel_workflow_demo",
           "pack": "cm_demo_pack",
           "ref": "cm_demo_pack.marvel_workflow_demo",
           "id": "5e4c213b90f52c00e35343ea",
           "name": "marvel_workflow_demo"
       }
   ]
   
6. arm4b

   added this to the 3.2.0 milestone on Apr 10, 2020
7. arm4b

   closed this as completedin #4874on Apr 10, 2020
8. arm4b

   added a commit that references this issue on Apr 10, 2020

   Merge pull request #4874 from winem/fix/4828-filter-actions-by-tagname

   ...

   755120a