Merge pull request #35 from annoviko/feature/034-body-log

Feature: Limit body to log

Author: annoviko

CHANGES

@@ -1,5 +1,17 @@
 ------------------------------------------------------------------------
 
+CHANGE NOTES FOR 0.2.7 (RELEASED: Jun 30, 2022)
+
+------------------------------------------------------------------------
+
+GENERAL CHANGES
+
+- Introduce the limit for body size to log and corresponding library `HttpCtrl.Logging` to configure it.
+  See: https://github.com/annoviko/robotframework-httpctrl/issues/34
+
+
+------------------------------------------------------------------------
+
 CHANGE NOTES FOR 0.2.6 (RELEASED: Apr 26, 2022)
 
 ------------------------------------------------------------------------

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2021 Andrei Novikov
+Copyright (c) 2018-2022 Andrei Novikov
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are

PKG-INFO.rst

@@ -36,9 +36,12 @@ Brief Overview of the Library Content
 
 - **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

README.rst

@@ -56,9 +56,12 @@ Brief Overview of the Library Content
 
 - **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

ci/github-ci-release.sh

@@ -104,6 +104,7 @@ cd $PATH_SOURCE
 python3 -m robot.libdoc -v $version -F reST HttpCtrl.Client $PATH_REPO_GH_PAGES/client.html
 python3 -m robot.libdoc -v $version -F reST HttpCtrl.Server $PATH_REPO_GH_PAGES/server.html
 python3 -m robot.libdoc -v $version -F reST HttpCtrl.Json $PATH_REPO_GH_PAGES/json.html
+python3 -m robot.libdoc -v $version -F reST HttpCtrl.Logging $PATH_REPO_GH_PAGES/logging.html
 
 
 # Commit and push documentation changes

ci/github-ci.sh

@@ -1,3 +1,8 @@
+# folders
+FOLDER_ROOT=`pwd`
+FOLDER_SRC=$FOLDER_ROOT/src
+FOLDER_TST=$FOLDER_ROOT/tst
+
 # error codes
 EXIT_CODE_INCORRECT_PATH=1
 EXIT_CODE_FAILED_TESTING=2
@@ -12,15 +17,15 @@ pip3 install docutils pygments
 
 # export path to the library
 echo "Export path to the HttpCtrl library."
-cd src || exit $EXIT_CODE_INCORRECT_PATH
+cd $FOLDER_SRC || exit $EXIT_CODE_INCORRECT_PATH
 PYTHONPATH=`pwd`
 export PYTHONPATH=${PYTHONPATH}
 
 echo "Path '$PYTHONPATH' is exported."
 
 # run tests
 echo "Run tests for HttpCtrl."
-cd ../tst || exit $EXIT_CODE_INCORRECT_PATH
+cd $FOLDER_TST || exit $EXIT_CODE_INCORRECT_PATH
 python3 -m robot.run *.robot
 result=$?
 
@@ -33,7 +38,12 @@ fi
 
 # generate documentation
 echo "Generate documentation for HttpCtrl."
-cd ../src || exit $EXIT_CODE_INCORRECT_PATH
-python3 -m robot.libdoc -v 0.1.10 -F reST HttpCtrl.Client client.html
-python3 -m robot.libdoc -v 0.1.10 -F reST HttpCtrl.Server server.html
-python3 -m robot.libdoc -v 0.1.10 -F reST HttpCtrl.Json json.html
+
+cd $FOLDER_ROOT
+version=`cat VERSION`
+
+cd $FOLDER_SRC || exit $EXIT_CODE_INCORRECT_PATH
+python3 -m robot.libdoc -v $version -F reST HttpCtrl.Client client.html
+python3 -m robot.libdoc -v $version -F reST HttpCtrl.Server server.html
+python3 -m robot.libdoc -v $version -F reST HttpCtrl.Json json.html
+python3 -m robot.libdoc -v $version -F reST HttpCtrl.Logging logging.html

setup.py

@@ -3,7 +3,7 @@
 HttpCtrl library provides HTTP/HTTPS client and server API to Robot Framework to make REST API testing easy.
 
 Authors: Andrei Novikov
-Date: 2018-2021
+Date: 2018-2022
 Copyright: The 3-Clause BSD License
 
 """
@@ -63,7 +63,7 @@ def load_version():
     author='Andrei Novikov',
     author_email='spb.andr@yandex.ru',
 
-    python_requires='>=3.4',
+    python_requires='>=3.6',
     install_requires=['robotframework'],
 
     package_dir={'': 'src'},

src/HttpCtrl/__init__.py

@@ -3,7 +3,7 @@
 HttpCtrl library provides HTTP/HTTPS client and server API to Robot Framework to make REST API testing easy.
 
 Authors: Andrei Novikov
-Date: 2018-2021
+Date: 2018-2022
 Copyright: The 3-Clause BSD License
 
 """
@@ -15,6 +15,8 @@
 
 from robot.api import logger
 
+from HttpCtrl.utils.logger import LoggerAssistant
+
 from HttpCtrl.internal_messages import IgnoreRequest
 from HttpCtrl.http_server import HttpServer
 from HttpCtrl.http_stub import HttpStubContainer, HttpStubCriteria
