.. image:: https://github.com/lemoncheesecake/lemoncheesecake/blob/master/doc/_static/logo.png?raw=true
:target: http://lemoncheesecake.io
------------
lemoncheesecake: Test Storytelling
==================================
.. image:: https://github.com/lemoncheesecake/lemoncheesecake/actions/workflows/tests.yml/badge.svg
:target: https://github.com/lemoncheesecake/lemoncheesecake/actions/workflows/tests.yml
.. image:: https://codecov.io/gh/lemoncheesecake/lemoncheesecake/branch/master/graph/badge.svg
:target: https://codecov.io/gh/lemoncheesecake/lemoncheesecake
.. image:: https://img.shields.io/pypi/v/lemoncheesecake.svg
:target: https://pypi.org/project/lemoncheesecake/
.. image:: https://img.shields.io/pypi/pyversions/lemoncheesecake.svg
:target: https://pypi.org/project/lemoncheesecake/
lemoncheesecake is an end-to-end test framework for Python that brings trust around test results.
It allows test developers to be very explicit about what their tests really do with logging, matchers, file attachments, etc..
Here is a test example:
.. code-block:: python
import json
import requests
import lemoncheesecake.api as lcc
from lemoncheesecake.matching import *
URL = "https://api.github.com/orgs/lemoncheesecake"
@lcc.suite("Github tests")
class github:
@lcc.test("Test Organization end-point")
def organization(self):
lcc.set_step("Get lemoncheesecake organization information")
lcc.log_info("GET %s" % URL)
resp = requests.get(URL)
require_that("HTTP code", resp.status_code, is_(200))
data = resp.json()
lcc.log_info("Response\n%s" % json.dumps(data, indent=4))
lcc.set_step("Check API response")
check_that_in(
data,
"type", is_("Organization"),
"id", is_integer(),
"description", is_not_none(),
"login", is_(present()),
"created_at", match_pattern("^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$"),
"has_organization_projects", is_true(),
"followers", is_(greater_than_or_equal_to(0)),
"following", is_(greater_than_or_equal_to(0)),
"repos_url", ends_with("/repos"),
"issues_url", ends_with("/issues"),
"events_url", ends_with("/events"),
"hooks_url", ends_with("/hooks"),
"members_url", ends_with("/members{/member}"),
"public_members_url", ends_with("/public_members{/member}")
)
And here are the corresponding test results:
.. image:: https://github.com/lemoncheesecake/lemoncheesecake/blob/master/doc/_static/report-sample.png?raw=true
:alt: test results
NB: in real test code, you'd better use
`lemoncheesecake-requests <https://github.com/lemoncheesecake/lemoncheesecake-requests>`_ when doing HTTP / REST API
testing.
Features
--------
- Advanced test hierarchies using suites, tests and nested suites
- Test description and metadata: tags, properties (key=value associations) and links
- Support for test filtering
- Multiple reporting flavors built-in: HTML, JSON, XML, JUnit, ReportPortal, Slack notifications
- BDD support using `behave <https://behave.readthedocs.io/en/latest/>`_
- Test parallelization
- Rich CLI toolbox
lemoncheesecake is compatible with Python 3.8-3.12.
Installation
------------
lemoncheesecake can be installed through pip:
.. code-block:: shell
$ pip install lemoncheesecake
For more details about installing lemoncheesecake with the non-default reporting backends, see
`here <http://docs.lemoncheesecake.io/en/latest/installation.html>`_.
Documentation
-------------
The documentation is available on http://docs.lemoncheesecake.io.
The lemoncheesecake ecosystem
-----------------------------
- `lemoncheesecake-requests <https://github.com/lemoncheesecake/lemoncheesecake-requests>`_ provides logging
and response checking features for `requests <https://docs.python-requests.org/en/master/>`_
and HTTP / REST API / Web Services testing
- `lemoncheesecake-selenium <https://github.com/lemoncheesecake/lemoncheesecake-selenium>`_ is a package
that helps you develop Web UI tests with `selenium <https://www.selenium.dev>`_
Contact
-------
Bugs and improvement ideas are welcomed in tickets. A Google Groups forum is also available for discussions about
lemoncheesecake: https://groups.google.com/forum/#!forum/lemoncheesecake.
Raw data
{
"_id": null,
"home_page": "http://lemoncheesecake.io",
"name": "lemoncheesecake",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "QA tests functional",
"author": "Nicolas Delon",
"author_email": "nicolas.delon@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ea/32/43f5cd95817ecd690201bd38fcf7610dd7dcaf757316ec2f0d1437108f3b/lemoncheesecake-1.15.0.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/lemoncheesecake/lemoncheesecake/blob/master/doc/_static/logo.png?raw=true\n :target: http://lemoncheesecake.io\n\n------------\n\nlemoncheesecake: Test Storytelling\n==================================\n\n.. image:: https://github.com/lemoncheesecake/lemoncheesecake/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/lemoncheesecake/lemoncheesecake/actions/workflows/tests.yml\n\n.. image:: https://codecov.io/gh/lemoncheesecake/lemoncheesecake/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/lemoncheesecake/lemoncheesecake\n\n.. image:: https://img.shields.io/pypi/v/lemoncheesecake.svg\n :target: https://pypi.org/project/lemoncheesecake/\n\n.. image:: https://img.shields.io/pypi/pyversions/lemoncheesecake.svg\n :target: https://pypi.org/project/lemoncheesecake/\n\nlemoncheesecake is an end-to-end test framework for Python that brings trust around test results.\nIt allows test developers to be very explicit about what their tests really do with logging, matchers, file attachments, etc..\n\nHere is a test example:\n\n.. code-block:: python\n\n import json\n import requests\n\n import lemoncheesecake.api as lcc\n from lemoncheesecake.matching import *\n\n URL = \"https://api.github.com/orgs/lemoncheesecake\"\n\n @lcc.suite(\"Github tests\")\n class github:\n @lcc.test(\"Test Organization end-point\")\n def organization(self):\n lcc.set_step(\"Get lemoncheesecake organization information\")\n lcc.log_info(\"GET %s\" % URL)\n resp = requests.get(URL)\n require_that(\"HTTP code\", resp.status_code, is_(200))\n data = resp.json()\n lcc.log_info(\"Response\\n%s\" % json.dumps(data, indent=4))\n\n lcc.set_step(\"Check API response\")\n check_that_in(\n data,\n \"type\", is_(\"Organization\"),\n \"id\", is_integer(),\n \"description\", is_not_none(),\n \"login\", is_(present()),\n \"created_at\", match_pattern(\"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$\"),\n \"has_organization_projects\", is_true(),\n \"followers\", is_(greater_than_or_equal_to(0)),\n \"following\", is_(greater_than_or_equal_to(0)),\n \"repos_url\", ends_with(\"/repos\"),\n \"issues_url\", ends_with(\"/issues\"),\n \"events_url\", ends_with(\"/events\"),\n \"hooks_url\", ends_with(\"/hooks\"),\n \"members_url\", ends_with(\"/members{/member}\"),\n \"public_members_url\", ends_with(\"/public_members{/member}\")\n )\n\nAnd here are the corresponding test results:\n\n.. image:: https://github.com/lemoncheesecake/lemoncheesecake/blob/master/doc/_static/report-sample.png?raw=true\n :alt: test results\n\nNB: in real test code, you'd better use\n`lemoncheesecake-requests <https://github.com/lemoncheesecake/lemoncheesecake-requests>`_ when doing HTTP / REST API\ntesting.\n\nFeatures\n--------\n\n- Advanced test hierarchies using suites, tests and nested suites\n\n- Test description and metadata: tags, properties (key=value associations) and links\n\n- Support for test filtering\n\n- Multiple reporting flavors built-in: HTML, JSON, XML, JUnit, ReportPortal, Slack notifications\n\n- BDD support using `behave <https://behave.readthedocs.io/en/latest/>`_\n\n- Test parallelization\n\n- Rich CLI toolbox\n\nlemoncheesecake is compatible with Python 3.8-3.12.\n\n\nInstallation\n------------\n\nlemoncheesecake can be installed through pip:\n\n.. code-block:: shell\n\n $ pip install lemoncheesecake\n\nFor more details about installing lemoncheesecake with the non-default reporting backends, see\n`here <http://docs.lemoncheesecake.io/en/latest/installation.html>`_.\n\nDocumentation\n-------------\n\nThe documentation is available on http://docs.lemoncheesecake.io.\n\nThe lemoncheesecake ecosystem\n-----------------------------\n\n- `lemoncheesecake-requests <https://github.com/lemoncheesecake/lemoncheesecake-requests>`_ provides logging\n and response checking features for `requests <https://docs.python-requests.org/en/master/>`_\n and HTTP / REST API / Web Services testing\n\n- `lemoncheesecake-selenium <https://github.com/lemoncheesecake/lemoncheesecake-selenium>`_ is a package\n that helps you develop Web UI tests with `selenium <https://www.selenium.dev>`_\n\nContact\n-------\n\nBugs and improvement ideas are welcomed in tickets. A Google Groups forum is also available for discussions about\nlemoncheesecake: https://groups.google.com/forum/#!forum/lemoncheesecake.\n\n\n",
"bugtrack_url": null,
"license": "Apache License (Version 2.0)",
"summary": "Test Storytelling",
"version": "1.15.0",
"project_urls": {
"Documentation": "http://docs.lemoncheesecake.io/",
"Homepage": "http://lemoncheesecake.io",
"Source": "https://github.com/lemoncheesecake/lemoncheesecake",
"Tracker": "https://github.com/lemoncheesecake/lemoncheesecake/issues"
},
"split_keywords": [
"qa",
"tests",
"functional"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea3243f5cd95817ecd690201bd38fcf7610dd7dcaf757316ec2f0d1437108f3b",
"md5": "16b5f89e31e81bf88788b89a995b6f91",
"sha256": "da93676ab46cb7f6970a70cabc6973078015d7cdc9374f2483a5ce5f7e8ac4c9"
},
"downloads": -1,
"filename": "lemoncheesecake-1.15.0.tar.gz",
"has_sig": false,
"md5_digest": "16b5f89e31e81bf88788b89a995b6f91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 484117,
"upload_time": "2023-12-12T22:09:04",
"upload_time_iso_8601": "2023-12-12T22:09:04.864454Z",
"url": "https://files.pythonhosted.org/packages/ea/32/43f5cd95817ecd690201bd38fcf7610dd7dcaf757316ec2f0d1437108f3b/lemoncheesecake-1.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-12 22:09:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "lemoncheesecake",
"github_project": "lemoncheesecake",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "lemoncheesecake"
}
JSON
