Introduction

Ignite.NET is built on top of Ignite and provides native APIs for .NET developers.

• Documentation: https://apacheignite-net.readme.io/docs
• Source code is in modules/platforms/dotnet folder

Requirements

• Oracle JDK 7+
• .NET Framework 4.0+
• PowerShell 3.0+
• Visual Studio 2010+
• Apache Maven

Getting Started With Modern Tooling

Even though Ignite.NET can be developed and run on VS2010 and JDK7, it is more common to use latest Visual Studio and JDK.

Assuming that we are on up-to-date Windows x64 installation:

Install software

1. Install Java JDK (not JRE): http://www.oracle.com/technetwork/java/javase/downloads/index.html
2. Set JAVA_HOME environment variable to point to the JDK installation directory (something like "C:\Program Files\Java\jdk1.8.0_111")
3. Download and unzip Apache Maven to some folder: https://maven.apache.org/download.cgi
4. Add Maven bin folder to PATH environment variable (example: "c:\Programs\Maven\apache-maven-3.3.9\bin\")
5. Install Visual Studio 2017 (free Community Edition will do). Make sure to include C++ stuff.

Get source code

• git clone https://git-wip-us.apache.org/repos/asf/ignite

For more details on working with GitHub forks and pull requests see How to Contribute#GitProcess

Build Java sources

In root source folder execute "mvn clean package -DskipTests -Dmaven.javadoc.skip=true -U -Plgpl,-examples,-release,-scala" command.

When doing pure .NET development, you only need to run this every time you update your branch from master.

Build .NET sources

• Open modules\platforms\dotnet\Apache.Ignite.sln in Visual Studio
• Confirm a proposal to upgrade C++ compilers and libraries (you can also do this later by right-clicking the solution in Solution Explorer and clicking "Retarget solution")
• Switch to x64 platform (you don't need AnyCPU for development - it is slower to build and requires x86 JDK installation)
• Build solution

Upgrading C++ compilers and libraries causes two vcxproj files to be modified. You should not commit them, but they get in the way. To fix this, execute the following PowerShell command in the root folder:

• ls *.vcxproj -Recurse | % {git update-index --assume-unchanged $_.FullName}

This command can be reverted by:

• ls *.vcxproj -Recurse | % {git update-index --no-assume-unchanged $_.FullName}

Running Unit Tests

Ignite.NET uses NUnit for unit tests. You can run them with ReSharper right away, or with NUnit Test Adapter for Visual Studio.

• Make sure to disable assembly shadow copy in unit test runner settings

Running Tests On TeamCity

• Ignite uses TeamCity-based continuous integration: http://ci.ignite.apache.org/
• If you do .NET-only development, you are interested only in test suites having "Platform.NET" in the name
• Create an account to be able to start new runs
• .NET NuGet suite can be used to produce release NuGet binaries (see Artifacts tab of a finished build)

Coding Guidelines

• Ignite.NET follows standard MSDN Framework Design Guidelines in regards to naming, project and namespace structure, type design, etc.
• Private fields should be _underscoreCamelCase (this is not covered by guidelines above)
• Non-private instance fields are not allowed
• Line length should not exceed 120 characters (use Editor Guidelines extension https://marketplace.visualstudio.com/items?itemName=PaulHarrington.EditorGuidelines)

Coding guidelines compliance is checked by .NET Inspections TeamCity suite (see below).

Static Code Analysis

Three code analysis tools are integrated with Ignite.NET project:

• NDepend: see modules/platforms/dotnet/Apache.Ignite.ndproj. We have 6 build machine licenses (see https://svn.apache.org/repos/private/pmc/ignite/licenses/NDepend.txt, PMC-only access), NDepend is installed on all Windows TeamCity agents and runs as part of .NET Inspections. Report can be seen right there on TeamCity build result page, on NDepend tab.
• ReSharper inspections (come integrated with TeamCity). There are two R# project files in modules/platforms/dotnet/, Apache.Ignite.sln.DotSettings and Apache.Ignite.sln.TeamCity.DotSettings. TeamCity file has less rules enabled, but all of them must pass. Another one is used when you open solution in Visual Studio.
• Microsoft FxCop. Since we officially support Visual Studio 2010, standalone FxCop 1.36 is used, see Apache.Ignite.FxCop in modules/platforms/dotnet/. Later Visual Studio versions have this functionality integrated, this can be enabled with "Run code analysis on build" in project settings.

All these tools assume that project has been built in Debug Any CPU mode.

Building Release Binaries

Solution Platforms Explained

Apache.Ignite.Core.dll assembly includes unmanaged "ignite.jni.dll" as a resource.

AnyCPU build includes two dlls, x64 and x86 (that's why the build takes longer). AnyCPU build requires both x86 and x64 JDK installed.

ignite.jni.dll requires corresponding (x64 or x86) JDK at compile time and JRE at run time.

Ignite.NET loads one of the dlls according to current execution mode (see UnmanagedUtils initializer), and attempts to resolve corresponding JRE using Windows Registry, if the JAVA_HOME variable is not set (IgniteUtils.GetJvmDllPaths).

x64 and x86 solution configurations rely on normal build process where C++ projects are built as dependencies. AnyCPU build, however, uses "build-common.ps1" PowerShell script as a pre-build event of Apache.Ignite.Core project to build C++ parts as both x64 and x86.

Build Script

There is a build.ps1 file in modules/platforms/dotnet folder (and build.bat that just calls build.ps1 so you don't have to run PowerShell manually).

This build script performs end to end build, including Java, .NET and NuGet. NuGet can be built only in AnyCPU mode (which requires both x64 and x86 JDK installed).

To build everything and produce release binaries (in bin folder) and NuGet packages (in nupkg folder), run the script without parameters.

Run `Get-Help .\build.ps1 -detailed` PowerShell command to view detailed build script documentation.