Skip to content

Latest commit

 

History

History
146 lines (105 loc) · 4.15 KB

Development.md

File metadata and controls

146 lines (105 loc) · 4.15 KB
Raw

Development and Testing Guide
Pip.Services MongoDB Components for Node.js

This document provides high-level instructions on how to build and test the microservice.

Environment Setup

This is a Node.js project and you have to install Node.js tools. You can download them from official Node.js website: https://nodejs.org/en/download/

After node is installed you can check it by running the following command:

node -version

Then you need to configure node tools:

# Install typescript compiler
npm install typescript -g
 
# Install typescript definitions utility
npm install tsd -g 

# Install typescript api document generator
npm install typedoc -g

# Install mocha test runner
npm install mocha -g

To work with GitHub code repository you need to install Git from: https://git-scm.com/downloads

If you are planning to develop and test using persistent storages other than flat files you may need to install database servers:

Installing

After your environment is ready you can check out source code from the Github repository:

git clone git@github.com:pip-services/pip-services-mongodb-node.git

Then go to the project folder and install dependent modules:

# Install dependencies
npm install

If you worked with the microservice before you can check out latest changes and update the dependencies:

# Update source code updates from github
git pull

# Update dependencies
npm update

Building

The commons is written in TypeScript language which is transcompiled into JavaScript. So, if you make changes to the source code you need to compile it before running or committing to github. The process will output compiled javascript files into /bin folder.

tsc

When you do continuous edit-build-test cycle, you can run typescript compiler with --watch option to detect and compile changes you make automatically:

tsc --watch

Testing

Before you execute tests you need to set configuration options in config.json file. As a starting point you can use example from config.example.json:

copy config/config.example.yaml config/config.yaml

After that check all configuration options. Specifically, pay attention to connection options for database and dependent microservices. For more information check Configuration Guide

Command to run unit tests:

npm test

You can also execute benchmarks as:

npm run benchmark

Release

Formal release process consistents of few steps. First of all it is required to tag guthub repository with a version number:

git tag vx.y.y
git push origin master --tags

Then the release can be pushed to the global NPM repository. To be able to make the release contributor must have an account with proper permissions at npm site.

npm login
npm publish

Microservice releases additionally require generation and publishing binary packages at http://downloads.pipservices.org

Contributing

Developers interested in contributing should read the following instructions:

Please do not ask general questions in an issue. Issues are only to report bugs, request enhancements, or request new features. For general questions and discussions, use the Contributors Forum.

It is important to note that for each release, the ChangeLog is a resource that will itemize all:

  • Bug Fixes
  • New Features
  • Breaking Changes