This document is to guide you through the steps to build and test ODataCpp.

Currently the following target platforms are supported:

• Windows 32-bit
• OS X 64-bit

1.Please install 'Git' on your system:

1. On Windows, please download and install 'Git for Windows' (http://msysgit.github.io/).

2. On OS X, please install 'Git' with your package manager. Take Homebrew for example:

brew install git

2.Get the source of ODataCpp from our GitHub:

git clone https://github.com/odata/odatacpp

1.Please ensure that you have Visual Studio 2012 installed.

2.ODataCpp depends on Casablanca (http://casablanca.codeplex.com) which is distributed as a NuGet package. Please restore this NuGet package before you open any solution:

cd odatacpp\msvc
.nuget\nuget.exe restore odatacpp_tests.sln

3.Open 'odatacpp_tests.sln' under 'odatacpp\msvc' with VS2012 and click 'Build Solution' in the 'BUILD' menu.

4.Built libraries are placed under 'odatacpp\output<Configuration>' where '' could be either 'Debug' or 'Release' according to your build configuration in VS2012.

1.Setup build environment for VS2012:

cd odatacpp
powershell
.\setup_ps_env_VS2012.ps1

If you receive an error message like 'running scripts is disabled on this system', please run PowerShell as administrator, type the following command, and then rerun the setup script above.

Set-ExecutionPolicy RemoteSigned

2.Here are some examples to invoke MSBuild:

1. Build Debug version of ODataCpp libraries in parallel.

msbuild /m

2. Build Release version of ODataCpp libraries.

msbuild /p:Configuration=Release

3. Rebuild Debug version of ODataCpp.

msbuild /t:Rebuild /p:Configuration=Debug

4. Clean build outputs.

msbuild /t:Clean

3.Built libraries are placed under the same folder of VS2012. Actually they are no different than the ones built by VS2012.

1.After you have successfully built the libraries, you can run our functional and end-to-end tests to check the basic functionality.

1. Test the Debug version of ODataCpp Libraries:

cd odatacpp\output\Debug
TestRunner.exe odata_functional_test.vs11d.dll odata_e2e_test.vs11d.dll

2. Test the Release version of ODataCpp Libraries:

cd odatacpp\output\Release
TestRunner.exe odata_functional_test.vs11.dll odata_e2e_test.vs11.dll

Don't worry about the failed tests as they are known issues and we will get them fixed in the future releases.

1.Please ensure that you have OS X later than 10.9, Xcode later than 5.0 and Xcode Command Line Tools installed.

2.Install the Homebrew package manager (http://brew.sh). Skip this step if you want to use your own package manager.

3.Install the required packages to build ODataCpp via Homebrew or your own package manager.

brew install cmake git boost libxml++ pkg-config

4.Clone (do not change the location below) and build the dependency library Casablanca (http://casablanca.codeplex.com).

cd odatacpp
mkdir lib
cd lib
git clone https://git01.codeplex.com/casablanca
cd casablanca
mkdir build.release
cd build.release
cmake ../Release -DCMAKE_BUILD_TYPE=Release
make -j 4

5.Return to the root folder of ODataCpp and generate 'Makefile' using CMake.

cd ../../..
cmake -DCMAKE_BUILD_TYPE=Debug # replace 'Debug' with 'Release' if needed
make -j 4

Ignore the possible warning CMP0042 issued by CMake.

6.Please find your built libraries under 'output'.

After successfully building the libraries, you can run the functional and end-to-end tests via the terminal.

cd odatacpp/output
./test_runner *tests*

Please ignore the failed tests as they are already known to us and will be fixed in the future releases.