Project Push Rules get method returning NoneType #1192

Activity

1. nejch commented on Sep 17, 2020

   

   nejch

   on Sep 17, 2020

   Member

   More actions

   I personally have no way of testing this as it's an EE feature, but the fact that it's returning None only on project creation makes me think the webhook is fired before GitLab has fully configured the project (an asynchronous task, probably).

   Can you try to give a generous sleep() before pushrules.get() and see if that helps? If that works, then you can find more graceful ways of handling it.

   👍React with 👍2Reacted by Max Wittig and Leonardo Godoy
2. L30Bola commented on Sep 25, 2020

   

   L30Bola

   on Sep 25, 2020

   Author

   More actions

   Hmm, sorry for the delay on giving an answer. So, I was wrong on this working on recently-created repositories. I tried creating one and waiting for it to be "workable". Even with the sleep and I still got the error, Push Rules is returning None on repository creation.
3. nejch commented on Sep 25, 2020

   

   nejch

   on Sep 25, 2020

   Member

   More actions

   Ah ok. Heh, then it's probably this:
   

   python-gitlab/gitlab/mixins.py

   Lines 69 to 72 in c161852

   	server_data = self.gitlab.http_get(self.path, **kwargs)
   	if server_data is None:
   	return None
   	return self._obj_cls(self, server_data)

   I guess the response from a plain request with curl/requests is empty as well, rather than a 404 response like with some other get endpoints (I can't try myself)?

   It'd be good then to check the rest of the codebase for similar scenarios to see if this is actually the desired behavior for GetWithoutIdMixin since some other people might be using it this way, and simply create the resource when it does not exist. e.g.

   project_push_rules = project.pushrules.get()
   if not project_push_rules:
       project.pushrules.create(data)

   ❤️React with ❤️1Reacted by Leonardo Godoy
4. L30Bola commented on Sep 25, 2020

   

   L30Bola

   on Sep 25, 2020

   Author

   More actions

   YAY! I changed the original function to this:

   def set_project_push_rules_configuration(gitlab, project_id, **kwargs):
       """
       On kwargs you pass arguments that are mutable using the Gitlab Project's Push Rules API
       Documentation on that: https://docs.gitlab.com/ee/api/projects.html#push-rules
   
       Double check your kwargs because arguments not supported by the API
       (let's say a typo, for example) are simply ignored
       """
   
       defaults = {
           "prevent_secrets": True,
       }
       defaults.update(kwargs)
       project = gitlab.projects.get(project_id)
       project_push_rules = project.pushrules.get()
       if project_push_rules is None:
           try:
               project.pushrules.create(defaults)
           except GitlabCreateError:
               exception(
                   "Couldn't create "
                   + project.name
                   + "'s (ID: "
                   + str(project_id)
                   + ") Push Rules configurations!"
               )
       else:
           project_push_rules = set_attrs(project_push_rules, defaults)
           try:
               project_push_rules.save()
           except GitlabUpdateError:
               exception(
                   "Couldn't update "
                   + project.name
                   + "'s (ID: "
                   + str(project_id)
                   + ") Push Rules configurations!"
               )

   And now it works! Thanks for the help.
5. L30Bola

   closed this as completedon Sep 25, 2020
6. github-actions

   locked as resolved and limited conversation to collaborators on Nov 7, 2021