- Overview
- Guides
- Concepts
- Considerations And Constraints
- Absolute File References
- Assembly Colocation Assumptions
- Concurrent Use Of Test Resources
- Cross Application Domain Testing
- Heavily Executed Code Under Test
- Implicit File Dependencies
- Multi Threaded Tests
- Netstandard Test Projects
- Project Atomicity
- Project Build Platform And Configuration
- Rdi Data Point Location
- Test Atomicity
- Unique Test Names
- Using NCrunch With Source Control
- Reference
- Global Configuration
- Overview
- Auto Adjust Clashing Marker Colours
- Build Log Verbosity
- Build Process Memory Limit
- Capabilities Of This Computer
- Coverage Marker Style
- Cpu Cores Assigned To NCrunch Or Ide
- Custom Environment Variables
- Disable Global Hotkey
- Engine Hosting Strategy
- Fast Lane Threads
- Fast Lane Threshold
- Grid Maximum Reconnection Attempts
- Grid Reconnection Delay
- Impact Detection Mode
- Listening Port
- Log To Output Window
- Logging Verbosity
- Marker Colours
- Max Failing Test Trace Log Size
- Max Number Of Processing Threads
- Max Passing Test Trace Log Size
- Max Test Runners To Pool
- NCrunch Tool Window Colors
- Node Id (Name)
- Password
- Performance Aggregation Type
- Performance Display Sensitivity
- Pipeline Optimisation Priority
- Rdi Storage Settings
- Sliding Build Delay
- Snapshot Storage Directory
- Solution Storage Data Limit
- Spinner Colours
- Terminate Test Runners On Complete
- Test Process Memory Limit
- Tests To Execute On This Machine
- Text Output Font
- Workspace Base Path
- Solution Configuration
- Overview
- Additional Files For Grid Processing
- Additional Files To Include
- Allow Parallel Test Execution
- Allow Tests In Parallel With Themselves
- Infer Project References Using Assembly
- Instrumentation Mode
- NCrunch Cache Storage Path
- Only Consider Tests Outofdate If Impacted
- Project Config File Storage Path
- Show Coverage For Tests
- Show Metrics For Tests
- Tests To Execute Automatically
- Project Configuration
- Overview
- Additional Files To Include
- Allow Dynamic Code Contract Checks
- Allow Static Code Contract Checks
- Analyse Line Execution Times
- Autodetect Nuget Build Dependencies
- Build Priority
- Build Process Cpu Architecture
- Build Sdk
- Collect Control Flow During Execution
- Consider Inconclusive Tests As Passing
- Copied Project Dependencies
- Copy Referenced Assemblies To Workspace
- Custom Build Properties
- Data Storage File Size
- Default Test Timeout
- Detect Stack Overflow
- Enable Rdi
- Files Excluded From Auto Build
- Framework Utilisation Types
- Ignore This Component Completely
- Implicit Project Dependencies
- Include Static References In Workspace
- Instrument Output Assembly
- Method Data Limit
- Ms Test Thread Apartment State
- Preload Assembly References
- Prevent Signing Of Assembly
- Proxy Process File Path
- Rdi Cache Size
- Required Capabilities
- Restrict Tostring Usage
- Run Pre Or Post Build Events
- String Length Limit
- Track File Dependencies
- Use Build Configuration
- Use Build Platform
- Use Cpu Architecture
- Runtime Framework
- Overview
- Atomic Attribute
- Category Attribute
- Collect Control Flow Attribute
- Distribute By Capabilities
- Duplicate By Dimensions
- Enable Rdi Attribute
- Environment Class
- Exclusively Uses Attribute
- Inclusively Uses Attribute
- Isolated Attribute
- Method Data Limit Attribute
- Requires Capability Attribute
- Restrict Tostring Attribute
- Serial Attribute
- String Length Limit Attribute
- Timeout Attribute
- Uses Threads Attribute
- Global Configuration
- Troubleshooting
- Tools
- Keyboard Shortcuts
- Manual Installation Instructions
Using NCrunch With Source Control
NCrunch has been designed with consideration for teams that want to share settings via source control systems.
For this reason, the main areas of configuration (global, solution and project) are separated into different files that are stored throughout the solution directory.
NCrunch stores data in the following files:
| File | Stored At | Contains |
|---|---|---|
| globalconfig.crunch.v3.xml | AppData\Roaming\NCrunch | Global settings specific to the currently logged in user |
| _NCrunch_SOLUTION\*.* | Solution Directory | Cached data such as test results and code coverage information |
| SOLUTION.v3.ncrunchsolution.user | Solution Directory | User preferences specific to the solution, such as column/filter arrangements within tool windows and the currently selected engine mode |
| PROJECT.v3.ncrunchproject.user | Project Directories | Project-specific configuration settings and ignored tests list (user-specific) |
| nCrunchTemp_* | Project Directories | Temporary generated files used when NCrunch is loading projects. Under normal circumstances, these are automatically removed and should rarely be seen. Otherwise, they can usually be safely deleted |
| SOLUTION.v3.ncrunchsolution | Solution Directory | Solution-specific configuration settings, metrics exclusion list, engine mode settings (to be shared with team) |
| PROJECT.v3.ncrunchproject | Project Directories | Project-specific configuration settings and ignored tests list (to be shared with team) |
It's recommended that the last two files listed in the above table (.v3.ncrunchsolution and .v3.ncrunchproject) be stored inside a source control system to be shared with team members. These files contain settings that are critical to being able to build projects and run tests, and as such they will be needed by anyone seeking to use NCrunch with the solution. Because these two files are named according to the NCrunch version, they can exist side-by-side with their equivalents for other NCrunch versions. This means it is possible for a solution to be shared by team members using different versions of NCrunch.
The remaining files should be placed on an exclusion list and left out of the source control system. These files contain user preference information and cached data that is not ideal for sharing within a team.
NCrunch settings files without a '.v3' in them are not used by the latest version of NCrunch and can be safely removed.
