forked from foobarfighter/foounit
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Bob Remeika
committed
Jun 16, 2011
1 parent
8f8a518
commit 4e29f15
Showing
6 changed files
with
129 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| layout: home | ||
| --- | ||
| <!-- About --> | ||
| <h1>About</h1> | ||
|
|
||
| <p> | ||
| foounit is an asynchronous BDD-style javascript test framework aimed at making cross-environment javascript testing simple. foounit is designed to make testing code that is shared between the server and the client less of a chore. It supports both commonjs loading and global scope loading of script files for immediate test dependencies in all environments. Test files are loaded in a functionally scoped environment to help minimize test pollution when running your suite. Test syntax is influenced heavily by Screw Unit, Jasmine and rspec.</p> | ||
|
|
||
| <p> | ||
| foounit is the love child of Bob Remeika (<a href="http://bobremeika.com">me</a>). It was <a href="http://twitter.com/#!/foobarfighter/status/71670398349099008">written out of spite</a> while consuming large amounts of alcohol. If you notice some bad code within foounit, it's definitely due to alcohol abuse. I'm not even going to try to pretend that I *meant* to do that. If you want to help with code quality then <a href="https://github.com/foobarfighter/foounit">patches are accepted</a>. | ||
| </p> | ||
|
|
||
| <p> | ||
| A common question that I get is why didn't I just use Jasmine. See the <a href="#/faq/jasmine">FAQ</a>. | ||
| </p> | ||
|
|
||
| <p> | ||
| foounit is currently used at <a href="http://www.yammer.com">Yammer Inc.</a> as the primary test harness for a core component of our client/server side architecture called yamjs. | ||
| </p> | ||
|
|
||
| <p> | ||
| foounit is a <a href="http://dojofoundation.org/">Dojo Foundation</a> project and is licensed under the Dojo Foundation License. This basically <a href="http://dojofoundation.org/about/hundredpoint">means</a> that no One Company owns the project and the code is gauranteed to be IP Free (free as in beer). This is another reason <a href="#/faq/jasmine">why I didn't want to use Jasmine</a>. | ||
| </p> | ||
|
|
||
| <p> | ||
| This website was created by <a href="http://www.heatherkphillips.com/">Heather Phillips</a> (Yammer) and the logo was created by James Kang (Yammer). | ||
| </p> | ||
| <!-- /About --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| layout: home | ||
| --- | ||
| <!-- Documentation --> | ||
| <h1>Documentation</h1> | ||
|
|
||
| <ul class="index"> | ||
| <li><a href="">Syntax overview</a></li> | ||
| <li><a href="">Async awesomeness</a></li> | ||
| <li><a href="">Matchers</a></li> | ||
| <li><a href="">How to test</a></li> | ||
| <li><a href="">FAQ</a></li> | ||
| </ul> | ||
| <!-- /Documentation --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| layout: home | ||
| --- | ||
| <!-- Download --> | ||
| <h1>Download</h1> | ||
|
|
||
| <a href="">foounit-browser.js</a> | ||
|
|
||
| <!-- /Download --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,62 @@ | ||
| --- | ||
| layout: home | ||
| title: blah blah | ||
| --- | ||
| <!-- Getting Started --> | ||
| <h1>Getting Started</h1> | ||
|
|
||
| <!-- About --> | ||
| <section class="about"> | ||
| <h2>About</h2> | ||
| <p>My life story</p> | ||
| </section> | ||
| <p> | ||
| First install foounit with npm: | ||
| <pre class="code">$ npm install foounit</pre> | ||
| </p> | ||
| <br/> | ||
|
|
||
| <p>Then follow these steps to run tests...</p> | ||
|
|
||
| <ul class="index"> | ||
| <li><a href="">in nodejs</a></li> | ||
| <li><a href="">in the browser</a></li> | ||
| <li><a href="">on code that is shared between the client and the server</a> | ||
| </ul> | ||
|
|
||
|
|
||
| <h3>In nodejs</h3> | ||
|
|
||
| <p> | ||
| Generate a sample suite in the spec directory: | ||
| <pre class="code">$ foounit generate --type=node spec</pre> | ||
| </p> | ||
|
|
||
| <p> | ||
| Run the test: | ||
| <pre class="code">$ node spec/example_spec.js</pre> | ||
| </p> | ||
|
|
||
| <h3>In the browser</h3> | ||
|
|
||
| <p> | ||
| Generate a sample suite in the spec directory: | ||
| <pre class="code">$ foounit generate --type=browser spec</pre> | ||
| </p> | ||
|
|
||
| <p> | ||
| Start a web server in the directory where the suite was created: | ||
| <pre class="code">$ foounit-server --spec=spec</pre> | ||
| <p> | ||
|
|
||
| <p> | ||
| Open a web browser at <a href="">http://localhost:5057/spec/suite.html</a> | ||
| </p> | ||
|
|
||
|
|
||
| <h3>Shared client and server code</h3> | ||
|
|
||
| <p> | ||
| Generate a sample suite in the spec directory: | ||
| <pre class="code">$ foounit generate --type=browser,node spec</pre> | ||
| <i>foounit is smart enough to know that when multiple environments are specified that it should create a shared directory for multi-environment testing</i> | ||
| </p> | ||
|
|
||
| <p> | ||
| Run the tests for each environment by following the directions in the previous steps. | ||
| </p> | ||
| <!-- /Getting Started --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| layout: home | ||
| --- | ||
| <!-- Support --> | ||
| <h1>Support</h1> | ||
|
|
||
| <ul> | ||
| <li>Twitter: <a href="http://twitter.com/foounit">@foounit</a></li> | ||
| <li>Mailing list: <a href="">Google groups</a></li> | ||
| <li>File a ticket: <a href="https://github.com/foobarfighter/foounit/issues?milestone=&labels=&_pjax=true&state=open">Submit an issue</a></li> | ||
| </ul> | ||
| <!-- /Support --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters