Added dns reslution tests

Added new TraceLocalRootGroups to track local root peer group updates after a successful DNS lookup. This Trace is important for testing purposes as well. Added localRootPeersProvider test environment and tests Added tests and mocks for publicRootPeersProvider and resolveDomainAddresses. Code styling and refactoring
IntersectMBO · May 14, 2021 · d633172 · d633172
1 parent 49076db
commit d633172
Show file tree

Hide file tree

Showing 4 changed files with 488 additions and 3 deletions.
diff --git a/ouroboros-network/ouroboros-network.cabal b/ouroboros-network/ouroboros-network.cabal
@@ -269,7 +269,7 @@ test-suite test
                        Test.Ouroboros.Network.PeerSelection
                        Test.Ouroboros.Network.PeerSelection.Instances
                        Test.Ouroboros.Network.PeerSelection.LocalRootPeers
-                       Test.Ouroboros.Network.PeerSelection.RootPeerDNS
+                       Test.Ouroboros.Network.PeerSelection.RootPeersDNS
                        Test.Ouroboros.Network.PeerSelection.Json
                        Test.Ouroboros.Network.PeerSelection.MockEnvironment
                        Test.Ouroboros.Network.PeerSelection.PeerGraph
@@ -313,6 +313,7 @@ test-suite test
                        tasty-hunit,
                        tasty-quickcheck,
                        text,
+                       time,
 
                        cardano-binary,
                        cardano-prelude,

diff --git a/ouroboros-network/src/Ouroboros/Network/PeerSelection/RootPeersDNS.hs b/ouroboros-network/src/Ouroboros/Network/PeerSelection/RootPeersDNS.hs
@@ -384,6 +384,8 @@ data TraceLocalRootPeers exception =
        -- ^ 'Int' is the configured valency for the local producer groups
      | TraceLocalRootWaiting DomainAddress DiffTime
      | TraceLocalRootResult  DomainAddress [(IPv4, DNS.TTL)]
+     | TraceLocalRootGroups  (Seq (Int, Map Socket.SockAddr PeerAdvertise))
+       -- ^ This traces the results of the local root peer provider
      | TraceLocalRootFailure DomainAddress (DNSorIOError exception)
        --TODO: classify DNS errors, config error vs transitory
   deriving Show
@@ -449,6 +451,7 @@ localRootPeersProvider tracer
                      RelayDomain {}  -> False
                    )
 
+  traceWith tracer (TraceLocalRootGroups rootPeersGroups)
   atomically $
     writeTVar rootPeersGroupsVar rootPeersGroups
 
@@ -516,7 +519,7 @@ localRootPeersProvider tracer
           case reply of
             Left err -> go rrNext (ttlForDnsError err ttl)
             Right results -> do
-              atomically $ do
+              tmpTracer <- atomically $ do
                 rootPeersGroups <- readTVar rootPeersGroupsVar
                 let (target, entry)  = rootPeersGroups `Seq.index` index
                     resultsMap       = Map.fromList (map fst results)
@@ -532,10 +535,14 @@ localRootPeersProvider tracer
                     tmpTracer =
                       contramap (const $ TraceLocalRootGroups rootPeersGroups')
                                 tracer
+
                 -- Only overwrite if it changed:
                 when (entry /= resultsMap) $
                   writeTVar rootPeersGroupsVar rootPeersGroups'
 
+                return tmpTracer
+
+              traceWith tmpTracer ()
               go rrNext (ttlForResults (map snd results))
 
 

diff --git a/ouroboros-network/test/Test/Ouroboros/Network/PeerSelection.hs b/ouroboros-network/test/Test/Ouroboros/Network/PeerSelection.hs
@@ -48,6 +48,7 @@ import           Ouroboros.Network.PeerSelection.RootPeersDNS
 
 import           Test.Ouroboros.Network.PeerSelection.Instances
 import qualified Test.Ouroboros.Network.PeerSelection.LocalRootPeers
+import qualified Test.Ouroboros.Network.PeerSelection.RootPeersDNS
 import qualified Test.Ouroboros.Network.PeerSelection.Json
 import           Test.Ouroboros.Network.PeerSelection.MockEnvironment hiding (tests)
 import qualified Test.Ouroboros.Network.PeerSelection.MockEnvironment
@@ -63,6 +64,7 @@ tests :: TestTree
 tests =
   testGroup "Ouroboros.Network.PeerSelection"
   [ Test.Ouroboros.Network.PeerSelection.LocalRootPeers.tests
+  , Test.Ouroboros.Network.PeerSelection.RootPeersDNS.tests
   , Test.Ouroboros.Network.PeerSelection.MockEnvironment.tests
   , testGroup "basic"
     [ testProperty "has output"         prop_governor_hasoutput
@@ -1917,7 +1919,7 @@ _governorFindingPublicRoots targetNumberOfRootPeers readDomains =
     tracer :: Show a => Tracer IO a
     tracer  = Tracer (BS.putStrLn . BS.pack . show)
 
-    dnsActions :: DNSActions ResolvConf DNS.Resolver IOException IO
+    dnsActions :: DNSActions DNS.Resolver IOException IO
     dnsActions = DNSActions {
             dnsResolverResource = resolverResource,
             dnsAsyncResolverResource = asyncResolverResource,