src: for every AGPL3.0 file, add SPDX identifier.
[oweals/gnunet.git] / src / integration-tests / test_integration_clique.py.in
index a2008742c224069773aeb4e754f3c2796d0a54a5..0444cf24979254d6753e08c656b089156679b6ad 100755 (executable)
 #!@PYTHON@
 #    This file is part of GNUnet.
-#    (C) 2010 Christian Grothoff (and other contributing authors)
+#    (C) 2010, 2018 Christian Grothoff (and other contributing authors)
 #
-#    GNUnet is free software; you can redistribute it and/or modify
-#    it under the terms of the GNU General Public License as published
-#    by the Free Software Foundation; either version 2, or (at your
-#    option) any later version.
+#    GNUnet is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
 #
 #    GNUnet is distributed in the hope that it will be useful, but
 #    WITHOUT ANY WARRANTY; without even the implied warranty of
 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-#    General Public License for more details.
+#    Affero General Public License for more details.
+#   
+#    You should have received a copy of the GNU Affero General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-#    You should have received a copy of the GNU General Public License
-#    along with GNUnet; see the file COPYING.  If not, write to the
-#    Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-#    Boston, MA 02111-1307, USA.
+#    SPDX-License-Identifier: AGPL3.0-or-later
 #
-# 
 #
-# This test starts 3 peers and expects bootstrap and a connected clique
+#
+# This test starts 3 peers (nated, server, no nat)and expects bootstrap
+# and a connected clique
 #
 # Conditions for successful exit:
-# Both peers have 1 connected peer in transport, core, topology, fs 
+# Both peers have 2 connected peers in transport, core, topology, fs and dht
 
 import sys
+import signal
 import os
 import subprocess
 import re
 import shutil
 import time
-import pexpect
+from gnunet_testing import Peer
+from gnunet_testing import Test
+from gnunet_testing import Check
+from gnunet_testing import Condition
+from gnunet_testing import *
+
+if os.name == "nt":
+    tmp = os.getenv("TEMP")
+else:
+    tmp = "/tmp"
 
-#definitions
+# definitions
 
 testname = "test_integration_clique"
