Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
QuickFIX/n implements the FIX protocol on .NET.
C# Ruby

This branch is 1 commit ahead, 535 commits behind connamara:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
AcceptanceTest
Examples
QuickFIX.NET
UnitTests
config
generator
resources/nunit
scripts
spec/fix
tutorial
web
.gitignore
.slugignore
Gemfile
Gemfile.lock
LICENSE
NEXT_VERSION.md
QuickFIX.NET.sln
README.md
RELEASE_NOTES.md
RELEASE_README.md
acceptance_test.bat
build.bat
config.ru
generate.bat
package_release.bat
unit_test.bat

README.md

QuickFIX/N

For tutorials on how to use QuickFIX/n, see the tutorial folder at the root of this project or visit the website.

This README is about setting up your system to do QuickFIX/n development.

System Setup

This project requires MSBuild, NUnit, Ruby (1.9.2), and xsltproc.

You can get xsltproc via cygwin, or by installing libxslt (which requires libxml2 and zlib).

You can get Ruby from rubyinstall.org/downloads

Code Generation

To generate the code from Data Dictionaries, you need Ruby/JRuby (http://jruby.org/download) and the Nokogiri gem:

gem install nokogiri
ruby generator/generate.rb

Build

To build the project, run:

build.bat

You can also override the default target, configuration, and .NET framework version by giving command line arguments:

build.bat Rebuild Release v3.5

The build.bat script expects MSBuild.exe to be on your PATH. If you run it from a Visual Studio cmd shell, this should not be a problem. However, if you run it from some other shell (e.g. cygwin), you may need to append something like:

C:\WINDOWS\Microsoft.NET\Framework\v3.5

to your PATH environment variable.

Unit Tests

To run the NUnit tests, run:

unit_test.bat

An HTML report of the test results will then be available here:

UnitTests\bin\Release\UnitTests.html

To run a Unit Test in the debugger (not sure if it works in VS Express):

  1. Right-click UnitTests project, click 'Properties'
  2. Go to Debug tab
  3. Change Start Action to 'Start external program: C:\Program Files\NUnit-2.5.9.10348\bin\net-2.0\nunit.exe' (change the path to what is appropriate for your system)
  4. Set your 'Command line arguments' to 'C:\dev\quickfixn\UnitTests\bin\Debug\UnitTests.dll' (change the path to what is appropriate for your system)
  5. Set your 'Working directory' to 'C:\dev\quickfixn\UnitTests\bin\Debug\' (change the path to what is appropriate for your system)
  6. Open NUnit in debugger as follows: Right-click UnitTests, choose Debug->Start New Instance
  7. NUnit GUI will open and VS will be in debugger mode. You can choose and run tests. If you recompile, you may need to close and relaunch NUnit.

Acceptance Tests

To run the full suite of acceptance tests:

acceptance_test.bat

An HTML report of the test results will then be available here:

AcceptanceTests\AcceptanceTests.html

To run one particular acceptance test, e.g. fix42\14e_IncorrectEnumValue.def:

cd AcceptanceTests
runat.bat release 5003 definitions\server\fix42\14e_IncorrectEnumValue.def cfg\at_42.cfg

(See acceptance_test.bat for the proper port numbers and config files to use in the above command.)

The test results will then be available in AcceptanceTests\TestResults.xml and debug information will be available in the AcceptanceTests\log directory.

To run a test with the debugger,

  1. Open the solution file in Visual Studio
  2. Right click on "AcceptanceTest" project
  3. Open the "properties" tab
  4. Click "Debug" on the left hand nav bar
  5. Set "Command line arguments" to "cfg\at.cfg"
  6. Set the working folder to "... AcceptanceTest"
  7. Save the properties
  8. Right click the "AcceptanceTest" project, go to Debug -> Start New Instance
  9. In command terminal, go into "AcceptanceTest" directory
  10. Run: ruby Runner.rb 127.0.0.1 5001 definitions\server\fix42\YourTestName.def

Website

The website is a small Ruby Sinatra application.

For development, you should install Ruby 1.9.2 and the bundler gem then bundle:

gem install bundler
bundle

Upon installing the gems, you can run this in the top directory to start the website:

thin start

thin automatically picks up the Rackfile config.ru in the top directory.

Website specific files live in /web.

The website also serves tutorial files from the /tutorial directory

Markdown should be used for all tutorial files whenever possible, so that viewers of the source can easily read plain text documentation.

For development purposes, you can install the shotgun web server; this will re-load the website on every request. To start the website with shotgun, simply run shotgun at the top directory:

shotgun -p 3002

Contributing to QuickFIX/n

If you come across any issues, please tell us. If you report a bug and don't include a fix, please include a failing test.

Pull requests are always appreciated. When creating a new pull request:

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
Something went wrong with that request. Please try again.