Skip to content
This repository

QuickFIX/n implements the FIX protocol on .NET.

This branch is 0 commits ahead and 0 commits behind master

Octocat-spinner-32 AcceptanceTest Merge branch 'master' of github.com:Daniel-Svensson/quickfixn into 16… October 07, 2013
Octocat-spinner-32 Examples Merge branch 'master' of github.com:Daniel-Svensson/quickfixn into 16… October 07, 2013
Octocat-spinner-32 QuickFIXn better doc comments on GetGroup its tests December 13, 2013
Octocat-spinner-32 UnitTests better doc comments on GetGroup its tests December 13, 2013
Octocat-spinner-32 config WIP: release script November 09, 2011
Octocat-spinner-32 generator (#175) correct some date fields to be generated/validated as DateOnly… October 03, 2013
Octocat-spinner-32 resources updated solution to include nunit June 20, 2009
Octocat-spinner-32 scripts correct script per new rubyzip gem interface December 11, 2013
Octocat-spinner-32 spec corrections/updates to FIX44 spec based on diff with QF/j version May 20, 2013
Octocat-spinner-32 tutorial Merge branch 'v1.5.0_maintenance' December 13, 2013
Octocat-spinner-32 web credit for #247 December 11, 2013
Octocat-spinner-32 .gitattributes Update gitattributes to corrupt certificates March 31, 2013
Octocat-spinner-32 .gitignore corrections to SessionSchedule.LastEndTime and tests February 05, 2013
Octocat-spinner-32 .slugignore change all occurrences of "QuickFIX.net" to "QuickFIXn", including fi… June 27, 2012
Octocat-spinner-32 Gemfile so long albino :( October 02, 2011
Octocat-spinner-32 Gemfile.lock lock file October 02, 2011
Octocat-spinner-32 LICENSE License file November 16, 2011
Octocat-spinner-32 NEXT_VERSION.md credit for #247 December 11, 2013
Octocat-spinner-32 QuickFIXn.sln converted to vs2010 September 07, 2012
Octocat-spinner-32 README.md update ruby version in README; add some comments to Session May 08, 2013
Octocat-spinner-32 RELEASE_NOTES.md forgot to give Daniel Svennson credit for the SSL fix December 11, 2013
Octocat-spinner-32 RELEASE_README.md minor November 09, 2011
Octocat-spinner-32 acceptance_test.bat do conversion to nunit format in jenkins instead of in this script January 22, 2013
Octocat-spinner-32 build.bat change all occurrences of "QuickFIX.net" to "QuickFIXn", including fi… June 27, 2012
Octocat-spinner-32 build.sh sh versions of bat scripts for mono (experimental) January 14, 2013
Octocat-spinner-32 config.ru we are using sinatra for website, here is the basic code October 02, 2011
Octocat-spinner-32 generate.bat buildbot has trouble running this command. It will call this script i… October 25, 2011
Octocat-spinner-32 package_release.bat change all occurrences of "QuickFIX.net" to "QuickFIXn", including fi… June 27, 2012
Octocat-spinner-32 unit_test.bat suppress error messages when files-to-be-deleted don't exist September 07, 2012
Octocat-spinner-32 unit_test.sh sh versions of bat scripts for mono (experimental) January 14, 2013
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 the following:

To build

  • Ruby (1.9.3 recommended) (used to generate message and field classes from the DataDictionary xml file)
  • Visual Studio 2010 or higher

To run tests

  • NUnit
  • xsltproc (can be gotten via cygwin, or by installing libxslt (which requires libxml2 and zlib)).
    • xsltproc is only used for pretty-formatting the test output. If you don't mind the error messages that appear because it's not found, you can ignore it. (We may get rid of this dependency.).

Code Generation

To regenerate the message and field class source from the Data Dictionaries, you need Ruby and the Nokogiri gem:

gem install nokogiri
generate.bat

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\v4.0.30319

to your PATH environment variable. (Note, this build tools dir does not mean that the project will build for .NET 4.0; these are merely the build tools that come with VS 2010.)

Unit Tests

To run the NUnit tests, run:

unit_test.bat

(This script expects nunit-console.exe to be on your PATH. You may have to append something like C:\Program Files\NUnit 2.6.1\bin to your PATH environment variable.)

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.6.1\bin\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 AcceptanceTest
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 and choose "Properties" from the menu
  3. Click "Debug" on the left hand nav bar
  4. Set "Command line arguments" to the relevant "cfg\at_XX.cfg" for your test
  5. Set the working directory to "[yourpath]\quickfixn\AcceptanceTest"
  6. Save the properties
  7. Right click the "AcceptanceTest" project, go to Debug -> Start New Instance
  8. In command terminal, go into "AcceptanceTest" directory
  9. Run: ruby Runner.rb 127.0.0.1 5001 definitions\server\fix42\YourTestName.def

Automated Build Server

We have an automated build server that builds and runs all unit and acceptance tests after code changes.

You can see the current build status here:

http://quickfixbuild.connamara.com/job/quickfix-n/

Website

The website is a small Ruby Sinatra application.

For development, install gems with bundler:

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
Something went wrong with that request. Please try again.