-verbose = False
-gnunetarm = ""
-gnunetstatistics = ""
-success = False
-timeout = 10
-
-#test conditions
-
-
-def vprintf (msg):
-    if verbose == True:
-        print msg
-
-def setup ():
-  srcdir = "../.."
-  gnunet_pyexpect_dir = os.path.join (srcdir, "contrib")
-  if gnunet_pyexpect_dir not in sys.path:
-    sys.path.append (gnunet_pyexpect_dir)
-  from gnunet_pyexpect import pexpect
-  global gnunetarm     
-  global gnunetstatistics
-  if os.name == 'posix':
-    gnunetarm = 'gnunet-arm'
-    gnunetstatistics = 'gnunet-statistics'
-  elif os.name == 'nt':
-    gnunetarm = 'gnunet-arm.exe'
-    gnunetstatistics = 'gnunet-statistics.exe'    
-  if os.name == "nt":
-    shutil.rmtree (os.path.join (os.getenv ("TEMP"), testname), True)
-  else:
-    shutil.rmtree ("/tmp/" + testname, True)
-
-def start ():
-       vprintf ("Starting bootstrap server & client")
-       try:
-           server = subprocess.Popen ([gnunetarm, '-sq', '-c', './confs/c_bootstrap_server.conf'])
-           server.communicate ()    
-       except OSError:
-           print "Can not start bootstrap server, exiting..."
-           exit (1)
-       try:
-           client = subprocess.Popen ([gnunetarm, '-sq', '-c', 'confs/c_no_nat_client.conf'])
-           client.communicate ()    
-       except OSError:
-           print "Can not start bootstrap client, exiting..."
-           exit (1)
-       try:
-           client = subprocess.Popen ([gnunetarm, '-sq', '-c', 'confs/c_no_nat_client_2.conf'])
-           client.communicate ()    
-       except OSError:
-           print "Can not start bootstrap client 2, exiting..."
-           exit (1)                        
-       vprintf ("Bootstrap server & client started")
-
-def stop ():
-       try:
-           client = subprocess.Popen ([gnunetarm, '-eq', '-c', 'confs/c_no_nat_client.conf'])
-           client.communicate ()    
-       except OSError:
-           print "Can not stop bootstrap client 1, exiting..."
-           exit (1)        
-       vprintf ("Bootstrap client stopped")
-
-
-def cleanup ():
-       if os.name == "nt":
-           shutil.rmtree (os.path.join (os.getenv ("TEMP"), "gnunet-test-fs-py-ns"), True)
-           shutil.rmtree (os.path.join (os.getenv ("TEMP"), "c_no_nat_client"), True)
-           shutil.rmtree (os.path.join (os.getenv ("TEMP"), "c_no_nat_client_2"), True)
-       else:
-           shutil.rmtree ("/tmp/c_bootstrap_server/", True)
-           shutil.rmtree ("/tmp/c_no_nat_client/", True)
-           shutil.rmtree ("/tmp/c_no_nat_client_2/", True)
-
-def check_statistics (conf, subsystem, name, value):
-    from gnunet_pyexpect import pexpect
-    server = pexpect ()
-    server.spawn (None, [gnunetstatistics, '-c', conf ,'-q','-n', name, '-s', subsystem ], stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
-    #server.expect ("stdout", re.compile (r""))
-    test = server.read("stdout", 10240)
-    if (test.find(str(value)) == -1): 
-        return False
+verbose = True
+check_timeout = 180
+
+
+def cleanup_onerror(function, path, excinfo):
+    import stat
+    if not os.path.exists(path):
+        pass
+    elif not os.access(path, os.W_OK):
+        # Is the error an access error ?
+        os.chmod(path, stat.S_IWUSR)
+        function(path)
     else:
-        return True 
-    
-    
-
-def check_connect ():
-  server_transport_connected = False
-  server_topology_connected = False
-  server_core_connected = False
-  server_core_session_map = False
-  server_fs_connected = False
-  client_transport_connected = False
-  client_topology_connected = False
-  client_core_connected = False
-  client_core_session_map = False
-  client_fs_connected = False
-  
-  client2_transport_connected = False
-  client2_topology_connected = False
-  client2_core_connected = False
-  client2_core_session_map = False
-  client2_fs_connected = False
-  
-  connected = False
-  count = 1
-  while ((connected == False) and (count <= timeout)):
-       # Perform TRANSPORT     
-       if ((False == server_transport_connected) and (True == check_statistics ('./confs/c_bootstrap_server.conf', 'transport', '# peers connected',2))):
-         server_transport_connected = True
-         vprintf ('Server transport services is connected')
-         
-       if ((False == client_transport_connected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'transport', '# peers connected',2))):
-         client_transport_connected = True
-         vprintf ('Client transport services is connected')
-         
-       if ((False == client2_transport_connected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'transport', '# peers connected',2))):
-         client2_transport_connected = True
-         vprintf ('Client 2 transport services is connected')    
-
-       # Perform TRANSPORT
-       if ((False == server_core_connected) and (True == check_statistics ('./confs/c_bootstrap_server.conf', 'core', '# neighbour entries allocated',2))):
-         server_core_connected = True
-         vprintf ('Server core services is connected')
-         
-       if ((False == client_core_connected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# neighbour entries allocated',2))):
-         client_core_connected = True
-         vprintf ('Client core services is connected')
-
-       if ((False == client2_core_connected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'core', '# neighbour entries allocated',2))):
-         client2_core_connected = True
-         vprintf ('Client2 core services is connected')                  
-         
-       # Perform TRANSPORT
-       if ((False == server_core_session_map) and (True == check_statistics ('./confs/c_bootstrap_server.conf', 'core', '# entries in session map',2))):
-         server_core_session_map = True
-         vprintf ('Server core services is connected')
-         
-       if ((False == client_core_session_map) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# entries in session map',2))):
-         client_core_session_map = True
-         vprintf ('Client core notifies about connected')
-
-       if ((False == client2_core_session_map) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'core', '# entries in session map',2))):
-         client2_core_session_map = True
-         vprintf ('Client2 core notifies about connected')       
-
-       # Perform TRANSPORT
-       if ((False == server_topology_connected) and (True == check_statistics ('./confs/c_bootstrap_server.conf', 'topology', '# peers connected',2))):
-         server_topology_connected = True
-         vprintf ('Server topology services is connected')
-         
-       if ((False == client_topology_connected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'topology', '# peers connected',2))):
-         client_topology_connected = True
-         vprintf ('Client topology services is connected')
-
-       if ((False == client2_topology_connected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'topology', '# peers connected',2))):
-         client2_topology_connected = True
-         vprintf ('Client2 topology services is connected')      
-         
-       # Perform TRANSPORT      
-       if ((False == server_fs_connected) and (True == check_statistics ('./confs/c_bootstrap_server.conf', 'fs', '# peers connected',2))):
-         server_fs_connected = True
-         vprintf ('Server fs services is connected')
-
-       if ((False == client_fs_connected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'fs', '# peers connected',2))):
-         client_fs_connected = True
-         vprintf ('Client fs services is connected')                    
-
-       if ((False == client2_fs_connected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'fs', '# peers connected',2))):
-         client2_fs_connected = True
-         vprintf ('Client2 fs services is connected')                   
-                   
-       # Check if conditions fulfilled
-       if ((True == client_transport_connected) and (True == client2_transport_connected) and (True == server_transport_connected) and 
-       (True == client_topology_connected) and (True == client2_topology_connected) and (True == server_topology_connected) and 
-       (True == client_core_connected) and (True == client2_core_connected) and (True == server_core_connected) and
-       (True == client_core_session_map) and (True == client2_core_session_map) and (True == server_core_session_map) and
-       (True == client_fs_connected) and (True == client2_fs_connected) and (True == server_fs_connected)):
-               connected = True
-               break 
-       print '.',
-       time.sleep(1)
-       count += 1
-  if (connected == False):
-               print ''
-               if (server_transport_connected == False):
-                       print ('Server transport was NOT connected')
-               if (server_topology_connected == False):
-                       print ('Server topology was NOT connected')
-               if (server_core_connected == False):
-                       print ('Server core was NOT connected')
-               if (server_core_session_map == False):
-                       print ('Server core sessions did NOT increase') 
-                                       
-               if (client_transport_connected == False):
-                       print ('Client transport was NOT connected')                    
-               if (client_topology_connected == False):
-                       print ('Client topology was NOT connected')
-               if (client_core_connected == False):
-                       print ('Client core was NOT connected')
-               if (client_core_session_map == False):
-                       print ('Client core sessions did NOT increase')
-                       
-               if (client2_transport_connected == False):
-                       print ('Client2 transport was NOT connected')                   
-               if (client2_topology_connected == False):
-                       print ('Client2 topology was NOT connected')
-               if (client2_core_connected == False):
-                       print ('Client2 core was NOT connected')
-               if (client2_core_session_map == False):
-                       print ('Client2 core sessions did NOT increase')                        
-               return False
-  else:
-       return True
-
-def check_disconnect_client ():
-       vprintf ("Shutting down client 2")
-       try:
-           server = subprocess.Popen ([gnunetarm, '-eq', '-c', './confs/c_no_nat_client_2.conf'])
-           server.communicate ()    
-       except OSError:
-           print "Can not stop client 2, exiting..."
-           exit (1)
-           
-       client_transport_disconnected = False
-       client_topology_disconnected = False
-       client_core_disconnected = False
-       client_core_session_map = False
-       client_fs_disconnected = False
-           
-       disconnected = False
-       count = 1
-       while ((disconnected == False) and (count <= timeout)):                   
-               if ((False == client_transport_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'transport', '# peers connected',0))):
-                 client_transport_disconnected = True
-                 vprintf ('Client transport services is disconnected')
-                 
-               if ((False == client_core_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# neighbour entries allocated',0))):
-                 client_core_disconnected = True
-                 vprintf ('Client core services is disconnected')
-                 
-               if ((False == client_core_session_map) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# entries in session map',0))):
-                 client_core_session_map = True
-                 vprintf ('Client core notifies about disconnected')
-                 
-               if ((False == client_topology_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'topology', '# peers connected',0))):
-                 client_topology_disconnected = True
-                 vprintf ('Client topology services is disconnected')
-                 
-               if ((False == client_fs_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'fs', '# peers connected',0))):
-                 client_fs_disconnected = True
-                 vprintf ('Client fs services is disconnected')
-                   
-               # Check if conditions fulfilled
-               if ((True == client_transport_disconnected) and
-               (True == client_topology_disconnected) and 
-               (True == client_core_disconnected) and 
-               (True == client_core_session_map) and 
-               (True == client_fs_disconnected)):
-                       disconnected = True
-                       break 
-               print '.'
-               time.sleep(1)
-               count += 1
-       if (disconnected == False):
-               print ''
-               if (client_transport_disconnected == False):
-                       print ('Client transport was NOT disconnected')
-               if (client_topology_disconnected == False):
-                       print ('Client topology was NOT disconnected')
-               if (client_core_disconnected == False):
-                       print ('Client core was NOT disconnected')
-               if (server_core_session_map == False):
-                       print ('Server core sessions did NOT increase')
-               return False
-       else:
-               return True         
-               
-def check_disconnect_server ():
-       vprintf ("Shutting down bootstrap server")
-       try:
-           server = subprocess.Popen ([gnunetarm, '-eq', '-c', './confs/c_bootstrap_server.conf'])
-           server.communicate ()    
-       except OSError:
-           print "Can not stop bootstrap server, exiting..."
-           exit (1)
-           
-       client_transport_disconnected = False
-       client_topology_disconnected = False
-       client_core_disconnected = False
-       client_core_session_map = False
-       client_fs_disconnected = False
-
-       client2_transport_disconnected = False
-       client2_topology_disconnected = False
-       client2_core_disconnected = False
-       client2_core_session_map = False
-       client2_fs_disconnected = False
-                   
-       disconnected = False
-       count = 1
-       while ((disconnected == False) and (count <= timeout)):                   
-               if ((False == client_transport_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'transport', '# peers connected',1))):
-                 client_transport_disconnected = True
-                 vprintf ('Client transport services is disconnected')
-                 
-               if ((False == client_core_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# neighbour entries allocated',1))):
-                 client_core_disconnected = True
-                 vprintf ('Client core services is disconnected')
-                 
-               if ((False == client_core_session_map) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'core', '# entries in session map',1))):
-                 client_core_session_map = True
-                 vprintf ('Client core notifies about disconnected')
-                 
-               if ((False == client_topology_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'topology', '# peers connected',1))):
-                 client_topology_disconnected = True
-                 vprintf ('Client topology services is disconnected')
-                 
-               if ((False == client_fs_disconnected) and (True == check_statistics ('./confs/c_no_nat_client.conf', 'fs', '# peers connected',1))):
-                 client_fs_disconnected = True
-                 vprintf ('Client fs services is disconnected')
-
-               if ((False == client2_transport_disconnected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'transport', '# peers connected',1))):
-                 client2_transport_disconnected = True
-                 vprintf ('Client2 transport services is disconnected')
-                 
-               if ((False == client2_core_disconnected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'core', '# neighbour entries allocated',1))):
-                 client2_core_disconnected = True
-                 vprintf ('Client2 core services is disconnected')
-                 
-               if ((False == client2_core_session_map) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'core', '# entries in session map',1))):
-                 client2_core_session_map = True
-                 vprintf ('Client2 core notifies about disconnected')
-                 
-               if ((False == client2_topology_disconnected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'topology', '# peers connected',1))):
-                 client2_topology_disconnected = True
-                 vprintf ('Client2 topology services is disconnected')
-                 
-               if ((False == client2_fs_disconnected) and (True == check_statistics ('./confs/c_no_nat_client_2.conf', 'fs', '# peers connected',1))):
-                 client2_fs_disconnected = True
-                 vprintf ('Client2 fs services is disconnected')
-                   
-                   
-               # Check if conditions fulfilled
-               if ((True == client_transport_disconnected) and
-               (True == client_topology_disconnected) and 
-               (True == client_core_disconnected) and 
-               (True == client_core_session_map) and 
-               (True == client_fs_disconnected) and
-               (True == client2_transport_disconnected) and
-               (True == client2_topology_disconnected) and 
-               (True == client2_core_disconnected) and 
-               (True == client2_core_session_map) and 
-               (True == client2_fs_disconnected)):
-                       disconnected = True
-                       #break 
-               print '.'
-               time.sleep(1)
-               count += 1
-       if (disconnected == False):
-               print ''
-               if (client_transport_disconnected == False):
-                       print ('Client transport was NOT disconnected')
-               if (client_topology_disconnected == False):
-                       print ('Client topology was NOT disconnected')
-               if (client_core_disconnected == False):
-                       print ('Client core was NOT disconnected')
-               if (client_core_session_map == False):
-                       print ('Client core sessions did NOT decrease')
-               if (client2_transport_disconnected == False):
-                       print ('Client2 transport was NOT disconnected')
-               if (client2_topology_disconnected == False):
-                       print ('Client2 topology was NOT disconnected')
-               if (client2_core_disconnected == False):
-                       print ('Client2 core was NOT disconnected')
-               if (client2_core_session_map == False):
-                       print ('Client2 core sessions did NOT decrease')                        
-               return False
-       else:
-               return True                     
-
-# 
+        raise
+
+
+def cleanup():
+    retries = 10
+    path = os.path.join(tmp, "c_bootstrap_server")
+    test.p("Removing " + path)
+    while ((os.path.exists(path)) and (retries > 0)):
+        shutil.rmtree((path), False, cleanup_onerror)
+        time.sleep(1)
+        retries -= 1
+    if (os.path.exists(path)):
+        test.p("Failed to remove " + path)
+    retries = 10
+    path = os.path.join(tmp, "c_no_nat_client")
+    test.p("Removing " + path)
+    while ((os.path.exists(path)) and (retries > 0)):
+        shutil.rmtree((path), False, cleanup_onerror)
+        time.sleep(1)
+        retries -= 1
+    if (os.path.exists(path)):
+        test.p("Failed to remove " + path)
+        retries = 10
+    path = os.path.join(tmp, "c_nat_client")
+    test.p("Removing " + path)
+    while ((os.path.exists(path)) and (retries > 0)):
+        shutil.rmtree((path), False, cleanup_onerror)
+        time.sleep(1)
+        retries -= 1
+    if (os.path.exists(path)):
+        test.p("Failed to remove " + path)
+
+
+def success_cont(check):
+    global success
+    success = True
+    print('Connected clique successfully')
+
+
+def fail_cont(check):
+    global success
+    success = False
+    check.evaluate(True)
+    print('Failed to connect clique')
+
+
+def check_connect():
+    check = Check(test)
+    check.add(StatisticsCondition(client, 'transport', '# peers connected', 2))
+    check.add(StatisticsCondition(client, 'core', '# peers connected', 2))
+    check.add(StatisticsCondition(client, 'topology', '# peers connected', 2))
+    check.add(StatisticsCondition(client, 'dht', '# peers connected', 2))
+    check.add(StatisticsCondition(client, 'fs', '# peers connected', 2))
+
+    check.add(StatisticsCondition(client_nat, 'transport', '# peers connected', 2))
+    check.add(StatisticsCondition(client_nat, 'core', '# peers connected', 2))
+    check.add(StatisticsCondition(client_nat, 'topology', '# peers connected', 2))
+    check.add(StatisticsCondition(client_nat, 'dht', '# peers connected', 2))
+    check.add(StatisticsCondition(client_nat, 'fs', '# peers connected', 2))
+
+    check.add(StatisticsCondition(server, 'transport', '# peers connected', 2))
+    check.add(StatisticsCondition(server, 'core', '# peers connected', 2))
+    check.add(StatisticsCondition(server, 'topology', '# peers connected', 2))
+    check.add(StatisticsCondition(server, 'dht', '# peers connected', 2))
+    check.add(StatisticsCondition(server, 'fs', '# peers connected', 2))
+
+    check.run_blocking(check_timeout, success_cont, fail_cont)
+
+#
 # Test execution
