def test_create_from_report(self):
dataset_populator = DatasetPopulator(self.galaxy_interactor)
workflow_populator = WorkflowPopulator(self.galaxy_interactor)
test_data = """
input_1:
value: 1.bed
type: File
"""
with dataset_populator.test_history() as history_id:
summary = workflow_populator.run_workflow("""
class: GalaxyWorkflow
inputs:
input_1: data
outputs:
output_1:
outputSource: first_cat/out_file1
steps:
first_cat:
tool_id: cat
in:
input1: input_1
""",
test_data=test_data,
history_id=history_id)
workflow_id = summary.workflow_id
invocation_id = summary.invocation_id
report_json = workflow_populator.workflow_report_json(
workflow_id, invocation_id)
assert "markdown" in report_json
self._assert_has_keys(report_json, "markdown", "render_format")
assert report_json["render_format"] == "markdown"
markdown_content = report_json["markdown"]
page_request = dict(
slug="invocation-report",
title="Invocation Report",
invocation_id=invocation_id,
)
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 200)
page_response = page_response.json()
show_response = self._get(f"pages/{page_response['id']}")
self._assert_status_code_is(show_response, 200)
show_json = show_response.json()
self._assert_has_keys(show_json, "slug", "title", "id")
self.assertEqual(show_json["slug"], "invocation-report")
self.assertEqual(show_json["title"], "Invocation Report")
self.assertEqual(show_json["content_format"], "markdown")
markdown_content = show_json["content"]
assert "## Workflow Outputs" in markdown_content
assert "## Workflow Inputs" in markdown_content
assert "## About This Report" not in markdown_content
class PageApiTestCase(BasePageApiTestCase, SharingApiTests):
api_name = "pages"
def setUp(self):
super().setUp()
self.dataset_populator = DatasetPopulator(self.galaxy_interactor)
self.workflow_populator = WorkflowPopulator(self.galaxy_interactor)
def create(self, name: str) -> str:
response_json = self._create_valid_page_with_slug(name)
return response_json["id"]
def test_create(self):
response_json = self._create_valid_page_with_slug("mypage")
self._assert_has_keys(response_json, "slug", "title", "id")
@skip_without_tool("cat")
def test_create_from_report(self):
test_data = """
input_1:
value: 1.bed
type: File
"""
with self.dataset_populator.test_history() as history_id:
summary = self.workflow_populator.run_workflow(
"""
class: GalaxyWorkflow
inputs:
input_1: data
outputs:
output_1:
outputSource: first_cat/out_file1
steps:
first_cat:
tool_id: cat
in:
input1: input_1
""",
test_data=test_data,
history_id=history_id)
workflow_id = summary.workflow_id
invocation_id = summary.invocation_id
report_json = self.workflow_populator.workflow_report_json(
workflow_id, invocation_id)
assert "markdown" in report_json
self._assert_has_keys(report_json, "markdown", "render_format")
assert report_json["render_format"] == "markdown"
markdown_content = report_json["markdown"]
page_request = dict(
slug="invocation-report",
title="Invocation Report",
invocation_id=invocation_id,
)
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 200)
page_response = page_response.json()
show_response = self._get(f"pages/{page_response['id']}")
self._assert_status_code_is(show_response, 200)
show_json = show_response.json()
self._assert_has_keys(show_json, "slug", "title", "id")
self.assertEqual(show_json["slug"], "invocation-report")
self.assertEqual(show_json["title"], "Invocation Report")
self.assertEqual(show_json["content_format"], "markdown")
markdown_content = show_json["content"]
assert "## Workflow Outputs" in markdown_content
assert "## Workflow Inputs" in markdown_content
assert "## About This Report" not in markdown_content
def test_index(self):
create_response_json = self._create_valid_page_with_slug("indexpage")
assert self._users_index_has_page_with_id(create_response_json["id"])
def test_index_does_not_show_unavailable_pages(self):
create_response_json = self._create_valid_page_as(
"*****@*****.**", "otherspageindex")
assert not self._users_index_has_page_with_id(
create_response_json["id"])
def test_cannot_create_pages_with_same_slug(self):
page_request = self._test_page_payload(slug="mypage1")
page_response_1 = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response_1, 200)
page_response_2 = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response_2, 400)
self._assert_error_code_is(
page_response_2,
error_codes.error_codes_by_name["USER_SLUG_DUPLICATE"])
def test_cannot_create_pages_with_invalid_slug(self):
page_request = self._test_page_payload(slug="invalid slug!")
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
def test_cannot_create_page_with_invalid_content_format(self):
page_request = self._test_page_payload(slug="mypageinvalidformat")
page_request["content_format"] = "xml"
page_response_1 = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response_1, 400)
self._assert_error_code_is(
page_response_1,
error_codes.error_codes_by_name["USER_REQUEST_INVALID_PARAMETER"])
def test_page_requires_name(self):
page_request = self._test_page_payload(slug="requires-name")
del page_request['title']
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
self._assert_error_code_is(
page_response,
error_codes.error_codes_by_name["USER_REQUEST_MISSING_PARAMETER"])
def test_page_requires_slug(self):
page_request = self._test_page_payload()
del page_request['slug']
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
def test_delete(self):
response_json = self._create_valid_page_with_slug("testdelete")
delete_response = delete(
self._api_url(f"pages/{response_json['id']}", use_key=True))
self._assert_status_code_is(delete_response, 204)
def test_400_on_delete_invalid_page_id(self):
delete_response = delete(
self._api_url(f"pages/{self._random_key()}", use_key=True))
self._assert_status_code_is(delete_response, 400)
self._assert_error_code_is(
delete_response, error_codes.error_codes_by_name["MALFORMED_ID"])
def test_403_on_delete_unowned_page(self):
page_response = self._create_valid_page_as("*****@*****.**",
"otherspage")
delete_response = delete(
self._api_url(f"pages/{page_response['id']}", use_key=True))
self._assert_status_code_is(delete_response, 403)
self._assert_error_code_is(
delete_response,
error_codes.error_codes_by_name["USER_DOES_NOT_OWN_ITEM"])
def test_400_on_invalid_id_encoding(self):
page_request = self._test_page_payload(slug="invalid-id-encding")
page_request[
"content"] = '''<p>Page!<div class="embedded-item" id="History-invaidencodedid"></div></p>'''
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
self._assert_error_code_is(
page_response, error_codes.error_codes_by_name["MALFORMED_ID"])
def test_400_on_invalid_id_encoding_markdown(self):
page_request = self._test_page_payload(
slug="invalid-id-encding-markdown", content_format="markdown")
page_request[
"content"] = '''```galaxy\nhistory_dataset_display(history_dataset_id=badencoding)\n```\n'''
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
self._assert_error_code_is(
page_response, error_codes.error_codes_by_name["MALFORMED_ID"])
def test_400_on_invalid_embedded_content(self):
valid_id = self.dataset_populator.new_history()
page_request = self._test_page_payload(slug="invalid-embed-content")
page_request[
"content"] = f'''<p>Page!<div class="embedded-item" id="CoolObject-{valid_id}"></div></p>'''
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
self._assert_error_code_is(
page_response,
error_codes.error_codes_by_name["USER_REQUEST_INVALID_PARAMETER"])
assert "embedded HTML content" in page_response.text
def test_400_on_invalid_markdown_call(self):
page_request = self._test_page_payload(slug="invalid-markdown-call",
content_format="markdown")
page_request["content"] = '''```galaxy\njob_metrics(job_id)\n```\n'''
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 400)
self._assert_error_code_is(
page_response,
error_codes.error_codes_by_name["MALFORMED_CONTENTS"])
def test_show(self):
response_json = self._create_valid_page_with_slug("pagetoshow")
show_response = self._get(f"pages/{response_json['id']}")
self._assert_status_code_is(show_response, 200)
show_json = show_response.json()
self._assert_has_keys(show_json, "slug", "title", "id")
self.assertEqual(show_json["slug"], "pagetoshow")
self.assertEqual(show_json["title"], "MY PAGE")
self.assertEqual(show_json["content"], "<p>Page!</p>")
self.assertEqual(show_json["content_format"], "html")
def test_403_on_unowner_show(self):
response_json = self._create_valid_page_as(
"*****@*****.**", "otherspageshow")
show_response = self._get(f"pages/{response_json['id']}")
self._assert_status_code_is(show_response, 403)
self._assert_error_code_is(
show_response,
error_codes.error_codes_by_name["USER_CANNOT_ACCESS_ITEM"])
def test_501_on_download_pdf_when_service_unavailable(self):
configuration = self.dataset_populator.get_configuration()
can_produce_markdown = configuration["markdown_to_pdf_available"]
if can_produce_markdown:
raise SkipTest(
"Skipping test because server does implement markdown conversion to PDF"
)
page_request = self._test_page_payload(
slug="md-page-to-pdf-not-implemented", content_format="markdown")
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 200)
page_id = page_response.json()['id']
pdf_response = self._get(f"pages/{page_id}.pdf")
api_asserts.assert_status_code_is(pdf_response, 501)
api_asserts.assert_error_code_is(
pdf_response, error_codes.
error_codes_by_name["SERVER_NOT_CONFIGURED_FOR_REQUEST"])
def test_pdf_when_service_available(self):
configuration = self.dataset_populator.get_configuration()
can_produce_markdown = configuration["markdown_to_pdf_available"]
if not can_produce_markdown:
raise SkipTest(
"Skipping test because server does not implement markdown conversion to PDF"
)
page_request = self._test_page_payload(slug="md-page-to-pdf",
content_format="markdown")
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 200)
page_id = page_response.json()['id']
pdf_response = self._get(f"pages/{page_id}.pdf")
api_asserts.assert_status_code_is(pdf_response, 200)
assert "application/pdf" in pdf_response.headers['content-type']
assert pdf_response.content[0:4] == b"%PDF"
def test_400_on_download_pdf_when_unsupported_content_format(self):
page_request = self._test_page_payload(slug="html-page-to-pdf",
content_format="html")
page_response = self._post("pages", page_request, json=True)
self._assert_status_code_is(page_response, 200)
page_id = page_response.json()['id']
pdf_response = self._get(f"pages/{page_id}.pdf")
self._assert_status_code_is(pdf_response, 400)
def _users_index_has_page_with_id(self, id):
index_response = self._get("pages")
self._assert_status_code_is(index_response, 200)
pages = index_response.json()
return id in (_["id"] for _ in pages)