Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: include information for local testing against the RealFileSystem #325

Merged
merged 2 commits into from
Jul 17, 2023
Merged

docs: include information for local testing against the RealFileSystem #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e9199b
doc: include information about constants for local testing against re…
vbreuss Jul 17, 2023
30e36f9
Update .gitignore
vbreuss Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Ignore the Directory.Build.props in the root directory so that
# the setting of specific constants can improve the developer experience
# without affecting the origin GIT repository:
# - `SKIP_TESTS_ON_REAL_FILESYSTEM`
# By setting this flag, all tests against the real file system are skipped when in DEBUG mode.
# - `INCLUDE_LONGRUNNING_TESTS_ALSO_IN_DEBUG_MODE`
# Per default, long-running tests against the real file system are skipped when in DEBUG mode. By setting this flag, these tests are run also in this mode.
# - `EXECUTE_EXAMPLE_TESTS`
# Tests in the example projects are only executed when this flag is set.
# without affecting the origin GIT repository.
# > https://github.com/Testably/Testably.Abstractions/blob/main/CONTRIBUTING.md#tests
/Directory.Build.props

# Set up Visual Studio to use WSL to execute unit tests in Ubuntu:
Expand Down
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,29 @@ In order to support this, static code analysis is performed using [SonarCloud](h

Additionally each push to the `main` branch checks the quality of the unit tests using [Stryker.NET](https://stryker-mutator.io/docs/stryker-net/introduction/).

## Tests
On the build system, unit tests are executed both against the `MockFileSystem` and the `RealFileSystem`. This ensures that the tests verify correct assumptions.
In order to simplify and speedup the development process, per default some tests are disabled in DEBUG mode. These can be enabled by adding a `Directory.Build.props` file in the root directory and set the corresponding constants:
- [`ENABLE_REALFILESYSTEMTESTS_IN_DEBUG`](https://github.com/Testably/Testably.Abstractions/blob/main/Tests/Helpers/Testably.Abstractions.Tests.SourceGenerator/ClassGenerators/FileSystemClassGenerator.cs#L59)
If set, the classes for executing tests against the real file system are created also in DEBUG mode.
- [`INCLUDE_LONGRUNNING_TESTS_ALSO_IN_DEBUG_MODE`](https://github.com/Testably/Testably.Abstractions/blob/main/Tests/Helpers/Testably.Abstractions.TestHelpers/Test.cs#L51)
In order to increase the test execution speed during development, long running tests are disabled in DEBUG mode.
When this constant is set, the corresponding tests are no longer skipped.
- [`SKIP_TESTS_ON_REAL_FILESYSTEM`](https://github.com/Testably/Testably.Abstractions/blob/main/Tests/Helpers/Testably.Abstractions.TestHelpers/Test.cs#L61)
In order to avoid unnecessary side-effects on development machines, tests against the real file system are not executed in DEBUG mode.
When this constant is set, this restriction no longer applies.

**Example:**
```xml
<Project>
<PropertyGroup>
<DefineConstants>$(DefineConstants);ENABLE_REALFILESYSTEMTESTS_IN_DEBUG</DefineConstants>
</PropertyGroup>
</Project>
```

*Note: This file is excluded in [`.gitignore`](https://github.com/Testably/Testably.Abstractions/blob/main/.gitignore) and remains local!*

## Versioning
This project uses [MinVer](https://github.com/adamralph/minver) for versioning.
Tags are automatically added during a release build. In order to trigger a release, create a release branch. After all tests are successful and the manual check is approved, that Tag is automatically applied and Nuget Packages are pushed to [nuget.org](https://www.nuget.org/packages/Testably.Abstractions).
Expand Down