[CLI] runner-all command is bugged #593

Activity

1. weakcamel commented on Sep 21, 2018

   

   weakcamel

   on Sep 21, 2018

   ContributorAuthor

   More actions

   A bit similar to #191
2. gpocentek

   added

   bug

   cli

   on Nov 22, 2018
3. pvdissel commented on Aug 27, 2019

   

   pvdissel

   on Aug 27, 2019

   More actions

   Issue still exists :(

   • python-gitlab version: 1.6.0
   • API version you are using (v3/v4): v4
   • Gitlab server version (or gitlab.com): 11.9.6
4. chrisoldwood commented on Jan 29, 2020

   

   chrisoldwood

   on Jan 29, 2020

   More actions

   I was trying to work out why I couldn't see shared runners and assumed it was a permissions thing but now I've had that sorted I've discovered another issue: gitlab runner list --all is not the same as gitlab runner all 🙂 . The spurious --id argument made no sense so I never really gave it a chance.

   The clue for me that I'd misunderstood was in #850 (Runner List does not support pagination options) but I think it would be nice if this could made clearer somewhere in the documentation or command line help.

   FWIW this is still broken with python-gitlab version 1.15.0.
5. chrisoldwood commented on Jan 29, 2020

   

   chrisoldwood

   on Jan 29, 2020

   More actions

   I'm no Python expert but I've managed to fix the crash and get JSON output working by looking at the code for the all custom action on the GroupMemberManager class.

   Hence in v4/objects.py inside the RunnerManager class all method (around line 4881 in 1.15.0), replace:

   return self.gitlab.http_list(path, query_data, **kwargs)
   

   with

   obj = self.gitlab.http_list(path, query_data, **kwargs)
   return [self._obj_cls(self, item) for item in obj]
   

   It still asks for the --id argument but you can just pass --id 0 on the command line as it's ignored.
6. chrisoldwood commented on Jan 29, 2020

   

   chrisoldwood

   on Jan 29, 2020

   More actions

   An alternative workaround, if you're looking for the paging behaviour (which is also broken) and want to avoid the spurious --id argument is to add a new type, called say all-runners, that behaves like runner list, e.g.

   $ gitlab -o json all-runners list --page 2 | jq
   

   This is the snippet of code I added to support that:

   class AllRunners(RESTObject):
       pass
   
   class AllRunnersManager(ListMixin, RESTManager):
       _path = "/runners/all"
       _obj_cls = AllRunners
       _list_filters = ("scope",)
   

   I looked in v4/cli.py and I think the code for handling custom_actions assumes that if the object type has an id then that must be a mandatory argument. But that's clearly all just conjecture though.

               # We need to get the object somehow
               if gitlab.mixins.GetWithoutIdMixin not in inspect.getmro(cls):
                   if cls._id_attr is not None:
                       id_attr = cls._id_attr.replace("_", "-")
                       sub_parser_action.add_argument("--%s" % id_attr, required=True)
   
7. JohnVillalovos

   closed this as completedin #2167on Jul 23, 2022
8. github-actions

   locked as resolved and limited conversation to collaborators on Jul 24, 2023