Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nullivex/angular-socket.io-mock
Mock Socket.io bindings for AngularJS, useful for testing as a drop in replacement
https://github.com/nullivex/angular-socket.io-mock
Last synced: about 2 months ago
JSON representation
Mock Socket.io bindings for AngularJS, useful for testing as a drop in replacement
- Host: GitHub
- URL: https://github.com/nullivex/angular-socket.io-mock
- Owner: nullivex
- Created: 2013-11-12T21:47:56.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-09-15T06:02:17.000Z (over 7 years ago)
- Last Synced: 2024-11-19T08:46:30.527Z (2 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 42
- Watchers: 6
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- starred-awesome - angular-socket.io-mock - Mock Socket.io bindings for AngularJS, useful for testing as a drop in replacement (JavaScript)
README
angular-socket.io-mock [](https://travis-ci.org/nullivex/angular-socket.io-mock)
======================
Mock Socket.io bindings for AngularJS, useful for testing as a drop in replacement for
https://github.com/btford/angular-socket-io which allows testing against a fake server.
## Usage
### Standard usage
* Make sure AngularJS is loaded prior to inclusion.
karma.conf.js
```js
module.exports = function(config) {
config.set({
files: [
{pattern: "bower_components/angular-socket.io-mock.js", included: false}
]
})
}
```
## With RequireJS
In all our projects we utilize RequireJS to use this test library with RequireJS is very simple. Just replace the entry
that points to the standard angular-socket-io with this library. Below is an example.
main.js
```js
require.config({
baseUrl: "/base/js",
shim: {
"socketio": {exports: "io"},
"angular": {exports: "angular"},
"ng-socket-io": ["angular","socketio"],
"ng-mocks": ["angular"]
},
paths: {
"angular": "/base/bower_components/angular/angular",
"socketio": "/base/bower_components/socket.io-client/dist/socket.io",
"ng-socket-io": "/base/bower_components/angular-socket.io-mock/angular-socket.io-mock",
"ng-mocks": "/base/bower_components/angular-mocks/angular-mocks"
},
callback: window.__karma__.start
})
```
Your bower.json should look something like this.
bower.json
```json
{
"name": "my-app",
"version": "0.0.1",
"dependencies": {
"angular": "latest",
"angular-socket-io": "latest"
},
"devDependencies": {
"socket.io-client": "latest",
"angular-mocks": "latest",
"angular-socket.io-mock": "latest"
}
}
```
### Example Test
This example uses Mocha Test as the testing framework and ChaiJS for the assertion library. It also uses RequireJS to
load the environment.
test.js
```js
define(["chai","angular","angular-mocks","angular-socket-io"],function(chai){
describe("Test Suite",function(){
beforeEach(module("app"))
it("should be using the mock ng-socket.io",inject(function($rootScope,$controller){
var expect = chai.expect
, scope = $rootScope.$new()
, ctrl = $controller("MyController",{$scope: scope})
expect(scope.save).to.be.a("function")
expect(scope.items).to.be.a("array")
expect(scope.items.length).to.equal(3)
}))
})
})
```
MyController.js
```js
define(["angular","ng-socket-io"],function(ng){
var app = ng.module("app",["btford.socket-io"])
app.controller("MyController",["$scope","socket",function($scope,socket){
//load items now
$scope.items = []
socket.emit("loadItems",{},function(res){
$scope.items = res.res
})
//setup functions
$scope.save = function(){}
}])
})
```
### Example test using Jasmine
Test.js
```js
describe('Controller: socketController', function () {
// load the controller's module
beforeEach(module('app'));
var socketController,
notify,
scope;
// Initialize the controller and a mock scope
beforeEach(inject(function ($controller, $rootScope, _notify_) {
scope = $rootScope.$new();
notify = _notify_;
socketController = $controller('socketController', {
$scope: scope
});
}));
it('The scope.items should change somehow', function() {
expect(scope.items.length).toEqual(0);
notify.receive('loadItems',{res: ['1','2','3']} )
expect(scope.items.length).toEqual(3);
});
});
```
```js
'use strict';
angular.module('app')
.controller('socketController', function ($scope, notify) {
// As first step to unit-test the socket, what we are
// going to do it is to try mocking an error, and changing
// a variable.
// This I hope it's easy enough to get started. It is not easy.
$scope.items = []
notify.on("loadItems", function(res){
$scope.items = res.res
});
});
```
### Todo
* Usage with sinon.js for spies
* Mocking responses
*Note* Please see https://github.com/btford/angular-socket-io for library usage.
## Changelog
### 1.3.0
* Merge pull request #14 adding entry point for package in `package.json`
### 1.2.0
* Merge pull request #10 adding a prefix and forward option
* Update to latest dependencies
* Publish on NPM
### 1.1.1
* Add `forward` support
### 1.1.0
* .receive will acknowledge any .emit events with a callback as the last parameter
### 1.0.0
* Upgraded to work with latest angular.
* Use 0.1.0 with older versions of angularjs.
* Add `once` support
### 0.1.0
* Fixed issue interface with the latest angular package.
### 0.0.1
* Initial Release