Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions atlassian/confluence/cloud/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -755,6 +755,62 @@ def remove_content_label(self, content_id, label_id, **kwargs):
"""Remove label from content."""
return self.delete(f"rest/api/content/{content_id}/label/{label_id}", **kwargs)

def set_page_label(self, page_id, label):
"""
Set a label on the page
:param page_id: content_id format
:param label: label to add
:return:
"""
url = f"rest/api/content/{page_id}/label"
data = {"prefix": "global", "name": label}

try:
response = self.post(path=url, data=data)
except HTTPError as e:
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"There is no content with the given id, "
"or the calling user does not have permission to view the content",
reason=e,
)

raise

return response

def remove_page_label(self, page_id, label):
"""
Delete Confluence page label
:param page_id: content_id format
:param label: label name
:return:
"""
url = f"rest/api/content/{page_id}/label"
# The label goes in the query string so names containing "/" work too
params = {"name": label}

try:
response = self.delete(path=url, params=params)
except HTTPError as e:
if e.response.status_code == 403:
raise ApiPermissionError(
"The user has view permission, but no edit permission to the content",
reason=e,
)
if e.response.status_code == 404:
# Raise ApiError as the documented reason is ambiguous
raise ApiError(
"The content or label doesn't exist, "
"or the calling user doesn't have view permission to the content",
reason=e,
)

raise

return response

# Attachment Management
def get_attachments(self, content_id, **kwargs):
"""Get content attachments."""
Expand Down
4 changes: 4 additions & 0 deletions docs/confluence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -440,9 +440,13 @@ Page actions
word_export = confluence.get_page_as_word(page_id)

# Set a label on the page
# ``ConfluenceCloud`` (and ``Confluence`` with a Cloud URL) also provide
# this, through ``/wiki/rest/api/content/{id}/label``.
confluence.set_page_label(page_id, label)

# Delete Confluence page label
# ``ConfluenceCloud`` (and ``Confluence`` with a Cloud URL) also provide
# this, through ``/wiki/rest/api/content/{id}/label?name=...``.
confluence.remove_page_label(page_id, label)

# Add comment into page
Expand Down
81 changes: 81 additions & 0 deletions tests/confluence/test_confluence_cloud.py
Original file line number Diff line number Diff line change
Expand Up @@ -868,6 +868,87 @@ def test_remove_content_label(self, mock_delete, confluence_cloud):
mock_delete.assert_called_once_with("rest/api/content/123/label/label1", **{})
assert result == {"success": True}

@patch.object(ConfluenceCloud, "post")
def test_set_page_label(self, mock_post, confluence_cloud):
mock_post.return_value = {"results": [{"prefix": "global", "name": "report"}]}

assert confluence_cloud.set_page_label("123", "report") == {"results": [{"prefix": "global", "name": "report"}]}
mock_post.assert_called_once_with(
path="rest/api/content/123/label",
data={"prefix": "global", "name": "report"},
)

def test_set_page_label_requests_wiki_label_endpoint(self, confluence_cloud):
response = Response()
response.status_code = 200
response._content = b'{"results": [{"prefix": "global", "name": "report"}]}'

with patch.object(confluence_cloud._session, "request", return_value=response) as mock_request:
confluence_cloud.set_page_label("123", "report")

assert mock_request.call_args.kwargs["method"] == "POST"
assert mock_request.call_args.kwargs["url"] == "https://test.atlassian.net/wiki/rest/api/content/123/label"
assert mock_request.call_args.kwargs["data"] == '{"prefix": "global", "name": "report"}'

@patch.object(ConfluenceCloud, "post")
def test_set_page_label_404_raises_api_error(self, mock_post, confluence_cloud):
response = Response()
response.status_code = 404
mock_post.side_effect = HTTPError(response=response)

with pytest.raises(ApiError, match="There is no content with the given id"):
confluence_cloud.set_page_label("123", "report")

@patch.object(ConfluenceCloud, "delete")
def test_remove_page_label(self, mock_delete, confluence_cloud):
mock_delete.return_value = None

assert confluence_cloud.remove_page_label("123", "report") is None
mock_delete.assert_called_once_with(path="rest/api/content/123/label", params={"name": "report"})

def test_remove_page_label_requests_wiki_label_endpoint(self, confluence_cloud):
response = Response()
response.status_code = 204

with patch.object(confluence_cloud._session, "request", return_value=response) as mock_request:
confluence_cloud.remove_page_label("123", "team/report")

assert mock_request.call_args.kwargs["method"] == "DELETE"
assert (
mock_request.call_args.kwargs["url"]
== "https://test.atlassian.net/wiki/rest/api/content/123/label?name=team%2Freport"
)

@pytest.mark.parametrize(
"status_code, error, message",
[
(403, ApiPermissionError, "no edit permission to the content"),
(404, ApiError, "The content or label doesn't exist"),
],
)
@patch.object(ConfluenceCloud, "delete")
def test_remove_page_label_errors(self, mock_delete, status_code, error, message, confluence_cloud):
response = Response()
response.status_code = status_code
mock_delete.side_effect = HTTPError(response=response)

with pytest.raises(error, match=message):
confluence_cloud.remove_page_label("123", "report")

@patch.object(ConfluenceCloud, "delete")
@patch.object(ConfluenceCloud, "post")
def test_page_labels_through_confluence_with_cloud_url(self, mock_post, mock_delete):
confluence = Confluence(url="https://test.atlassian.net", username="user", password="api-token")

confluence.set_page_label("123", "report")
confluence.remove_page_label("123", "report")

mock_post.assert_called_once_with(
path="rest/api/content/123/label",
data={"prefix": "global", "name": "report"},
)
mock_delete.assert_called_once_with(path="rest/api/content/123/label", params={"name": "report"})

# Attachment Management Tests
@patch.object(ConfluenceCloud, "get")
def test_get_attachments(self, mock_get, confluence_cloud):
Expand Down
Loading