Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

dvsa/cvs-devkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CVS Devkit

Run AWS Lambda node functions locally with a mock API Gateway and DynamoDB to test against

  • npm install
  • node_modules/.bin/sls dynamodb install
  • npm start to start serverless locally with default ports
  • IS_OFFLINE=true DYNAMO_PORT={dynamodb port} SERVERLESS_PORT={serverless port} ./node_modules/serverless/bin/serverless offline start to start serverless locally with custom ports

Description

This dev tool allows to manage multiple git operations across all CVS Dev Services

Installation

To get started locally, follow these instructions:

Gem Installation

Download and install rake with the following.

  gem install rake

Please follow the rake documentation on how to install the package on your machine

First

  1. clone this repository in your project directory
  2. cd into the project and run rake clone

Usage

Command Description
rake help -- display help
rake branch -- display current branch of all repos
rake clone -- run 'git clone' on all repos
rake pull -- run 'git pull --rebase' on all repos
rake create_branch "BRANCH" -- run 'git checkout -b BRANCH' on all repos
rake checkout_master -- run 'git checkout master' on all repos
rake checkout_develop -- run 'git checkout develop' on all repos
rake needs_commit -- checks if any of the repos need a commit
rake install -- run npm install in all repositories
rake start -- run npm run start in all repositories

Testing

In order to test, you need to run the following:

  • npm run test for unit tests
  • npm run test-i for integration tests
  • The IS_OFFLINE environment variable needs to be set to true in order for the microservice to connect to the local dynamodb instance. Defaults to true
  • The SERVERLESS_PORT environment variable needs to be set to a value representing the port you want the serverless instance to run on. This variable is mandatory. Defaults to 3000
  • The DYNAMO_PORT environment variable needs to be set to a value representing the port you want the dynamodb shell to run on. This variable is mandatory. Defaults to 8000.