GeoHealthCheck.plugins.check.checks
===================================

.. py:module:: GeoHealthCheck.plugins.check.checks


Classes
-------

.. autoapisummary::

   GeoHealthCheck.plugins.check.checks.HttpStatusNoError
   GeoHealthCheck.plugins.check.checks.HttpHasHeaderValue
   GeoHealthCheck.plugins.check.checks.HttpHasContentType
   GeoHealthCheck.plugins.check.checks.HttpHasImageContentType
   GeoHealthCheck.plugins.check.checks.XmlParse
   GeoHealthCheck.plugins.check.checks.JsonParse
   GeoHealthCheck.plugins.check.checks.ContainsStrings
   GeoHealthCheck.plugins.check.checks.NotContainsStrings
   GeoHealthCheck.plugins.check.checks.NotContainsOwsException


Module Contents
---------------

.. py:class:: HttpStatusNoError

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if HTTP status code is not in the 400- or 500-range.


   .. py:attribute:: NAME
      :value: 'HTTP status should not be errored'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'Response should not contain a HTTP 400 or 500 range Error'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:method:: perform()

      Default check: Resource should at least give no error



.. py:class:: HttpHasHeaderValue

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if header exists and has given header value.
   See http://docs.python-requests.org/en/master/user/quickstart


   .. py:attribute:: NAME
      :value: 'Has specific HTTP Header value'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response has specific HTTP Header value'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: HttpHasContentType

   Bases: :py:obj:`HttpHasHeaderValue`


   Checks if HTTP response has content type.


   .. py:attribute:: NAME
      :value: 'Has specific Content-Type'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response has specific Content-Type'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Params defs for header content type.



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: HttpHasImageContentType

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if HTTP response has image content type.


   .. py:attribute:: NAME
      :value: 'HTTP response is image'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response has image/* Content-Type'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: XmlParse

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if HTTP response is valid XML.


   .. py:attribute:: NAME
      :value: 'Valid XML response'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response contains valid XML'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: JsonParse

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if HTTP response is valid JSON.


   .. py:attribute:: NAME
      :value: 'Valid JSON response'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response contains valid JSON'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: ContainsStrings

   Bases: :py:obj:`GeoHealthCheck.check.Check`


   Checks if HTTP response contains given strings (keywords).


   .. py:attribute:: NAME
      :value: 'Response contains strings'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response contains all (comma-separated) strings specified'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: NotContainsStrings

   Bases: :py:obj:`ContainsStrings`


   Checks if HTTP response NOT contains given strings (keywords).


   .. py:attribute:: NAME
      :value: 'Response NOT contains strings'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: Multiline-String

      .. raw:: html

         <details><summary>Show Value</summary>

      .. code-block:: python

         """
                 HTTP response does not contain any of the
                 (comma-separated) strings specified
                 """

      .. raw:: html

         </details>



      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs



   .. py:method:: perform()

      Perform this Check's specific check. TODO: return Result object.
      :return:



.. py:class:: NotContainsOwsException

   Bases: :py:obj:`NotContainsStrings`


   Checks if HTTP response NOT contains given OWS Exceptions.


   .. py:attribute:: NAME
      :value: 'Response NOT contains OWS Exception'


      Short name of Plugin. TODO: i18n e.g. NAME_nl_NL ?



   .. py:attribute:: DESCRIPTION
      :value: 'HTTP response does not contain an OWS Exception'


      Longer description of Plugin.
      TODO: optional i18n e.g. DESCRIPTION_de_DE ?



   .. py:attribute:: PARAM_DEFS

      Param defs