feat(uploads): wrap agents and agents/revision endpoints#195
Closed
Valyrian-Code wants to merge 1 commit into
Closed
feat(uploads): wrap agents and agents/revision endpoints#195Valyrian-Code wants to merge 1 commit into
Valyrian-Code wants to merge 1 commit into
Conversation
Refs fossology#52. Adds two read-only getters for the agents that have run on an upload: - upload_agents() -> GET /uploads/{id}/agents, returning a list[AgentOfUpload] (uploadId / agentName / currentAgentId / currentAgentRev / isAgentRunning / successfulAgents) - upload_agents_revision() -> GET /uploads/{id}/agents/revision, returning a list[AgentsRevision] (id / name / revision) Adds the AgentOfUpload and AgentsRevision models to obj.py following the existing from_json convention. Both methods raise AuthorizationError on HTTP 403, consistent with the other uploads endpoints. Verified against Fossology 4.4.0 (API 1.6.1) running in a container: all 7 tests pass (live happy paths, mocked payload/parse assertions, and 403/500 error paths). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Signed-off-by: RAJVEER42 <irajveer.bishnoi2310@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the uploads API wrapper to expose Fossology’s “agents run on an upload” data, adding typed model objects and corresponding client methods for two read-only endpoints.
Changes:
- Added
upload_agents()wrapper forGET /uploads/{id}/agentsreturninglist[AgentOfUpload]. - Added
upload_agents_revision()wrapper forGET /uploads/{id}/agents/revisionreturninglist[AgentsRevision]. - Added new tests and new
obj.pymodels to parse the responses via the existingfrom_jsonconvention.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
tests/test_uploads.py |
Adds tests for the two new uploads getters (payload parsing and some error paths). |
fossology/uploads.py |
Implements the two new uploads endpoints and error handling. |
fossology/obj.py |
Introduces AgentOfUpload and AgentsRevision models with from_json + __str__. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+409
to
+420
| @responses.activate | ||
| def test_upload_agents_revision_500_error( | ||
| foss: Fossology, foss_server: str, upload: Upload | ||
| ): | ||
| responses.add( | ||
| responses.GET, | ||
| f"{foss_server}/api/v1/uploads/{upload.id}/agents/revision", | ||
| status=500, | ||
| ) | ||
| with pytest.raises(FossologyApiError): | ||
| foss.upload_agents_revision(upload) | ||
|
|
Contributor
Author
|
Replaced by #198. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #52.
Adds two read-only getters for the agents that have run on an upload:
upload_agents()→GET /uploads/{id}/agents— returnslist[AgentOfUpload](uploadId/agentName/currentAgentId/currentAgentRev/isAgentRunning/successfulAgents)upload_agents_revision()→GET /uploads/{id}/agents/revision— returnslist[AgentsRevision](id/name/revision)Adds the
AgentOfUploadandAgentsRevisionmodels toobj.py, following the existingfrom_jsonconvention. Both methods raiseAuthorizationErroron HTTP 403, consistent with the other uploads endpoints.API details
Verified against Fossology 4.4.0 (API 1.6.1) running in a container.
Tests
All 7 pass live: happy paths for both getters, mocked payload/parse assertions, and 403/500 error paths.
ruffandmypypass.🤖 Generated with Claude Code