M2_HOMEenvironment variable to location of maven installation
JAVA_HOMEenvironment variable to java installation directory
protoc.exeexecutable in the windows path
%M2_HOME%/binto the windows path as well
For Building projects:
To build and run tests in Visual Studio on local machine:
-Trait:Environmentto filter out tests which are supposed to run on Yarn. If not filtered out, these tests will fail.
To build REEF.NET from command line, execute
To run .NET tests on local machine from command line, execute
TestRunner.proj already has a filter set up to exclude Yarn tests.
For Building DotNet projects:
We are in the process of converting the C# support to use dotnet core as well as support for Visual Studio 2017. As a result there are .DotNet.csproj files that sit beside the existing csproj files. To build the dotnet projects, you will need the .NET Core SDK installed on your machine as well as Visual Studio 2017.
Note: Building in Visual Studio 2017 is not yet supported. You will need to build at the command line using the .NET Core SDK tools (dotnet). However Visual Studio 2017 does support opening the DotNet solution. .NET Core applications are supported on both Windows and Linux, the projects will only build fully on Windows since they do target the .net45 framework.
The .NET Core SDK tools are located here:
Scroll down the page to access the latest builds of .NET Core SDK, download the Windows X64 installer.
At the time of writing the current version used is 2.0.0-preview1-005825. Any version that is equal or newer should also work.
To build from Visual Studio 2017:
This is not currently supported and you will need to build from the command line however VS2017 can be used to view the solution.
To open the project in VS2017, open the solution
To build from the command line, in the
reef\lang\cs path, type the following:
dotnet clean Org.Apache.REEF.DotNet.sln dotnet restore Org.Apache.REEF.DotNet.sln dotnet build Org.Apache.REEF.DotNet.sln
cleanwill clean any previously built binary
restorerestores nuget dependencies
buildbuilds the solution
To build nuget packages, type the following:
dotnet pack Org.Apache.REEF.DotNet.sln
This will build nuget packages for each project.
Projects will build out to
reef\bin\<AssemblyName> and will contain all the platforms that the project supports. Each project is in various stages as they are transitioning to dotnet core 2.0 - therefore they may only build .net45 and .net46 assemblies.
We use AppVeyor to run continuous integration for REEF .NET code (i.e. build code and run tests for all pull requests and commits to master branch).
It can be convenient to set up AppVeyor for your fork of REEF repository, for example, to reproduce a test failure which can't be reproduced locally or to get AppVeyor test run results earlier than the official ones.
To isolate a specific test or group of tests, you can modify
test_script section of
appveyor.yml. For example, to run only one test
test_script section as follows:
test_script: - cmd: cd .\lang\cs - cmd: .\.nuget\nuget.exe restore .\.nuget\packages.config -o .\packages - cmd: .\packages\xunit.runner.console.2.1.0\tools\xunit.console.exe .\bin\x64\Debug\Org.Apache.REEF.Tests\Org.Apache.REEF.Tests.dll -method Org.Apache.REEF.Tests.Functional.IMRU.IMRUCloseTaskTest.TestTaskCloseOnLocalRuntime
nuget restore is necessary to install
xunit.runner.console package, which by default is installed in