-# 
+#
 
-vprintf ("Running " + testname)
-setup ()
-start ()
 
-ret = check_connect ()
-if (ret == True):
-       vprintf ('Peers connected')
-       if (True == check_disconnect_server ()):
-               if (True == check_disconnect_client ()):
-                       success = True
+def SigHandler(signum=None, frame=None):
+    global success
+    global server
+    global client
+    global client_nat
+
+    print('Test was aborted!')
+    if (None != server):
+        server.stop()
+    if (None != client):
+        client.stop()
+    if (None != client_nat):
+        client_nat.stop()
+    cleanup()
+    sys.exit(success)
+
+
+def run():
+    global success
+    global test
+    global server
+    global client
+    global client_nat
+
+    success = False
+    server = None
+    client = None
+    client_nat = None
+    test = Test('test_integration_clique', verbose)
+    cleanup()
+
+    server = Peer(test, './confs/c_bootstrap_server.conf')
+    if (True != server.start()):
+        print('Failed to start server')
+        if (None != server):
+            server.stop()
+        cleanup()
+        sys.exit(success)
+
+    # Server has to settle down
+    time.sleep(5)
+
+    client = Peer(test, './confs/c_no_nat_client.conf')
+    if (True != client.start()):
+        print('Failed to start client')
+        if (None != server):
+            server.stop()
+        if (None != client):
+            client.stop()
+        cleanup()
+        sys.exit(success)
+
+    # Server has to settle down
+    time.sleep(5)
+
+    client_nat = Peer(test, './confs/c_nat_client.conf')
+    if (True != client_nat.start()):
+        print('Failed to start client_nat')
+        if (None != server):
+            server.stop()
+        if (None != client):
+            client.stop()
+        if (None != client_nat):
+            client_nat.stop()
+        cleanup()
+        sys.exit(success)
+
+    if ((client.started == True) and (client_nat.started == True) and (server.started == True)):
+        test.p('Peers started, running check')
+        check_connect()
+
+    server.stop()
+    client.stop()
+    client_nat.stop()
+
+    cleanup()
+
+    if (success == False):
+        print('Test failed')
+        return False
+    else:
+        return True
 
-stop ()
-cleanup ()
 
+try:
+    run()
+except (KeyboardInterrupt, SystemExit):
+    print('Test interrupted')
+    server.stop()
+    client.stop()
+    client_nat.stop()
+    cleanup()
 if (success == False):
-       print ('Test failed')
-       exit (1)
+    sys.exit(1)
 else:
-       exit (0)
-
+    sys.exit(0)