Helps to SAVE the file before you commit debian_default_test
authorKrista 'DarthMama' Bennett <krista@pep.foundation>
Thu, 14 Nov 2019 18:07:04 +0100
branchdebian_default_test
changeset 417524bc4d8584a0
parent 4174 f0a92cd15836
child 4176 7f75fc75ae5d
Helps to SAVE the file before you commit
test/README.md
     1.1 --- a/test/README.md	Thu Nov 14 18:00:17 2019 +0100
     1.2 +++ b/test/README.md	Thu Nov 14 18:07:04 2019 +0100
     1.3 @@ -65,9 +65,16 @@
     1.4  
     1.5  ##### MacOS
     1.6  
     1.7 -I am totally guessing for now - this is a placeholder - that
     1.8 -macports gtest install will do the same. Will need to find the directories this
     1.9 -goes in. Guessing `/opt/local/src`.
    1.10 +  1. Install package `gtest` from Macports
    1.11 +  
    1.12 +  2. Macports will build the libraries for you.
    1.13 +  
    1.14 +  3. In the next major section ("Building the Test Suite"), under 
    1.15 +  "Makefile and local.conf", set `GTEST_SRC_DIR` to 
    1.16 +  `/opt/local/src/googletest` in `local.conf` (see instructions below)
    1.17 +  
    1.18 +  4. Make sure `/opt/local/lib` is in your library path when compiling and 
    1.19 +  linking the tests.
    1.20  
    1.21  #### Downloading and compiling the source yourself
    1.22  
    1.23 @@ -93,16 +100,14 @@
    1.24    ```
    1.25    
    1.26    5. In the lib directory of your current directory are located the
    1.27 -  library files you'll use. Copy or symlink them to the library location 
    1.28 -  of your choice (make sure this is a directory that can be seen during 
    1.29 -  the test build process - i.e. one that's in one of the library paths 
    1.30 +  library files you'll use (`lib/*.a`). Copy or symlink them to the library 
    1.31 +  location  of your choice (make sure this is a directory that can be seen 
    1.32 +  during the test build process - i.e. one that's in one of the library paths 
    1.33    used in building. Mine are located in `$HOME/lib`.
    1.34  
    1.35 -  6. See `Makefile` and `local.conf` under "Building the test suite" -
    1.36 -  In this scenario, I set GTEST_SRC_DIR googletest/googletest under the 
    1.37 -  directory I checked out googletest in (i.e. the absolute path of where 
    1.38 -  the `src` and `include` directories were above - for me, 
    1.39 -  `/Users/krista/googletest/googletest`).
    1.40 +  6. See `Makefile` and `local.conf` under "Building the test suite" below -
    1.41 +  In this scenario, I set `GTEST_SRC_DIR` as `<clone_path>/googletest/googletest` (i.e. the absolute path of where the `src` and `include` directories were 
    1.42 +  above - for me, `/Users/krista/googletest/googletest`).
    1.43    
    1.44  ### Installing `gtest-parallel`
    1.45  
    1.46 @@ -123,8 +128,10 @@
    1.47  
    1.48    * `GTEST_SRC_DIR`: This is the directory where you compiled googletest above
    1.49    (defaults to `/usr/src/gtest`)
    1.50 +  
    1.51    * `GTEST_INC_DIR`: This is where the include files for googletest are located
    1.52    (defaults to `$(GTEST_SRC_DIR)/include`)
    1.53 +  
    1.54    * `GTEST_PL`: This is the full path to the *python file* for `gtest_parallel`
    1.55    (default presumes you cloned it under `src` in your home directory, i.e. it is
    1.56    `$(HOME)/src/gtest-parallel/gtest_parallel.py`)
    1.57 @@ -140,6 +147,7 @@
    1.58  Do one of:
    1.59  
    1.60    1. `make test` OR
    1.61 +  
    1.62    2. `python3 <path to gtest-parallel.py> ./EngineTests`
    1.63  
    1.64  ### To run individual test suites, especially for debugging purposes