Skip to content

Commit

Permalink
chore(*): initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
daniellmb committed Sep 14, 2013
0 parents commit b86a7e5
Show file tree
Hide file tree
Showing 63 changed files with 3,287 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# package managers #
######################
node_modules
npm-debug.log
bower_components

# generated test files #
######################
spec.coffee
spec.js

# generated coverage files #
coverage/

# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db
33 changes: 33 additions & 0 deletions .jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"maxparams": 4,
"maxdepth": 2,
"maxstatements": 15,
"maxcomplexity": 8,
"node": true,
"browser": true,
"esnext": true,
"bitwise": true,
"curly": true,
"eqeqeq": true,
"immed": true,
"indent": 2,
"latedef": true,
"newcap": true,
"noarg": true,
"quotmark": "single",
"regexp": true,
"smarttabs": true,
"white": true,
"predef": {
"angular": false,
"inject": false,
"module": false,
"jasmine": true,
"spyOn": false,
"describe": false,
"beforeEach": false,
"afterEach": false,
"it": false,
"expect": false
}
}
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
language: node_js
node_js:
- "0.10"
before_script:
- "npm i -g grunt-cli"
- "bash init-repo.sh"
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License

Copyright (c) 2013 Daniel Lamb <daniellmb.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
103 changes: 103 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# Angular Unit Test Patterns [![Build Status](https://travis-ci.org/daniellmb/angular-test-patterns.png)](https://travis-ci.org/daniellmb/angular-test-patterns)

High Quality Cut-n-Paste Guide for Testing your AngularJS [Controllers](patterns/controller.md), [Services](patterns/service.md), [Directives](patterns/directive.md) and [Filters](patterns/filter.md). As well as ideas on how to use [Mocks](patterns/mock.md), [End-to-End](patterns/e2e.md) tests, [Performance](patterns/performance.md) testing and [More](patterns/perceptualdiff.md)!

## Testing Patterns

