M1 맥북 Google test 환경 구축

📌C/C++를 테스트하는 프레임워크인 Google test를 M1맥북에서 세팅하는 과정에 대해 다루는 글입니다.

 

보통 WSL에 깔아서 많이 사용하는데 M1, M2맥북에서는 잘 되지 않는다고 해서 docker를 이용해 환경을 세팅했다. 명령어들은 iTerm에 입력하며 진행했다.

 

먼저 아래 이미지를 pull 받고 이후 컨테이너를 생성하여 실행한다.

https://hub.docker.com/r/srzzumix/googletest/

Docker

docker pull srzzumix/googletest

docker run -it -v /$(pwd):/code srzzumix/googletest sh

여기까지 실행했다면 아래와 같이 #으로 시작하는 커맨드라인으로 진입하게 된다.

dockerDesktop 앱에서도 컨테이너가 생성된 것을 확인할 수 있다.

나가려면 exit 명령어를 사용하면 된다. 다만 docker run -it -v /$(pwd):/code srzzumix/googletest sh명령어는 이미지를 통해 컨테이너를 만드는 명령어이기 때문에 다시 해당 컨테이너의 커맨드라인으로 접근하려면 컨테이너를 실행하는 명령어인 아래 명령어를 사용해야 한다. 위 명령어를 계속 사용하면 계속하여 컨테이너가 새로 생성된다.

docker exec -it [컨테이너 Id] /bin/sh

이제 설치한 googleTest를 사용해보도록 하자. 위 명령어로 다시 컨테이너 커맨드라인에 접근한 뒤 폴더를 만들도록 하자.

mkdir my_project && cd my_project

그리고 my_project 폴더에 아래와 같이 파일을 두개 만들어야 한다. 파일명도 맞춰야 정상적으로 vi로 파일을 생성하려했으나 잘 되지 않아서 나는 vscode로 진행했다.

 

CMakeLists.txt

cmake_minimum_required(VERSION 3.14)
project(my_project)

# GoogleTest requires at least C++14
set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

include(FetchContent)
FetchContent_Declare(
  googletest
  URL https://github.com/google/googletest/archive/03597a01ee50ed33e9dfd640b249b4be3799d395.zip
)
# For Windows: Prevent overriding the parent project's compiler/linker settings
set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
FetchContent_MakeAvailable(googletest)

enable_testing()

add_executable(
  hello_test
  hello_test.cc
)
target_link_libraries(
  hello_test
  GTest::gtest_main
)

include(GoogleTest)
gtest_discover_tests(hello_test)

hello_test.cc

#include <gtest/gtest.h>

// Demonstrate some basic assertions.
TEST(HelloTest, BasicAssertions) {
  // Expect two strings not to be equal.
  EXPECT_STRNE("hello", "world");
  // Expect equality.
  EXPECT_EQ(7 * 6, 42);
}

 

이제 다시 터미널로 돌아와서 아래 명령어를 순차적으로 입력하면 된다.

mkdir build && cd build

cmake ..  //CMakeLists.txt에 정의된 내용을 바탕으로 Makefile 파일 생성

make //Makefile실행

./hello_test //hello_test파일 실행

여기까지 했으면 build 파일 안에 hello_test 실행 파일이 생성되었을텐데 이것을 실행하면 된다. googleTest환경이 도커에 구축되어 있기에 iterm에서 docker exec 명령어를 이용해 bash를 연 뒤 실행해도 되고 더 간단한 방법으로는 vscode에서 docker extension을 이용하는 방법이 있다.

 

docker extension을 깔면 왼쪽에 도커 로그가 생기는데 컨테이너 중 구글 테스트가 깔린 컨테이너를 우클릭하면 attach shell메뉴가 나온다.

해당 쉘에서 위에서 만든 build폴더로 이동한 뒤 hello_test파일을 실행하면 테스트 결과를 얻을 수 있다.

cd my_project/build //위에서 만든 폴더로 이동

./hello_test. //hello_test파일 실행

이제 test파일이 바뀌었다면 build 폴더에서 make명령어를 실행해 준 뒤 다시 hello_test파일을 실행하면 된다. 테스트를 위해 hello_test.cc의 내용을 아래와 같이 수정했다.

#include <gtest/gtest.h>

// Demonstrate some basic assertions.
TEST(HelloTest, BasicAssertions) {
  // Expect two strings not to be equal.
  EXPECT_STRNE("hello", "world");
  // Expect equality.
  EXPECT_EQ(7 * 6, 42);

  // [추가된 내용] 실패할 테스트
  EXPECT_EQ(7 * 6, 50);
}

 

이후 docker의 bash에서 아래 명령어들을 실행해주었다.

//build폴더에서

make //make파일에 명시된 내용에 따라 재컴파일

./hello_test //새로 만들어진 hello_test파일 생성

여기까지 성공했다면 googleTest환경 구축이 완료된다. 마지막으로 위에서 사용한 cmake와 make에 대해 설명하고 글을 마치도록 하겠다.

 

cmake명령은 Makefile을 생성하는 명령어이고 make파일은 Makefile에 정의된 내용을 실행하는 명령어이다.

 

Makefile에 대해 간단히 설명하자면 파일간의 의존성을 정의해 놓은 파일이다. 예를들어 파일 구조가 아래와 같다고 생각해보자.

이 상황에서 world.c가 수정되었다고 하면 우리는 world.c와 world.h를 컴파일하여 world.o를 만들고 다시 hello1.o와 world.o를 컴파일하여 hello_world실행파일을 만들어야 할 것이다. 만일 파일 구조가 더 복잡하다면? 더 여러번 컴파일 명령어를 쳐야 할 것이다.

 

이를 간편하게 해주는 것이 Makefile이다. Makefile에는 각 파일이 어떤 파일에 의존하고있는지 정보가 기록되어있어서 make명령어 한 줄이면 위에서 해야 할 작업을 모두 해준다. 만일 위와 같은 상황이라면 make명령어를 입력했을 때 world.c와 world.h를 컴파일하여 world.o를 만들고 다시 hello1.o와 world.o를 컴파일하여 새로운 hello_world 실행파일을 만들어 줄 것이다.