Merge pull request #30 from bcgov/SSOTEAM-2795

chore: document local env

Author: thegentlemanphysicist

.bin/db-setup.sh

@@ -8,7 +8,7 @@ NODE_ENV=development
 APP_URL=http://localhost:8080
 LOG_LEVEL=info
 COOKIE_SECRETS="s3cr3t1,s3cr3t1,s3cr3t2"
-JWKS=
+JWKS={"json string generated by the jwks-generator"}
 CORS_ORIGINS=*
 HASH_SALT=
 AWS_REGION=ca-central-1

.env.example

@@ -0,0 +1,13 @@
+SHELL := /usr/bin/env bash
+
+.PHONY: test_db
+test_db:
+	pg_ctl start
+	createdb -U postgres runner || true
+	@cd .bin; chmod +x ./db-setup.sh
+	psql -U postgres -c 'drop database if exists otp_test';
+	@cd .bin; ./db-setup.sh otp_test
+
+.PHONY: unit_test
+unit_test:
+	yarn test

Makefile

@@ -59,11 +59,13 @@ OTP Provider -> Authenticates user via email-based OTP and returns identity asse
 ### Steps
 
 1. Create `.env` from `.env.example` and update all the values
-2. Run `yarn` to install all the dependencies
-3. Run `yarn dev` to start a local server
-4. Run `yarn build` to create a javascript bundle for production deployment
-5. Run `yarn start` to run the javascript bundle
-6. Run `yarn tailwind` to compile the css (will hot reload)
+2. Generate a local `JWKS={}` env variable for the `.env` file using the the script in the [./jwks-generator](./jwks-generator/) folder.
+3. Run `yarn` to install all the dependencies
+4. Run `yarn tailwind` on first build of project otherwise yarn build will fail due to missing css files.
+5. Run `yarn dev` to start a local server
+6. Run `yarn build` to create a javascript bundle for production deployment
+7. Run `yarn start` to run the javascript bundle
+8. Run `yarn tailwind` to compile the css (will hot reload)
 
 ## AWS Simple Email Service
 
@@ -84,6 +86,16 @@ OTP Provider -> Authenticates user via email-based OTP and returns identity asse
 
 The app runs locally using tsup to compile the server and client files into the `build` directory. To recompile the css on the fly, run `yarn tailwind` in another terminal.
 
+## Local Unit tests
+
+The local tests are built and run using:
+
+`make test_db`
+
+and
+
+`make unit_test`
+
 ## Test Data
 
 - Given the application and database are up and database migration is successfully complete, run below SQL to add a client for testing purposes.
@@ -141,7 +153,7 @@ End to end testing is done with playwright. As prerequisite the end-to-end tests
 
 - `psql -c 'create database otp_test'`;
 - `yarn build && DB_NAME=otp_test node build/migrate.js`
-- `psql -d otp_test -f e2e/seed.sql`
+- `psql -U postgres -d otp_test -f e2e/seed.sql`
 
 This is only needed the first time to initialize the db. To run the tests run `yarn test:e2e`
 

README.md

@@ -0,0 +1,11 @@
+This javascript snippet allows a user to generate the JWKS json environment variable.
+
+Run two commands
+
+`yarn install`
+
+and
+
+`node jwks-generator.js `
+
+To generate the JWKS env variable for a local otp server. This environment variable is not wrapped in quotes in the .en file. **Note: the local server requires the private keys to run**

jwks-generator/Readme.md

@@ -0,0 +1,14 @@
+const jose = require('node-jose');
+
+async function createKeystore() {
+  const keystore = jose.JWK.createKeyStore();
+
+  // Generate a new RSA key
+  await keystore.generate('RSA', 2048, { alg: 'RS256', use: 'sig' });
+
+  // Export the public key set (pass 'false' to exclude private keys)
+  const jwks = keystore.toJSON(true);
+  console.log(JSON.stringify(jwks, null, 2).replace(/[\r\n]+/g, ' '));
+}
+
+createKeystore();

jwks-generator/jwks-generator.js

@@ -0,0 +1,16 @@
+{
+  "name": "otp-stuff",
+  "version": "1.0.0",
+  "description": "",
+  "main": "jwks-generator.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "jose": "^6.2.2",
+    "node-jose": "^2.2.0"
+  }
+}