Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add coverage to ci test command #1453

Merged
merged 4 commits into from
Oct 11, 2024
Merged

ci: add coverage to ci test command #1453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5af8367
ci: add coverage to ci test command
karrui Oct 11, 2024
dd2e0f6
feat(ci): load env with github action, run test:ci script
karrui Oct 11, 2024
f1f9863
fix: add ci as valid dd_env in convict
karrui Oct 11, 2024
ba85db0
feat: use dotenv cli instead of sourcing .env.test
karrui Oct 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 57 additions & 57 deletions .env.test
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,91 +1,91 @@
export CLIENT_ID="i am a client"
export CLIENT_SECRET="i am a secret"
export REDIRECT_URI="http://localhost:8081/v1/auth"
export NODE_ENV="test"
export COOKIE_DOMAIN="localhost"
export AUTH_TOKEN_EXPIRY_DURATION_IN_MILLISECONDS=800000000
export JWT_SECRET="blah"
export ENCRYPTION_SECRET="blah"
export FRONTEND_URL="http://localhost:3000"
export GITHUB_ORG_NAME="isomerpages"
export GITHUB_BUILD_ORG_NAME="opengovsg"
export GITHUB_BUILD_REPO_NAME="isomer-build"
export MUTEX_TABLE_NAME="mutex-table"
export MAX_NUM_OTP_ATTEMPTS=5
export OTP_EXPIRY=900000
export SESSION_SECRET=blahblah
CLIENT_ID="i am a client"
CLIENT_SECRET="i am a secret"
REDIRECT_URI="http://localhost:8081/v1/auth"
NODE_ENV="test"
COOKIE_DOMAIN="localhost"
AUTH_TOKEN_EXPIRY_DURATION_IN_MILLISECONDS=800000000
JWT_SECRET="blah"
ENCRYPTION_SECRET="blah"
FRONTEND_URL="http://localhost:3000"
GITHUB_ORG_NAME="isomerpages"
GITHUB_BUILD_ORG_NAME="opengovsg"
GITHUB_BUILD_REPO_NAME="isomer-build"
MUTEX_TABLE_NAME="mutex-table"
MAX_NUM_OTP_ATTEMPTS=5
OTP_EXPIRY=900000
SESSION_SECRET=blahblah

# GitHub access token to create repo
export SYSTEM_GITHUB_TOKEN="github_token"
SYSTEM_GITHUB_TOKEN="github_token"

# FormSG keys
export SITE_CREATE_FORM_KEY="site_form_key"
export SITE_LAUNCH_FORM_KEY="site_launch_form_key"
export GGS_REPAIR_FORM_KEY="ggs_repair_form_key"
export SITE_CHECKER_FORM_KEY="site_checker_form_key"
export SITE_AUDIT_LOGS_FORM_KEY="site_audit_logs_form_key"
export NOTIFY_SITE_COLLABORATORS_FORM_KEY="notify_site_collaborators_form_key"
SITE_CREATE_FORM_KEY="site_form_key"
SITE_LAUNCH_FORM_KEY="site_launch_form_key"
GGS_REPAIR_FORM_KEY="ggs_repair_form_key"
SITE_CHECKER_FORM_KEY="site_checker_form_key"
SITE_AUDIT_LOGS_FORM_KEY="site_audit_logs_form_key"
NOTIFY_SITE_COLLABORATORS_FORM_KEY="notify_site_collaborators_form_key"

# Required to connect to DynamoDB
export AWS_ACCESS_KEY_ID="abc123"
export AWS_SECRET_ACCESS_KEY="xyz123"
AWS_ACCESS_KEY_ID="abc123"
AWS_SECRET_ACCESS_KEY="xyz123"

# Required to run end-to-end tests
export E2E_TEST_REPO="e2e-test-repo"
export E2E_TEST_SECRET="test"
export E2E_TEST_GH_TOKEN="test"
E2E_TEST_REPO="e2e-test-repo"
E2E_TEST_SECRET="test"
E2E_TEST_GH_TOKEN="test"

# Database
export DB_URI="postgres://isomer:[email protected]:54321/isomercms_test"
export DB_MIN_POOL="1"
export DB_MAX_POOL="10"
export DB_ENABLE_LOGGING="true"
DB_URI="postgres://isomer:[email protected]:54321/isomercms_test"
DB_MIN_POOL="1"
DB_MAX_POOL="10"
DB_ENABLE_LOGGING="true"

export LOCAL_SITE_ACCESS_TOKEN="dummy"
export OTP_SECRET="dummysecret"
LOCAL_SITE_ACCESS_TOKEN="dummy"
OTP_SECRET="dummysecret"

# Email
export POSTMAN_API_KEY="some api key"
POSTMAN_API_KEY="some api key"

# SMS
export POSTMAN_SMS_CRED_NAME="isomer"
POSTMAN_SMS_CRED_NAME="isomer"

# Amplify
export AWS_REGION="ap-southeast-1"
export AWS_ACCOUNT_NUMBER="random"
AWS_REGION="ap-southeast-1"
AWS_ACCOUNT_NUMBER="random"

# DataDog
export DD_ENV="local"
export DD_SERVICE="isomer"
export DD_TAGS="service:isomer"
DD_ENV="ci"
DD_SERVICE="isomer"
DD_TAGS="service:isomer"

# Cloudmersive
export CLOUDMERSIVE_API_KEY="cloudmersive"
CLOUDMERSIVE_API_KEY="cloudmersive"