@@ -26,16 +28,19 @@
 class Client:
     """
 
-    HTTP/HTTPS Client Library that provides comprehensive interface to Robot Framework to control HTTP/HTTPS client.
+    HTTP/HTTPS Client library that provides comprehensive interface to Robot Framework to control HTTP/HTTPS client.
 
     See other HttpCtrl libraries:
 
     - HttpCtrl.Server_ - HTTP Server API for testing where easy-controlled HTTP server is required.
 
     - HttpCtrl.Json_ - Json related API for testing where work with Json message is required.
 
+    - HttpCtrl.Logging_ - Logging related API to configure the logging system that is used by HttpCtrl library.
+
     .. _HttpCtrl.Server: server.html
     .. _HttpCtrl.Json: json.html
+    .. _HttpCtrl.Logging: logging.html
 
     Example how to send GET request to obtain origin IP address and check that response is not empty:
 
@@ -212,7 +217,8 @@ def __send(self, connection_type, method, url, body):
         logger.info("Request (type: '%s', method '%s') was sent to '%s'." % (connection_type, method, endpoint))
         logger.info("%s %s" % (method, url))
         if body is not None:
-            logger.info("%s" % body)
+            body_to_log = LoggerAssistant.get_body(body)
+            logger.info("%s" % body_to_log)
 
         return connection
 
@@ -658,16 +664,19 @@ def get_body_from_response(self, response):
 class Server:
     """
 
-    HTTP Server Library that provides comprehensive interface to Robot Framework to control HTTP server.
+    HTTP Server library that provides comprehensive interface to Robot Framework to control HTTP server.
 
     See other HttpCtrl libraries:
 
     - HttpCtrl.Client_ - HTTP/HTTP Client API for testing where easy-controlled HTTP/HTTPS client is required.
 
     - HttpCtrl.Json_ - Json related API for testing where work with Json message is required.
 
+    - HttpCtrl.Logging_ - Logging related API to configure the logging system that is used by HttpCtrl library.
+
     .. _HttpCtrl.Client: client.html
     .. _HttpCtrl.Json: json.html
+    .. _HttpCtrl.Logging: logging.html
 
     Here is an example of receiving POST request. In this example HTTP client sends POST request to HTTP server. HTTP
     server receives it and checks incoming request for correctness.
@@ -1283,7 +1292,7 @@ def reply_by(self, status, body=None):
 class Json:
     """
 
-    Json Library provide comprehensive interface to Robot Framework to work with JSON structures that are actively
+    Json library provide comprehensive interface to Robot Framework to work with JSON structures that are actively
     used for Internet communication nowadays.
 
     See other HttpCtrl libraries:
@@ -1292,8 +1301,11 @@ class Json:
 
     - HttpCtrl.Server_ - HTTP Server API for testing where easy-controlled HTTP server is required.
 
+    - HttpCtrl.Logging_ - Logging related API to configure the logging system that is used by HttpCtrl library.
+
     .. _HttpCtrl.Client: client.html
     .. _HttpCtrl.Server: server.html
+    .. _HttpCtrl.Logging: logging.html
 
     Example where Json values are updated in a string and then read from it:
 
@@ -1457,3 +1469,57 @@ def set_json_value_in_string(json_string, path, value):
                 current_element = current_element[key]
 
         return json.dumps(json_content)
+
+
+
+class Logging:
+    """
+
+    Logging library provide functionality to configure the logging system that is used by HttpCtrl library.
+
+    See other HttpCtrl libraries:
+
+    - HttpCtrl.Client_ - HTTP/HTTP Client API for testing where easy-controlled HTTP/HTTPS client is required.
+
+    - HttpCtrl.Server_ - HTTP Server API for testing where easy-controlled HTTP server is required.
+
+    - HttpCtrl.Json_ - Json related API for testing where work with Json message is required.
+
+    .. _HttpCtrl.Client: client.html
+    .. _HttpCtrl.Server: server.html
+    .. _HttpCtrl.Json: json.html
+
+    """
+
+    @staticmethod
+    def set_body_size_limit_to_log(body_size):
+        """
+
+        Set body (HTTP request/response) size that is allowed to log. By default the library logs `512` symbols of the body. If the
+        limit should be removed then `${None}` value can be provided to the function.
+
+        The logging body limit protects test logs to be too large if tests use big data for testing.
+
+        Example how to set the logging body limit to 1024 symbols:
+
+        +----------------------------+------+
+        | Set Body Size Limit To Log | 1024 |
+        +----------------------------+------+
+
+        .. code:: text
+
+            Set Body Size Limit To Log    1024
+
+        Example how to remove the logging body limit:
+
+        +----------------------------+---------+
+        | Set Body Size Limit To Log | ${None} |
+        +----------------------------+---------+
+
+        .. code:: text
+
+            Set Body Size Limit To Log    ${None}
+
+        """
+
+        LoggerAssistant.set_body_size(body_size)

src/HttpCtrl/http_handler.py

@@ -3,7 +3,7 @@
 HttpCtrl library provides HTTP/HTTPS client and server API to Robot Framework to make REST API testing easy.
 
 Authors: Andrei Novikov
-Date: 2018-2021
+Date: 2018-2022
 Copyright: The 3-Clause BSD License
 
 """

src/HttpCtrl/http_server.py

@@ -3,7 +3,7 @@
 HttpCtrl library provides HTTP/HTTPS client and server API to Robot Framework to make REST API testing easy.
 
 Authors: Andrei Novikov
-Date: 2018-2021
+Date: 2018-2022
 Copyright: The 3-Clause BSD License
 
 """