feat: add error handling function (#8)

* feat: add `_set_error` function * test: add test for `_set_error` function * test: merge test for checking out invalid Git repo
threeal · Mar 11, 2024 · 689cab5 · 689cab5
1 parent 380c0be
commit 689cab5
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 33 deletions.
diff --git a/cmake/GitCheckout.cmake b/cmake/GitCheckout.cmake
@@ -1,5 +1,22 @@
 include_guard(GLOBAL)
 
+# Set error with a specified message.
+#
+# If the `ERROR_VARIABLE` is specified, it will set the error message to that variable.
+# Otherwise, it will print the error message and halt the execution.
+#
+# Arguments:
+#   - MESSAGE: The error message.
+macro(_set_error MESSAGE)
+  cmake_parse_arguments(ARG "" "ERROR_VARIABLE" "" ${ARGN})
+  if(ARG_ERROR_VARIABLE)
+    set(${ARG_ERROR_VARIABLE} "${MESSAGE}" PARENT_SCOPE)
+    return()
+  else()
+    message(FATAL_ERROR "${MESSAGE}")
+  endif()
+endmacro()
+
 # Clones and checks out a Git repository from a remote location.
 #
 # If the `ERROR_VARIABLE` is specified, it will set the error message to that variable.
@@ -14,10 +31,9 @@ function(git_checkout URL)
     RESULT_VARIABLE RES
   )
   if(NOT RES EQUAL 0)
-    if(ARG_ERROR_VARIABLE)
-      set(${ARG_ERROR_VARIABLE} "Failed to clone ${URL} (${RES})" PARENT_SCOPE)
-    else()
-      message(FATAL_ERROR "Failed to clone ${URL} (${RES})")
-    endif()
+    _set_error(
+      "Failed to clone ${URL} (${RES})"
+      ERROR_VARIABLE ${ARG_ERROR_VARIABLE}
+    )
   endif()
 endfunction()
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -12,7 +12,8 @@ endfunction()
 
 add_cmake_test(
   GitCheckoutTest.cmake
+  "Set error"
+  "Set error with variable specified"
   "Check out a Git repository"
   "Check out an invalid Git repository"
-  "Check out an invalid Git repository with error variable specified"
 )
diff --git a/test/GitCheckoutTest.cmake b/test/GitCheckoutTest.cmake
@@ -5,47 +5,64 @@ endif()
 
 set(TEST_COUNT 0)
 
-if("Check out a Git repository" MATCHES ${TEST_MATCHES})
-  math(EXPR TEST_COUNT "${TEST_COUNT} + 1")
-
-  if(EXISTS project-starter)
-    file(REMOVE_RECURSE project-starter)
-  endif()
-
-  include(GitCheckout)
-  git_checkout(https://github.com/threeal/project-starter)
-
-  if(NOT EXISTS project-starter)
-    message(FATAL_ERROR "project-starter should exist")
-  endif()
-endif()
-
-if("Check out an invalid Git repository" MATCHES ${TEST_MATCHES})
+if("Set error" MATCHES ${TEST_MATCHES})
   math(EXPR TEST_COUNT "${TEST_COUNT} + 1")
 
   set(MOCK_MESSAGE on)
   macro(message MODE MESSAGE)
     if(MOCK_MESSAGE)
-      if(${MODE} STREQUAL FATAL_ERROR)
-        set(FATAL_ERROR_MESSAGE "${MESSAGE}" PARENT_SCOPE)
-      endif()
+      set(${MODE}_MESSAGE "${MESSAGE}" PARENT_SCOPE)
     else()
       _message(${MODE} ${MESSAGE})
     endif()
   endmacro()
 
   include(GitCheckout)
-  git_checkout(https://github.com/threeal/invalid-project)
+
+  function(foo)
+    _set_error("Unknown error")
+  endfunction()
+
+  foo()
 
   set(MOCK_MESSAGE off)
+  if(NOT FATAL_ERROR_MESSAGE STREQUAL "Unknown error")
+    message(FATAL_ERROR "It should have set the error to 'Unknown error' but instead got '${FATAL_ERROR_MESSAGE}'")
+  endif()
+endif()
+
+if("Set error with variable specified" MATCHES ${TEST_MATCHES})
+  math(EXPR TEST_COUNT "${TEST_COUNT} + 1")
+
+  include(GitCheckout)
+
+  function(foo)
+    _set_error("Unknown error" ERROR_VARIABLE ERR)
+  endfunction()
+
+  foo()
+
+  if(NOT ERR STREQUAL "Unknown error")
+    message(FATAL_ERROR "It should have set the error to 'Unknown error' but instead got '${ERR}'")
+  endif()
+endif()
+
+if("Check out a Git repository" MATCHES ${TEST_MATCHES})
+  math(EXPR TEST_COUNT "${TEST_COUNT} + 1")
+
+  if(EXISTS project-starter)
+    file(REMOVE_RECURSE project-starter)
+  endif()
 
-  set(EXPECTED_FATAL_ERROR_MESSAGE "Failed to clone https://github.com/threeal/invalid-project (128)")
-  if(NOT FATAL_ERROR_MESSAGE STREQUAL EXPECTED_FATAL_ERROR_MESSAGE)
-    message(FATAL_ERROR "It should fail to check out because of `${EXPECTED_FATAL_ERROR_MESSAGE}`, but got `${FATAL_ERROR_MESSAGE}` instead")
+  include(GitCheckout)
+  git_checkout(https://github.com/threeal/project-starter)
+
+  if(NOT EXISTS project-starter)
+    message(FATAL_ERROR "The 'project-starter' directory should exist")
   endif()
 endif()
 
-if("Check out an invalid Git repository with error variable specified" MATCHES ${TEST_MATCHES})
+if("Check out an invalid Git repository" MATCHES ${TEST_MATCHES})
   math(EXPR TEST_COUNT "${TEST_COUNT} + 1")
 
   include(GitCheckout)
@@ -54,9 +71,9 @@ if("Check out an invalid Git repository with error variable specified" MATCHES $
     ERROR_VARIABLE ERR
   )
 
-  set(EXPECTED_FATAL_ERROR_MESSAGE "Failed to clone https://github.com/threeal/invalid-project (128)")
-  if(NOT ${ERR} STREQUAL EXPECTED_FATAL_ERROR_MESSAGE)
-    message(FATAL_ERROR "It should fail to check out because of `${EXPECTED_FATAL_ERROR_MESSAGE}`, but got `${ERR}` instead")
+  set(EXPECTED_ERR "Failed to clone https://github.com/threeal/invalid-project (128)")
+  if(NOT ${ERR} STREQUAL EXPECTED_ERR)
+    message(FATAL_ERROR "It should fail to check out because of '${EXPECTED_ERR}' but instead got '${ERR}'")
   endif()
 endif()