Skip to content

building-and-testing.md

Latest commit

 

History

History
103 lines (73 loc) · 4.75 KB

building-and-testing.md

File metadata and controls

103 lines (73 loc) · 4.75 KB

Building and Testing

Command Line

Prerequisites

Execution

NOTE: If the project is open in Visual Studio, its background restore may interfere with these commands. It is recommended to close all instances of Visual Studio that have this project open before executing.

To build the source, clone or download and unzip the repository. From the repository or distribution root, execute the build command from a command prompt and include the desired options from the build options table below:

Windows
> build [options]
Linux or macOS
./build [options]

NOTE: The build file will need to be given permission to run using the command chmod u+x build before the first execution.

Build Options

The following options are case-insensitive. Each option has both a short form indicated by a single - and a long form indicated by --. The options that require a value must be followed by a space and then the value, similar to running the dotnet CLI.

Short Long Description Example
‑config ‑‑configuration The build configuration ("Release" or "Debug"). build ‑‑configuration Debug
‑t ‑‑test Runs the tests after building. This option does not require a value. build ‑t

For example the following command creates a Release build with NuGet package with a version generated using the nbgv tool and will also run the tests for every target framework.

Windows
> build --configuration Release --test
Linux or macOS
./build --configuration Release --test

NuGet packages are output by the build to the /_artifacts/NuGetPackages/ directory. Test results (if applicable) are output to the /_artifacts/TestResults/ directory.

You can setup Visual Studio to read the NuGet packages like any NuGet feed by following these steps:

  1. In Visual Studio, right-click the solution in Solution Explorer, and choose "Manage NuGet Packages for Solution"
  2. Click the gear icon next to the Package sources dropdown.
  3. Click the + icon (for add)
  4. Give the source a name such as spatial4n Local Packages
  5. Click the ... button next to the Source field, and choose the /src/_artifacts/NuGetPackages folder on your local system.
  6. Click Ok

Then all you need to do is choose the spatial4n Local Packages feed from the dropdown (in the NuGet Package Manager) and you can search for, install, and update the NuGet packages just as you can with any Internet-based feed.

Visual Studio

Prerequisites

NOTE: Visual Studio 2022 is only supported for building and testing .NET Core and .NET Standard 2.1 due to false errors caused by lack of LSP language support for C# 14.0. It is recommended to use Visual Studio 2026, which fully supports our build. If using Visual Studio 2022, we recommend running dotnet build on the command line prior to submitting PRs to ensure builds succeed on .NET Framework and .NET Standard 2.0.

Execution

  1. Open J2N.sln in Visual Studio.
  2. Build a project or the entire solution, and wait for Visual Studio to discover the tests.
  3. Run or debug the tests in Test Explorer, optionally using the desired filters.

TIP: When running tests in Visual Studio, set the default processor architecture to either 32 or 64 bit depending on your preference.