Now works for self-downloaded and Macports distributions. README.md updated. Will merge this into default. debian_default_test
authorKrista 'DarthMama' Bennett <krista@pep.foundation>
Thu, 14 Nov 2019 18:00:17 +0100
branchdebian_default_test
changeset 4174f0a92cd15836
parent 4173 c7efa2a98f2a
child 4175 24bc4d8584a0
Now works for self-downloaded and Macports distributions. README.md updated. Will merge this into default.
test/README.md
     1.1 --- a/test/README.md	Thu Nov 14 16:59:12 2019 +0100
     1.2 +++ b/test/README.md	Thu Nov 14 18:00:17 2019 +0100
     1.3 @@ -71,16 +71,39 @@
     1.4  
     1.5  #### Downloading and compiling the source yourself
     1.6  
     1.7 -For now, don't.
     1.8 +  1. Get the source, Fred. (Luke is tired of the source, I hear.)
     1.9 +  ```
    1.10 +  git clone https://github.com/google/googletest.git
    1.11 +  ```
    1.12 +  
    1.13 +  2. Switch into the source directory and find the directory 
    1.14 +  containing the `src` and `include` directories. Mark this directory
    1.15 +  for later. (For me, this is `./googletest/googletest`)
    1.16 +  
    1.17 +  3. Edit `CMakeLists.txt` here to contain the following line at the top:
    1.18 +  ```
    1.19 +  set (CMAKE_CXX_STANDARD 11)
    1.20 +  ```
    1.21 +  (If you don't, it won't compile, and I will shake my fist at you.)
    1.22 +  
    1.23 +  4. Execute, in this directory:
    1.24 +  ```
    1.25 +  cmake CMakeLists.txt
    1.26 +  make
    1.27 +  ```
    1.28 +  
    1.29 +  5. In the lib directory of your current directory are located the
    1.30 +  library files you'll use. Copy or symlink them to the library location 
    1.31 +  of your choice (make sure this is a directory that can be seen during 
    1.32 +  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 -Or do, and document it for me.
    1.36 -
    1.37 -If you were using the git repo and it was working before, please follow the
    1.38 -instructions above for Debian/Ubuntu, only with your source repository in mind
    1.39 -instead of `/usr/src`, and pay attention to the variables you'll need to set in
    1.40 -`local.conf` for the Makefile - they are different from before.
    1.41 -It should work, but I haven't tested it yet.
    1.42 -
    1.43 +  6. See `Makefile` and `local.conf` under "Building the test suite" -
    1.44 +  In this scenario, I set GTEST_SRC_DIR googletest/googletest under the 
    1.45 +  directory I checked out googletest in (i.e. the absolute path of where 
    1.46 +  the `src` and `include` directories were above - for me, 
    1.47 +  `/Users/krista/googletest/googletest`).
    1.48 +  
    1.49  ### Installing `gtest-parallel`
    1.50  
    1.51  Pick a source directory and put your `gtest-parallel` source there
    1.52 @@ -98,9 +121,9 @@
    1.53  `local.conf` in the top-level engine directory as needed. The relevant variables
    1.54  are:
    1.55  
    1.56 -  * `GTEST_SRC_DIR`: This is the directory where the gtest source you compiled
    1.57 -  above is located (defaults to `/usr/src/gtest`)
    1.58 -  * `GTEST_INC_DIR`: This is where the include files for gtest are located
    1.59 +  * `GTEST_SRC_DIR`: This is the directory where you compiled googletest above
    1.60 +  (defaults to `/usr/src/gtest`)
    1.61 +  * `GTEST_INC_DIR`: This is where the include files for googletest are located
    1.62    (defaults to `$(GTEST_SRC_DIR)/include`)
    1.63    * `GTEST_PL`: This is the full path to the *python file* for `gtest_parallel`
    1.64    (default presumes you cloned it under `src` in your home directory, i.e. it is
    1.65 @@ -168,3 +191,17 @@
    1.66  # Creating new tests
    1.67  
    1.68  Script next on the agenda...
    1.69 +
    1.70 +# Known Problems
    1.71 +
    1.72 +There are 5 (maybe 6) tests that currently fail which are the function of
    1.73 +broken tests, not the engine. They are on the agenda to fix (expired
    1.74 +keys inside imported mails, etc). You'll see something like this - please
    1.75 +ignore for this particular second in time:
    1.76 +```
    1.77 +    170 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_no_es
    1.78 +     170 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_revoked_sign_no_alt
    1.79 +     253 ms: ./EngineTests SubkeyRatingEvalTest.check_subkey_rating_eval_weak_e_strong_ecc_se
    1.80 +    1189 ms: ./EngineTests KeyResetMessageTest.check_non_reset_receive_revoked
    1.81 +    1376 ms: ./EngineTests KeyResetMessageTest.check_reset_receive_revoked
    1.82 +```