Skip to content

Instantly share code, notes, and snippets.

@PotOfCoffee2Go
Last active June 23, 2017 03:41
Show Gist options
  • Save PotOfCoffee2Go/1c23632c5af85fc9effd99e5c4a28f1c to your computer and use it in GitHub Desktop.
Save PotOfCoffee2Go/1c23632c5af85fc9effd99e5c4a28f1c to your computer and use it in GitHub Desktop.
Local install of PotOfCoffee2Go changes to node-red-contrib-alasql

Draft 6/21/2017

Review procedures of updates to PotOfCoffee2Go fork of node-red-contrib-alasql

Before accepting Pull Requests to PotOfCoffee2Go fork of node-red-contrib-alasql a review of the updates will be performed.

The review will be done by installing changes locally, kick-the-tires, and upon acceptance will be submitted to https://github.com/AlaSQL/node-red-contrib-alasql for merging into the next production release.

Currently, nodes developed under node-red do not have a system of test verification - such as mocha, jasmine, etc. The best that can be done at this time, is to build a node-red test suite of flows that test the modifications. No updates will be accepted by PotOfCoffee2Go without a set of accompanying node-red flows which test the changes.

The reviewers will integrate the flows into what will become a standard set of test flows to be approved by the maintainers of the official production release of node-red-contrib-alasql AlaSQL, CodeScullery, Vallen, sister company hagemeyer, and possibly customers such as Siemens might wish to be involved.

Review PotOfCoffee2Go node-red-contrib-alasql

Before accepting updates, a review of the changes will be performed locally by installing and testing the system. Since some of the flows will be accessing corporate Oracle, MSSQL, MySql, PIM, and ERP databases/systems (which are firewall protected), not all flows will be eligible for release to the general public. Git repos will be established on the corporate git server(s) to test such flows and will be added to the install script below.

It is assumed that the reviewers are currently running Nodejs Version 6 on there systems as recommended by node-red. Node-red have not verified Nodejs Version 7 as of this writing. There are components in the PotOfCoffee2Go release of node-red-contrib-alasql that require Nodejs Version 6 or greater. Also, assume all the normal stuff - git, node-red, github account, corporate access, etc. already installed on your system.

Note: If you have multiple Nodejs releases on your local machine, look into the NVM package which allows you to manage/switch between releases of Nodejs on your system - Google is your friend.

Installing PotOfCoffee2Go changes to node-red-contrib-alasql for review.

Below is a preliminary script that can be used to install the latest updates to PotOfCoffee2Go fork. *Note that this script is likely to change! Contact Jim Kauffman (for the most up-to-date shell script) who is be spearheading the review team.

Create an empty directory and open a command window in that directory. Copy/Paste the following commands:

mkdir .forks
cd .forks

git clone https://github.com/PotOfCoffee2Go/node-red-contrib-alasql.git
cd node-red-contrib-alasql
npm install

cd ../..
npm install .forks/node-red-contrib-alasql

node-red -u poc2go-node-red-alasql-tests ".forks/node-red-contrib-alasql/flows/alafiletests.json"

The above creates a forks directory of various node-red node repos currently under review. In this case we are interested only in installing PotOfCoffee2Go's fork of node-red-contrib-alasql.

Install node-red-contrib-alasql.

Go back to the project home directory

Create/install a symlink to the node-red-contrib-alasql we just installed

Fire up node-red - which will create a node-red user directory named poc2go-node-red-alasql-tests and start the alafiletests.json test flows contained in node-red-contrib-alasql flows directory.


Access the node-red site to be reviewed is at http://localhost:1880. It will display the Test Suite of flows to run tests. Select the tabs that reference ala file flows to review the various aspects of changes to node-red-contrib-alasql. Move stuff around, make new and specific flow tests, etc.

Occasionally, you might get a Lost connection to server message on the node-red http://localhost:1880 site, which usually means the node-red application crashed. Go back to the command window; select, cut, and paste in an email to Jim. Insure Jim gets the versions Node-RED version: v0.16.2 and Node.js version: v6.9.5 lines displayed when the server comes up. Shortly there will be a Test version: v0.2.3 that will also be displayed - include that as well as anything that looks like an error - usually at the bottom.

To restart the node-red server - reissue the command :

node-red -u poc2go-node-red-alasql-tests ".forks/node-red-contrib-alasql/flows/alafiletests.json"

Of course, feel free to make any changes the files in .forks/node-red-contrib-alasql. Do a git commit -a -m "comment" followed by a git push. Your changes will be reviewed by the programming staff.

Thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment