@researchdatabox/redbox-dev-tools 0.0.1-beta.9950 → 5.0.0-RC1

package/templates/hook-archetype/standard/support/integration-testing/run-mocha-redbox.sh.hbs

@@ -0,0 +1,100 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+set -o xtrace
+
+cd /opt/redbox-portal
+
+rm -rf /opt/redbox-portal/coverage/mocha/* || true
+rm /opt/redbox-portal/.tmp/junit/backend-mocha/backend-mocha.xml || true
+
+node_cmd=(node)
+
+export TS_NODE_PROJECT=/opt/redbox-portal/tsconfig.json
+export TS_NODE_TRANSPILE_ONLY=true
+export TS_NODE_COMPILER_OPTIONS='{"module":"commonjs","moduleResolution":"node","esModuleInterop":true}'
+
+export RBPORTAL_COVERAGE_DIR=${RBPORTAL_COVERAGE_DIR:-/tmp/coverage/mocha}
+mkdir -p "$RBPORTAL_COVERAGE_DIR"
+chmod 777 "$RBPORTAL_COVERAGE_DIR" || true
+
+export NYC_OUTPUT=${NYC_OUTPUT:-/tmp/nyc_output}
+mkdir -p "$NYC_OUTPUT"
+chmod 777 "$NYC_OUTPUT" || true
+
+test_args=()
+if [[ -n "${RBPORTAL_MOCHA_TEST_PATHS:-}" ]]; then
+  mapfile -t env_test_args <<< "${RBPORTAL_MOCHA_TEST_PATHS}"
+  test_args+=("${env_test_args[@]}")
+fi
+
+if [[ ${#@} -gt 0 ]]; then
+  test_args+=("$@")
+fi
+
+if [[ ${#test_args[@]} -eq 0 ]]; then
+  test_args=(test/integration/**/*.test.ts)
+fi
+
+if [[ ! -x node_modules/.bin/mocha ]] || [[ ! -x node_modules/.bin/nyc ]]; then
+  echo "Test dependencies not found. Running npm install..."
+  npm install
+fi
+
+if [[ ! -f node_modules/redoc/bundles/redoc.standalone.js ]]; then
+  npm install --no-save --ignore-scripts --strict-peer-deps redoc@2.5.2
+fi
+
+npm run webpack
+
+rm -rf node_modules/redoc node_modules/should
+
+echo "Generating shims via redbox-core loader..."
+node -e "
+  const { generateAllShims } = require('@researchdatabox/redbox-core');
+  generateAllShims(process.cwd(), {
+    forceRegenerate: true,
+    verbose: true
+  }).catch(err => {
+    console.error('Shim generation failed:', err);
+    process.exit(1);
+  });
+"
+
+bootstrap_test=test/bootstrap.test.ts
+
+mocha_cmd=(node_modules/.bin/mocha)
+nyc_cmd=(node_modules/.bin/nyc)
+if [[ -n "${RBPORTAL_REMOTE_DEBUG:-}" ]]; then
+  nyc_cmd+=(--inspect="${RBPORTAL_REMOTE_DEBUG}")
+fi
+
+final_args=("${node_cmd[@]}" "${mocha_cmd[@]}")
+
+mocha_config_args=()
+if [[ -f test/integration/.mocharc.js ]]; then
+  mocha_config_args+=(--config test/integration/.mocharc.js)
+else
+  mocha_config_args+=(
+    --require ts-node/register
+    --require chai
+    --extension ts,js
+    --recursive
+    --timeout 30s
+    --ui bdd
+  )
+  if [[ "${CI:-false}" == "true" ]]; then
+    mocha_config_args+=(--reporter mocha-junit-reporter --reporter-option mochaFile=./.tmp/junit/backend-mocha/backend-mocha.xml)
+  else
+    mocha_config_args+=(--reporter spec)
+  fi
+fi
+
+exec "${nyc_cmd[@]}" --no-clean \
+  --temp-dir "$NYC_OUTPUT" \
+  --report-dir "$RBPORTAL_COVERAGE_DIR" \
+  --reporter=lcov --exclude-after-remap=false \
+  "${final_args[@]}" \
+  \
+  "${mocha_config_args[@]}" \
+  --exit "${bootstrap_test}" "${test_args[@]}"

package/templates/hook-archetype/standard/support/prepare-minio.sh.hbs

