@team-codeme/crud-forge 0.0.0-stage → 1.0.0

package/test-files/GDL/example.gdl

@@ -0,0 +1,15 @@
+model Book {
+  title String required
+  description TextBlob
+  publicationDate LocalDate
+  price BigDecimal
+}
+
+model Author {
+  firstName String required
+  lastName String required
+}
+
+relations {
+  Author has_many Book
+}

package/test-files/JDL/example.jdl

@@ -0,0 +1,15 @@
+entity Book {
+  title String required
+  description TextBlob
+  publicationDate LocalDate
+  price BigDecimal
+}
+
+entity Author {
+  firstName String required
+  lastName String required
+}
+
+relationship OneToMany {
+  Author{book} to Book{author}
+}

package/test-files/config/crudforge.config.yml

@@ -0,0 +1,127 @@
+# CRUDForge CLI Configuration
+project:
+  name: CRUDForge App
+  description: Angular Material CRUD generated by CRUDForge
+
+input:
+  file: ""
+  type: "jdl"
+
+output:
+  directory: "./generated-app"
+  structure: "entity-folder"
+
+preset: "crud"
+dryRun: false
+validation: true
+
+branding:
+  banner: true
+  bannerColor: "green"
+
+fuse:
+  enabled: true
+  routesFile: "src/app/domains/admin/routes.ts"
+  navigationFile: "src/app/domains/admin/layout/data/navigation.ts"
+  cleanLayout: false
+  includePrebuilt: false
+  folderType: ""
+  theme:
+    scheme: "system"
+    primary: "#1565C0"
+    error: "#dc2626"
+
+generate:
+  models: true
+  services: true
+  formServices: true
+  routes: true
+  enums: true
+  relationships: true
+  components:
+    list: true
+    card: true
+    detail: true
+  forms:
+    form: true
+    formPage: true
+    update: true
+    validators: true
+    mappers: true
+  interaction:
+    actions: true
+    filter: true
+  globals:
+    constants: true
+    tests: false
+    sharedAssets: true
+  registrations:
+    navigation: true
+    routes: true
+
+ui:
+  framework: "material"
+  useSkeletonLoading: true
+  snackbarPositionTop: false
+  viewMode: "card"
+  formMode: "sidebar"
+  searchMode: "field"
+  cardBreakpointPx: 640
+  gridCols:
+    mobile: 1
+    tablet: 2
+    desktop: 4
+  styling:
+    snackbarSuccessColor: "#16a34a"
+    snackbarErrorColor: "#dc2626"
+
+api:
+  baseUrl: "/api"
+  microservice: ""
+  endpointStyle: "kebab-plural"
+  dateLibrary: "dayjs"
+  responseType: "http-response"
+
+fields:
+  audit:
+    enabled: true
+    hideInForms: true
+    hideInLists: true
+    showInDetail: true
+    names:
+      - createdBy
+      - createdDate
+      - lastModifiedBy
+      - lastModifiedDate
+  technical:
+    enabled: true
+    names:
+      - debug
+      - refType
+      - refId
+  formatting:
+    dateMediumFormat: "medium"
+    numberFormat: "1.0-2"
+    stringCase: "default"
+
+formBehavior:
+  uppercaseInputs: true
+  updateOn: "change"
+  showErrorMessages: true
+  autoFocusFirstInput: true
+
+mock:
+  enabled: true
+  recordsPerEntity: 100
+  values:
+    stringPrefix: "Mock "
+    numberMin: 1
+    numberMax: 1000
+    booleanDefault: true
+
+namingConventions:
+  entityPrefix: ""
+  entitySuffix: ""
+  modelInterfacePrefix: "I"
+  kebabCaseFiles: true
+  enumValueCasing: "uppercase"

package/test-run.sh

