Added cmake tests that prevents people from changing message datatypes

.github/workflows/windows_x86_build.yml

@@ -24,7 +24,7 @@ jobs:
 
     - name: Create Build Environment
       run: mkdir ${{runner.workspace}}\grpc-labview\build
-
+    
     - name: Configure CMake
       working-directory: ${{runner.workspace}}\grpc-labview\build
       run: cmake -G "Visual Studio 16 2019" -A Win32 ..

CMakeLists.txt

@@ -54,6 +54,15 @@ include_directories("${CMAKE_CURRENT_BINARY_DIR}" "./src" "./third_party/grpc" "
 #----------------------------------------------------------------------
 # LabVIEW support for grpc and protobuf
 #----------------------------------------------------------------------
+
+add_custom_target(Detect_MessageMetadata_Structural_Changes
+    COMMAND ${CMAKE_COMMAND} -E echo "Running MessageMetadata structure test.py ..."
+    COMMAND python -m pip install -r ${CMAKE_CURRENT_SOURCE_DIR}/tests/CMakeTests/requirements.txt
+    COMMAND python ${CMAKE_CURRENT_SOURCE_DIR}/tests/CMakeTests/run_test.py
+    RESULT_VARIABLE shell_command_result
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+)
+
 add_library(labview_grpc_server SHARED
   src/grpc_client.cc
   src/grpc_server.cc
@@ -180,3 +189,9 @@ target_link_libraries(test_server
  ${_REFLECTION}
  ${_GRPC_GRPCPP}
  ${_PROTOBUF_LIBPROTOBUF})
+
+add_dependencies(labview_grpc_server Detect_MessageMetadata_Structural_Changes)
+add_dependencies(labview_grpc_generator Detect_MessageMetadata_Structural_Changes)
+add_dependencies(test_client Detect_MessageMetadata_Structural_Changes)
+add_dependencies(test_server Detect_MessageMetadata_Structural_Changes)
+add_dependencies(example_client Detect_MessageMetadata_Structural_Changes)

docs/Building.md

@@ -18,6 +18,7 @@ To prepare for cmake + Microsoft Visual C++ compiler build
 - Install Visual Studio 2019 (Visual C++ compiler will be used).
 - Install [Git](https://git-scm.com/).
 - Install [CMake](https://cmake.org/download/).
+- Install [Python 3.7 or Higher](https://www.python.org/downloads/).
 
 
 #### Building 64-bit

tests/CMakeTests/.gitignore

@@ -0,0 +1 @@
+exported_function_list.json

tests/CMakeTests/requirements.txt

@@ -0,0 +1 @@
+pytest

tests/CMakeTests/run_test.py

@@ -0,0 +1,27 @@
+import subprocess
+import sys
+import os
+
+def run_tests():
+    message_structures_test_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "tests/message_structure_test.py")
+    exported_functions_test_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "tests/exported_functions_test.py")
+    exported_functions_addition_test_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), "tests/exported_functions_addition_test.py")
+
+    # Check the exit code
+    result_message_structure = subprocess.run(["python", "-m", "pytest", message_structures_test_path, "-vv"])
+    if result_message_structure.returncode != 0:
+        print(f"Message structural tests failed with exit code {result_message_structure.returncode}. Exiting.")
+        sys.exit(result_message_structure.returncode)
+    result_exported_functions = subprocess.run(["python", "-m", "pytest", exported_functions_test_path, "-vv"])
+    if result_exported_functions.returncode != 0:
+        print(f"Function structural tests failed with exit code {result_exported_functions.returncode}. Exiting.")
+        sys.exit(result_exported_functions.returncode)
+    result_exported_functions_addition = subprocess.run(["python", exported_functions_addition_test_path])
+    if result_exported_functions_addition.returncode != 0:
+        print(f"Function structural tests failed with exit code {result_exported_functions_addition.returncode}. Exiting.")
+        sys.exit(result_exported_functions_addition.returncode)
+
+    print("All structural tests passed.")
+
+if __name__ == "__main__":
+    run_tests()