Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikestockdale committed Nov 18, 2016
1 parent 267f163 commit 1957a1b
Show file tree
Hide file tree
Showing 171 changed files with 12,434 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/DbFit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- fitSharp
Copyright © Syterra Software Inc. All rights reserved.
The use and distribution terms for this software are covered by the Common Public License 1.0 (http://opensource.org/licenses/cpl.php)
which can be found in the file license.txt at the root of this distribution. By using this software in any fashion, you are agreeing
to be bound by the terms of this license. You must not remove this notice, or any other, from this software. -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link href="fitsharp1.css" type="text/css" rel="stylesheet">
<link href="fit.css" type="text/css" rel="stylesheet">
<title>Db Fit</title>
</head>
<body>
<div class="topbar"><a href="FitSharp.html" class="siteid"><i>fit</i>Sharp</a></div>
<div class="pagename">Db Fit</div>
<div class="content"><a class="externallink" href="http://dbfit.github.io/dbfit/docs/">DbFit</a> is a set of fixtures which enables <a href="Fit.html">Fit</a> tests to execute directly against a database.<br>
<br>
A .NET version is included with <span style="font-family:verdana,sans-serif"><i>fit</i>Sharp</span>. Recently, development has been restarted on the Java version so it may contaiin new features that are not in the .NET version.<br>
<br>
We can use DbFit by including the following in a <a href="FitSharp/SuiteConfigurationFile.html">Suite Configuration File</a>. <pre class="code">&lt;suiteConfig>

&lt;ApplicationUnderTest>
&lt;addNamespace>dbfit.fixture&lt;/addNamespace>
&lt;addAssembly>C:\apps\fitSharp\dbfit.dll&lt;/addAssembly>

&lt!-- choose one or more of the following -->
&lt;addAssembly>C:\apps\fitSharp\dbfit.sqlserver.dll&lt;/addAssembly>
&lt;addAssembly>C:\apps\fitSharp\dbfit.mysql.dll&lt;/addAssembly>
&lt;addAssembly>C:\apps\fitSharp\dbfit.oracle.dll&lt;/addAssembly>
&lt;addAssembly>C:\apps\fitSharp\dbfit.sybase.dll&lt;/addAssembly>

&lt;/ApplicationUnderTest>

&lt;/suiteConfig>
</pre>To open a database connection using the connection strings in the .NET application configuration file, we can use:<br>
<pre class="code">| connect using config | myConnectionName | </pre><br>
</div>
<div style="width:100%;text-align:right">
<span class="footer">&copy; Copyright <a href="http://www.syterra.com">Syterra Software Inc.</a> All rights reserved.</span>
</div>

</body>
</html>
26 changes: 26 additions & 0 deletions docs/Fit.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- fitSharp
Copyright © Syterra Software Inc. All rights reserved.
The use and distribution terms for this software are covered by the Common Public License 1.0 (http://opensource.org/licenses/cpl.php)
which can be found in the file license.txt at the root of this distribution. By using this software in any fashion, you are agreeing
to be bound by the terms of this license. You must not remove this notice, or any other, from this software. -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link href="fitsharp1.css" type="text/css" rel="stylesheet">
<link href="fit.css" type="text/css" rel="stylesheet">
<title>Fit</title>
</head>
<body>
<div class="topbar"><a href="FitSharp.html" class="siteid"><i>fit</i>Sharp</a></div>
<div class="pagename">Fit</div>
<div class="content"><span style="font-family:verdana,sans-serif"><i>fit</i>Sharp</span> includes a .NET implementation of the Framework for Integrated Test (<a class="externallink" href="http://fit.c2.com">Fit</a>) tool, including a .NET version of <a class="externallink" href="http://sourceforge.net/projects/fitlibrary">FitLibrary</a>. You can use it to test .NET applications with story tests stored in the <a class="externallink" href="http://www.fitnesse.org">FitNesse</a> wiki or in plain old HTML files.<br>
<br>
The <span style="font-family:verdana,sans-serif"><i>fit</i>Sharp</span> Fit implementation is based on the Fitnesse.NET code base, but contains some <a href="Fit/BreakingChanges.html">Breaking Changes</a> made to clean up historical inconsistencies and provide a platform for new features.<br>
<ul><li><a href="Fit/WritingTests.html">Writing Tests</a></li><li><a href="FitSharp/LoadingAssemblies.html">Loading Assemblies</a></li><li><a href="Fit/UsingFitnesse.html">Using Fitnesse</a></li><li><a href="Fit/UsingHtmlFiles.html">Using Html Files</a></li><li><a href="FitSharp/AppConfigFile.html">App Config Files</a></li></ul>The following information has been copied from the previous implementation. I'm working my way through it bringing it up to date - at this point, some of it may be obsolete.<ul><li>The <a href="Fit/FeatureList.html">Feature List</a> describes what <span style="font-family:verdana,sans-serif"><i>fit</i>Sharp</span> Fit can do. This is a work in progress that is being enhanced with each release.</li><li>The <a href="Fit/SampleInputFiles.html">Sample Input Files</a> and <a href="Fit/SampleOutputFiles.html">Sample Output Files</a> are used by the story tests for <span style="font-family:verdana,sans-serif"><i>fit</i>Sharp</span> Fit.</li><li>Some <a href="Fit/UnitTests.html">Unit Tests</a> have been written with Fit to exercise its capabilities.</li></ul></div>
<div style="width:100%;text-align:right">
<span class="footer">&copy; Copyright <a href="http://www.syterra.com">Syterra Software Inc.</a> All rights reserved.</span>
</div>

</body>
</html>
81 changes: 81 additions & 0 deletions docs/Fit/AbandonStoryTest.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
<!--2016-11-17 20:49:48,3,0,0,0-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- fitSharp
Copyright © Syterra Software Inc. All rights reserved.
The use and distribution terms for this software are covered by the Common Public License 1.0 (http://opensource.org/licenses/cpl.php)
which can be found in the file license.txt at the root of this distribution. By using this software in any fashion, you are agreeing
to be bound by the terms of this license. You must not remove this notice, or any other, from this software. -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link href="../fitsharp1.css" type="text/css" rel="stylesheet">
<link href="fit.css" type="text/css" rel="stylesheet">
<title>Abandon Story Test</title>
</head>
<body>
<div class="topbar"><a href="../FitSharp.html" class="siteid"><i>fit</i>Sharp</a></div>
<div class="pagename">Abandon Story Test</div>
<div class="content"><br>
We can throw an exception AbandonStoryTestException anywhere in fixture or <a href="../Fit/DomainAdapter.html">Domain Adapter</a> code to stop execution of the current story test. The exception can be constructed with a custom message which will appear in the test result. <pre class="code"> throw new AbandonStoryTestException();
throw new AbandonStoryTestException("my message");</pre><br>
If a story test is executing in <a href="../Fit/FlowMode.html">Flow Mode</a>, we can also use the <a href="../Fit/AbandonStoryTestKeyword.html">Abandon Story Test Keyword</a> to stop execution.<br>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<tr><td class="pass"><span class="fit_member">when input is</span><span><a href="javascript:void(0)" onclick="this.parentNode.nextSibling.style.display=this.parentNode.nextSibling.style.display=='none'?'':'none'">&#8659;</a></span><div style="display:none"><div class="fit_extension"><table border="1" cellpadding="2" cellspacing="0">
<tr><td><span class="fit_interpreter">story test fixture</span></td></tr>
<tr><td><span class="fit_keyword">check</span></td><td><span class="fit_member">plain test</span></td><td>'sample domain adapter'<br>
<br>
'throw abandon'<br>
<br>
'other stuff'<br>
'thats not processed'</td><td class="pass"><div><table><tr><td><span class="fit_SUT">sample domain adapter</span></td> </tr></table></div><br /><div><table><tr><td class="error"><span class="fit_member">throw abandon</span><hr /><pre><div class="fit_stacktrace">Story test abandoned.</div></pre></td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table></div></div></td><td>'sample domain adapter'<br>
<br>
'throw abandon'<br>
<br>
'other stuff'<br>
'thats not processed'</td><td><span class="fit_member">then output is</span></td><td><div><table><tr><td><span class="fit_SUT">sample domain adapter</span></td> </tr></table></div><br /><div><table><tr><td class="error"><span class="fit_member">throw abandon</span><hr /><pre><div class="fit_stacktrace">Story test abandoned.</div></pre></td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<tr><td class="pass"><span class="fit_member">when input is</span><span><a href="javascript:void(0)" onclick="this.parentNode.nextSibling.style.display=this.parentNode.nextSibling.style.display=='none'?'':'none'">&#8659;</a></span><div style="display:none"><div class="fit_extension"><table border="1" cellpadding="2" cellspacing="0">
<tr><td><span class="fit_interpreter">story test fixture</span></td></tr>
<tr><td><span class="fit_keyword">check</span></td><td><span class="fit_member">plain test</span></td><td>'sample domain adapter'<br>
<br>
'throw abandon' 'my message'<br>
<br>
'other stuff'<br>
'thats not processed'</td><td class="pass"><div><table><tr><td><span class="fit_SUT">sample domain adapter</span></td> </tr></table></div><br /><div><table><tr><td class="error"><span class="fit_member">throw abandon</span><hr /><pre><div class="fit_stacktrace">my message</div></pre></td><td>my message</td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table></div></div></td><td>'sample domain adapter'<br>
<br>
'throw abandon' 'my message'<br>
<br>
'other stuff'<br>
'thats not processed'</td><td><span class="fit_member">then output is</span></td><td><div><table><tr><td><span class="fit_SUT">sample domain adapter</span></td> </tr></table></div><br /><div><table><tr><td class="error"><span class="fit_member">throw abandon</span><hr /><pre><div class="fit_stacktrace">my message</div></pre></td><td>my message</td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<tr><td class="pass"><span class="fit_member">when input is</span><span><a href="javascript:void(0)" onclick="this.parentNode.nextSibling.style.display=this.parentNode.nextSibling.style.display=='none'?'':'none'">&#8659;</a></span><div style="display:none"><div class="fit_extension"><table border="1" cellpadding="2" cellspacing="0">
<tr><td><span class="fit_interpreter">story test fixture</span></td></tr>
<tr><td><span class="fit_keyword">check</span></td><td><span class="fit_member">plain test</span></td><td>use column with new 'sample domain adapter'<br>
'throw abandon?'<br>
x<br>
y<br>
<br>
'other stuff'<br>
'thats not processed'</td><td class="pass"><div><table><tr><td><span class="fit_interpreter">use</span></td> <td><span class="fit_interpreter">column</span></td> <td><span class="fit_keyword">with</span></td> <td><span class="fit_keyword">new</span></td> <td><span class="fit_SUT">sample domain adapter</span></td> </tr></table><table><tr><td><span class="fit_member">throw abandon?</span></td> </tr></table><table><tr><td class="error">x<hr /><pre><div class="fit_stacktrace">Story test abandoned.</div></pre></td> </tr></table><table><tr><td>y</td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table></div></div></td><td>use column with new 'sample domain adapter'<br>
'throw abandon?'<br>
x<br>
y<br>
<br>
'other stuff'<br>
'thats not processed'</td><td><span class="fit_member">then output is</span></td><td><div><table><tr><td><span class="fit_interpreter">use</span></td> <td><span class="fit_interpreter">column</span></td> <td><span class="fit_keyword">with</span></td> <td><span class="fit_keyword">new</span></td> <td><span class="fit_SUT">sample domain adapter</span></td> </tr></table><table><tr><td><span class="fit_member">throw abandon?</span></td> </tr></table><table><tr><td class="error">x<hr /><pre><div class="fit_stacktrace">Story test abandoned.</div></pre></td> </tr></table><table><tr><td>y</td> </tr></table></div><br /><div><table><tr><td>other stuff</td> </tr></table><table><tr><td>thats not processed</td> </tr></table></div></td></tr>
</table>
</div>
<div style="width:100%;text-align:right">
<span class="footer">&copy; Copyright <a href="http://www.syterra.com">Syterra Software Inc.</a> All rights reserved.</span>
</div>

</body>
</html>
57 changes: 57 additions & 0 deletions docs/Fit/AbandonStoryTestKeyword.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!--2016-11-17 20:49:48,2,0,0,0-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- fitSharp
Copyright © Syterra Software Inc. All rights reserved.
The use and distribution terms for this software are covered by the Common Public License 1.0 (http://opensource.org/licenses/cpl.php)
which can be found in the file license.txt at the root of this distribution. By using this software in any fashion, you are agreeing
to be bound by the terms of this license. You must not remove this notice, or any other, from this software. -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<link href="../fitsharp1.css" type="text/css" rel="stylesheet">
<link href="fit.css" type="text/css" rel="stylesheet">
<title>Abandon Story Test Keyword</title>
</head>
<body>
<div class="topbar"><a href="../FitSharp.html" class="siteid"><i>fit</i>Sharp</a></div>
<div class="pagename">Abandon Story Test Keyword</div>
<div class="content">This is one of the <a href="../Fit/FlowFixtureKeywords.html">Flow Fixture Keywords</a>. The abandon story test keyword stops execution of the current story test. The keyword cell is marked as ignored.<br>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<tr><td class="pass"><span class="fit_member">when input is</span><span><a href="javascript:void(0)" onclick="this.parentNode.nextSibling.style.display=this.parentNode.nextSibling.style.display=='none'?'':'none'">&#8659;</a></span><div style="display:none"><div class="fit_extension"><table border="1" cellpadding="2" cellspacing="0">
<tr><td><span class="fit_interpreter">story test fixture</span></td></tr>
<tr><td><span class="fit_keyword">check</span></td><td><span class="fit_member">plain test</span></td><td>'sample domain'<br>
<br>
'abandon story test'<br>
more stuff<br>
<br>
thats not processed</td><td class="pass"><div><table><tr><td><span class="fit_SUT">sample domain</span></td> </tr></table></div><br /><div><table><tr><td class="ignore"><span class="fit_keyword">abandon story test</span></td> </tr></table><table><tr><td>more</td> <td>stuff</td> </tr></table></div><br /><div><table><tr><td>thats</td> <td>not</td> <td>processed</td> </tr></table></div></td></tr>
</table></div></div></td><td>'sample domain'<br>
<br>
'abandon story test'<br>
more stuff<br>
<br>
thats not processed</td><td><span class="fit_member">then output is</span></td><td><div><table><tr><td><span class="fit_SUT">sample domain</span></td> </tr></table></div><br /><div><table><tr><td class="ignore"><span class="fit_keyword">abandon story test</span></td> </tr></table><table><tr><td>more</td> <td>stuff</td> </tr></table></div><br /><div><table><tr><td>thats</td> <td>not</td> <td>processed</td> </tr></table></div></td></tr>
</table>
<br>
<table border="1" cellpadding="2" cellspacing="0">
<tr><td class="pass"><span class="fit_member">when input is</span><span><a href="javascript:void(0)" onclick="this.parentNode.nextSibling.style.display=this.parentNode.nextSibling.style.display=='none'?'':'none'">&#8659;</a></span><div style="display:none"><div class="fit_extension"><table border="1" cellpadding="2" cellspacing="0">
<tr><td><span class="fit_interpreter">story test fixture</span></td></tr>
<tr><td><span class="fit_keyword">check</span></td><td><span class="fit_member">plain test</span></td><td>'sample domain'<br>
'abandon story test'<br>
more stuff<br>
<br>
thats not processed</td><td class="pass"><div><table><tr><td><span class="fit_SUT">sample domain</span></td> </tr></table><table><tr><td class="ignore"><span class="fit_keyword">abandon story test</span></td> </tr></table><table><tr><td>more</td> <td>stuff</td> </tr></table></div><br /><div><table><tr><td>thats</td> <td>not</td> <td>processed</td> </tr></table></div></td></tr>
</table></div></div></td><td>'sample domain'<br>
'abandon story test'<br>
more stuff<br>
<br>
thats not processed</td><td><span class="fit_member">then output is</span></td><td><div><table><tr><td><span class="fit_SUT">sample domain</span></td> </tr></table><table><tr><td class="ignore"><span class="fit_keyword">abandon story test</span></td> </tr></table><table><tr><td>more</td> <td>stuff</td> </tr></table></div><br /><div><table><tr><td>thats</td> <td>not</td> <td>processed</td> </tr></table></div></td></tr>
</table>
</div>
<div style="width:100%;text-align:right">
<span class="footer">&copy; Copyright <a href="http://www.syterra.com">Syterra Software Inc.</a> All rights reserved.</span>
</div>

</body>
</html>
Loading

0 comments on commit 1957a1b

Please sign in to comment.