Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmsv/xunit-to-nunit
Converts C# XUnit tests to NUnit tests
https://github.com/jmsv/xunit-to-nunit
c-sharp converter dotnet hacktoberfest nunit parser unit-testing xunit
Last synced: 26 days ago
JSON representation
Converts C# XUnit tests to NUnit tests
- Host: GitHub
- URL: https://github.com/jmsv/xunit-to-nunit
- Owner: jmsv
- License: mit
- Created: 2017-06-16T10:18:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-11-01T00:27:03.000Z (about 2 years ago)
- Last Synced: 2024-09-26T21:56:24.712Z (about 1 month ago)
- Topics: c-sharp, converter, dotnet, hacktoberfest, nunit, parser, unit-testing, xunit
- Language: C#
- Homepage: https://jmsv.github.io/xunit-to-nunit
- Size: 160 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xunit-to-nunit
[](https://badge.fury.io/js/xunit-to-nunit)
[](https://travis-ci.org/jmsv/xunit-to-nunit)
[](https://www.versioneye.com/user/projects/59819587368b080078e5cabc?child=summary)
[](https://nodei.co/npm/xunit-to-nunit/)
Converts C# XUnit tests to NUnit tests.
_Disclaimer: Far from perfect - something I used as a quick hack to convert loads of large tests_
## Links
- Converter app: [jmsv.github.io/xunit-to-nunit](https://jmsv.github.io/xunit-to-nunit)
- Node module: [npmjs.com/package/xunit-to-nunit](https://www.npmjs.com/package/xunit-to-nunit)
## :package: Installation
```bash
npm install xunit-to-nunit
```
## Usage
### Require
```javascript
var x2n = require('xunit-to-nunit')
```
### Convert test from string
```javascript
var nunitTest = x2n.convertCode(xunitTest)
```
### Convert test from file
```javascript
x2n.convertFile('xunit-source-path.cs', 'nunit-destination-path.cs')
```
### Convert tests from directory
```javascript
x2n.convertFiles('xunit/source/directory', 'nunit/destination/directory')
```
This function calls `convertFile` for all files in the source directory.
#### Options
`convertFiles` has a third (optional) parameter: `options`. This should be a dictionary value, containing all or any of the following parameters:
##### :wrench: recursive (default: `false`)
Set to `true`, this parameter will convert tests in all subdirectories including those at the source root. Directory structure is maintained at the conversion destination.
##### :wrench: verbose (default: `true`)
When `true`, the module logs an info message to the terminal when a file is converted. When a file conversion fails, a error log message is displayed regardless of the value of `verbose`.
For example,
```javascript
var options = {
recursive: true,
verbose: false
}
x2n.convertFiles('xunit/source/directory', 'nunit/destination/directory', options)
```
#### Writing converted tests to source directory
When _source = destination_, '`_NUnit`' is appended to the filename. For example, where _destination = `dir`_, `dir/SomeTests.cs` is converted and the result is written to `dir/SomeTests_NUnit.cs`.
This behaviour can be changed with the following parameters:
##### :wrench: append (default: `'_NUnit'`)
String to be appended to filenames when writing destination files to the source directory.
##### :wrench: overwrite (default: `false`)
If _`overwrite` = true_, `append` is ignored, and source files are overwritten at destination.
For example,
```javascript
// Append destination filenames with `append` text
var options = {
append: '_Test',
overwrite: false // `overwrite` is false by default
}
// or, overwrite source files
var options = {
overwrite: true
}
x2n.convertFiles('xunit/source/directory', 'nunit/destination/directory', options)
```
## Contributing
Feel free to add things / suggest things to be added by either [opening an issue](https://github.com/jmsv/xunit-to-nunit/issues) or by submitting a pull request.
## References
- https://xunit.github.io/docs/comparisons.html