Use GoogleTest as a submodule (#2371)

* Add googletest submodule * Refactor googletest usage * Update submodule usage in workflwos * Spelling * Update missed workflows * Use checkout@v4
nasa · Nov 27, 2023 · b9551a2 · b9551a2
1 parent dc3cb60
commit b9551a2
Show file tree

Hide file tree

Showing 16 changed files with 45 additions and 75 deletions.
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
@@ -390,6 +390,7 @@ gettime
 gettimeofday
 getty
 ghprb
+gitmodules
 gmock
 Gnc
 Gnd

diff --git a/.github/workflows/autodocs.yml b/.github/workflows/autodocs.yml
@@ -10,9 +10,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: Setup Dependencies
       run: |

diff --git a/.github/workflows/build-test-macos.yml b/.github/workflows/build-test-macos.yml
@@ -21,9 +21,10 @@ jobs:
     runs-on: macos-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: F prime CI step
       run: ./ci/tests/Framework.bash
@@ -40,9 +41,10 @@ jobs:
     runs-on: macos-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: F prime CI step
       run: ./ci/tests/Ref.bash
@@ -59,9 +61,10 @@ jobs:
     runs-on: macos-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: Install coreutils
       run: brew install coreutils

diff --git a/.github/workflows/build-test-rpi.yml b/.github/workflows/build-test-rpi.yml
@@ -23,9 +23,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: Setup RPI Toolchain
       uses: fprime-community/setup-rpi-sysroot@main

diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml
@@ -21,9 +21,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: F prime CI step
       run: ./ci/tests/Framework.bash
@@ -40,9 +41,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: F prime CI step
       run: ./ci/tests/Ref.bash
@@ -59,9 +61,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: Setup Valgrind
       run: |
@@ -82,9 +85,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: Setup Dependencies
       run: |
@@ -104,9 +108,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: "Checkout F´ Repository"
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
     - uses: ./.github/actions/setup
     - name: CMake Tests
       working-directory: ./cmake/test

diff --git a/.github/workflows/cppcheck-scan.yml b/.github/workflows/cppcheck-scan.yml
@@ -24,9 +24,10 @@ jobs:
 
     steps:
       - name: "Checkout F´ Repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
       - uses: ./.github/actions/setup
 
       - name: Install cppcheck

diff --git a/.github/workflows/cpplint-scan.yml b/.github/workflows/cpplint-scan.yml
@@ -23,9 +23,10 @@ jobs:
 
     steps:
       - name: "Checkout F´ Repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
       - uses: ./.github/actions/setup
 
       - name: Install cpplint

diff --git a/.github/workflows/ext-raspberry-led-blinker.yml b/.github/workflows/ext-raspberry-led-blinker.yml
@@ -30,15 +30,15 @@ jobs:
     needs: get-branch
     steps:
       - name: "Checkout target repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: false
           repository: fprime-community/fprime-workshop-led-blinker
           ref: ${{ needs.get-branch.outputs.target-branch }}
       - name: "Overlay current F´ revision"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: true
           path: ./fprime
           fetch-depth: 0
       - uses: ./fprime/.github/actions/setup

diff --git a/.github/workflows/fpp-tests.yml b/.github/workflows/fpp-tests.yml
@@ -17,9 +17,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: "Checkout F´ Repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          submodules: true
       - name: "Install requirements.txt"
         run: |
           pip3 install -r ./requirements.txt

diff --git a/.github/workflows/reusable-project-builder.yml b/.github/workflows/reusable-project-builder.yml
@@ -47,15 +47,15 @@ jobs:
     name: "Build"
     steps:
       - name: "Checkout target repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: false 
           repository: ${{ inputs.target_repository }}
           ref: ${{ inputs.target_ref }}
       - name: "Overlay current F´ revision"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: true
           path: ${{ inputs.fprime_location }}
       - name: "Install requirements.txt"
         run: |
@@ -78,15 +78,15 @@ jobs:
     name: "Unit Tests"
     steps:
       - name: "Checkout target repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: false
           repository: ${{ inputs.target_repository }}
           ref: ${{ inputs.target_ref }}
       - name: "Overlay current F´ revision"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
-          submodules: recursive
+          submodules: true
           path: ${{ inputs.fprime_location }}
       - name: "Install requirements.txt"
         run: |

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "googletest"]
+	path = googletest
+	url = https://github.com/google/googletest.git
diff --git a/Drv/Ip/CMakeLists.txt b/Drv/Ip/CMakeLists.txt
@@ -27,7 +27,7 @@ if (BUILD_TESTING)
 		"${CMAKE_CURRENT_LIST_DIR}/test/ut/SocketTestHelper.cpp")
 	target_include_directories(PortSelector PUBLIC
 			"${FPRIME_FRAMEWORK_PATH}/STest"
-			"${FPRIME_FRAMEWORK_PATH}/gtest/googletest-src/googletest/include"
+			"${FPRIME_FRAMEWORK_PATH}/googletest/googletest/include"
 	)
 	add_dependencies(PortSelector STest Fw_Buffer)
 	target_link_libraries(PortSelector STest Fw_Buffer)

diff --git a/cmake/FPrime.cmake b/cmake/FPrime.cmake
@@ -160,7 +160,7 @@ function(fprime_setup_included_code)
     setup_global_targets()
     # For BUILD_TESTING builds then set up libraries that support testing
     if (BUILD_TESTING AND NOT DEFINED FPRIME_SUB_BUILD_TARGETS)
-        include("${FPRIME_FRAMEWORK_PATH}/cmake/googletest-download/googletest.cmake")
+        add_subdirectory("${FPRIME_FRAMEWORK_PATH}/googletest/" "${CMAKE_BINARY_DIR}/F-Prime/googletest")
     endif()
     if (BUILD_TESTING)
         add_subdirectory("${FPRIME_FRAMEWORK_PATH}/STest/" "${CMAKE_BINARY_DIR}/F-Prime/STest")

diff --git a/cmake/googletest-download/CMakeLists.txt.in b/cmake/googletest-download/CMakeLists.txt.in
diff --git a/cmake/googletest-download/googletest.cmake b/cmake/googletest-download/googletest.cmake
diff --git a/googletest b/googletest
-Original file line number
+Diff line change
@@ Expand Up / @@ -390,6 +390,7 @@ gettime @@
     gettimeofday
     getty
     ghprb
+    gitmodules
     gmock
     Gnc
     Gnd
@@ Expand Down @@