Instructions for syncing with the development environment (#622)

* Instructions for syncing with the development environment. [skip-ci]
unee-t/bugzilla-customisation@25329c2

* Add file back to give better idea of what is required from scratch setup

Author: kaihendry

.env.sample

@@ -8,6 +8,6 @@ MAIL_URL=<SMPT provider URL>
 CLOUDINARY_URL=<retrieve by registering for a free account on Cloudinary (should end with /image/upload)>
 CLOUDINARY_PRESET=<generate in your Cloudinary account (look into 'Unsigned Uploading')>
 API_ACCESS_TOKEN=<set any value that will be used to authenticate API requests to this server by the "accessToken" query param>
-FROM_EMAIL="LOCAL DEV Unee-T Case <dev.[email protected]>"
+FROM_EMAIL="Local Unee-T Case <case.local@unee-t.com>"
 STAGE=dev
 DOMAIN=<domain origin of the application>

README.md

@@ -7,7 +7,7 @@
 
 They are securely managed in AWS's [parameter store](https://ap-southeast-1.console.aws.amazon.com/ec2/v2/home?region=ap-southeast-1#Parameters:sort=Name). The variables are retrieved via [an environment setup script](https://github.com/unee-t/frontend/blob/master/aws-env.dev), which is utilised by `deploy.sh`.
 
-For local development, copy `.env.sample` to `.env`. The values of the environment variables can be obtained from other developers via [Unee-T Slack](https://unee-t.slack.com/messages/C6UM93HD2).
+For local development, use `./env-setup.bash` assuming you have been access to the `uneet-dev` development environment.
 
 # Deployment
 
@@ -78,20 +78,10 @@ Run in browser's developer console:
 
 ## How do I set up for local development?
 
-Assuming `.env` is already setup, you need to populate yours users db, by cross
-referencing an existing user in the Bugzilla backend. For example running in
-the dev tools of your browser:
-
-	Accounts.createUser({ email: '[email protected]', password: 'leonel', profile: { bzLogin: '[email protected]', bzPass: 'leonel' }})
-
-Ensure it worked by looking at the `npm start` log.
-
-Note: `[email protected]` is setup inside
-https://github.com/unee-t/bugzilla-customisation/tree/master/sql & loaded via [bugzilla-customisation](https://github.com/unee-t/bugzilla-customisation/)'s `make up`.
-
-Next in `meteor mongo`, you can verify the address (without going to mailinator to answer the mail) like so:
-
-	db.users.update({'emails.address': '[email protected]'}, {$set : {'emails.0.verified': true}})
+1. Make a backup snapshot of the devlopment Mongo database using `backup/dump.sh`
+2. `meteor reset` to clear state
+3. `npm run start` to start the mongo service
+3. `mongorestore -h 127.0.0.1 --port 3001 -d meteor $(date "+dev-%Y%m%d")/meteor`
 
 ## How to test the notifications / email templates?
 
@@ -108,4 +98,4 @@ to the bugzillaCreds **id** from `db.users.find().pretty()`
 
 ## error: Error: url must be absolute and start with http:// or https://
 
-Your `.env` file is almost not set up correctly.
+Your `.env` file is not set up correctly, consider `./env-setup.bash`

backup/dump.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-for STAGE in prod
+for STAGE in dev
 do
 	echo Mongo dumping stage $STAGE
 	source ../aws-env.$STAGE

backup/local/Makefile

@@ -0,0 +1,5 @@
+dump:
+	mongodump -h 127.0.0.1 --port 3001 -d meteor
+
+restore:
+	mongorestore -h 127.0.0.1 --port 3001 -d meteor dump/meteor

env-setup.bash

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+if test -f .env
+then
+	echo .env already exists. Stopping.
+	exit
+fi
+
+ssm() {
+	echo $(aws --profile uneet-dev ssm get-parameters --names $1 --with-decryption --query Parameters[0].Value --output text)
+}
+
+cat << EOF > .env
+BUGZILLA_ADMIN_KEY=$(ssm BUGZILLA_ADMIN_KEY)
+MAIL_URL=smtps://$(ssm SES_SMTP_USERNAME):$(ssm SES_SMTP_PASSWORD)@email-smtp.us-west-2.amazonaws.com:465
+CLOUDINARY_URL=https://api.cloudinary.com/v1_1/unee-t-staging/image/upload
+CLOUDINARY_PRESET=$(ssm CLOUDINARY_PRESET)
+API_ACCESS_TOKEN=$(ssm API_ACCESS_TOKEN)
+FROM_EMAIL="Local Unee-T Case <[email protected]>"
+APIENROLL_LAMBDA_URL=http://localhost:4000
+INVITE_LAMBDA_URL=http://localhost:9000
+UNIT_CREATE_LAMBDA_URL=http://localhost:4001/create
+STAGE=dev
+DOMAIN=unee-t.com
+PDFGEN_LAMBDA_URL=https://pdfgen.dev.unee-t.com
+PDFCONVERT_LAMBDA_URL=https://prince.dev.unee-t.com
+EOF