doc: explain the purpose of different integration tests
authorAzul <azul@riseup.net>
Wed, 21 Sep 2016 11:05:50 +0000 (13:05 +0200)
committerAzul <azul@riseup.net>
Wed, 21 Sep 2016 11:05:50 +0000 (13:05 +0200)
test/integration/dispatcher_test.rb
test/integration/nickserver_test.rb

index 986972c..b3a50a0 100644 (file)
@@ -1,6 +1,17 @@
 require 'test_helper'
 require 'nickserver/dispatcher'
 
+#
+# Test integration between the Dispatcher and the RequestHandlers
+#
+# Starting from a given request we test the interaction between the dispatcher
+# and the different RequestHandlers. There's a lot of combinations possible
+# and we only test a couple of them to ensure the parts work together well.
+#
+# This does not test the server. We stub and mock the sources. The nickserver
+# integration test covers these as well.
+#
+
 class Nickserver::DispatcherTest < Minitest::Test
 
   def test_empty_query
index a62c7f9..06d6e29 100644 (file)
@@ -3,6 +3,13 @@ require 'support/http_stub_helper'
 require 'nickserver/server'
 require 'json'
 
+# Integration Test for the whole nickserver without network dependecy.
+#
+# These tests are meant to test the integration between the different
+# components of the nickserver from the ReelServer all the way down to
+# the different sources.
+# These tests do not test the low level network adapter, the daemonization
+# or the startup script.
 #
 # Some important notes to understanding these tests:
 #