Skip to content
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.

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

Upload of Generic Package assumes "message" in server's response #2557

Closed
paisleyrob opened this issue Apr 27, 2023 · 2 comments · Fixed by #2581
Closed

Upload of Generic Package assumes "message" in server's response #2557

paisleyrob opened this issue Apr 27, 2023 · 2 comments · Fixed by #2581
Labels

Comments

@paisleyrob
Copy link

Description of the problem, including code/CLI snippet

    project = gl.projects.get(id=project_id)
    result = project.generic_packages.upload(
        file_name=filename,
        package_name=name,
        package_version=version,
        path=upload,
        query_data={"select": "package_file"},
    )

Crashes with:

Traceback (most recent call last):
  File "/w/docker/gitlab-tools.py", line 396, in <module>
    args[0].func(*args)
  File "/w/docker/gitlab-tools.py", line 261, in upload_generic_package
    result = project.generic_packages.upload(
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/gitlab/cli.py", line 71, in wrapped_f
    return f(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/gitlab/exceptions.py", line 336, in wrapped_f
    return f(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/gitlab/v4/objects/packages.py", line 91, in upload
    "message": server_data["message"],
               ~~~~~~~~~~~^^^^^^^^^^^
KeyError: 'message'

Expected Behavior

Return the JSON from GitLab either instead of this response, or as a server_data key in this response.

Actual Behavior

KeyError: 'message'

Specifications

  • python-gitlab version: 3.14.0
  • API version you are using (v3/v4): v4
  • Gitlab server version (or gitlab.com): 15.9.4-ee

Suggested diff something like:

--- gitlab/v4/objects/packages.py 2023-04-27 11:56:35.718464491 -0400
+++ gitlab/v4/objects/packages.py.new     2023-04-27 11:55:20.213449771 -0400
@@ -88,7 +88,8 @@
                 "package_version": package_version,
                 "file_name": file_name,
                 "path": path,
-                "message": server_data["message"],
+                "message": server_data.get("message"),
+                "server_data": server_data,
             },
         )
@nejch nejch added the bug label Apr 27, 2023
@JohnVillalovos
Copy link
Collaborator

Looks like the API has changed since python-gitlab implemented support for this: https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

@nejch
Copy link
Member

nejch commented Apr 27, 2023

Agreed, a bit strange but it depends on the select attribute introduced some time later, I feel like we've had this discussion somewhere but can't find it, maybe it was on gitter.

Probably indeed best to expose whatever the server responds with (maybe with just .json?) and deprecate message entirely.

JohnVillalovos added a commit that referenced this issue May 28, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
JohnVillalovos added a commit that referenced this issue May 29, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
JohnVillalovos added a commit that referenced this issue May 29, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
JohnVillalovos added a commit that referenced this issue May 31, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
JohnVillalovos added a commit that referenced this issue May 31, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
nejch pushed a commit that referenced this issue Jun 6, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
nejch pushed a commit that referenced this issue Jun 6, 2023
Add ability to use `select="package_file"` when uploading a generic
package as described in:
https://docs.gitlab.com/ee/user/packages/generic_packages/index.html

Closes: #2557
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants