Add TestHarness python integration scripts to dev package

CMakeLists.txt

@@ -257,6 +257,53 @@ configure_file(programs/cleos/LICENSE.CLI11                                licen
 
 install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/licenses/leap" DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/licenses/" COMPONENT base)
 
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/libraries/testing/contracts DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/libraries/testing COMPONENT dev EXCLUDE_FROM_ALL
+        PATTERN "CMakeFiles" EXCLUDE
+        PATTERN "*.cmake" EXCLUDE
+        PATTERN "Makefile" EXCLUDE)
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/unittests/contracts DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/unittests COMPONENT dev EXCLUDE_FROM_ALL
+        PATTERN "CMakeFiles" EXCLUDE
+        PATTERN "*.cmake" EXCLUDE
+        PATTERN "Makefile" EXCLUDE)
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/tests/TestHarness DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/tests COMPONENT dev EXCLUDE_FROM_ALL
+        FILES_MATCHING
+        PATTERN "*.py"
+        PATTERN "*.json"
+        PATTERN "__pycache__" EXCLUDE
+        PATTERN "CMakeFiles" EXCLUDE)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/tests/launcher.py DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/tests COMPONENT dev EXCLUDE_FROM_ALL)
+
+if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.21)
+   # Cmake versions < 3.21 did not support installing symbolic links to a directory via install(FILES ...)
+   # Cmake 3.21 fixed this (https://gitlab.kitware.com/cmake/cmake/-/commit/d71a7cc19d6e03f89581efdaa8d63db216184d40)
+   # If/when the lowest cmake version supported becomes >= 3.21, the else block as well as the postinit and prerm scripts
+   # would be a good option to remove in favor of using the facilities in cmake / cpack directly.
+
+   add_custom_target(link_target ALL
+      COMMAND ${CMAKE_COMMAND} -E make_directory lib/python3/dist-packages
+      COMMAND ${CMAKE_COMMAND} -E create_symlink ../../../share/leap_testing/tests/TestHarness lib/python3/dist-packages/TestHarness
+      COMMAND ${CMAKE_COMMAND} -E make_directory share/leap_testing
+      COMMAND ${CMAKE_COMMAND} -E create_symlink ../../bin share/leap_testing/bin)
+
+   install(FILES ${CMAKE_CURRENT_BINARY_DIR}/lib/python3/dist-packages/TestHarness DESTINATION ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages COMPONENT dev EXCLUDE_FROM_ALL)
+   install(FILES ${CMAKE_CURRENT_BINARY_DIR}/share/leap_testing/bin DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing COMPONENT dev EXCLUDE_FROM_ALL)
+else()
+   # The following install(CODE ...) steps are necessary for `make dev-install` to work on cmake versions < 3.21.
+   # However, it can flag as an error if using `make package` instead of `make dev-install` for installation.
+   # This is due to those directories and symbolic links being created in the postinit script during the package install instead.
+
+   # Note If/when doing `make package`, it is not a true error if you see:
+   # Error creating directory "/<leap_install_dir>/lib/python3/dist-packages".
+   # CMake Error: failed to create symbolic link '/<leap_install_dir>/lib/python3/dist-packages/TestHarness': no such file or directory
+   # CMake Error: failed to create symbolic link '/<leap_install_dir>/share/leap_testing/bin': no such file or directory
+
+   install(CODE "execute_process( COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages)" COMPONENT dev EXCLUDE_FROM_ALL)
+   install(CODE "execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ../../../share/leap_testing/tests/TestHarness ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages/TestHarness)" COMPONENT dev EXCLUDE_FROM_ALL)
+   install(CODE "execute_process( COMMAND ${CMAKE_COMMAND} -E create_symlink ../../bin ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/bin)" COMPONENT dev EXCLUDE_FROM_ALL)
+
+   # The `make package` installation of symlinks happens via the `postinst` script installed in cmake.package via the line below
+endif()
+
 configure_file(${CMAKE_SOURCE_DIR}/libraries/cli11/bash-completion/completions/leap-util
                ${CMAKE_BINARY_DIR}/programs/leap-util/bash-completion/completions/leap-util COPYONLY)
 configure_file(${CMAKE_SOURCE_DIR}/libraries/cli11/bash-completion/completions/cleos

package.cmake

@@ -61,7 +61,7 @@ set(CPACK_DEBIAN_BASE_FILE_NAME "${CPACK_DEBIAN_FILE_NAME}.deb")
 string(REGEX REPLACE "^(${CMAKE_PROJECT_NAME})" "\\1-dev" CPACK_DEBIAN_DEV_FILE_NAME "${CPACK_DEBIAN_BASE_FILE_NAME}")
 
 #deb package tooling will be unable to detect deps for the dev package. llvm is tricky since we don't know what package could have been used; try to figure it out
-set(CPACK_DEBIAN_DEV_PACKAGE_DEPENDS "libboost-all-dev, libssl-dev, libgmp-dev")
+set(CPACK_DEBIAN_DEV_PACKAGE_DEPENDS "libboost-all-dev, libssl-dev, libgmp-dev, python3-numpy")
 find_program(DPKG_QUERY "dpkg-query")
 if(DPKG_QUERY AND OS_RELEASE MATCHES "\n?ID=\"?ubuntu" AND LLVM_CMAKE_DIR)
    execute_process(COMMAND "${DPKG_QUERY}" -S "${LLVM_CMAKE_DIR}" COMMAND cut -d: -f1 RESULT_VARIABLE LLVM_PKG_FIND_RESULT OUTPUT_VARIABLE LLVM_PKG_FIND_OUTPUT)
@@ -70,6 +70,7 @@ if(DPKG_QUERY AND OS_RELEASE MATCHES "\n?ID=\"?ubuntu" AND LLVM_CMAKE_DIR)
       string(APPEND CPACK_DEBIAN_DEV_PACKAGE_DEPENDS ", ${LLVM_PKG_FIND_OUTPUT}")
    endif()
 endif()
+set(CPACK_DEBIAN_DEV_PACKAGE_CONTROL_EXTRA ${CMAKE_BINARY_DIR}/scripts/postinst;${CMAKE_BINARY_DIR}/scripts/prerm)
 
 #since rpm packages aren't component based, make sure description picks up more detailed description instead of just summary
 set(CPACK_RPM_PACKAGE_DESCRIPTION "${CPACK_COMPONENT_BASE_DESCRIPTION}")

programs/nodeos/CMakeLists.txt

@@ -5,7 +5,7 @@ if( UNIX AND NOT APPLE )
 endif()
 
 configure_file(config.hpp.in config.hpp ESCAPE_QUOTES)
-configure_file(logging.json ${CMAKE_BINARY_DIR}/logging.json COPYONLY)
+configure_file(logging.json ${CMAKE_BINARY_DIR}/tests/TestHarness/logging-template.json)
 
 target_include_directories(${NODE_EXECUTABLE_NAME} PUBLIC ${CMAKE_CURRENT_BINARY_DIR})
 

scripts/CMakeLists.txt

@@ -4,3 +4,5 @@ configure_file(eosio-tn_down.sh eosio-tn_down.sh COPYONLY)
 configure_file(eosio-tn_roll.sh eosio-tn_roll.sh COPYONLY)
 configure_file(eosio-tn_up.sh eosio-tn_up.sh COPYONLY)
 configure_file(abi_is_json.py abi_is_json.py COPYONLY)
+configure_file(postinst .)
+configure_file(prerm .)

scripts/postinst

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+set -e
+
+if [ ! -L ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages/TestHarness ]; then
+    mkdir -p ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages
+    ln -s ../../../share/leap_testing/tests/TestHarness ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages/TestHarness
+fi
+
+if [ ! -L ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/bin ]; then
+    mkdir -p ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing
+    ln -s ../../bin ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/bin
+fi

scripts/prerm

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+rm -f ${CMAKE_INSTALL_FULL_LIBDIR}/python3/dist-packages/TestHarness
+rm -f ${CMAKE_INSTALL_FULL_DATAROOTDIR}/leap_testing/bin

tests/CMakeLists.txt

@@ -13,8 +13,6 @@ target_include_directories( plugin_test PUBLIC
                             ${CMAKE_SOURCE_DIR}/unittests
                             ${CMAKE_BINARY_DIR}/unittests/include/ )
 
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/core_symbol.py.in ${CMAKE_CURRENT_BINARY_DIR}/core_symbol.py)
-
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/p2p_tests/dawn_515/test.sh ${CMAKE_CURRENT_BINARY_DIR}/p2p_tests/dawn_515/test.sh COPYONLY)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/block_log_util_test.py ${CMAKE_CURRENT_BINARY_DIR}/block_log_util_test.py COPYONLY)
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/block_log_retain_blocks_test.py ${CMAKE_CURRENT_BINARY_DIR}/block_log_retain_blocks_test.py COPYONLY)

tests/TestHarness/CMakeLists.txt

@@ -1,4 +1,5 @@
 configure_file(__init__.py . COPYONLY)
+configure_file(core_symbol.py.in core_symbol.py)
 configure_file(testUtils.py . COPYONLY)
 configure_file(WalletMgr.py . COPYONLY)
 configure_file(Node.py . COPYONLY)

tests/TestHarness/Cluster.py

@@ -14,7 +14,7 @@
 import socket
 from pathlib import Path
 
-from core_symbol import CORE_SYMBOL
+from .core_symbol import CORE_SYMBOL
 from .testUtils import Account
 from .testUtils import BlockLogAction
 from .testUtils import Utils
@@ -133,6 +133,10 @@ def __init__(self, walletd=False, localCluster=True, host="localhost", port=8888
         self.nodeosVers=nodeosVers
         self.nodeosLogPath=Path(Utils.TestLogRoot) / Path(f'{Path(sys.argv[0]).stem}{os.getpid()}')
 
+        self.launcherPath = Path(__file__).resolve().parents[1] / "launcher.py"
+        self.libTestingContractsPath = Path(__file__).resolve().parents[2] / "libraries" / "testing" / "contracts"
+        self.unittestsContractsPath = Path(__file__).resolve().parents[2] / "unittests" / "contracts"
+
         if unshared:
             unshare(CLONE_NEWNET)
             for index, name in socket.if_nameindex():
@@ -259,7 +263,7 @@ def launch(self, pnodes=1, unstartedNodes=0, totalNodes=1, prodCount=1, topo="me
             time.sleep(2)
         loggingLevelDictString = json.dumps(self.loggingLevelDict, separators=(',', ':'))
         cmd="%s %s -p %s -n %s -d %s -i %s -f %s --unstarted-nodes %s --logging-level %s --logging-level-map %s" % (
-            sys.executable, "tests/launcher.py", pnodes, totalNodes, delay, datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3],
+            sys.executable, str(self.launcherPath), pnodes, totalNodes, delay, datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3],
             producerFlag, unstartedNodes, self.loggingLevel, loggingLevelDictString)
         cmdArr=cmd.split()
         if self.staging:
