Merge pull request 3scale-qe#133 from mkudlej/cms_api_1

CMS objects support

Author: mkudlej

tests/integration/conftest.py

@@ -497,3 +497,84 @@ def fields_definition(api, fields_definitions_params):
     entity = api.fields_definitions.create(fields_definitions_params)
     yield entity
     cleanup(entity)
+
+
+@pytest.fixture(scope="module")
+def cms_file_data(cms_section):
+    """CMS file fixture data"""
+    return {"path": f"/path{get_suffix()}", "downloadable": True, 'section_id': cms_section['id']}
+
+
+@pytest.fixture(scope="module")
+def cms_file_files(active_docs_body):
+    """CMS file fixture files.
+    File object can be used instead of file body 'active_docs_body',
+    see https://requests.readthedocs.io/en/latest/user/advanced/#post-multiple-multipart-encoded-files """
+    return {"attachment": (f"name-{get_suffix()}", active_docs_body, "application/json", {"Expires": 0})}
+
+
+@pytest.fixture(scope="module")
+def cms_file(api, cms_file_data, cms_file_files):
+    """CMS file fixture"""
+    entity = api.cms_files.create(params={}, files=cms_file_files, data=cms_file_data)
+    yield entity
+    cleanup(entity)
+
+
+@pytest.fixture(scope="module")
+def cms_section_params():
+    """CMS section fixture params"""
+    return {"title": f"title-{get_suffix()}", "public": True, "partial_path": f"/path-{get_suffix()}"}
+
+
+@pytest.fixture(scope="module")
+def cms_section(api, cms_section_params):
+    """CMS section fixture"""
+    entity = api.cms_sections.create(cms_section_params)
+    yield entity
+    cleanup(entity)
+
+
+@pytest.fixture(scope="module")
+def cms_partial_params():
+    """CMS partial fixture params"""
+    return {"system_name": f"sname-{get_suffix()}", "draft": f"draft-{get_suffix()}"}
+
+
+@pytest.fixture(scope="module")
+def cms_partial(api, cms_partial_params):
+    """CMS partial fixture"""
+    entity = api.cms_partials.create(cms_partial_params)
+    yield entity
+    cleanup(entity)
+
+
+@pytest.fixture(scope="module")
+def cms_layout_params(cms_section):
+    """CMS layout fixture params"""
+    return {"system_name": f"sname-{get_suffix()}", "draft": f"draft-{get_suffix()}",
+            "title": f"title-{get_suffix()}", "liquid_enabled": True, "section_id": cms_section['id']}
+
+@pytest.fixture(scope="module")
+def cms_layout(api, cms_layout_params):
+    """CMS layout fixture"""
+    entity = api.cms_layouts.create(cms_layout_params)
+    yield entity
+    cleanup(entity)
+
+@pytest.fixture(scope="module")
+def cms_page_params(cms_section, cms_layout):
+    """CMS page fixture params"""
+    return {"system_name": f"sname-{get_suffix()}", "draft": f"draft-{get_suffix()}",
+            "title": f"title-{get_suffix()}", "path": f"/path-{get_suffix()}",
+            "section_name": f"section-{get_suffix()}", "section_id": cms_section['id'],
+            "layout_name": f"layout-{get_suffix()}", "layout_id": cms_layout['id'],
+            "liquid_enabled": True, "handler": "markdown", "content_type": "text/html"}
+
+
+@pytest.fixture(scope="module")
+def cms_page(api, cms_page_params):
+    """CMS page fixture"""
+    entity = api.cms_pages.create(cms_page_params)
+    yield entity
+    cleanup(entity)

tests/integration/test_integration_cms.py

