anna-api-test-framework

Framework for rapid development of API tests and report generation

Authors

• @EvgeniiGerasin

Features

• Rapid and straightforward development of tests using high-level methods
• Generating a report with test results in Allure
• The report will be useful for stakeholder

Installation

Install my-project with pip:

  pip install anna-api-test-framework

Usage/Examples

from anna import Action, Report, Assert

@Report.epic('Simple tests')
@Report.story('Tests google')
@Report.testcase('https://www.google.com', 'Google')
@Report.link('https://www.google.com', 'Jast another link')
class TestExample:

    @Report.title('Simple test google')
    @Report.severity('CRITICAL')
    def test_simple_request(self):
        url = 'https://google.com'
        method = 'GET'
        want = 200 
        # insert discription of the test
        Report.description(url=url, method=method, other='other information')
        # doing request and geting response
        action = Action()
        response = action.request(method=method, url=url)
        got = response.status_code
        # checking response
        with Report.step('Checking response'):
            Assert.compare(
                variable_first=want,
                comparison_sign='==',
                variable_second=got,
                text_error='Response status code is not equal to expected'
            )

For run test and generat a report use following commands:

  pytest alluredir="./results"

For generat and open a report you need to install Allure and use the following commands:

  allure generate "./results" -c -o "./report"
  allure open "./report"

After that, the generated report will automatically open in your browser

The report contains all the information you need