@@ -0,0 +1,272 @@
+#!/usr/bin/env bash
+# test-run.sh — run CRUDForge generator QA from any working directory.
+# Modes: mock (default) | live | generate
+#
+# One generated Fuse app under CRUDFORGE_TESTING_AREA (created if missing):
+#   crudforge-app/
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+cd "$ROOT"
+
+MODE="${1:-${CRUDFORGE_QA_MODE:-mock}}"
+ENV_FILE="${CRUDFORGE_ENV_FILE:-$ROOT/.env.qa}"
+LIVE_PREFS="$ROOT/e2e/crudforge.iam-live.yml"
+
+# Default external QA sandbox (outside the generator repo). Override with CRUDFORGE_TESTING_AREA.
+DEFAULT_TESTING_AREA="/Users/abdulla/Work/CRUD-FORDGE-SETUP/crud-fordge-testing-area"
+TESTING_AREA="${CRUDFORGE_TESTING_AREA:-$DEFAULT_TESTING_AREA}"
+APP_NAME="${CRUDFORGE_E2E_APP_NAME:-crudforge-app}"
+
+# ---------------------------------------------------------------------------
+# Real Keycloak Admin Service (middleware) — hardcoded for live / generate.
+# Keep in sync with e2e/crudforge.iam-live.yml + scripts/e2e-prepare-iam-live.js
+# Docs: http://62.84.188.166:31740/  |  operator: crud / crud  |  client: crudforge-client-QA
+# Do not proxy to native Keycloak :30080 — middleware fronts /realms + /api/v1.
+# ---------------------------------------------------------------------------
+QA_KC_ADMIN_SERVICE_URL="http://62.84.188.166:31740"
+QA_KC_SERVER_URL="$QA_KC_ADMIN_SERVICE_URL"
+QA_KC_REALM="CRUD-FORDGE"
+QA_KC_CLIENT_ID="crudforge-client-QA"
+QA_KC_FORWARDED_PROTO="https"
+QA_KC_OPERATOR_USER="crud"
+QA_KC_OPERATOR_PASS="crud"
+
+if [[ -f "$ENV_FILE" ]]; then
+  echo "🔵 Loading env from $ENV_FILE"
+  set -a
+  # shellcheck disable=SC1090
+  source "$ENV_FILE"
+  set +a
+fi
+
+# Re-resolve after env file (caller / .env.qa may override paths only)
+TESTING_AREA="${CRUDFORGE_TESTING_AREA:-$TESTING_AREA}"
+APP_NAME="${CRUDFORGE_E2E_APP_NAME:-$APP_NAME}"
+export CRUDFORGE_TESTING_AREA="$TESTING_AREA"
+export CRUDFORGE_E2E_APP_DIR="${CRUDFORGE_E2E_APP_DIR:-$TESTING_AREA/$APP_NAME}"
+# Back-compat aliases — all point at the single app root
+export CRUDFORGE_E2E_IAM_APP_DIR="${CRUDFORGE_E2E_IAM_APP_DIR:-$CRUDFORGE_E2E_APP_DIR}"
+export CRUDFORGE_E2E_IAM_LIVE_APP_DIR="${CRUDFORGE_E2E_IAM_LIVE_APP_DIR:-$CRUDFORGE_E2E_APP_DIR}"
+export CRUDFORGE_LIVE_OUTPUT_DIR="${CRUDFORGE_LIVE_OUTPUT_DIR:-$CRUDFORGE_E2E_APP_DIR}"
+
+# Prefer the host Playwright browser install over sandbox cache stubs.
+unset PLAYWRIGHT_BROWSERS_PATH
+
+pin_live_keycloak() {
+  # Always win over .env.qa for the real QA Keycloak endpoints + operator.
+  export CRUDFORGE_KC_SERVER_URL="$QA_KC_SERVER_URL"
+  export CRUDFORGE_KC_REALM="$QA_KC_REALM"
+  export CRUDFORGE_KC_CLIENT_ID="$QA_KC_CLIENT_ID"
+  export CRUDFORGE_KC_ADMIN_SERVICE_URL="$QA_KC_ADMIN_SERVICE_URL"
+  export CRUDFORGE_KC_FORWARDED_PROTO="$QA_KC_FORWARDED_PROTO"
+  export KEYCLOAK_ADMIN_USERNAME="$QA_KC_OPERATOR_USER"
+  export KEYCLOAK_ADMIN_PASSWORD="$QA_KC_OPERATOR_PASS"
+}
+
+assert_live_wiring() {
+  local app="$1"
+  local proxy="$app/proxy.conf.json"
+  local proxy_dev="$app/proxy.dev.conf.json"
+  local envf="$app/src/environments/environment.ts"
+  local signin="$app/src/app/domains/auth/features/sign-in/sign-in.ts"
+
+  echo "🔎 Asserting LIVE Keycloak wiring in $app"
+  for f in "$proxy" "$proxy_dev" "$envf" "$signin"; do
+    if [[ ! -f "$f" ]]; then
+      echo "❌ Missing required file: $f"
+      exit 1
+    fi
+  done
+
+  node - "$proxy" "$proxy_dev" "$envf" "$signin" "$QA_KC_ADMIN_SERVICE_URL" "$QA_KC_CLIENT_ID" "$QA_KC_REALM" <<'NODE'
+const fs = require('fs');
+const [proxyPath, proxyDevPath, envPath, signInPath, adminServiceUrl, clientId, realm] = process.argv.slice(2);
+const admin = adminServiceUrl.replace(/\/+$/, '');
+
+function checkProxy(file, label) {
+  const p = JSON.parse(fs.readFileSync(file, 'utf8'));
+  const realms = p['/realms'];
+  const kcAdmin = p['/services/keycloak-admin'];
+  if (!realms || realms.target !== admin) {
+    throw new Error(`${label}: /realms must target middleware ${admin} (not Keycloak :30080)`);
+  }
+  if (p['/admin/realms']) {
+    throw new Error(`${label}: must not proxy /admin/realms (use Keycloak Admin Service /api/v1)`);
+  }
+  if (!kcAdmin || kcAdmin.target !== admin) {
+    throw new Error(`${label}: /services/keycloak-admin must target ${admin}`);
+  }
+  if (/"password"|clientSecret|KEYCLOAK_ADMIN_PASSWORD/i.test(JSON.stringify(p))) {
+    throw new Error(`${label}: proxy must not contain credentials`);
+  }
+  if (String(JSON.stringify(p)).includes(':30080')) {
+    throw new Error(`${label}: must not reference Keycloak :30080`);
+  }
+}
+
+checkProxy(proxyPath, 'proxy.conf.json');
+checkProxy(proxyDevPath, 'proxy.dev.conf.json');
+
+const env = fs.readFileSync(envPath, 'utf8');
+const required = [
+  `kcRealm: '${realm}'`,
+  `kcClientId: '${clientId}'`,
+  `kcServerUrl: '${admin}'`,
+  `useMockAuth: false`,
+  `sso: '/realms/${realm}/protocol/openid-connect/token'`,
+  `kcAdminServiceUrl: '/services/keycloak-admin'`,
+  `useKeycloakAdminService: true`,
+];
+for (const needle of required) {
+  if (!env.includes(needle)) {
+    throw new Error(`environment.ts missing: ${needle}`);
+  }
+}
+if (/PASSWORD|clientSecret|KEYCLOAK_ADMIN_PASSWORD|:30080/i.test(env)) {
+  throw new Error('environment.ts must not embed secrets or Keycloak :30080');
+}
+
+const signIn = fs.readFileSync(signInPath, 'utf8');
+if (!signIn.includes("email: 'crud'") || !signIn.includes("password: 'crud'")) {
+  throw new Error("sign-in.ts must prefill email/password with crud / crud");
+}
+
+console.log('✅ proxy → Keycloak Admin Service :31740 (/realms + /services/keycloak-admin)');
+console.log('✅ environment.ts → live middleware links (no secrets, no :30080)');
+console.log('✅ sign-in.ts → crud / crud form bind');
+NODE
+}
+
+is_unsafe_output() {
+  local target="$1"
+  case "$target" in
+    /|/Users|/home|/etc|/var|/usr|"$HOME") return 0 ;;
+  esac
+  if [[ "$target" == "$ROOT" ]]; then
+    return 0
+  fi
+  if [[ ${#target} -lt 8 ]]; then
+    return 0
+  fi
+  return 1
+}
+
+ensure_testing_area() {
+  if is_unsafe_output "$TESTING_AREA"; then
+    echo "❌ Refusing unsafe CRUDFORGE_TESTING_AREA: $TESTING_AREA"
+    exit 1
+  fi
+  mkdir -p "$TESTING_AREA"
+  echo "🔵 Testing area: $TESTING_AREA"
+  echo "🔵 Single Fuse app: $CRUDFORGE_E2E_APP_DIR"
+}
+
+run_mock() {
+  echo "▶️  MOCK mode: generator tests + Playwright (one Fuse app; no remote Keycloak mutations)"
+  ensure_testing_area
+  node test/verify.js
+  npm run e2e:prepare
+  npm run test:e2e
+  npm run e2e:prepare:iam
+  npm run test:e2e:iam
+  # Shared testing-area app must end on LIVE Keycloak wiring (proxy + environment + crud/crud form).
+  # Otherwise a plain `./test-run.sh` leaves mock IAM and wipes /realms + admin-service proxies.
+  pin_live_keycloak
+  npm run e2e:prepare:iam:live
+  assert_live_wiring "$CRUDFORGE_E2E_APP_DIR"
+  echo "✅ MOCK QA finished; testing-area left on LIVE Keycloak (app: $CRUDFORGE_E2E_APP_DIR)"
+}
+
+run_live() {
+  echo "▶️  LIVE mode: bootstrap real Keycloak, regenerate same Fuse app, build, Playwright"
+  ensure_testing_area
+  pin_live_keycloak
+
+  if [[ -z "${CRUDFORGE_QA_ADMIN_PASSWORD:-}" || -z "${CRUDFORGE_QA_USER_PASSWORD:-}" ]]; then
+    echo "❌ LIVE mode still needs CRUDFORGE_QA_ADMIN_PASSWORD and CRUDFORGE_QA_USER_PASSWORD for seeded app users."
+    echo "   Copy .env.qa.example to .env.qa (gitignored) for those only."
+    exit 1
+  fi
+
+  echo "🔵 Keycloak server     : ${CRUDFORGE_KC_SERVER_URL}"
+  echo "🔵 Realm               : ${CRUDFORGE_KC_REALM}"
+  echo "🔵 App client ID       : ${CRUDFORGE_KC_CLIENT_ID}"
+  echo "🔵 Middleware service  : ${CRUDFORGE_KC_ADMIN_SERVICE_URL}"
+  echo "🔵 Operator (bootstrap): ${KEYCLOAK_ADMIN_USERNAME} / ****"
+  echo "🔵 SPA sign-in prefill : ${QA_KC_OPERATOR_USER} / ${QA_KC_OPERATOR_PASS}"
+  echo "🔵 Preferences         : ${LIVE_PREFS}"
+
+  if [[ -f "$ENV_FILE" ]]; then
+    node cli.js bootstrap --preferences "$LIVE_PREFS" --env-file "$ENV_FILE"
+    node cli.js bootstrap --preferences "$LIVE_PREFS" --env-file "$ENV_FILE"
+  else
+    node cli.js bootstrap --preferences "$LIVE_PREFS"
+    node cli.js bootstrap --preferences "$LIVE_PREFS"
+  fi
+  echo "🔵 Second bootstrap completed (idempotency)."
+
+  npm run e2e:prepare:iam:live
+
+  local live_app="$CRUDFORGE_E2E_APP_DIR"
+  if [[ ! -d "$live_app" ]]; then
+    echo "❌ Live app was not generated at $live_app"
+    exit 1
+  fi
+  assert_live_wiring "$live_app"
+  if [[ -x "$live_app/node_modules/.bin/tsc" ]]; then
+    "$live_app/node_modules/.bin/tsc" -p "$live_app/tsconfig.app.json" --noEmit
+  elif [[ -x "$ROOT/e2e/.app/node_modules/.bin/tsc" ]]; then
+    "$ROOT/e2e/.app/node_modules/.bin/tsc" -p "$live_app/tsconfig.app.json" --noEmit
+  else
+    echo "⚠️ TypeScript compiler not found in the generated app; skipping tsc (ng serve will still typecheck)."
+  fi
+
+  npm run test:e2e:iam:live
+  echo "✅ LIVE QA finished (app: $CRUDFORGE_E2E_APP_DIR)"
+  echo "   Manual serve: npm run e2e:serve:iam:live  →  http://127.0.0.1:4202  (sign-in: ${QA_KC_OPERATOR_USER} / ${QA_KC_OPERATOR_PASS})"
+  echo "   Do not use port 4300 production serve for live Keycloak unless proxy targets Admin Service :31740."
+}
+
+run_generate_only() {
+  ensure_testing_area
+  pin_live_keycloak
+  local output="${CRUDFORGE_LIVE_OUTPUT_DIR}"
+  mkdir -p "$(dirname "$output")"
+  output="$(cd "$(dirname "$output")" && pwd)/$(basename "$output")"
+  if is_unsafe_output "$output"; then
+    echo "❌ Refusing to write unsafe output directory: $output"
+    exit 1
+  fi
+  echo "▶️  Generate-only (live Keycloak prefs) into $output"
+  echo "🔵 Keycloak: ${CRUDFORGE_KC_SERVER_URL} realm=${CRUDFORGE_KC_REALM} client=${CRUDFORGE_KC_CLIENT_ID}"
+  node cli.js generate "$ROOT/test/fixtures/mock.jdl" "$output" \
+    --preferences "$LIVE_PREFS" \
+    --fuse --clean-layout -m test-service \
+    --keycloak \
+    --kc-server-url "$CRUDFORGE_KC_SERVER_URL" \
+    --kc-realm "$CRUDFORGE_KC_REALM" \
+    --kc-client-id "$CRUDFORGE_KC_CLIENT_ID" \
+    --kc-admin-service-url "$CRUDFORGE_KC_ADMIN_SERVICE_URL"
+}
+
+case "$MODE" in
+  mock) run_mock ;;
+  live) run_live ;;
+  generate) run_generate_only ;;
+  *)
+    echo "Usage: $0 [mock|live|generate]"
+    echo "  mock     generator verify + CRUD e2e + mock IAM e2e (default)"
+    echo "  live     bootstrap real Keycloak, regenerate same app, tsc, live Playwright"
+    echo "  generate generate into CRUDFORGE_LIVE_OUTPUT_DIR (live Keycloak prefs, no bootstrap)"
+    echo ""
+    echo "Testing area (created if missing):"
+    echo "  CRUDFORGE_TESTING_AREA=${DEFAULT_TESTING_AREA}"
+    echo "  Single app folder: \$CRUDFORGE_TESTING_AREA/${APP_NAME}"
+    echo ""
+    echo "Keycloak Admin Service QA (live/generate):"
+    echo "  ${QA_KC_ADMIN_SERVICE_URL}  realm=${QA_KC_REALM}  client=${QA_KC_CLIENT_ID}"
+    echo "  operator ${QA_KC_OPERATOR_USER}/${QA_KC_OPERATOR_PASS}  (no native :30080 proxies)"
+    exit 1
+    ;;
+esac