@@ -0,0 +1,74 @@
+#! /bin/sh
+MINIO_URL="${HOOK_S3_ENDPOINT:-http://minio:9000}"
+MINIO_WAIT_SECONDS="${MINIO_WAIT_SECONDS:-180}"
+
+wait_for_minio() {
+  echo "Waiting for MinIO at ${MINIO_URL}..."
+  for _ in $(seq 1 "${MINIO_WAIT_SECONDS}"); do
+    if curl -fsS "${MINIO_URL}/minio/health/ready" >/dev/null; then
+      return 0
+    fi
+    sleep 1
+  done
+  echo "MinIO did not become ready within ${MINIO_WAIT_SECONDS} seconds." >&2
+  return 1
+}
+
+ensure_mc() {
+  if [ ! -x /tmp/mc ]; then
+    case "$(uname -m)" in
+      x86_64) mc_arch=amd64 ;;
+      aarch64|arm64) mc_arch=arm64 ;;
+      *) echo "Unsupported architecture: $(uname -m)" >&2; return 1 ;;
+    esac
+    curl -fsSL -o /tmp/mc "https://dl.min.io/client/mc/release/linux-${mc_arch}/mc"
+    chmod +x /tmp/mc
+  fi
+}
+
+ensure_alias() {
+  /tmp/mc alias set local "${MINIO_URL}" "${HOOK_S3_ACCESS_KEY}" "${HOOK_S3_SECRET_KEY}" >/dev/null
+}
+
+ensure_bucket() {
+  if /tmp/mc stat "local/${HOOK_S3_BUCKET}" >/dev/null 2>&1; then
+    echo "Attachments bucket exists, skipping creation."
+    return 0
+  fi
+
+  /tmp/mc mb "local/${HOOK_S3_BUCKET}"
+}
+
+ensure_credentials() {
+  CREDS_DIR=/home/node/.aws
+  CREDS_FILE="${CREDS_DIR}/credentials"
+  DESIRED_CREDS_FILE=/tmp/minio-credentials
+
+  cat > "${DESIRED_CREDS_FILE}" <<EOF
+[default]
+aws_access_key_id = ${HOOK_S3_ACCESS_KEY}
+aws_secret_access_key = ${HOOK_S3_SECRET_KEY}
+EOF
+
+  mkdir -p "${CREDS_DIR}"
+
+  if [ -f "${CREDS_FILE}" ] && cmp -s "${CREDS_FILE}" "${DESIRED_CREDS_FILE}"; then
+    echo "Reusing existing credentials file: ${CREDS_FILE}"
+    rm -f "${DESIRED_CREDS_FILE}"
+    return 0
+  fi
+
+  echo "Writing credentials file: ${CREDS_FILE}"
+  mv "${DESIRED_CREDS_FILE}" "${CREDS_FILE}"
+}
+
+if [ -z "${HOOK_S3_BUCKET:-}" ]; then
+  echo "HOOK_S3_BUCKET is not set; skipping MinIO preparation."
+  exit 0
+fi
+
+ensure_mc
+wait_for_minio
+ensure_alias
+ensure_bucket
+ensure_credentials

package/templates/hook-archetype/standard/test/integration/hook-registration.test.ts.hbs

@@ -1,13 +1,15 @@
 const { expect, firstValueFrom } = require('@researchdatabox/redbox-dev-tools/testing');
 
 describe('{{packageName}} integration', function () {
-  it('registers example services and form configs with the lifted portal', async function () {
+  it('registers example services, form configs, config, and migrations with the lifted portal', async function () {
     expect(sails.services.exampleservice).to.exist;
 
     const result = await firstValueFrom(sails.services.exampleservice.describe());
     expect(result).to.deep.equal({ hook: '{{packageName}}', status: 'ready' });
 
     const hookModule = require('{{packageName}}');
+    expect(hookModule.registerRedboxConfig()).to.have.property('brandingConfigurationDefaults');
     expect(hookModule.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+    expect(hookModule.registerRedboxMigrations()).to.deep.equal([]);
   });
 });

package/templates/hook-archetype/standard/test/unit/index.test.ts.hbs

@@ -18,23 +18,29 @@ describe('hook entrypoint', function () {
   });
 
   it('exports the standard hook registrations and aliases', async function () {
-    expect(hookModule.registerRedboxConfig()).to.deep.equal({});
+    const config = hookModule.registerRedboxConfig();
+
+    expect(config).to.have.property('brandingConfigurationDefaults');
+    expect(config).to.have.property('reusableFormDefinitions');
+    expect(config.brandingConfigurationDefaults.menu).to.deep.equal({ items: [], showSearch: true });
+    expect(config.brandingConfigurationDefaults.homePanels).to.deep.equal({ panels: [] });
     expect(hookModule.registerRedboxServices()).to.have.property('ExampleService');
     expect(hookModule.registerRedboxControllers()).to.have.property('ExampleController');
     expect(hookModule.registerRedboxFormConfigs()).to.have.property('generated-view-only');
+    expect(hookModule.registerRedboxMigrations()).to.deep.equal([]);
+    expect(hookModule.MigrationExports).to.equal(hookModule.registerRedboxMigrations());
     expect(hookModule.registerFormConfig()).to.equal(hookModule.registerRedboxFormConfigs());
 
     const result = await firstValueFrom(hookModule.registerRedboxServices().ExampleService.describe());
     expect(result).to.deep.equal({ hook: '{{packageName}}', status: 'ready' });
   });
 
-  it('applies reusable form definitions and branding defaults during configure', function () {
+  it('keeps configure empty while config is provided through registerRedboxConfig', function () {
     const hook = hookModule((global as any).sails);
 
     hook.configure?.();
 
-    expect((global as any).sails.config.brandingConfigurationDefaults.menu).to.deep.equal({ items: [], showSearch: true });
-    expect((global as any).sails.config.brandingConfigurationDefaults.homePanels).to.deep.equal({ panels: [] });
-    expect((global as any).sails.config.reusableFormDefinitions).to.exist;
+    expect((global as any).sails.config.brandingConfigurationDefaults).to.deep.equal({});
+    expect((global as any).sails.config.reusableFormDefinitions).to.deep.equal({});
   });
 });

package/templates/hook-archetype/standard/views/default/.gitkeep

@@ -0,0 +1 @@
+