==========
 Tutorial
==========

How to Work With ``unettest``
-----------------------------

I think it will be easiest to show how to use ``unettest`` with terminal screen sessions.
It'll reveal how to think with ``unettest`` most directly. 

.. NOTE::
  In these, the infant days of ``unettest``, it was going by ``nginxray``. Please make
  the mental substitutions until I get around to updating the screenshots :)

Setup
^^^^^

You must first acquire ``unettest``. You can get a copy here:

* `MacOS <https://nginxray.s3.us-east-2.amazonaws.com/nginxray.mac>`_
  (`SHA-256 checksum <https://nginxray.s3.us-east-2.amazonaws.com/mac-sha256>`_)
* `Linux <https://nginxray.s3.us-east-2.amazonaws.com/nginxray.nix>`_
  (`SHA-256 checksum <https://nginxray.s3.us-east-2.amazonaws.com/nix-sha256>`_)

Add it to your path (``/usr/local/bin/`` is an option). You can use it as it or give it a
snappy alias.

You can see how to write these config files here: :doc:`config_document`. 

.. image:: tutorial_photos/0alias.png


Ready
^^^^^

.. image:: tutorial_photos/1ready.png

You can cue up two terminals and run this in a sort of server/client mode.

Set
^^^

.. image:: tutorial_photos/2set.png

Firing off the left-side ``unettest`` with ``-s``, to "spin" up the servers and let them go.

Go
^^

.. image:: tutorial_photos/3go.png

Firing off the right-side ``unettest`` with a ``-t`` to run the "tests".

See how the contents of those tests are reported in the logs on the left. Super easy to
develop with! Like shining a flashlight in a dark corner.

Tests
^^^^^

.. image:: tutorial_photos/4testconfig.png

This is the logical structure of the systems under test and the tests excercising their
functionality.

A Network REPL!
^^^^^^^^^^^^^^^

.. image:: tutorial_photos/5repl.png

You can work with any number of services like a REPL. You can access a service directly (I
would consider this going "around") or through the NGINX server being run by ``unettest``.