gtests/README.md

   1 Glslang Tests based on the Google Test Framework
   2 ================================================
   3
   4 This directory contains [Google Test][gtest] based test fixture and test
   5 cases for glslang.
   6
   7 Apart from typical unit tests, necessary utility methods are added into
   8 the [`GlslangTests`](TestFixture.h) fixture to provide the ability to do
   9 file-based integration tests. Various `*.FromFile.cpp` files lists names
  10 of files containing input shader code in the `Test/` directory. Utility
  11 methods will load the input shader source, compile them, and compare with
  12 the corresponding expected output in the `Test/baseResults/` directory.
  13
  14 How to run the tests
  15 --------------------
  16
  17 Please make sure you have a copy of [Google Test][gtest] checked out under
  18 the `External` directory before building. After building, just run the
  19 `ctest` command or the `gtests/glslangtests` binary in your build directory.
  20
  21 The `gtests/glslangtests` binary also provides an `--update-mode` command
  22 line option, which, if supplied, will overwrite the golden files under
  23 the `Test/baseResults/` directory with real output from that invocation.
  24 This serves as an easy way to update golden files.
  25
  26 [gtest]: https://github.com/google/googletest