# GitGuardian
export GITGUARDIAN_API_KEY="gitguardian"
GITGUARDIAN_API_KEY="gitguardian"

# SQS Queue
export INCOMING_QUEUE_URL="incoming"
export OUTGOING_QUEUE_URL="outgoing"
export SITE_LAUNCH_QUEUE_URL="site_launch"
INCOMING_QUEUE_URL="incoming"
OUTGOING_QUEUE_URL="outgoing"
SITE_LAUNCH_QUEUE_URL="site_launch"

# DynamoDB
export SITE_LAUNCH_DYNAMO_DB_TABLE_NAME="ddb-name"
export STEP_FUNCTIONS_ARN="arn:aws:some-arn"
export SITE_PASSWORD_SECRET_KEY="1234567812345678123456781234567812345678123456781234567812345678"
SITE_LAUNCH_DYNAMO_DB_TABLE_NAME="ddb-name"
STEP_FUNCTIONS_ARN="arn:aws:some-arn"
SITE_PASSWORD_SECRET_KEY="1234567812345678123456781234567812345678123456781234567812345678"

export NETLIFY_ACCESS_TOKEN="blahblah"
NETLIFY_ACCESS_TOKEN="blahblah"

# sgID
export SGID_CLIENT_ID="client"
export SGID_CLIENT_SECRET="secret"
export SGID_PRIVATE_KEY="private"
export SGID_REDIRECT_URI="http://localhost:8081/v2/auth/sgid/auth-redirect"
SGID_CLIENT_ID="client"
SGID_CLIENT_SECRET="secret"
SGID_PRIVATE_KEY="private"
SGID_REDIRECT_URI="http://localhost:8081/v2/auth/sgid/auth-redirect"

# GrowthBook
export GROWTHBOOK_CLIENT_KEY="some random key"
GROWTHBOOK_CLIENT_KEY="some random key"

export KEYCDN_API_KEY="secret"
KEYCDN_API_KEY="secret"

export REDIS_HOST="redis"
REDIS_HOST="redis"
6 changes: 5 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ jobs:
key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
- run: npm ci
- run: npm run test:docker
- name: Load .env file
uses: xom9ikk/dotenv@v2
with:
mode: test
# Not using Datadog Test Visibility action since we need to use the local
# (patched) package for it to work with neverthrow
- name: run tests
Expand All @@ -99,7 +103,7 @@ jobs:
DD_SERVICE: isomer
DD_API_KEY: ${{ secrets.DD_API_KEY }}
DD_CIVISIBILITY_AUTO_INSTRUMENTATION_PROVIDER: github
run: . .env.test && npx jest --runInBand
run: npm run test:ci

gatekeep:
name: Determine if Build & Deploy is needed
Expand Down
25 changes: 25 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"start:support:prod": "node --unhandled-rejections=warn -r ts-node/register/transpile-only -r tsconfig-paths/register support/index.ts",
"dev": "source .env && docker compose -f docker-compose.dev.yml up",
"test:docker": "docker run -d -p 54321:5432 --name postgres -e POSTGRES_USER=isomer -e POSTGRES_PASSWORD=password -e POSTGRES_DB=isomercms_test postgres:latest",
"test": "source .env.test && jest --runInBand",
"test": "dotenv -e .env.test jest --runInBand",
"test:ci": "jest --runInBand --coverage",
"release": "bash scripts/release_prep.sh",
"lint": "npx eslint .",
"lint-fix": "eslint --ignore-path .gitignore . --fix",
Expand Down Expand Up @@ -62,6 +63,7 @@
"debug": "~2.6.9",
"dompurify": "^3.1.3",
"dotenv": "^16.4.5",
"dotenv-cli": "^7.4.2",
"eventsource": "^2.0.2",
"exponential-backoff": "^3.1.0",
"express": "~4.19.2",
Expand Down
1 change: 1 addition & 0 deletions src/config/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

convict.addFormat({
name: "required-string",
validate: (val: any) => {

Check warning on line 5 in src/config/config.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected any. Specify a different type
if (!val) throw new Error("value cannot be empty, null or undefined")
if (typeof val !== "string") throw new Error("value must be a string")
},
Expand All @@ -10,14 +10,14 @@

convict.addFormat({
name: "required-positive-number",
validate: (val: any) => {

Check warning on line 13 in src/config/config.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected any. Specify a different type
if (val === null || val === undefined || val === "")
throw new Error("value cannot be empty, null or undefined")
if (typeof val !== "number") throw new Error("value must be a number")
},
coerce: (val: string) => {
const coercedVal = Number(val)
if (isNaN(coercedVal)) {

Check warning on line 20 in src/config/config.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected use of 'isNaN'. Use Number.isNaN instead https://github.com/airbnb/javascript#standard-library--isnan
throw new Error(
"value provided is not a positive number. please provide a valid positive number"
)
Expand All @@ -31,7 +31,7 @@

convict.addFormat({
name: "required-boolean",
validate: (val: any) => {

Check warning on line 34 in src/config/config.ts

View workflow job for this annotation

GitHub Actions / lint 

Unexpected any. Specify a different type
if (val === null || val === undefined)
throw new Error("value cannot be empty, null or undefined")
if (typeof val !== "boolean") throw new Error("value must be a boolean")
Expand Down Expand Up @@ -275,6 +275,7 @@
"prod",
"stg",
"dev",
"ci",
],
env: "DD_ENV",
default: "local",
Expand Down
Loading