@freshworks/shiftleft-tools 1.1.8

package/templates/postman-node/README.md.ejs

@@ -0,0 +1,26 @@
+# <%= serviceDisplayName %> — Postman API Tests
+
+Node.js/Express integration tests using Newman. Config-driven via `config/local.json` and `config/staging.json`.
+
+## Quick start
+
+```bash
+cd postman && npm ci --ignore-scripts
+cd scripts && ./runners/run-tests.sh local
+```
+
+## Full pipeline (unit + mutation + Postman + coverage + report)
+
+```bash
+cd postman/scripts && ./run-all.sh
+```
+
+## Structure
+
+- `collections/crud/` — numbered Newman collections (bootstrap first, cleanup last)
+- `config/` — environment-specific setup (DB, app, auth)
+- `scripts/runners/run-tests.sh` — unified local/staging runner
+- `scripts/setup-mocks.js` — nock stubs (load when `NODE_ENV=integration-tests`)
+- `mocks/` — per-service nock definitions
+
+Reference implementation: `freshapps_api_node`

package/templates/postman-node/collections/crud/01-bootstrap.json.ejs

@@ -0,0 +1,34 @@
+{
+  "info": {
+    "name": "01-bootstrap",
+    "description": "Bootstrap collection — runs first. Sets shared env vars for later collections.",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "item": [
+    {
+      "name": "Health - GET /health",
+      "request": {
+        "method": "GET",
+        "header": [],
+        "url": {
+          "raw": "{{base_url}}/health",
+          "host": ["{{base_url}}"],
+          "path": ["health"]
+        }
+      },
+      "event": [
+        {
+          "listen": "test",
+          "script": {
+            "exec": [
+              "pm.test('Status is 200', function () {",
+              "    pm.response.to.have.status(200);",
+              "});"
+            ],
+            "type": "text/javascript"
+          }
+        }
+      ]
+    }
+  ]
+}

package/templates/postman-node/config/local.json.ejs

@@ -0,0 +1,46 @@
+{
+  "comment": "Local environment configuration for <%= serviceName %> Postman tests",
+  "environment": "local",
+  "api_url": "http://localhost:4013",
+  "setup": {
+    "database": {
+      "enabled": false,
+      "type": "docker",
+      "container_name": "<%= serviceNameLower %>-test-mysql",
+      "port": 3309,
+      "host": "127.0.0.1",
+      "user": "testuser",
+      "password": "testpass",
+      "database": "<%= serviceNameLower %>"
+    },
+    "app": {
+      "enabled": true,
+      "port": 4013,
+      "node_env": "integration-tests",
+      "env_file": "postman/local.test.env",
+      "start_command": "yarn start"
+    },
+    "migrations": {
+      "enabled": false
+    }
+  },
+  "auth": {
+    "type": "local",
+    "jwt": {
+      "secret": "change-me-local-jwt-secret",
+      "issuer": "<%= serviceNameLower %>_automation",
+      "account_id": "102",
+      "product": "freshdesk",
+      "expiry": "3600",
+      "users": {
+        "developer": {
+          "user_id": "1001",
+          "user_role": "developer",
+          "user_email": "developer@example.com",
+          "user_name": "Developer User"
+        }
+      }
+    }
+  },
+  "test_data": {}
+}

package/templates/postman-node/config/staging.json.ejs

@@ -0,0 +1,31 @@
+{
+  "comment": "Staging environment configuration for <%= serviceName %> Postman tests",
+  "environment": "staging",
+  "api_url": "https://staging.example.com",
+  "setup": {
+    "database": { "enabled": false },
+    "app": { "enabled": false },
+    "migrations": { "enabled": false }
+  },
+  "auth": {
+    "type": "aws",
+    "aws": {
+      "secret_name": "staging_stack_secrets",
+      "account_id": "000000000000",
+      "region": "us-west-2"
+    },
+    "jwt": {
+      "issuer": "<%= serviceNameLower %>_automation",
+      "product": "freshdesk",
+      "expiry": "3600",
+      "users": {
+        "developer": {
+          "user_id": "1001",
+          "user_role": "developer",
+          "user_email": "developer@example.com",
+          "user_name": "Developer User"
+        }
+      }
+    }
+  }
+}

package/templates/postman-node/local.test.env.ejs

@@ -0,0 +1,3 @@
+NODE_ENV=integration-tests
+PORT=4013
+LOG_LEVEL=error

package/templates/postman-node/mocks/external.js

@@ -0,0 +1,14 @@
+'use strict';
+
+/**
+ * Example external HTTP stubs. Add one file per external dependency.
+ */
+function setupExternalMocks(nock) {
+  // Replace with your service's external domains
+  nock('https://api.example.com')
+    .persist()
+    .get(/.*/)
+    .reply(200, { success: true });
+}
+
+module.exports = { setupExternalMocks };

package/templates/postman-node/package.json.ejs

@@ -0,0 +1,39 @@
+{
+  "name": "<%= serviceName %>-postman-tests",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Postman API tests for <%= serviceName %>",
+  "scripts": {
+    "prepare": "cd .. && husky postman/.husky",
+    "test:local": "./scripts/runners/run-tests.sh local",<% if (includeStaging) { %>
+    "test:staging": "./scripts/runners/run-tests.sh staging",<% } %>
+    "report:consolidated": "./scripts/report-generators/generate-consolidated-report.sh",
+    "audit": "npm audit --audit-level=high",
+    "audit:signatures": "npm audit signatures",
+    "security:check": "npm run audit && npm run audit:signatures",
+    "format": "prettier --write '**/*.json' '!node_modules/**'",
+    "format:check": "prettier --check '**/*.json' '!node_modules/**'"
+  },
+  "dependencies": {
+    "jsonwebtoken": "9.0.2",
+    "newman": "6.2.2",
+    "newman-reporter-htmlextra": "1.23.1",
+    "nock": "13.5.6"
+  },
+  "devDependencies": {
+    "aws-sdk-mock": "6.2.1",
+    "husky": "9.1.7",
+    "prettier": "3.4.2"
+  },
+  "overrides": {
+    "tunnel-agent": "0.6.0",
+    "tough-cookie": "4.1.3",
+    "semver": "7.5.4"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.4.0"
+  },
+  "keywords": ["postman", "api-testing", "newman", "<%= serviceName %>"],
+  "license": "UNLICENSED"
+}

package/templates/postman-node/requirements.txt

@@ -0,0 +1 @@
+defusedxml>=0.7.1

package/templates/postman-node/scripts/database/cleanup-mysql.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Cleanup MySQL container
+
+CONTAINER_NAME="${MYSQL_CONTAINER_NAME:-integration-test-mysql}"
+
+echo "Cleaning up MySQL container..."
+
+if podman rm -f "$CONTAINER_NAME" 2>/dev/null; then
+  echo "MySQL container '$CONTAINER_NAME' removed"
+else
+  echo "No container to remove (already cleaned up)"
+fi

package/templates/postman-node/scripts/database/run-migrations.js

@@ -0,0 +1,29 @@
+'use strict';
+
+/**
+ * Database migration stub for local Postman integration tests.
+ *
+ * Customize this for your ORM (Sequelize, Knex, TypeORM, etc.) or disable
+ * migrations in postman/config/local.json: setup.migrations.enabled = false
+ *
+ * Reference implementation: freshapps_api_node/postman/scripts/database/run-migrations.js
+ */
+
+const path = require('path');
+
+// eslint-disable-next-line no-unused-vars
+const PROJECT_ROOT = path.resolve(__dirname, '../../..');
+
+async function runMigrations() {
+  console.log('[run-migrations] No migrations configured — customize postman/scripts/database/run-migrations.js');
+  console.log('[run-migrations] Or set setup.migrations.enabled to false in postman/config/local.json');
+}
+
+if (require.main === module) {
+  runMigrations().catch((err) => {
+    console.error(err);
+    process.exit(1);
+  });
+}
+
+module.exports = { runMigrations };

package/templates/postman-node/scripts/database/start-mysql.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+# Start ephemeral MySQL container for integration tests
+
+set -e
+
+CONTAINER_NAME="${MYSQL_CONTAINER_NAME:-integration-test-mysql}"
+MYSQL_PORT="${MYSQL_PORT:-3309}"
+MYSQL_ROOT_PASSWORD="${MYSQL_ROOT_PASSWORD:-testpass}"
+MYSQL_DATABASE="${MYSQL_DATABASE:-freshapps}"
+MYSQL_USER="${MYSQL_USER:-testuser}"
+MYSQL_PASSWORD="${MYSQL_PASSWORD:-testpass}"
+
+echo "Starting MySQL container..."
+echo "  Container: $CONTAINER_NAME"
+echo "  Port: $MYSQL_PORT"
+echo "  Database: $MYSQL_DATABASE"
+
+# Remove existing container if it exists
+podman rm -f "$CONTAINER_NAME" 2>/dev/null || true
+
+# Start MySQL container
+podman run -d \
+  --name "$CONTAINER_NAME" \
+  -e MYSQL_ROOT_PASSWORD="$MYSQL_ROOT_PASSWORD" \
+  -e MYSQL_DATABASE="$MYSQL_DATABASE" \
+  -e MYSQL_USER="$MYSQL_USER" \
+  -e MYSQL_PASSWORD="$MYSQL_PASSWORD" \
+  -p "$MYSQL_PORT:3306" \
+  mysql:8.0 \
+  --default-authentication-plugin=mysql_native_password \
+  --character-set-server=utf8mb4 \
+  --collation-server=utf8mb4_unicode_ci
+
+echo "MySQL container started"

package/templates/postman-node/scripts/database/wait-for-mysql.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+# Wait for MySQL to be ready and grant permissions
+
+set -e
+
+CONTAINER_NAME="${MYSQL_CONTAINER_NAME:-integration-test-mysql}"
+MYSQL_ROOT_PASSWORD="${MYSQL_ROOT_PASSWORD:-testpass}"
+MYSQL_USER="${MYSQL_USER:-testuser}"
+MAX_WAIT="${MAX_WAIT:-20}"
+INTERVAL=2
+
+echo "Waiting for MySQL to be ready (max ${MAX_WAIT}s)..."
+
+elapsed=0
+while [ $elapsed -lt $MAX_WAIT ]; do
+  if podman exec "$CONTAINER_NAME" mysqladmin ping -h localhost --silent 2>/dev/null; then
+    echo "MySQL is ready! (took ${elapsed}s)"
+    
+    # Grant full privileges to testuser for creating and managing databases
+    echo "Granting privileges to ${MYSQL_USER}..."
+    podman exec "$CONTAINER_NAME" mysql -uroot -p"${MYSQL_ROOT_PASSWORD}" -e "
+      GRANT ALL PRIVILEGES ON *.* TO '${MYSQL_USER}'@'%' WITH GRANT OPTION;
+      FLUSH PRIVILEGES;
+    " 2>/dev/null || echo "Warning: Could not grant privileges (may already be set)"
+    
+    echo "Database user configured successfully"
+    exit 0
+  fi
+  
+  sleep $INTERVAL
+  elapsed=$((elapsed + INTERVAL))
+  echo "  Waiting... (${elapsed}s)"
+done
+
+echo "ERROR: MySQL did not become ready within ${MAX_WAIT}s"
+exit 1