@@ -1083,11 +1087,11 @@ def bootstrap(self, biosNode, totalNodes, prodCount, totalProducers, pfSetupPoli
             return None
 
         contract="eosio.bios"
-        contractDir="libraries/testing/contracts/%s" % (contract)
+        contractDir= str(self.libTestingContractsPath / contract)
         if PFSetupPolicy.hasPreactivateFeature(pfSetupPolicy):
-            contractDir="libraries/testing/contracts/old_versions/v1.7.0-develop-preactivate_feature/%s" % (contract)
+            contractDir=str(self.libTestingContractsPath / "old_versions" / "v1.7.0-develop-preactivate_feature" / contract)
         else:
-            contractDir="libraries/testing/contracts/old_versions/v1.6.0-rc3/%s" % (contract)
+            contractDir=str(self.libTestingContractsPath / "old_versions" / "v1.6.0-rc3" / contract)
         wasmFile="%s.wasm" % (contract)
         abiFile="%s.abi" % (contract)
         Utils.Print("Publish %s contract" % (contract))
@@ -1203,7 +1207,7 @@ def createSystemAccount(accountName):
         eosioTokenAccount = copy.deepcopy(eosioAccount)
         eosioTokenAccount.name = 'eosio.token'
         contract="eosio.token"
-        contractDir="unittests/contracts/%s" % (contract)
+        contractDir=str(self.unittestsContractsPath / contract)
         wasmFile="%s.wasm" % (contract)
         abiFile="%s.abi" % (contract)
         Utils.Print("Publish %s contract" % (contract))
@@ -1259,7 +1263,7 @@ def createSystemAccount(accountName):
 
         if loadSystemContract:
             contract="eosio.system"
-            contractDir="unittests/contracts/%s" % (contract)
+            contractDir=str(self.unittestsContractsPath / contract)
             wasmFile="%s.wasm" % (contract)
             abiFile="%s.abi" % (contract)
             Utils.Print("Publish %s contract" % (contract))
@@ -1443,7 +1447,7 @@ def dumpErrorDetails(self):
     def killall(self, kill=True, silent=True, allInstances=False):
         """Kill cluster nodeos instances. allInstances will kill all nodeos instances running on the system."""
         signalNum=9 if kill else 15
-        cmd="%s -k %d --nogen -p 1 -n 1 --nodeos-log-path %s" % ("python3 tests/launcher.py", signalNum, self.nodeosLogPath)
+        cmd="%s -k %d --nogen -p 1 -n 1 --nodeos-log-path %s" % (f"python3 {str(self.launcherPath)}", signalNum, self.nodeosLogPath)
         if Utils.Debug: Utils.Print("cmd: %s" % (cmd))
         if 0 != subprocess.call(cmd.split(), stdout=Utils.FNull):
             if not silent: Utils.Print("Launcher failed to shut down eos cluster.")

tests/TestHarness/Node.py

@@ -10,7 +10,7 @@
 
 from datetime import datetime
 from datetime import timedelta
-from core_symbol import CORE_SYMBOL
+from .core_symbol import CORE_SYMBOL
 from .queries import NodeosQueries, BlockType
 from .transactions import Transactions
 from .testUtils import Utils

tests/TestHarness/__init__.py

@@ -1,4 +1,4 @@
-__all__ = ['Node', 'Cluster', 'WalletMgr', 'logging', 'depresolver', 'testUtils', 'TestHelper', 'queries', 'transactions', 'launch_transaction_generators', 'TransactionGeneratorsLauncher', 'TpsTrxGensConfig']
+__all__ = ['Node', 'Cluster', 'WalletMgr', 'logging', 'depresolver', 'testUtils', 'TestHelper', 'queries', 'transactions', 'launch_transaction_generators', 'TransactionGeneratorsLauncher', 'TpsTrxGensConfig', 'core_symbol']
 
 from .Cluster import Cluster
 from .Node import Node
@@ -9,3 +9,4 @@
 from .Node import ReturnType
 from .TestHelper import TestHelper
 from .launch_transaction_generators import TransactionGeneratorsLauncher, TpsTrxGensConfig
+from .core_symbol import CORE_SYMBOL

tests/TestHarness/core_symbol.py.in

@@ -0,0 +1,5 @@
+import os
+
+sys_core_symbol = os.environ.get('CORE_SYMBOL_NAME')
+
+CORE_SYMBOL=sys_core_symbol if sys_core_symbol else '${CORE_SYMBOL_NAME}'

tests/TestHarness/queries.py

@@ -10,7 +10,7 @@
 import urllib.parse
 import urllib.error
 
-from core_symbol import CORE_SYMBOL
+from .core_symbol import CORE_SYMBOL
 from .testUtils import Account
 from .testUtils import EnumType
 from .testUtils import addEnum

tests/TestHarness/testUtils.py

@@ -16,6 +16,7 @@
 import traceback
 import shutil
 import sys
+from pathlib import Path
 
 ###########################################################################################
 
@@ -55,29 +56,30 @@ class Utils:
     Debug=False
     FNull = open(os.devnull, 'w')
 
-    EosClientPath="programs/cleos/cleos"
+    testBinPath = Path(__file__).resolve().parents[2] / 'bin'
+
+    EosClientPath=str(testBinPath / "cleos")
     MiscEosClientArgs="--no-auto-keosd"
 
-    LeapClientPath="programs/leap-util/leap-util"
+    LeapClientPath=str(testBinPath / "leap-util")
 
     EosWalletName="keosd"
-    EosWalletPath="programs/keosd/"+ EosWalletName
+    EosWalletPath=str(testBinPath / EosWalletName)
 
     EosServerName="nodeos"
-    EosServerPath="programs/nodeos/"+ EosServerName
+    EosServerPath=str(testBinPath / EosServerName)
 
-    EosLauncherPath="programs/eosio-launcher/eosio-launcher"
     ShuttingDown=False
 
     EosBlockLogPath="programs/eosio-blocklog/eosio-blocklog"
 
     FileDivider="================================================================="
-    TestLogRoot="TestLogs"
+    TestLogRoot=f"{str(Path.cwd().resolve())}/TestLogs"
     DataRoot=os.path.basename(sys.argv[0]).rsplit('.',maxsplit=1)[0]
     PID = os.getpid()
     DataPath= f"{TestLogRoot}/{DataRoot}{PID}"
     DataDir= f"{DataPath}/"
-    ConfigDir="etc/eosio/"
+    ConfigDir=f"{str(Path.cwd().resolve())}/etc/eosio/"
 
     TimeFmt='%Y-%m-%dT%H:%M:%S.%f'
 
@@ -90,10 +92,10 @@ def checkOutputFileWrite(time, cmd, output, error):
         stop=Utils.timestamp()
         if not hasattr(Utils, "checkOutputFile"):
             if not os.path.isdir(Utils.TestLogRoot):
-                if Utils.Debug: Utils.Print("creating dir %s in dir: %s" % (Utils.TestLogRoot, os.getcwd()))
+                if Utils.Debug: Utils.Print("TestLogRoot creating dir %s in dir: %s" % (Utils.TestLogRoot, os.getcwd()))
                 os.mkdir(Utils.TestLogRoot)
             if not os.path.isdir(Utils.DataPath):
-                if Utils.Debug: Utils.Print("creating dir %s in dir: %s" % (Utils.DataPath, os.getcwd()))
+                if Utils.Debug: Utils.Print("DataPath creating dir %s in dir: %s" % (Utils.DataPath, os.getcwd()))
                 os.mkdir(Utils.DataPath)
             filename=f"{Utils.DataPath}/subprocess_results.log"
             if Utils.Debug: Utils.Print("opening %s in dir: %s" % (filename, os.getcwd()))

tests/TestHarness/transactions.py

@@ -4,7 +4,7 @@
 import subprocess
 import time
 
-from core_symbol import CORE_SYMBOL
+from .core_symbol import CORE_SYMBOL
 from .depresolver import dep
 from .queries import NodeosQueries
 from .testUtils import Account
@@ -220,13 +220,15 @@ def pushTransaction(self, trans, opts="", silentErrors=False, permissions=None):
             return (False, msg)
 
     # returns tuple with transaction execution status and transaction
-    def pushMessage(self, account, action, data, opts, silentErrors=False, signatures=None, expectTrxTrace=True):
+    def pushMessage(self, account, action, data, opts, silentErrors=False, signatures=None, expectTrxTrace=True, force=False):
         cmd="%s %s push action -j %s %s" % (Utils.EosClientPath, self.eosClientArgs(), account, action)
         cmdArr=cmd.split()
         # not using sign_str, since cmdArr messes up the string
         if signatures is not None:
             cmdArr.append("--sign-with")
             cmdArr.append("[ \"%s\" ]" % ("\", \"".join(signatures)))
+        if force:
+            cmdArr.append("-f")
         if data is not None:
             cmdArr.append(data)
         if opts is not None:

tests/block_log_util_test.py

@@ -18,8 +18,6 @@
 Print=Utils.Print
 errorExit=Utils.errorExit
 
-from core_symbol import CORE_SYMBOL
-
 def verifyBlockLog(expected_block_num, trimmedBlockLog):
     firstBlockNum = expected_block_num
     for block in trimmedBlockLog:

tests/compute_transaction_test.py

@@ -2,8 +2,7 @@
 
 import random
 
-from TestHarness import Account, Cluster, ReturnType, TestHelper, Utils, WalletMgr
-from core_symbol import CORE_SYMBOL
+from TestHarness import Account, Cluster, ReturnType, TestHelper, Utils, WalletMgr, CORE_SYMBOL
 
 ###############################################################
 # compute_transaction_tests

tests/get_account_test.py

@@ -3,7 +3,6 @@
 import random
 
 from TestHarness import Account, Cluster, ReturnType, TestHelper, Utils, WalletMgr
-from core_symbol import CORE_SYMBOL
 
 ###############################################################
 # get_account_test

tests/launcher.py

@@ -378,7 +378,7 @@ def write_logging_config_file(self, node):
         dex = str(node.index).zfill(2)
         if dex in self.args.logging_level_map:
             ll = self.args.logging_level_map[dex]
-        with open(Path(os.getcwd()) / 'logging.json', 'r') as default:
+        with open(Path(__file__).resolve().parents[0] / 'TestHarness' / 'logging-template.json', 'r') as default:
             cfg = json.load(default)
         for logger in cfg['loggers']:
             logger['level'] = ll

tests/launcher_test.py

@@ -4,7 +4,7 @@
 import re
 import os
 
-from TestHarness import Cluster, Node, TestHelper, Utils, WalletMgr
+from TestHarness import Cluster, Node, TestHelper, Utils, WalletMgr, CORE_SYMBOL
 from pathlib import Path
 
 ###############################################################
@@ -17,7 +17,6 @@
 Print=Utils.Print
 errorExit=Utils.errorExit
 cmdError=Utils.cmdError
-from core_symbol import CORE_SYMBOL
 
 args = TestHelper.parse_args({"--defproducera_prvt_key","--dump-error-details","--dont-launch","--keep-logs",
                               "-v","--leave-running","--clean-run","--unshared"})

tests/nodeos_contrl_c_test.py

@@ -3,8 +3,7 @@
 import signal
 import time
 
-from TestHarness import Cluster, Node, TestHelper, Utils, WalletMgr
-from core_symbol import CORE_SYMBOL
+from TestHarness import Cluster, Node, TestHelper, Utils, WalletMgr, CORE_SYMBOL
 
 ###############################################################
 # nodeos_contrl_c_lr_test