@@ -0,0 +1,273 @@
+import pytest
+from tests.integration import asserts
+from threescale_api import errors
+from .asserts import assert_resource, assert_resource_params
+
+
+# Files
+def test_file_list(api, cms_file):
+    """ List all files. """
+    assert len(api.cms_files.list()) >= 1
+
+
+def test_file_can_be_created(cms_file_data, cms_file):
+    """ Is file created properly? """
+    assert_resource(cms_file)
+    assert_resource_params(cms_file, cms_file_data)
+
+
+def test_file_can_be_read(api, cms_file_data, cms_file):
+    """ It is possible to get file by ID? """
+    read = api.cms_files.read(cms_file.entity_id)
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_file_data)
+
+
+def test_file_can_be_read_by_name(api, cms_file_data, cms_file):
+    """ It is possible to get file by name? """
+    file_path = cms_file['path']
+    read = api.cms_files[file_path]
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_file_data)
+
+
+def test_file_can_be_updated(cms_file_data, cms_file):
+    """ Can be file object updated? """
+    updated_path = cms_file['path'] + 'up'
+    cms_file['path'] = cms_file['path'] + 'up'
+    # TODO https://issues.redhat.com/browse/THREESCALE-9571
+    for item in "created_at", "updated_at", "url", "title", "content_type":
+        cms_file.pop(item)
+    cms_file.update()
+    assert cms_file['path'] == updated_path
+    updated = cms_file.read()
+    assert updated['path'] == updated_path
+    assert cms_file['path'] == updated_path
+
+
+# Sections
+
+
+def test_section_list(api, cms_section):
+    """ List all sections. """
+    assert len(api.cms_sections.list()) >= 1
+
+
+def test_section_can_be_created(cms_section_params, cms_section):
+    """ Is section created properly? """
+    assert_resource(cms_section)
+    assert_resource_params(cms_section, cms_section_params)
+
+
+def test_section_can_be_read(api, cms_section_params, cms_section):
+    """ It is possible to get section by ID? """
+    read = api.cms_sections.read(cms_section.entity_id)
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_section_params)
+
+
+def test_section_can_be_updated(cms_section_params, cms_section):
+    """ Can be section object updated? """
+    updated_title = cms_section['title'] + 'up'
+    cms_section['title'] = cms_section['title'] + 'up'
+    # TODO https://issues.redhat.com/browse/THREESCALE-9571
+    for item in "created_at", "updated_at":
+        cms_section.pop(item)
+    cms_section.update()
+    assert cms_section['title'] == updated_title
+    updated = cms_section.read()
+    assert updated['title'] == updated_title
+    assert cms_section['title'] == updated_title
+
+
+# # bug!!! TODO https://issues.redhat.com/browse/THREESCALE-9572
+# def test_builtin_section_delete(api):
+#     """It is not possible to delete section partial."""
+#     with pytest.raises(errors.ApiClientError) as exc_info:
+#         api.cms_sections.list()[0].delete()
+#     assert exc_info.value.code == 423
+#     # TODO
+#     # assert exc_info.value.code == 400
+
+
+# Partials
+# builtin
+
+
+def test_builtin_partials_list(api):
+    """ List all sections. """
+    assert len(api.cms_builtin_partials.list()) >= 1
+
+
+def test_builtin_partial_can_be_read(api):
+    """ It is possible to get partial by ID? """
+    cms_partial = api.cms_builtin_partials.list()[-1]
+    read = api.cms_builtin_partials.read(cms_partial.entity_id)
+    asserts.assert_resource(read)
+
+def test_builtin_partial_delete(api):
+    """It is not possible to delete builtin partial."""
+    with pytest.raises(errors.ApiClientError) as exc_info:
+        api.cms_builtin_partials.list()[0].delete()
+    assert exc_info.value.code == 423
+    # TODO https://issues.redhat.com/browse/THREESCALE-9572
+    # assert exc_info.value.code == 400
+
+# user
+
+
+def test_partial_list(api, cms_partial):
+    """ List all user defined partials. """
+    assert len(api.cms_partials.list()) >= 1
+
+
+def test_partial_can_be_created(cms_partial_params, cms_partial):
+    """ Is partial created properly? """
+    assert_resource(cms_partial)
+    assert_resource_params(cms_partial, cms_partial_params)
+
+
+def test_partial_can_be_read(api, cms_partial_params, cms_partial):
+    """ It is possible to get partial by ID? """
+    read = api.cms_partials.read(cms_partial.entity_id)
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_partial_params)
+
+
+def test_partial_can_be_updated(cms_partial_params, cms_partial):
+    """ Can be partial object updated? """
+    updated_draft = cms_partial['draft'] + 'up'
+    cms_partial['draft'] = cms_partial['draft'] + 'up'
+    # TODO https://issues.redhat.com/browse/THREESCALE-9571
+    for item in "created_at", "updated_at", "published":
+        cms_partial.pop(item)
+    cms_partial.update()
+    assert cms_partial['draft'] == updated_draft
+    updated = cms_partial.read()
+    assert updated['draft'] == updated_draft
+    assert cms_partial['draft'] == updated_draft
+
+
+def test_partial_publish(cms_partial):
+    """ Test publishing of partials. """
+    assert cms_partial.entity.get('published', None) is None
+    draft = cms_partial['draft']
+    cms_partial = cms_partial.publish()
+    # assert draft == cms_partial['draft'] bug
+    # assert cms_partial['published'] == cms_partial['draft'] bug
+    assert draft == cms_partial['published']
+
+
+# Pages
+# builtin
+
+
+def test_builtin_pages_list(api):
+    """ List all sections. """
+    assert len(api.cms_builtin_pages.list()) >= 1
+
+
+def test_builtin_page_can_be_read(api):
+    """ It is possible to get page by ID? """
+    cms_page = api.cms_builtin_pages.list()[-1]
+    read = api.cms_builtin_pages.read(cms_page.entity_id)
+    asserts.assert_resource(read)
+
+
+def test_builtin_page_delete(api):
+    """It is not possible to delete builtin page."""
+    with pytest.raises(errors.ApiClientError) as exc_info:
+        api.cms_builtin_pages.list()[0].delete()
+    assert exc_info.value.code == 423
+    # TODO https://issues.redhat.com/browse/THREESCALE-9572
+    # assert exc_info.value.code == 400
+
+
+# user
+
+
+def test_page_list(api, cms_page):
+    """ List all user defined pages. """
+    assert len(api.cms_pages.list()) >= 1
+
+
+def test_page_can_be_created(cms_page_params, cms_page):
+    """ Is page created properly? """
+    assert_resource(cms_page)
+    assert_resource_params(cms_page, cms_page_params)
+
+
+def test_page_can_be_read(api, cms_page_params, cms_page):
+    """ It is possible to get page by ID? """
+    read = api.cms_pages.read(cms_page.entity_id)
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_page_params)
+
+
+def test_page_can_be_updated(cms_page_params, cms_page):
+    """ Can be page object updated? """
+    updated_draft = cms_page['draft'] + 'up'
+    cms_page['draft'] = cms_page['draft'] + 'up'
+    # TODO https://issues.redhat.com/browse/THREESCALE-9571
+    for item in "created_at", "updated_at", "hidden", "published":
+        cms_page.pop(item)
+    cms_page.update()
+    assert cms_page['draft'] == updated_draft
+    updated = cms_page.read()
+    assert updated['draft'] == updated_draft
+    assert cms_page['draft'] == updated_draft
+
+
+def test_page_publish(cms_page):
+    """ Test publishing of pages. """
+    assert cms_page.entity.get('published', None) is None
+    draft = cms_page['draft']
+    cms_page = cms_page.publish()
+    # assert draft == cms_page['draft'] bug
+    # assert cms_page['published'] == cms_page['draft'] bug
+    assert draft == cms_page['published']
+
+
+# Layouts
+
+
+def test_layout_list(api, cms_layout):
+    """ List all user defined layouts. """
+    assert len(api.cms_layouts.list()) >= 1
+
+
+def test_layout_can_be_created(cms_layout_params, cms_layout):
+    """ Is layout created properly? """
+    assert_resource(cms_layout)
+    assert_resource_params(cms_layout, cms_layout_params)
+
+
+def test_layout_can_be_read(api, cms_layout_params, cms_layout):
+    """ It is possible to get layout by ID? """
+    read = api.cms_layouts.read(cms_layout.entity_id)
+    asserts.assert_resource(read)
+    asserts.assert_resource_params(read, cms_layout_params)
+
+
+def test_layout_can_be_updated(cms_layout_params, cms_layout):
+    """ Can be layout object updated? """
+    updated_draft = cms_layout['draft'] + 'up'
+    cms_layout['draft'] = cms_layout['draft'] + 'up'
+    # TODO https://issues.redhat.com/browse/THREESCALE-9571
+    for item in "created_at", "updated_at", "published":
+        cms_layout.pop(item)
+    cms_layout.update()
+    assert cms_layout['draft'] == updated_draft
+    updated = cms_layout.read()
+    assert updated['draft'] == updated_draft
+    assert cms_layout['draft'] == updated_draft
+
+
+def test_layout_publish(cms_layout):
+    """ Test publishing of layouts. """
+    assert cms_layout.entity.get('published', None) is None
+    draft = cms_layout['draft']
+    cms_layout = cms_layout.publish()
+    # assert draft == cms_layout['draft'] bug
+    # assert cms_layout['published'] == cms_layout['draft'] bug
+    assert draft == cms_layout['published']