Skip to content

Commit

Permalink
fix: node 6.x.x crypto deprecated message; baboon required now nodejs…
Browse files Browse the repository at this point in the history 
… 6.x.x

fix: ci test
  • Loading branch information
@DasZiesel
DasZiesel committed Dec 6, 2017
1 parent 68036d8 commit 61d0df6
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 224 deletions.
2 changes: 1 addition & 1 deletion Gruntfile.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ module.exports = function (grunt) {
},
test: { specs: ['test/**'] },
ci: {
specs: { specs: ['test/**'] },
specs: ['test/**'],
options: {
reporters: {
junit: {
Expand Down
219 changes: 2 additions & 217 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
> [![NPM version](https://badge.fury.io/js/baboon.svg)](http://badge.fury.io/js/baboon)
[![Build Status](https://secure.travis-ci.org/litixsoft/baboon.svg?branch=master)](https://travis-ci.org/litixsoft/baboon)
[![david-dm](https://david-dm.org/litixsoft/baboon.svg?theme=shields.io)](https://david-dm.org/litixsoft/baboon/)
[![david-dm](https://david-dm.org/litixsoft/baboon/dev-status.svg?theme=shields.io)](https://david-dm.org/litixsoft/baboon#info=devDependencies&view=table)

Baboon is an open source web toolkit for creating Single Page Real-time applications.
It combines tools, libraries, own developments as well as existing frameworks into a complete,
Expand All @@ -17,7 +16,6 @@ Baboon takes care of the complete setup of an immediately usable architecture fo
the basic functionality of the application. In addition to simple things like LESS-based design,
it also includes the complete implementation of a websocket transport for the real-time communication inside the application. Last but not least the availability of many modules makes Baboon a full SPA-framework. All that is left to you is taking care of your business logic - the rest is done by Baboon.

* Web site: http://baboon.litixsoft.de/products-baboon
* Baboon project generator https://github.com/litixsoft/generator-baboon

# Install
Expand All @@ -28,8 +26,8 @@ The installation of a Baboon project is very simple. However, some preparatory w
Baboon need only NodeJS on the respective system.
In production mode on server with activated rights system following stack is desirable:

* MongoDb 2.4.5 or newer
* NodeJs 10.22 or newer
* MongoDb 3.X.X or newer
* NodeJs 6.X.X

Such a stack including NodeJS version management, RedisIO, MongoDb and other tools can be found here: the [baboon-stack](https://github.com/litixsoft/baboon-stack) covers an easy-to-use one-click setup for Windows, Linux and Mac.
The baboon-stack is suitable with the NodeJS version management also ideal for development.
Expand Down Expand Up @@ -76,219 +74,6 @@ We will check the tests, the example and test coverage. In case your changes are
# Building and Testing Baboon
This section describes how to set up your development environment to build and test Baboon with the example app.

## System requirements

Baboon need only NodeJS on the respective system.
In production mode on server with activated rights system following stack is desirable:

* MongoDb 2.4.5 or newer
* NodeJs 10.22 or newer

Such a stack including NodeJS version management, RedisIO, MongoDb and other tools can be found here: the [baboon-stack](https://github.com/litixsoft/baboon-stack) covers an easy-to-use one-click setup for Windows, Linux and Mac.
The baboon-stack is suitable with the NodeJS version management also ideal for development.

## NodeJS global dependencies
Without using baboon-stack, you need install Baboon's global dependencies. Skip this section when using Baboon-stack.

Linux / Mac:

$ sudo npm install -g karma bower grunt-cli yo generator-baboon

Windows:

$ npm install -g karma bower grunt-cli yo generator-baboon

## Install Baboon and example app
The example application is also the reference implementation of Baboon.
Fork Baboon repository and install the dependent modules with npm and bower.

$ git clone https://github.com/litixsoft/baboon.git
$ cd baboon
$ npm install
$ cd example
$ npm install
$ bower install

## Important:
Make sure to always keep the directory you are in in mind. Grunt commands in the baboon/ directory always refer to the
Baboon library. Grunt commands in the baboon/example always refer to the example application.

## Running example
To debug code and run end-to-end tests, it is useful to have a local implementation. For this purpose,
we built an example application with a fully functional web-server on ExpressJs basis.

$ cd baboon/example
$ grunt serve

The `grunt serve` command builds the example application in development mode, starts the server and opens the application in a browser.
It then monitors changes inside the directories. When a change to files is detected, grunt rebuilds the app and
reloads the site in the browser.

You can also manually start the `server.js` in development mode. This is sometimes needed for debugging.
You have to trigger the build by yourself then. After each change do a:

$ grunt build:dev
$ node server.js --config development

You can also manually start the `server.js` in production mode. This is sometimes needed for debugging.
You have to trigger the build by yourself then. After each change do a:

$ grunt build
$ node server.js

## Running tests
You can run all unit tests from Baboon lib and example application with:

$ npm test // directory baboon

Baboon lib tests only

$ grunt test // directory baboon

Example app server and client unit tests only

$ grunt test // directory baboon/example

Example app server unit tests only

$ grunt test:server // directory baboon/example

Example app client unit tests only

$ grunt test:client // directory baboon/example

## Running end to end tests
You can run end to end scenario tests in example app with:

Test in development mode:

$ grunt e2e // directory baboon/example

Test in production mode:

$ grunt e2e:dist // directory baboon/example

## Running coverage
You can run a coverage task for Baboon lib with:

$ grunt cover // directory baboon

You can run a coverage task for example app server and client with:

$ grunt cover // directory baboon/example

You can run a coverage task for example app server with:

$ grunt cover:server // directory baboon/example

You can run a coverage task for example app client with:

$ grunt cover:client // directory baboon/example

## All Baboon lib grunt tasks
Important: this tasks run inside the baboon directory only.

Run baboon unit tests and jshint

$ grunt test

Run baboon unit tests, jshint and code coverage

$ grunt cover

Run baboon unit tests, jshint and code coverage for ci systems

$ grunt ci

This generates xml reports inside the build folder.

## All Baboon example app grunt tasks
Important: this tasks run inside the baboon/example directory only.

Build application in development mode, start express server, open browser with app and watch for changes.

$ grunt serve

Build application in development mode, start express server, open browser with app.

$ grunt serve:dist

Build application in development mode only.

$ grunt build:dev

Build application in production mode only.

$ grunt build

Create the api documentation

$ grunt doc

Create the api documentation and start the docu-application in browser

$ grunt doc:serve

Run all unit tests

$ grunt test

Run client unit tests

$ grunt test:client

Run server unit tests

$ grunt test:server

Run e2e protractor tests in development mode

$ grunt e2e

Run e2e protractor tests in production mode

$ grunt e2e:dist

Run coverage for server and client

$ grunt cover

Run coverage for client

$ grunt cover:client

Run coverage for server

$ grunt cover:server

Run unit tests, jshint and code coverage for ci systems

$ grunt ci

This generates xml reports inside the build folder.

## Release a new version
We use [grunt-bump](https://github.com/vojtajina/grunt-bump) and [grunt-conventional-changelog](https://github.com/btford/grunt-conventional-changelog) internally to manage our releases.
To handle the workflow, we created a grunt task `release`. This happens:

* Bump version in package.json
* Update the CHANGELOG.md file
* Commit in git with message "Release v[`the new version number`]"
* Create a git tag v[`the new version number`]

### Create a new release
Release a new patch

$ grunt release

Release a new minor version

$ grunt release:minor

Release a new major version

$ grunt release:major

# Author
[Litixsoft GmbH](http://www.litixsoft.de)

Expand Down
6 changes: 3 additions & 3 deletions lib/crypto.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ module.exports = function () {

data.salt = buffer.toString('hex');

crypto.pbkdf2(password, data.salt, iterations, keyLen, function (error, encodedPassword) {
crypto.pbkdf2(password, data.salt, iterations, keyLen, 'sha1', function (error, encodedPassword) {
if (error) {
callback(error);
return;
Expand Down Expand Up @@ -66,15 +66,15 @@ module.exports = function () {
* @param {Function} callback The callback function.
*/
pub.compare = function (plain, hash, salt, callback) {
crypto.pbkdf2(plain, salt, iterations, keyLen, function (error, encodedPassword) {
crypto.pbkdf2(plain, salt, iterations, keyLen, 'sha1', function (error, encodedPassword) {
if (error) {
callback(error);
return;
}

var hashToCompare = encodedPassword.toString('hex');

callback(null, {is_equal: hash === hashToCompare});
callback(null, { is_equal: hash === hashToCompare });
});
};

Expand Down
6 changes: 3 additions & 3 deletions test/crypto.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ describe('Crypto', function () {

var stubs = {};
stubs.crypto = {
pbkdf2: function (a, b, c, d, callback) {
pbkdf2: function (a, b, c, d, e, callback) {
callback('error');
}
};
Expand Down Expand Up @@ -132,7 +132,7 @@ describe('Crypto', function () {

var stubs = {};
stubs.crypto = {
pbkdf2: function (a, b, c, d, callback) {
pbkdf2: function (a, b, c, d, e, callback) {
callback('error');
}
};
Expand All @@ -145,4 +145,4 @@ describe('Crypto', function () {
});
});
});
});
});

0 comments on commit 61d0df6

Please sign in to comment.