* Unit Testing
* [Controllers](patterns/controller.md#unit-testing-angularjs-controllers)
* [Directives](patterns/directive.md#unit-testing-angularjs-directives)
* [Filters](patterns/filter.md#unit-testing-angularjs-filters)
* [Services](patterns/service.md#unit-testing-angularjs-services)
* End-to-end Scenarios (Integration)
* [E2E Scenarios](patterns/e2e.md#end-to-end-testing-angularjs)
* [Using Mocks](patterns/mock.md#unit-testing-angularjs-using-mocks)
* [Test Coverage Enforcement](patterns/coverage.md#coverage-threshold-enforcement-for-angularjs)
* [Complexity Threshold Enforcement](patterns/complexity.md#complexity-threshold-enforcement-for-angularjs)
* [Performance Testing](patterns/performance.md#performance-testing-angularjs)
* [Perceptual Difference Testing](patterns/perceptualdiff.md#perceptual-difference-testing-angularjs)

## What's an AngularJS Test Pattern?
A test pattern is a proven way to ~~properly~~ test a given feature of your AngularJS application. It's a design pattern for testing.

## Why?
This started as a place for me to jot down the patterns I've been using while building several AngularJS projects.

## Contributing Test Patterns
**Pull Requests Welcome!** I would love see these patterns evolve over time from community input as
more refined approches are discovered. So *please share what's working well for you!*

### Prepare your environment
* Install [Node.js](http://nodejs.org) (NPM will come bundled).
* [Fork](http://help.github.com/forking) the [main repository](https://github.com/daniellmb/angular-test-patterns).
* Clone your Github repository: `git clone [email protected]:<github username>/angular-test-patterns.git`
* Go to the test patterns directory: `cd angular-test-patterns`
* Add the [main repository](https://github.com/daniellmb/angular-test-patterns) as an upstream remote to your repository: `git remote add upstream https://github.com/daniellmb/angular-test-patterns.git`
* Run `bash init-repo.sh` to initialize your local repository.

### To add a new test pattern
* Edit or create a markdown file to hold your new test pattern.
* Add a [test pattern section](spec/lib/parse.util.coffee.md#anatomy-of-a-test-pattern-section) for your pattern
* In your new section add [code blocks](spec/lib/parse.util.coffee.md#anatomy-of-a-test-pattern-code-block) for each of the [supported languages](spec/config.json#L2).
* Edit the [example applications](/example) to satisfy your new pattern.
* Run `npm test` to ensure the pattern is valid. This does the following:
* Unit tests the [test pattern rules](#unit-testing-the-patterns).
* Unit tests that each pattern follows those rules.
* Unit tests the [example applications](/example) against the patterns.

### Unit Testing the Patterns
To ensure a clear and consistent style of test patterns, every block of code must pass the following [rules](spec/rules) via `npm test` The rules are written in literate CoffeeScript so they are nicely self-documenting.

* [Test Pattern Language is Supported](spec/rules/code-lang.spec.coffee.md)
* [Test Pattern Language is Commented](spec/rules/code-comment.spec.coffee.md)
* [Test Pattern Code is Valid](spec/rules/valid-code.spec.coffee.md)
* [Test Pattern is Lint-Free](spec/rules/lint-free.spec.coffee.md)

### To add a new pattern rule
* Create a new `<my-rule-name>.spec.coffee.md` literate CoffeeScript file in the `spec/rules` folder.
* Create a new `<my-rule-name>` folder in the `spec/fixtures` folder.
* Add a text file for each of the supported languages, [see examples](spec/fixtures).
* Make your fixture as specific as possible. For example, if you are testing that the pattern is [lint-free](spec/fixtures/lint-free/coffeescript.txt) you don't need to include a [code comment](spec/fixtures/code-comment/coffeescript.txt) as there is a separate test for that.
* Define your test pattern rule, [see examples](spec/rules).
* Run `npm run testRules` to ensure the rule passes using the fixtures.

### Submitting Your Changes
* Create and checkout a new branch off the master branch for your changes: `git checkout -b my-fix-branch master`
* Create your patch, make sure that all tests pass.
* Commit your changes and create a descriptive commit message (the commit message is used to generate release notes, please check out the [commit message conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y) and the commit message presubmit hook [validate-commit-msg.js](hooks/validate-commit-msg.js)): `git commit -a`
* Push your branch to Github: `git push origin my-fix-branch`
* In Github, send a pull request to `daniellmb:master`
* When the patch is reviewed and merged, delete your branch and pull yours — and other — changes from the main (upstream) repository:
* Delete your branch in Github, run: `git push origin :my-fix-branch`
* Check out the master branch, run: `git checkout master`
* Delete your local branch, run: `git branch -D my-fix-branch`
* Update your master with the latest upstream version, run: `git pull --ff upstream master`
* If you need to make changes to your pull request, you can update the commit with `git commit --amend`. Then, update the pull request with `git push -f`.

That's it! Thank you for your contribution!

## The Future
Once we have a solid set of robust testing patterns, I'd like to get them integrated into a [Yeoman](http://yeoman.io) AngularJS [generator](http://yeoman.io/generators.html).

## License
The MIT License

Copyright (c) 2013 Daniel Lamb <daniellmb.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
3 changes: 3 additions & 0 deletions example/.bowerrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"directory": "bower_components"
}
70 changes: 70 additions & 0 deletions example/Gruntfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
module.exports = function (grunt) {
require('load-grunt-tasks')(grunt);
grunt.initConfig({
jshint: {
//list of source files to analyze
all: [
'Gruntfile.js',
'javascript/*.js',
//use to check pattern specs as well
'../spec/*.js'
],
options: {
//reuse pattern specs jsHint settings
jshintrc: '../.jshintrc'
}
},
coffeelint: {
//list of source files to analyze
all: 'coffeescript/*.coffee',
//reuse pattern specs coffeelint settings
options: require('../spec/config.json').coffeelint
},
complexity: {
js: {
//list of source files to analyze
src: ['javascript/*.js'],
options: {
// show only maintainability errors
errorsOnly: false,
// http://en.wikipedia.org/wiki/Cyclomatic_complexity
cyclomatic: 8,
// http://en.wikipedia.org/wiki/Halstead_complexity_measures
halstead: 8,
maintainability: 100
}
}
},
karma: {
coffee: {
configFile: 'coffeescript/karma.conf.coffee'
},
javascript: {
configFile: 'javascript/karma.conf.js'
}
},
clean: {
coverage: '{,*/}/coverage/*'
},
coverage: {
options: {
thresholds: {
statements: 100,
branches: 100,
functions: 100,
lines: 100
},
dir: 'coverage',
root: 'javascript'
}
}
});
grunt.registerTask('default', [
'coffeelint',
'jshint',
'complexity',
'clean:coverage',
'karma',
'coverage'
]);
};
12 changes: 12 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AngularJS Example Applications

Each sample application satisfies all of the unit test patterns available, from [controllers](../patterns/controller.md) to [filters](../patterns/filter.md). To run the test patterns against the example applications use: `npm run testExamples`. This task extracts the test patterns from the markdown files and generates a jasmine unit test file for each of the supported code languages. Once this is done the generated specs are run against the example application using karma just as a normal AngularJS application would be.

Example applications are provided in the following languages:

* [CoffeeScript](coffeescript)
* [JavaScript](javascript)

**Please Note:** that these examples are configured into a single file to be succinct... not maintainable. You'll want to break your aplication out into separate files and folders as needed.

[Read more](../#whats-an-angularjs-test-pattern) about how test patterns are used and created.
12 changes: 12 additions & 0 deletions example/bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "myExample",
"version": "0.0.0",
"dependencies": {
"angular": "~1.0.8",
"angular-sanitize": "~1.0.8"
},
"devDependencies": {
"angular-mocks": "~1.0.8",
"angular-scenario": "~1.0.8"
}
}
Loading

0 comments on commit b86a7e5

Please sign in to comment.