Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/annoviko/robotframework-httpctrl

HttpCtrl is a library for Robot Framework that provides API of HTTP(S) client and server
https://github.com/annoviko/robotframework-httpctrl

http https python robotframework

Last synced: 2 months ago
JSON representation

HttpCtrl is a library for Robot Framework that provides API of HTTP(S) client and server

Host: GitHub
URL: https://github.com/annoviko/robotframework-httpctrl
Owner: annoviko
License: bsd-3-clause
Created: 2018-12-27T10:18:28.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-03T12:58:32.000Z (about 2 years ago)
Last Synced: 2024-09-26T20:52:08.117Z (3 months ago)
Topics: http, https, python, robotframework
Language: Python
Homepage: https://annoviko.github.io/robotframework-httpctrl/
Size: 586 KB
Stars: 13
Watchers: 5
Forks: 2
Open Issues: 4
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES
- License: LICENSE

Awesome Lists containing this project

README

        |Build Status Linux| |PyPi|

HttpCtrl library for Robot Framework

====================================

**RobotFramework-HttpCtrl** is a library for Robot Framework that provides HTTP/HTTPS client and HTTP server (IPv4 and IPv6) services

to make REST API testing easy.

**Author**: Andrei Novikov

**License**: The 3-Clause BSD License

**Documentation**: https://annoviko.github.io/robotframework-httpctrl/

Request Feature

===============

New features are implemented by request that can be created here using issues [`Press Me to Create a Feature Request`_]. Please, do not hesitate to create feature requests.

.. _Press Me to Create a Feature Request: https://github.com/annoviko/robotframework-httpctrl/issues/new?assignees=&labels=&template=feature_request.md&title=

Bug Reporting

=============

Please, do not hesitate to report about bugs using issues here [`Press Me to Report a Bug`_].

.. _Press Me to Report a Bug: https://github.com/annoviko/robotframework-httpctrl/issues/new?assignees=&labels=bug&template=bug_report.md&title=

Dependencies

============

**Python version**: >=3.8

Installation

============

Installation using pip3 tool:

.. code:: bash

    $ pip3 install robotframework-httpctrl

Brief Overview of the Library Content

=====================================

**HttpCtrl** contains following general libraries:

- **HttpCtrl.Client** - provides API to work with HTTP/HTTPS client [`link client documentation`_].

- **HttpCtrl.Server** - provides API to work with HTTP server [`link server documentation`_].

- **HttpCtrl.Json** - provides API to work Json messages [`link json documentation`_].

- **HttpCtrl.Logging** - provides API to configure the logging system that is used by `HttpCtrl` library [`link logging documentation`_].

.. _link client documentation: https://annoviko.github.io/robotframework-httpctrl/client.html

.. _link server documentation: https://annoviko.github.io/robotframework-httpctrl/server.html

.. _link json documentation: https://annoviko.github.io/robotframework-httpctrl/json.html

.. _link logging documentation: https://annoviko.github.io/robotframework-httpctrl/logging.html

Examples

========

Send GET request to obtain origin IP address and check that is not empty:

.. code:: robotframework

    *** Settings ***

    Library         String

    Library         HttpCtrl.Client

    Library         HttpCtrl.Json

    *** Test Cases ***

    Get Origin Address

        Initialize Client   www.httpbin.org

        Send HTTP Request   GET   /ip

        ${response status}=   Get Response Status

        ${response body}=     Get Response Body

        ${response body}=     Decode Bytes To String   ${response body}   UTF-8

        ${expected status}=   Convert To Integer   200

        Should Be Equal   ${response status}   ${expected status}

        ${origin}=    Get Json Value From String   ${response body}   origin

        Should Not Be Empty   ${origin}

Send POST request and extract required information from response:

.. code:: robotframework

    *** Settings ***

    Library         String

    Library         HttpCtrl.Client

    Library         HttpCtrl.Json

    *** Test Cases ***

    Send POST Request

        Initialize Client   www.httpbin.org

        ${body}=   Set Variable   { "message": "Hello World!" }

        Send HTTP Request   POST   /post   ${body}

        ${response status}=   Get Response Status

        ${response body}=     Get Response Body

        ${response body}=     Decode Bytes To String   ${response body}   UTF-8

        ${expected status}=   Convert To Integer   200

        Should Be Equal   ${response status}   ${expected status}

        ${message}=    Get Json Value From String   ${response body}   data

        Should Be Equal   ${message}   ${body}

Send PATCH request using HTTPS protocol:

.. code:: robotframework

    *** Settings ***

    Library         String

    Library         HttpCtrl.Client

    Library         HttpCtrl.Json

    *** Test Cases ***

    Send HTTPS PATCH Request

        Initialize Client   www.httpbin.org

        ${body}=   Set Variable   { "volume": 77, "mute": false }

        Send HTTPS Request   PATCH   /patch   ${body}

        ${response status}=   Get Response Status

        ${response body}=     Get Response Body

        ${response body}=     Decode Bytes To String   ${response body}   UTF-8

        ${expected status}=   Convert To Integer   200

        Should Be Equal   ${response status}   ${expected status}

        ${volume}=   Get Json Value From String   ${response body}   json/volume

        Should Be Equal   ${volume}   ${77}

        ${mute}=   Get Json Value From String   ${response body}   json/mute

        Should Be Equal   ${mute}   ${False}

In this example HTTP client sends POST request to HTTP server. HTTP server receives it and checks incoming

request for correctness.

.. code:: robotframework

    *** Settings ***

    Library         String

    Library         HttpCtrl.Client

    Library         HttpCtrl.Server

    Test Setup       Initialize HTTP Client And Server

    Test Teardown    Terminate HTTP Server

    *** Test Cases ***

    Receive And Reply To POST

        ${request body}=   Set Variable   { "message": "Hello!" }

        Send HTTP Request Async   POST   /post   ${request body}

        Wait For Request

        Reply By   200

        ${method}=   Get Request Method

        ${url}=      Get Request Url

        ${body}=     Get Request Body

        ${body}=     Decode Bytes To String   ${body}   UTF-8

        Should Be Equal   ${method}   POST

        Should Be Equal   ${url}      /post

        Should Be Equal   ${body}     ${request body}

    *** Keywords ***

    Initialize HTTP Client And Server

        Initialize Client   127.0.0.1   8000

        Start Server        127.0.0.1   8000

    Terminate HTTP Server

        Stop Server

.. |Build Status Linux| image:: https://github.com/annoviko/robotframework-httpctrl/actions/workflows/build-httpctrl.yml/badge.svg

   :target: https://github.com/annoviko/robotframework-httpctrl/actions

.. |PyPi| image:: https://badge.fury.io/py/robotframework-httpctrl.svg

   :target: https://badge.fury.io/py/robotframework-httpctrl