community.general/docs/docsite/rst/dev_guide/testing_httptester.rst

**********
httptester
**********

.. contents:: Topics

Overview
========

``httptester`` is a docker container used to host certain resources required by :doc:`testing_integration`. This is to avoid CI tests requiring external resources (such as git or package repos) which, if temporarily unavailable, would cause tests to fail.

HTTP Testing endpoint which provides the following capabilities:

* httpbin
* nginx
* SSL
* SNI


Source files can be found at `test/utils/docker/httptester/ <https://github.com/ansible/ansible/tree/devel/test/utils/docker/httptester>`_

Building
========

Docker
------

Both ways of building ``docker`` utilize the ``nginx:alpine`` image, but can
be customized for ``Fedora``, ``Red Hat``, ``CentOS``, ``Ubuntu``,
``Debian`` and other variants of ``Alpine``

When utilizing ``packer`` or configuring with ``ansible-playbook``,
the services will not automatically start on launch, and will have to be
manually started using::

    cd test/utils/docker/httptester
    ./services.sh

Such as when starting a docker container::

    cd test/utils/docker/httptester
    docker run -ti --rm -p 80:80 -p 443:443 --name httptester ansible/ansible:httptester /services.sh

docker build
------------

::

    cd test/utils/docker/httptester
    docker build -t ansible/ansible:httptester .

packer
------

The ``packer`` build will use ``ansible-playbook`` to perform the
configuration, and will tag the image as ``ansible/ansible:httptester``::

    cd test/utils/docker/httptester
    packer build packer.json

Ansible
=======

::
    cd test/utils/docker/httptester
    ansible-playbook -i hosts -v httptester.yml


Extending httptester
====================

If you have sometime to improve ``httptester`` please add a comment on the `Testing Working Group Agenda <https://github.com/ansible/community/blob/master/meetings/README.md>`_ to avoid duplicated effort.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 10:08:26 +02:00			`**********`
			`httptester`
			`**********`

			`.. contents:: Topics`

			`Overview`
			`========`

			``httptester`` is a docker container used to host certain resources required by :doc:`testing_integration`. This is to avoid CI tests requiring external resources (such as git or package repos) which, if temporarily unavailable, would cause tests to fail.

			`HTTP Testing endpoint which provides the following capabilities:`

			`* httpbin`
			`* nginx`
			`* SSL`
			`* SNI`


			Source files can be found at `test/utils/docker/httptester/ <https://github.com/ansible/ansible/tree/devel/test/utils/docker/httptester>`_

			`Building`
			`========`

			`Docker`
			`------`

			Both ways of building ``docker`` utilize the ``nginx:alpine`` image, but can
			be customized for ``Fedora``, ``Red Hat``, ``CentOS``, ``Ubuntu``,
			``Debian`` and other variants of ``Alpine``

			When utilizing ``packer`` or configuring with ``ansible-playbook``,
			`the services will not automatically start on launch, and will have to be`
			`manually started using::`

			`cd test/utils/docker/httptester`
			`./services.sh`

			`Such as when starting a docker container::`

			`cd test/utils/docker/httptester`
			`docker run -ti --rm -p 80:80 -p 443:443 --name httptester ansible/ansible:httptester /services.sh`

			`docker build`
			`------------`

			`::`

			`cd test/utils/docker/httptester`
			`docker build -t ansible/ansible:httptester .`

			`packer`
			`------`

			The ``packer`` build will use ``ansible-playbook`` to perform the
			configuration, and will tag the image as ``ansible/ansible:httptester``::

			`cd test/utils/docker/httptester`
			`packer build packer.json`

			`Ansible`
			`=======`

			`::`
			`cd test/utils/docker/httptester`
			`ansible-playbook -i hosts -v httptester.yml`


			`Extending httptester`
			`====================`

docs: fix community meetings link (#27264) 2017-07-25 15:23:01 +02:00			If you have sometime to improve ``httptester`` please add a comment on the `Testing Working Group Agenda <https://github.com/ansible/community/blob/master/meetings/README.md>`_ to avoid duplicated effort.