From 7aae2ac34c4b0c8ff233297d7f9011b2850a389d Mon Sep 17 00:00:00 2001 From: Hyuk Myeong Date: Tue, 15 Sep 2020 02:17:23 +0900 Subject: [PATCH 1/5] Improve the tutorial that may be confusing --- README.md | 4 ++-- googletest/README.md | 48 ++++++++++++++++++++++++++------------------ 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index e8eefe5fba..bd87183415 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ is now available. ## Welcome to **Google Test**, Google's C++ test framework! -This repository is a merger of the formerly separate GoogleTest and GoogleMock +This repository is a merger of the formerly separate Google Test and Google Mock projects. These were so closely related that it makes sense to maintain and release them together. @@ -98,7 +98,7 @@ is a VS Code extension allowing to view Google Tests in a tree view, and run/debug your tests. [C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS -Code extension allowing to view Google Tests in a tree view, and run/debug your +Code extension allowing to view Google Test in a tree view, and run/debug your tests. [Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser diff --git a/googletest/README.md b/googletest/README.md index 8520549c7d..4ab3cb2d69 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -24,17 +24,20 @@ another project. When building Google Test as a standalone project, the typical workflow starts with: - mkdir mybuild # Create a directory to hold the build output. - cd mybuild - cmake ${GTEST_DIR} # Generate native build scripts. + git clone https://github.com/google/googletest.git -b release-1.10.0 + cd googletest + mkdir build # Create a directory to hold the build output. + cd build + cmake .. # Generate native build scripts for Google Test -If you want to build Google Test's samples, you should replace the last command -with +If you are on a \*nix system, you should now see a Makefile in the current +directory. Just type `make` to build gtest. - cmake -Dgtest_build_samples=ON ${GTEST_DIR} + make -If you are on a \*nix system, you should now see a Makefile in the current -directory. Just type 'make' to build gtest. +And if you are a system administrator, you can simply install Google Test. + + sudo make install # Install in /usr/local/ by default If you use Windows and have Visual Studio installed, a `gtest.sln` file and several `.vcproj` files will be created. You can then build them using Visual @@ -44,26 +47,31 @@ On Mac OS X with Xcode installed, a `.xcodeproj` file will be generated. #### Incorporating Into An Existing CMake Project -If you want to use gtest in a project which already uses CMake, then a more -robust and flexible approach is to build gtest as part of that project directly. -This is done by making the GoogleTest source code available to the main build -and adding it using CMake's `add_subdirectory()` command. This has the -significant advantage that the same compiler and linker settings are used -between gtest and the rest of your project, so issues associated with using -incompatible libraries (eg debug/release), etc. are avoided. This is -particularly useful on Windows. Making GoogleTest's source code available to the +The easiest way to use Google Test is importing installed libraries and headers. + +* Import Google Test by using `find_package` (or `pkg_check_modules`). + For example, if `find_package(GTest CONFIG REQUIRED)` is succeed, + you can use the libraries as `GTest::gtest`, `GTest::gmock`. + +And a more robust and flexible approach is to build gtest as part of that project +directly. This is done by making the Google Test source code available to the +main build and adding it using CMake's `add_subdirectory()` command. +This has the significant advantage that the same compiler and linker settings +are used between gtest and the rest of your project, so issues associated with +using incompatible libraries (eg debug/release), etc. are avoided. This is +particularly useful on Windows. Making Google Test's source code available to the main build can be done a few different ways: -* Download the GoogleTest source code manually and place it at a known +* Download the Google Test source code manually and place it at a known location. This is the least flexible approach and can make it more difficult to use with continuous integration systems, etc. -* Embed the GoogleTest source code as a direct copy in the main project's +* Embed the Google Test source code as a direct copy in the main project's source tree. This is often the simplest approach, but is also the hardest to keep up to date. Some organizations may not permit this method. -* Add GoogleTest as a git submodule or equivalent. This may not always be +* Add Google Test as a git submodule or equivalent. This may not always be possible or appropriate. Git submodules, for example, have their own set of advantages and drawbacks. -* Use CMake to download GoogleTest as part of the build's configure step. This +* Use CMake to download Google Test as part of the build's configure step. This is just a little more complex, but doesn't have the limitations of the other methods. From 32437f41ecaa71de2855397267de05d36025fea5 Mon Sep 17 00:00:00 2001 From: Hyuk Myeong Date: Tue, 15 Sep 2020 02:30:34 +0900 Subject: [PATCH 2/5] Remove a space --- googletest/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/googletest/README.md b/googletest/README.md index 4ab3cb2d69..afa08f7ad0 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -51,7 +51,7 @@ The easiest way to use Google Test is importing installed libraries and headers. * Import Google Test by using `find_package` (or `pkg_check_modules`). For example, if `find_package(GTest CONFIG REQUIRED)` is succeed, - you can use the libraries as `GTest::gtest`, `GTest::gmock`. + you can use the libraries as `GTest::gtest`, `GTest::gmock`. And a more robust and flexible approach is to build gtest as part of that project directly. This is done by making the Google Test source code available to the From 2d1a18ff3a1e823daf17c7386470197aae61286f Mon Sep 17 00:00:00 2001 From: Hyuk Myeong Date: Tue, 15 Sep 2020 21:15:43 +0900 Subject: [PATCH 3/5] Apply the reviewed comment --- googletest/README.md | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/googletest/README.md b/googletest/README.md index afa08f7ad0..7fe5301490 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -22,21 +22,24 @@ another project. #### Standalone CMake Project When building Google Test as a standalone project, the typical workflow starts -with: +with git clone https://github.com/google/googletest.git -b release-1.10.0 - cd googletest + cd googletest # Main directory of the cloned repository. mkdir build # Create a directory to hold the build output. cd build - cmake .. # Generate native build scripts for Google Test + cmake .. # Generate native build scripts for Google Test. -If you are on a \*nix system, you should now see a Makefile in the current -directory. Just type `make` to build gtest. +If you want to build without Google Mock, you should replace the last command +with - make + cmake .. -DBUILD_GMOCK=OFF -And if you are a system administrator, you can simply install Google Test. +If you are on a \*nix system, you should now see a Makefile in the current +directory. Just type `make` to build Google Test. And then you can simply +install Google Test if you are a system administrator. + make sudo make install # Install in /usr/local/ by default If you use Windows and have Visual Studio installed, a `gtest.sln` file and @@ -47,18 +50,19 @@ On Mac OS X with Xcode installed, a `.xcodeproj` file will be generated. #### Incorporating Into An Existing CMake Project -The easiest way to use Google Test is importing installed libraries and headers. +If you want to use Google Test in a project which already uses CMake, +the easiest way is to get installed libraries and headers. * Import Google Test by using `find_package` (or `pkg_check_modules`). For example, if `find_package(GTest CONFIG REQUIRED)` is succeed, you can use the libraries as `GTest::gtest`, `GTest::gmock`. -And a more robust and flexible approach is to build gtest as part of that project -directly. This is done by making the Google Test source code available to the -main build and adding it using CMake's `add_subdirectory()` command. +And a more robust and flexible approach is to build Google Test as part of that +project directly. This is done by making the Google Test source code available +to the main build and adding it using CMake's `add_subdirectory()` command. This has the significant advantage that the same compiler and linker settings -are used between gtest and the rest of your project, so issues associated with -using incompatible libraries (eg debug/release), etc. are avoided. This is +are used between Google Test and the rest of your project, so issues associated +with using incompatible libraries (eg debug/release), etc. are avoided. This is particularly useful on Windows. Making Google Test's source code available to the main build can be done a few different ways: From 5afcb3ca4d1b01eee16f3d4030b40d16ed241c8f Mon Sep 17 00:00:00 2001 From: Hyuk Myeong Date: Tue, 15 Sep 2020 21:31:07 +0900 Subject: [PATCH 4/5] Add follow-up patch for more natural reading --- googletest/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/googletest/README.md b/googletest/README.md index 7fe5301490..a5465cdc5c 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -30,7 +30,8 @@ with cd build cmake .. # Generate native build scripts for Google Test. -If you want to build without Google Mock, you should replace the last command +The above command also includes Google Mock by default. And so, if you want +to build only Google Test, you should replace the last command with cmake .. -DBUILD_GMOCK=OFF From 242ee2720ce245ab1278531d0d9c3ba94660c8ba Mon Sep 17 00:00:00 2001 From: Hyuk Myeong Date: Wed, 16 Sep 2020 01:33:41 +0900 Subject: [PATCH 5/5] Remove spaces between Google Test and Google Mock --- README.md | 36 +++++++++++----------- googlemock/README.md | 8 ++--- googletest/README.md | 72 ++++++++++++++++++++++---------------------- 3 files changed, 58 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index bd87183415..75514519b8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Google Test +# GoogleTest #### OSS Builds Status: @@ -19,19 +19,19 @@ is now available. * We are also planning to take a dependency on [Abseil](https://github.com/abseil/abseil-cpp). -## Welcome to **Google Test**, Google's C++ test framework! +## Welcome to **GoogleTest**, Google's C++ test framework! -This repository is a merger of the formerly separate Google Test and Google Mock +This repository is a merger of the formerly separate GoogleTest and GoogleMock projects. These were so closely related that it makes sense to maintain and release them together. ### Getting started: -The information for **Google Test** is available in the -[Google Test Primer](googletest/docs/primer.md) documentation. +The information for **GoogleTest** is available in the +[GoogleTest Primer](googletest/docs/primer.md) documentation. -**Google Mock** is an extension to Google Test for writing and using C++ mock -classes. See the separate [Google Mock documentation](googlemock/README.md). +**GoogleMock** is an extension to GoogleTest for writing and using C++ mock +classes. See the separate [GoogleMock documentation](googlemock/README.md). More detailed documentation for googletest is in its interior [googletest/README.md](googletest/README.md) file. @@ -51,7 +51,7 @@ More detailed documentation for googletest is in its interior ## Platforms -Google test has been used on a variety of platforms: +GoogleTest has been used on a variety of platforms: * Linux * Mac OS X @@ -62,9 +62,9 @@ Google test has been used on a variety of platforms: * Symbian * PlatformIO -## Who Is Using Google Test? +## Who Is Using GoogleTest? -In addition to many internal projects at Google, Google Test is also used by the +In addition to many internal projects at Google, GoogleTest is also used by the following notable projects: * The [Chromium projects](http://www.chromium.org/) (behind the Chrome browser @@ -80,13 +80,13 @@ following notable projects: automated test-runner and Graphical User Interface with powerful features for Windows and Linux platforms. -[Google Test UI](https://github.com/ospector/gtest-gbar) is test runner that +[GoogleTest UI](https://github.com/ospector/gtest-gbar) is test runner that runs your test binary, allows you to track its progress via a progress bar, and displays a list of test failures. Clicking on one shows failure text. Google Test UI is written in C#. [GTest TAP Listener](https://github.com/kinow/gtest-tap-listener) is an event -listener for Google Test that implements the +listener for GoogleTest that implements the [TAP protocol](https://en.wikipedia.org/wiki/Test_Anything_Protocol) for test result output. If your test runner understands TAP, you may find it useful. @@ -94,19 +94,19 @@ result output. If your test runner understands TAP, you may find it useful. runs tests from your binary in parallel to provide significant speed-up. [GoogleTest Adapter](https://marketplace.visualstudio.com/items?itemName=DavidSchuldenfrei.gtest-adapter) -is a VS Code extension allowing to view Google Tests in a tree view, and +is a VS Code extension allowing to view GoogleTest in a tree view, and run/debug your tests. [C++ TestMate](https://github.com/matepek/vscode-catch2-test-adapter) is a VS -Code extension allowing to view Google Test in a tree view, and run/debug your +Code extension allowing to view GoogleTest in a tree view, and run/debug your tests. [Cornichon](https://pypi.org/project/cornichon/) is a small Gherkin DSL parser -that generates stub code for Google Test. +that generates stub code for GoogleTest. ## Requirements -Google Test is designed to have fairly minimal requirements to build and use +GoogleTest is designed to have fairly minimal requirements to build and use with your projects, but there are some. If you notice any problems on your platform, please file an issue on the [GoogleTest GitHub Issue Tracker](https://github.com/google/googletest/issues). @@ -115,11 +115,11 @@ Patches for fixing them are welcome! ### Build Requirements -These are the base requirements to build and use Google Test from a source +These are the base requirements to build and use GoogleTest from a source package: * [Bazel](https://bazel.build/) or [CMake](https://cmake.org/). NOTE: Bazel is - the build system that googletest is using internally and tests against. + the build system that GoogleTest is using internally and tests against. CMake is community-supported. * a C++11-standard-compliant compiler diff --git a/googlemock/README.md b/googlemock/README.md index 11414f9ca3..82c0c57520 100644 --- a/googlemock/README.md +++ b/googlemock/README.md @@ -37,8 +37,8 @@ Details and examples can be found here: Please note that code under scripts/generator/ is from the [cppclean project](http://code.google.com/p/cppclean/) and under the Apache -License, which is different from Google Mock's license. +License, which is different from GoogleMock's license. -Google Mock is a part of -[Google Test C++ testing framework](http://github.com/google/googletest/) and a -subject to the same requirements. +GoogleMock is a part of +[GoogleTest C++ testing framework](http://github.com/google/googletest/) and a +subject to the same requirements. \ No newline at end of file diff --git a/googletest/README.md b/googletest/README.md index a5465cdc5c..805a3bd1b1 100644 --- a/googletest/README.md +++ b/googletest/README.md @@ -2,43 +2,43 @@ #### Setup -To build Google Test and your tests that use it, you need to tell your build +To build GoogleTest and your tests that use it, you need to tell your build system where to find its headers and source files. The exact way to do it depends on which build system you use, and is usually straightforward. ### Build with CMake -Google Test comes with a CMake build script +GoogleTest comes with a CMake build script ([CMakeLists.txt](https://github.com/google/googletest/blob/master/CMakeLists.txt)) that can be used on a wide range of platforms ("C" stands for cross-platform.). If you don't have CMake installed already, you can download it for free from . CMake works by generating native makefiles or build projects that can be used in -the compiler environment of your choice. You can either build Google Test as a +the compiler environment of your choice. You can either build GoogleTest as a standalone project or it can be incorporated into an existing CMake build for another project. #### Standalone CMake Project -When building Google Test as a standalone project, the typical workflow starts +When building GoogleTest as a standalone project, the typical workflow starts with git clone https://github.com/google/googletest.git -b release-1.10.0 cd googletest # Main directory of the cloned repository. mkdir build # Create a directory to hold the build output. cd build - cmake .. # Generate native build scripts for Google Test. + cmake .. # Generate native build scripts for GoogleTest. -The above command also includes Google Mock by default. And so, if you want -to build only Google Test, you should replace the last command +The above command also includes GoogleMock by default. And so, if you want +to build only GoogleTest, you should replace the last command with cmake .. -DBUILD_GMOCK=OFF If you are on a \*nix system, you should now see a Makefile in the current -directory. Just type `make` to build Google Test. And then you can simply -install Google Test if you are a system administrator. +directory. Just type `make` to build GoogleTest. And then you can simply +install GoogleTest if you are a system administrator. make sudo make install # Install in /usr/local/ by default @@ -51,32 +51,32 @@ On Mac OS X with Xcode installed, a `.xcodeproj` file will be generated. #### Incorporating Into An Existing CMake Project -If you want to use Google Test in a project which already uses CMake, +If you want to use GoogleTest in a project which already uses CMake, the easiest way is to get installed libraries and headers. -* Import Google Test by using `find_package` (or `pkg_check_modules`). +* Import GoogleTest by using `find_package` (or `pkg_check_modules`). For example, if `find_package(GTest CONFIG REQUIRED)` is succeed, you can use the libraries as `GTest::gtest`, `GTest::gmock`. -And a more robust and flexible approach is to build Google Test as part of that -project directly. This is done by making the Google Test source code available +And a more robust and flexible approach is to build GoogleTest as part of that +project directly. This is done by making the GoogleTest source code available to the main build and adding it using CMake's `add_subdirectory()` command. This has the significant advantage that the same compiler and linker settings -are used between Google Test and the rest of your project, so issues associated +are used between GoogleTest and the rest of your project, so issues associated with using incompatible libraries (eg debug/release), etc. are avoided. This is -particularly useful on Windows. Making Google Test's source code available to the +particularly useful on Windows. Making GoogleTest's source code available to the main build can be done a few different ways: -* Download the Google Test source code manually and place it at a known +* Download the GoogleTest source code manually and place it at a known location. This is the least flexible approach and can make it more difficult to use with continuous integration systems, etc. -* Embed the Google Test source code as a direct copy in the main project's +* Embed the GoogleTest source code as a direct copy in the main project's source tree. This is often the simplest approach, but is also the hardest to keep up to date. Some organizations may not permit this method. -* Add Google Test as a git submodule or equivalent. This may not always be +* Add GoogleTest as a git submodule or equivalent. This may not always be possible or appropriate. Git submodules, for example, have their own set of advantages and drawbacks. -* Use CMake to download Google Test as part of the build's configure step. This +* Use CMake to download GoogleTest as part of the build's configure step. This is just a little more complex, but doesn't have the limitations of the other methods. @@ -154,12 +154,12 @@ also contains a link to a fully generalized implementation of the technique. ##### Visual Studio Dynamic vs Static Runtimes By default, new Visual Studio projects link the C runtimes dynamically but -Google Test links them statically. This will generate an error that looks +GoogleTest links them statically. This will generate an error that looks something like the following: gtest.lib(gtest-all.obj) : error LNK2038: mismatch detected for 'RuntimeLibrary': value 'MTd_StaticDebug' doesn't match value 'MDd_DynamicDebug' in main.obj -Google Test already has a CMake option for this: `gtest_force_shared_crt` +GoogleTest already has a CMake option for this: `gtest_force_shared_crt` Enabling this option will make gtest link the runtimes dynamically too, and match the project in which it is included. @@ -167,17 +167,17 @@ match the project in which it is included. #### C++ Standard Version An environment that supports C++11 is required in order to successfully build -Google Test. One way to ensure this is to specify the standard in the top-level +GoogleTest. One way to ensure this is to specify the standard in the top-level project, for example by using the `set(CMAKE_CXX_STANDARD 11)` command. If this -is not feasible, for example in a C project using Google Test for validation, +is not feasible, for example in a C project using GoogleTest for validation, then it can be specified by adding it to the options for cmake via the `DCMAKE_CXX_FLAGS` option. -### Tweaking Google Test +### Tweaking GoogleTest -Google Test can be used in diverse environments. The default configuration may +GoogleTest can be used in diverse environments. The default configuration may not work (or may not work well) out of the box in some environments. However, -you can easily tweak Google Test by defining control macros on the compiler +you can easily tweak GoogleTest by defining control macros on the compiler command line. Generally, these macros are named like `GTEST_XYZ` and you define them to either 1 or 0 to enable or disable a certain feature. @@ -186,12 +186,12 @@ We list the most frequently used macros below. For a complete list, see file ### Multi-threaded Tests -Google Test is thread-safe where the pthread library is available. After +GoogleTest is thread-safe where the pthread library is available. After `#include "gtest/gtest.h"`, you can check the `GTEST_IS_THREADSAFE` macro to see whether this is the case (yes if the macro is `#defined` to 1, no if it's undefined.). -If Google Test doesn't correctly detect whether pthread is available in your +If GoogleTest doesn't correctly detect whether pthread is available in your environment, you can force it with -DGTEST_HAS_PTHREAD=1 @@ -200,7 +200,7 @@ or -DGTEST_HAS_PTHREAD=0 -When Google Test uses pthread, you may need to add flags to your compiler and/or +When GoogleTest uses pthread, you may need to add flags to your compiler and/or linker to select the pthread library, or you'll get link errors. If you use the CMake script, this is taken care of for you. If you use your own build script, you'll need to read your compiler and linker's manual to figure out what flags @@ -208,8 +208,8 @@ to add. ### As a Shared Library (DLL) -Google Test is compact, so most users can build and link it as a static library -for the simplicity. You can choose to use Google Test as a shared library (known +GoogleTest is compact, so most users can build and link it as a static library +for the simplicity. You can choose to use GoogleTest as a shared library (known as a DLL on Windows) if you prefer. To compile *gtest* as a shared library, add @@ -229,22 +229,22 @@ Note: while the above steps aren't technically necessary today when using some compilers (e.g. GCC), they may become necessary in the future, if we decide to improve the speed of loading the library (see for details). Therefore you are recommended -to always add the above flags when using Google Test as a shared library. -Otherwise a future release of Google Test may break your build script. +to always add the above flags when using GoogleTest as a shared library. +Otherwise a future release of GoogleTest may break your build script. ### Avoiding Macro Name Clashes In C++, macros don't obey namespaces. Therefore two libraries that both define a macro of the same name will clash if you `#include` both definitions. In case a -Google Test macro clashes with another library, you can force Google Test to +GoogleTest macro clashes with another library, you can force GoogleTest to rename its macro to avoid the conflict. -Specifically, if both Google Test and some other code define macro FOO, you can +Specifically, if both GoogleTest and some other code define macro FOO, you can add -DGTEST_DONT_DEFINE_FOO=1 -to the compiler flags to tell Google Test to change the macro's name from `FOO` +to the compiler flags to tell GoogleTest to change the macro's name from `FOO` to `GTEST_FOO`. Currently `FOO` can be `FAIL`, `SUCCEED`, or `TEST`. For example, with `-DGTEST_DONT_DEFINE_TEST=1`, you'll need to write