@1aboveio/skills 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -2
- package/bin/cli.mjs +14 -0
- package/bin/select-core.mjs +172 -0
- package/package.json +146 -4
- package/skills/app-dev/airflow/LICENSE +3 -0
- package/skills/app-dev/airflow/SKILL.md +199 -0
- package/skills/app-dev/airflow/release-check.mjs +93 -0
- package/skills/app-dev/android-foundation/LICENSE +3 -0
- package/skills/app-dev/android-foundation/SKILL.md +192 -0
- package/skills/app-dev/android-foundation/assets/android-ci-job.yml +217 -0
- package/skills/app-dev/android-foundation/references/ci.md +87 -0
- package/skills/app-dev/android-foundation/references/gotchas.md +221 -0
- package/skills/app-dev/android-foundation/references/setup.md +164 -0
- package/skills/app-dev/android-foundation/release-check.mjs +93 -0
- package/skills/app-dev/android-foundation/scripts/device-run.sh +176 -0
- package/skills/app-dev/android-foundation/scripts/device-run.test.mjs +172 -0
- package/skills/app-dev/app-debug/LICENSE +3 -0
- package/skills/app-dev/app-debug/SKILL.md +110 -0
- package/skills/app-dev/app-debug/references/common-errors.md +128 -0
- package/skills/app-dev/app-debug/release-check.mjs +93 -0
- package/skills/app-dev/better-auth/LICENSE +3 -0
- package/skills/app-dev/better-auth/SKILL.md +598 -0
- package/skills/app-dev/better-auth/references/feishu-api.md +270 -0
- package/skills/app-dev/better-auth/release-check.mjs +93 -0
- package/skills/app-dev/data-catalog/LICENSE +3 -0
- package/skills/app-dev/data-catalog/SKILL.md +204 -0
- package/skills/app-dev/data-catalog/agents/openai.yaml +3 -0
- package/skills/app-dev/data-catalog/references/data-catalog-conventions.md +75 -0
- package/skills/app-dev/data-catalog/references/field-definitions.md +116 -0
- package/skills/app-dev/data-catalog/references/format.md +121 -0
- package/skills/app-dev/data-catalog/release-check.mjs +93 -0
- package/skills/app-dev/data-catalog/scripts/data-catalog.test.mjs +36 -0
- package/skills/app-dev/data-catalog/scripts/data_catalog.py +1392 -0
- package/skills/app-dev/data-catalog/scripts/persist-conventions-core.mjs +117 -0
- package/skills/app-dev/data-catalog/scripts/persist-conventions.mjs +17 -0
- package/skills/app-dev/data-catalog/scripts/test_data_catalog.py +571 -0
- package/skills/app-dev/ios-foundation/LICENSE +3 -0
- package/skills/app-dev/ios-foundation/SKILL.md +184 -0
- package/skills/app-dev/ios-foundation/references/setup.md +243 -0
- package/skills/app-dev/ios-foundation/release-check.mjs +93 -0
- package/skills/app-dev/monorepo/LICENSE +3 -0
- package/skills/app-dev/monorepo/SKILL.md +462 -0
- package/skills/app-dev/monorepo/release-check.mjs +93 -0
- package/skills/app-dev/nextjs-fullstack/LICENSE +3 -0
- package/skills/app-dev/nextjs-fullstack/SKILL.md +211 -0
- package/skills/app-dev/nextjs-fullstack/conventions.md +318 -0
- package/skills/app-dev/nextjs-fullstack/frontend-conventions.md +61 -0
- package/skills/app-dev/nextjs-fullstack/nextjs16.md +287 -0
- package/skills/app-dev/nextjs-fullstack/release-check.mjs +93 -0
- package/skills/app-dev/nextjs-fullstack/server-actions.md +409 -0
- package/skills/app-dev/prisma-setup/LICENSE +3 -0
- package/skills/app-dev/prisma-setup/SKILL.md +181 -0
- package/skills/app-dev/prisma-setup/nextjs.md +258 -0
- package/skills/app-dev/prisma-setup/release-check.mjs +93 -0
- package/skills/app-dev/prisma-setup/turborepo.md +301 -0
- package/skills/app-dev/pyspark/LICENSE +3 -0
- package/skills/app-dev/pyspark/SKILL.md +127 -0
- package/skills/app-dev/pyspark/assets/templates/etl.py +748 -0
- package/skills/app-dev/pyspark/assets/templates/utils/__init__.py +1 -0
- package/skills/app-dev/pyspark/assets/templates/utils/hudi_metadata.py +14 -0
- package/skills/app-dev/pyspark/references/diagnosis-and-profiling.md +169 -0
- package/skills/app-dev/pyspark/references/etl-contract.md +129 -0
- package/skills/app-dev/pyspark/references/production-validation.md +131 -0
- package/skills/app-dev/pyspark/references/reconciliation.md +38 -0
- package/skills/app-dev/pyspark/references/transformation-design.md +190 -0
- package/skills/app-dev/pyspark/references/velocity-feature-calculation.md +193 -0
- package/skills/app-dev/pyspark/release-check.mjs +93 -0
- package/skills/app-dev/pyspark/scripts/spark_eventlog_summary.py +223 -0
- package/skills/app-dev/python-backend/LICENSE +3 -0
- package/skills/app-dev/python-backend/SKILL.md +325 -0
- package/skills/app-dev/python-backend/assets/uv-install.sh +48 -0
- package/skills/app-dev/python-backend/references/uv-installs.md +83 -0
- package/skills/app-dev/python-backend/release-check.mjs +93 -0
- package/skills/app-dev/shadcn/LICENSE +3 -0
- package/skills/app-dev/shadcn/SKILL.md +120 -0
- package/skills/app-dev/shadcn/assets/shadcn-small.png +0 -0
- package/skills/app-dev/shadcn/assets/shadcn.png +0 -0
- package/skills/app-dev/shadcn/cli.md +411 -0
- package/skills/app-dev/shadcn/customization.md +224 -0
- package/skills/app-dev/shadcn/mcp.md +101 -0
- package/skills/app-dev/shadcn/release-check.mjs +93 -0
- package/skills/app-dev/shadcn/rules/base-vs-radix.md +323 -0
- package/skills/app-dev/shadcn/rules/component-selection.md +67 -0
- package/skills/app-dev/shadcn/rules/composition.md +195 -0
- package/skills/app-dev/shadcn/rules/data-table.md +201 -0
- package/skills/app-dev/shadcn/rules/forms.md +255 -0
- package/skills/app-dev/shadcn/rules/icons.md +103 -0
- package/skills/app-dev/shadcn/rules/styling.md +167 -0
- package/skills/app-dev/zod-v4/LICENSE +3 -0
- package/skills/app-dev/zod-v4/SKILL.md +286 -0
- package/skills/app-dev/zod-v4/release-check.mjs +93 -0
- package/skills/cicd/cloud-build/LICENSE +3 -0
- package/skills/cicd/cloud-build/SKILL.md +707 -0
- package/skills/cicd/cloud-build/release-check.mjs +93 -0
- package/skills/cicd/cloud-debug/LICENSE +3 -0
- package/skills/cicd/cloud-debug/SKILL.md +315 -0
- package/skills/cicd/cloud-debug/references/build-failures.md +238 -0
- package/skills/cicd/cloud-debug/references/deploy-failures.md +376 -0
- package/skills/cicd/cloud-debug/references/pipeline-failures.md +378 -0
- package/skills/cicd/cloud-debug/release-check.mjs +93 -0
- package/skills/cicd/cloud-deploy/LICENSE +3 -0
- package/skills/cicd/cloud-deploy/SKILL.md +230 -0
- package/skills/cicd/cloud-deploy/references/config-templates.md +257 -0
- package/skills/cicd/cloud-deploy/release-check.mjs +93 -0
- package/skills/cicd/docker/LICENSE +3 -0
- package/skills/cicd/docker/SKILL.md +151 -0
- package/skills/cicd/docker/release-check.mjs +93 -0
- package/skills/cicd/github-actions/LICENSE +3 -0
- package/skills/cicd/github-actions/SKILL.md +111 -0
- package/skills/cicd/github-actions/references/audit-profile-optimize.md +150 -0
- package/skills/cicd/github-actions/references/ci-case-studies.md +141 -0
- package/skills/cicd/github-actions/references/conditional-ci.md +214 -0
- package/skills/cicd/github-actions/references/debugging.md +13 -0
- package/skills/cicd/github-actions/references/pipeline.md +87 -0
- package/skills/cicd/github-actions/references/post-deploy-and-publishing.md +33 -0
- package/skills/cicd/github-actions/references/runners.md +253 -0
- package/skills/cicd/github-actions/references/security.md +29 -0
- package/skills/cicd/github-actions/references/speed-and-audit.md +115 -0
- package/skills/cicd/github-actions/references/two-pass-reading.md +92 -0
- package/skills/cicd/github-actions/release-check.mjs +93 -0
- package/skills/cicd/github-actions/scripts/ci-run-audit-core.mjs +612 -0
- package/skills/cicd/github-actions/scripts/ci-run-audit.mjs +4 -0
- package/skills/cicd/github-actions/scripts/ci-run-audit.test.mjs +637 -0
- package/skills/cicd/github-flow/LICENSE +3 -0
- package/skills/cicd/github-flow/SKILL.md +123 -0
- package/skills/cicd/github-flow/references/ci-conventions.md +14 -0
- package/skills/cicd/github-flow/release-check.mjs +93 -0
- package/skills/cicd/github-flow/scripts/flow-core.mjs +105 -0
- package/skills/cicd/github-flow/scripts/flow.mjs +81 -0
- package/skills/cicd/github-flow/scripts/flow.test.mjs +114 -0
- package/skills/cicd/github-flow/scripts/persist-conventions-core.mjs +117 -0
- package/skills/cicd/github-flow/scripts/persist-conventions.mjs +49 -0
- package/skills/cicd/github-flow/scripts/persist-conventions.test.mjs +108 -0
- package/skills/cicd/google-cloud/LICENSE +3 -0
- package/skills/cicd/google-cloud/SKILL.md +119 -0
- package/skills/cicd/google-cloud/references/gcs.md +469 -0
- package/skills/cicd/google-cloud/references/iam.md +451 -0
- package/skills/cicd/google-cloud/references/project.md +349 -0
- package/skills/cicd/google-cloud/references/secrets.md +336 -0
- package/skills/cicd/google-cloud/references/vpc.md +312 -0
- package/skills/cicd/google-cloud/release-check.mjs +93 -0
- package/skills/cicd/google-cloud/scripts/create-sa.sh +36 -0
- package/skills/cicd/google-cloud/scripts/gcp-config.sh +31 -0
- package/skills/cicd/google-cloud/scripts/grant-iap.sh +41 -0
- package/skills/cicd/google-cloud/scripts/setup-secrets.sh +48 -0
- package/skills/cicd/mergify/LICENSE +3 -0
- package/skills/cicd/mergify/SKILL.md +102 -0
- package/skills/cicd/mergify/assets/templates/mergify.yml +215 -0
- package/skills/cicd/mergify/assets/templates/ruleset.json +46 -0
- package/skills/cicd/mergify/references/branch-protection.md +282 -0
- package/skills/cicd/mergify/references/configuration.md +274 -0
- package/skills/cicd/mergify/references/diagnosis.md +109 -0
- package/skills/cicd/mergify/references/stacks.md +84 -0
- package/skills/cicd/mergify/references/traps.md +119 -0
- package/skills/cicd/mergify/references/watch-contract.md +274 -0
- package/skills/cicd/mergify/release-check.mjs +93 -0
- package/skills/cicd/mergify/scripts/audit-core.mjs +208 -0
- package/skills/cicd/mergify/scripts/audit.mjs +4 -0
- package/skills/cicd/mergify/scripts/audit.test.mjs +201 -0
- package/skills/cicd/mergify/scripts/entrypoints.test.mjs +106 -0
- package/skills/cicd/mergify/scripts/pr-620-mergify-comments.fixture.json +30 -0
- package/skills/cicd/mergify/scripts/stack-push-core.mjs +258 -0
- package/skills/cicd/mergify/scripts/stack-push.mjs +4 -0
- package/skills/cicd/mergify/scripts/stack-push.test.mjs +233 -0
- package/skills/cicd/mergify/scripts/watch-pr-delivery-core.mjs +1065 -0
- package/skills/cicd/mergify/scripts/watch-pr-delivery.mjs +4 -0
- package/skills/cicd/mergify/scripts/watch-pr-delivery.test.mjs +1826 -0
- package/skills/cicd/podman/LICENSE +3 -0
- package/skills/cicd/podman/SKILL.md +71 -0
- package/skills/cicd/podman/agents/openai.yaml +4 -0
- package/skills/cicd/podman/assets/templates/podman-compose-socket-directory.yml +6 -0
- package/skills/cicd/podman/assets/templates/podman-service-override.conf +3 -0
- package/skills/cicd/podman/references/compose-compatibility.md +70 -0
- package/skills/cicd/podman/references/networking-and-ports.md +74 -0
- package/skills/cicd/podman/references/rootless-services-and-sockets.md +156 -0
- package/skills/cicd/podman/references/troubleshooting.md +98 -0
- package/skills/cicd/podman/release-check.mjs +93 -0
- package/skills/content/article-review/LICENSE +3 -0
- package/skills/content/article-review/SKILL.md +66 -0
- package/skills/content/article-review/references/report-format.md +68 -0
- package/skills/content/article-review/references/template-guide.md +79 -0
- package/skills/content/article-review/references/template-wechat-payments.md +125 -0
- package/skills/content/article-review/release-check.mjs +93 -0
- package/skills/content/article-to-image/LICENSE +3 -0
- package/skills/content/article-to-image/SKILL.md +91 -0
- package/skills/content/article-to-image/references/formats.md +53 -0
- package/skills/content/article-to-image/release-check.mjs +93 -0
- package/skills/content/flowchart-svg/LICENSE +3 -0
- package/skills/content/flowchart-svg/SKILL.md +43 -0
- package/skills/content/flowchart-svg/release-check.mjs +93 -0
- package/skills/content/flowchart-svg/scripts/export_png.sh +8 -0
- package/skills/content/image-gen/LICENSE +3 -0
- package/skills/content/image-gen/SKILL.md +192 -0
- package/skills/content/image-gen/release-check.mjs +93 -0
- package/skills/content/image-gen/scripts/credentials.mjs +217 -0
- package/skills/content/image-gen/scripts/credentials.test.mjs +212 -0
- package/skills/content/image-gen/scripts/generate.mjs +240 -0
- package/skills/content/image-gen/scripts/options.mjs +293 -0
- package/skills/content/image-gen/scripts/options.test.mjs +245 -0
- package/skills/content/mermaid/LICENSE +3 -0
- package/skills/content/mermaid/SKILL.md +635 -0
- package/skills/content/mermaid/release-check.mjs +93 -0
- package/skills/content/wechat-article-writer/LICENSE +3 -0
- package/skills/content/wechat-article-writer/SKILL.md +92 -0
- package/skills/content/wechat-article-writer/references/style-selector.md +133 -0
- package/skills/content/wechat-article-writer/references/writing-rules.md +152 -0
- package/skills/content/wechat-article-writer/release-check.mjs +93 -0
- package/skills/content/wechat-article-writer/templates/wechat-comparison.md +52 -0
- package/skills/content/wechat-article-writer/templates/wechat-howto.md +51 -0
- package/skills/content/wechat-article-writer/templates/wechat-insight.md +50 -0
- package/skills/content/wechat-article-writer/templates/wechat-pitfall.md +52 -0
- package/skills/content/wechat-publisher/LICENSE +3 -0
- package/skills/content/wechat-publisher/SKILL.md +171 -0
- package/skills/content/wechat-publisher/references/api.md +105 -0
- package/skills/content/wechat-publisher/references/layout-rules.md +57 -0
- package/skills/content/wechat-publisher/references/wechat-safe-template.html +86 -0
- package/skills/content/wechat-publisher/release-check.mjs +93 -0
- package/skills/content/wechat-publisher/scripts/md_to_wechat_html.py +194 -0
- package/skills/content/wechat-publisher/scripts/publish.py +239 -0
- package/skills/content/wechat-search/LICENSE +3 -0
- package/skills/content/wechat-search/SKILL.md +211 -0
- package/skills/content/wechat-search/release-check.mjs +93 -0
- package/skills/content/wechat-search/scripts/start-chrome.sh +83 -0
- package/skills/content/xai-search/LICENSE +3 -0
- package/skills/content/xai-search/SKILL.md +79 -0
- package/skills/content/xai-search/release-check.mjs +93 -0
- package/skills/content/xai-search/scripts/xai_search.sh +187 -0
- package/skills/content/xai-search/tests/smoke_test.sh +36 -0
- package/skills/core/distill-writing/LICENSE +3 -0
- package/skills/core/distill-writing/SKILL.md +74 -0
- package/skills/core/distill-writing/references/extraction.md +95 -0
- package/skills/core/distill-writing/references/updating.md +46 -0
- package/skills/core/distill-writing/release-check.mjs +93 -0
- package/skills/core/doc-to-md/LICENSE +3 -0
- package/skills/core/doc-to-md/SKILL.md +78 -0
- package/skills/core/doc-to-md/release-check.mjs +93 -0
- package/skills/core/doc-to-md/scripts/convert.py +157 -0
- package/skills/core/editorial-review/LICENSE +3 -0
- package/skills/core/editorial-review/SKILL.md +79 -0
- package/skills/core/editorial-review/references/checklist.md +94 -0
- package/skills/core/editorial-review/release-check.mjs +93 -0
- package/skills/core/house-style/LICENSE +3 -0
- package/skills/core/house-style/SKILL.md +33 -0
- package/skills/core/house-style/references/defaults.md +66 -0
- package/skills/core/house-style/references/rules.md +267 -0
- package/skills/core/house-style/references/sources.md +27 -0
- package/skills/core/house-style/references/style-en.md +131 -0
- package/skills/core/house-style/references/style-zh.md +141 -0
- package/skills/core/house-style/references/terminology-zh.md +223 -0
- package/skills/core/house-style/release-check.mjs +93 -0
- package/skills/core/house-style/templates/brd.md +103 -0
- package/skills/core/house-style/templates/commercial-proposal.md +93 -0
- package/skills/core/house-style/templates/compliance-policy.md +109 -0
- package/skills/core/house-style/templates/gap-analysis.md +105 -0
- package/skills/core/house-style/templates/general.md +63 -0
- package/skills/core/house-style/templates/integration-guide.md +98 -0
- package/skills/core/house-style/templates/prd.md +81 -0
- package/skills/core/house-style/templates/risk-operations-procedure.md +94 -0
- package/skills/core/house-style/templates/technical-spec.md +96 -0
- package/skills/core/polish-cn/LICENSE +3 -0
- package/skills/core/polish-cn/SKILL.md +102 -0
- package/skills/core/polish-cn/references/brief.md +93 -0
- package/skills/core/polish-cn/references/models.md +76 -0
- package/skills/core/polish-cn/release-check.mjs +93 -0
- package/skills/core/polish-cn/scripts/polish-cn.test.mjs +244 -0
- package/skills/core/polish-cn/scripts/polish_blocks.py +489 -0
- package/skills/core/reg-parser/LICENSE +3 -0
- package/skills/core/reg-parser/SKILL.md +212 -0
- package/skills/core/reg-parser/references/checklist-schema.md +223 -0
- package/skills/core/reg-parser/references/checklists/hk-amlo-checklist.json +1306 -0
- package/skills/core/reg-parser/references/checklists/hk-amlo-checklist.md +469 -0
- package/skills/core/reg-parser/references/checklists/hk-fi-corporate-onboarding-cdd-checklist.json +634 -0
- package/skills/core/reg-parser/references/checklists/hk-fi-corporate-onboarding-cdd-checklist.md +233 -0
- package/skills/core/reg-parser/references/checklists/hk-mso-guideline-checklist.json +2194 -0
- package/skills/core/reg-parser/references/checklists/hk-mso-guideline-checklist.md +771 -0
- package/skills/core/reg-parser/references/checklists/kyc-aml-checklist.md +258 -0
- package/skills/core/reg-parser/references/checklists/visa-vars-checklist.md +1058 -0
- package/skills/core/reg-parser/references/mandates/hk-amlo-cap615.md +389 -0
- package/skills/core/reg-parser/references/mandates/visa-vars.md +205 -0
- package/skills/core/reg-parser/release-check.mjs +93 -0
- package/skills/core/reg-parser/scripts/compare_checklist.py +230 -0
- package/skills/core/reg-parser/scripts/dump_checklist.py +361 -0
- package/skills/core/reg-parser/scripts/preprocess-mandate.sh +187 -0
- package/skills/core/reg-parser/scripts/reg-parser.test.mjs +165 -0
- package/skills/core/reg-parser/scripts/test_quarantine.sh +105 -0
- package/skills/core/reg-parser/scripts/validate_checklist.py +563 -0
- package/skills/core/reg-parser/scripts/validate_mandate.py +273 -0
- package/skills/core/terminology/LICENSE +3 -0
- package/skills/core/terminology/SKILL.md +62 -0
- package/skills/core/terminology/references/format.md +50 -0
- package/skills/core/terminology/references/init.md +32 -0
- package/skills/core/terminology/release-check.mjs +93 -0
- package/skills/core/write-doc/LICENSE +3 -0
- package/skills/core/write-doc/SKILL.md +141 -0
- package/skills/core/write-doc/references/bilingual.md +60 -0
- package/skills/core/write-doc/release-check.mjs +93 -0
- package/skills/engineering/better-review/LICENSE +3 -0
- package/skills/engineering/better-review/SKILL.md +249 -0
- package/skills/engineering/better-review/agents/openai.yaml +9 -0
- package/skills/engineering/better-review/references/domain-hazards.md +53 -0
- package/skills/engineering/better-review/references/passes.md +147 -0
- package/skills/engineering/better-review/references/result.md +151 -0
- package/skills/engineering/better-review/release-check.mjs +93 -0
- package/skills/engineering/better-review/scripts/pr-context.mjs +212 -0
- package/skills/engineering/better-review/scripts/pr-context.test.mjs +168 -0
- package/skills/engineering/better-review/scripts/rereview-scope.mjs +503 -0
- package/skills/engineering/better-review/scripts/rereview-scope.test.mjs +587 -0
- package/skills/engineering/better-review/scripts/scan-diff.mjs +365 -0
- package/skills/engineering/better-review/scripts/scan-diff.test.mjs +414 -0
- package/skills/engineering/better-review/scripts/vendor-sync.test.mjs +96 -0
- package/skills/engineering/e2e-test/LICENSE +3 -0
- package/skills/engineering/e2e-test/SKILL.md +98 -0
- package/skills/engineering/e2e-test/assets/ci-gates.cloudbuild.yaml +24 -0
- package/skills/engineering/e2e-test/references/authoring/auth-flows.md +159 -0
- package/skills/engineering/e2e-test/references/authoring/playwright-config.md +73 -0
- package/skills/engineering/e2e-test/references/authoring/playwright-patterns.md +144 -0
- package/skills/engineering/e2e-test/references/ci-integration.md +25 -0
- package/skills/engineering/e2e-test/references/ci-playwright-container.md +290 -0
- package/skills/engineering/e2e-test/references/presentation-sweep.md +104 -0
- package/skills/engineering/e2e-test/references/reviewing.md +41 -0
- package/skills/engineering/e2e-test/references/route-manifest.md +51 -0
- package/skills/engineering/e2e-test/release-check.mjs +93 -0
- package/skills/engineering/e2e-test/scripts/detect-routes-nextjs.mjs +200 -0
- package/skills/engineering/e2e-test/scripts/presentation-checks.mjs +171 -0
- package/skills/engineering/e2e-test/scripts/presentation-checks.test.mjs +106 -0
- package/skills/engineering/e2e-test/scripts/presentation-perceivability.mjs +179 -0
- package/skills/engineering/e2e-test/scripts/presentation-perceivability.test.mjs +117 -0
- package/skills/engineering/e2e-test/scripts/presentation-reachability.mjs +154 -0
- package/skills/engineering/e2e-test/scripts/presentation-reachability.test.mjs +69 -0
- package/skills/engineering/e2e-test/scripts/presentation-render-health.mjs +141 -0
- package/skills/engineering/e2e-test/scripts/presentation-render-health.test.mjs +98 -0
- package/skills/engineering/e2e-test/scripts/presentation-sweep.mjs +147 -0
- package/skills/engineering/e2e-test/scripts/presentation-sweep.test.mjs +71 -0
- package/skills/engineering/e2e-test/scripts/presentation-temporal.mjs +127 -0
- package/skills/engineering/e2e-test/scripts/presentation-temporal.test.mjs +59 -0
- package/skills/engineering/e2e-test/scripts/project-route-manifest.mjs +82 -0
- package/skills/engineering/e2e-test/scripts/project-route-manifest.test.mjs +76 -0
- package/skills/engineering/e2e-test/scripts/validate-manifest.mjs +106 -0
- package/skills/engineering/engineering-runtime/LICENSE +3 -0
- package/skills/engineering/engineering-runtime/SKILL.md +11 -0
- package/skills/engineering/engineering-runtime/agents/openai.yaml +6 -0
- package/skills/engineering/engineering-runtime/coherence/workflow.json +597 -0
- package/skills/engineering/engineering-runtime/engineering-runtime.test.mjs +68 -0
- package/skills/engineering/engineering-runtime/release-check.mjs +93 -0
- package/skills/engineering/engineering-runtime/scripts/exact-head-artifact.mjs +131 -0
- package/skills/engineering/engineering-runtime/scripts/head-check-set.mjs +398 -0
- package/skills/engineering/engineering-runtime/scripts/invocation-policy.mjs +187 -0
- package/skills/engineering/engineering-runtime/scripts/invocation-policy.test.mjs +95 -0
- package/skills/engineering/engineering-runtime/scripts/main-module.mjs +79 -0
- package/skills/engineering/engineering-runtime/scripts/main-module.test.mjs +288 -0
- package/skills/engineering/engineering-runtime/scripts/mergify-yaml.mjs +11 -0
- package/skills/engineering/engineering-runtime/scripts/package-lock.json +43 -0
- package/skills/engineering/engineering-runtime/scripts/package.json +10 -0
- package/skills/engineering/engineering-runtime/scripts/required-check-plan.mjs +223 -0
- package/skills/engineering/engineering-runtime/scripts/required-check-plan.test.mjs +96 -0
- package/skills/engineering/engineering-runtime/scripts/review-completion.mjs +56 -0
- package/skills/engineering/engineering-runtime/scripts/workflow-coherence.mjs +595 -0
- package/skills/engineering/engineering-runtime/scripts/workflow-policy.mjs +189 -0
- package/skills/engineering/engineering-runtime/scripts/yaml-mapping.mjs +18 -0
- package/skills/engineering/ensure-coverage/LICENSE +3 -0
- package/skills/engineering/ensure-coverage/SKILL.md +129 -0
- package/skills/engineering/ensure-coverage/references/breadth/coverage-ledger.md +92 -0
- package/skills/engineering/ensure-coverage/references/breadth/inventory-contract.md +85 -0
- package/skills/engineering/ensure-coverage/references/breadth/surface-baseline.md +44 -0
- package/skills/engineering/ensure-coverage/references/breadth/surface-discovery.md +16 -0
- package/skills/engineering/ensure-coverage/references/depth/characterization.md +68 -0
- package/skills/engineering/ensure-coverage/references/depth/coverage.config.example.json +19 -0
- package/skills/engineering/ensure-coverage/references/depth/grading.md +35 -0
- package/skills/engineering/ensure-coverage/references/depth/mock-policy.md +57 -0
- package/skills/engineering/ensure-coverage/references/depth/test-smells.md +39 -0
- package/skills/engineering/ensure-coverage/references/enforcement/ci-contract.md +44 -0
- package/skills/engineering/ensure-coverage/references/examples/coverage-ledger.md +110 -0
- package/skills/engineering/ensure-coverage/references/examples/refund-flow.md +35 -0
- package/skills/engineering/ensure-coverage/references/presentation/axis.md +64 -0
- package/skills/engineering/ensure-coverage/references/process/audit-mode.md +27 -0
- package/skills/engineering/ensure-coverage/references/process/output-template.md +139 -0
- package/skills/engineering/ensure-coverage/references/process/test-strategy.md +56 -0
- package/skills/engineering/ensure-coverage/release-check.mjs +93 -0
- package/skills/engineering/ensure-coverage/schemas/coverage-config.schema.json +67 -0
- package/skills/engineering/ensure-coverage/schemas/coverage-file.schema.json +140 -0
- package/skills/engineering/ensure-coverage/scripts/README.md +99 -0
- package/skills/engineering/ensure-coverage/scripts/adapters/nextjs-inventory.mjs +182 -0
- package/skills/engineering/ensure-coverage/scripts/adapters/nextjs-inventory.test.mjs +96 -0
- package/skills/engineering/ensure-coverage/scripts/check-quarantine-expiry.mjs +105 -0
- package/skills/engineering/ensure-coverage/scripts/check-quarantine-expiry.test.mjs +47 -0
- package/skills/engineering/ensure-coverage/scripts/ci-audit.mjs +137 -0
- package/skills/engineering/ensure-coverage/scripts/ci-audit.test.mjs +86 -0
- package/skills/engineering/ensure-coverage/scripts/coverage-ledger.mjs +674 -0
- package/skills/engineering/ensure-coverage/scripts/coverage-ledger.test.mjs +447 -0
- package/skills/engineering/ensure-coverage/scripts/design-parity.mjs +591 -0
- package/skills/engineering/ensure-coverage/scripts/design-parity.test.mjs +552 -0
- package/skills/engineering/ensure-coverage/scripts/lint-tests.mjs +282 -0
- package/skills/engineering/ensure-coverage/scripts/lint-tests.test.mjs +289 -0
- package/skills/engineering/ensure-coverage/scripts/mock-policy-config.mjs +176 -0
- package/skills/engineering/ensure-coverage/scripts/mock-policy-config.test.mjs +119 -0
- package/skills/engineering/ensure-coverage/scripts/package.json +19 -0
- package/skills/engineering/golden-path/LICENSE +3 -0
- package/skills/engineering/golden-path/SKILL.md +230 -0
- package/skills/engineering/golden-path/agents/openai.yaml +3 -0
- package/skills/engineering/golden-path/assets/golden-paths.example.json +57 -0
- package/skills/engineering/golden-path/references/contract.md +239 -0
- package/skills/engineering/golden-path/references/migration.md +111 -0
- package/skills/engineering/golden-path/release-check.mjs +93 -0
- package/skills/engineering/golden-path/scripts/golden-path-core.mjs +1779 -0
- package/skills/engineering/golden-path/scripts/golden-path.mjs +6 -0
- package/skills/engineering/golden-path/scripts/golden-path.test.mjs +1457 -0
- package/skills/engineering/harness-runtime/LICENSE +3 -0
- package/skills/engineering/harness-runtime/SKILL.md +19 -0
- package/skills/engineering/harness-runtime/agents/openai.yaml +6 -0
- package/skills/engineering/harness-runtime/bin/discover-models.mjs +4 -0
- package/skills/engineering/harness-runtime/bin/model-catalog.mjs +4 -0
- package/skills/engineering/harness-runtime/contracts.md +15 -0
- package/skills/engineering/harness-runtime/discover-models.mjs +392 -0
- package/skills/engineering/harness-runtime/discover-models.test.mjs +363 -0
- package/skills/engineering/harness-runtime/fixtures/native-question-schemas.json +33 -0
- package/skills/engineering/harness-runtime/fixtures/question-responses.json +54 -0
- package/skills/engineering/harness-runtime/harness-runtime.test.mjs +967 -0
- package/skills/engineering/harness-runtime/index.mjs +767 -0
- package/skills/engineering/harness-runtime/model-catalog-seed.test.mjs +829 -0
- package/skills/engineering/harness-runtime/model-catalog.mjs +787 -0
- package/skills/engineering/harness-runtime/model-catalog.test.mjs +366 -0
- package/skills/engineering/harness-runtime/native-question-contracts.md +37 -0
- package/skills/engineering/harness-runtime/references/model-catalog-seed.json +408 -0
- package/skills/engineering/harness-runtime/references/model-catalog.md +57 -0
- package/skills/engineering/harness-runtime/release-check.mjs +93 -0
- package/skills/engineering/resolve-issues/LICENSE +3 -0
- package/skills/engineering/resolve-issues/SKILL.md +250 -0
- package/skills/engineering/resolve-issues/agents/openai.yaml +9 -0
- package/skills/engineering/resolve-issues/plugin-hooks.json +17 -0
- package/skills/engineering/resolve-issues/references/canary.md +28 -0
- package/skills/engineering/resolve-issues/references/ci.md +105 -0
- package/skills/engineering/resolve-issues/references/done.md +25 -0
- package/skills/engineering/resolve-issues/references/dropbox.md +90 -0
- package/skills/engineering/resolve-issues/references/expire.md +318 -0
- package/skills/engineering/resolve-issues/references/exploration.md +202 -0
- package/skills/engineering/resolve-issues/references/implementation.md +303 -0
- package/skills/engineering/resolve-issues/references/preflight.md +445 -0
- package/skills/engineering/resolve-issues/references/review.md +228 -0
- package/skills/engineering/resolve-issues/references/shared-modules.md +44 -0
- package/skills/engineering/resolve-issues/references/task-plan.md +264 -0
- package/skills/engineering/resolve-issues/release-check.mjs +93 -0
- package/skills/engineering/resolve-issues/scripts/cleanup-runs.mjs +364 -0
- package/skills/engineering/resolve-issues/scripts/cleanup-runs.test.mjs +280 -0
- package/skills/engineering/resolve-issues/scripts/discover-models.mjs +9 -0
- package/skills/engineering/resolve-issues/scripts/dropbox.mjs +473 -0
- package/skills/engineering/resolve-issues/scripts/dropbox.test.mjs +346 -0
- package/skills/engineering/resolve-issues/scripts/findings-reuse.mjs +98 -0
- package/skills/engineering/resolve-issues/scripts/findings-reuse.test.mjs +88 -0
- package/skills/engineering/resolve-issues/scripts/github-reviews.mjs +384 -0
- package/skills/engineering/resolve-issues/scripts/github-reviews.test.mjs +264 -0
- package/skills/engineering/resolve-issues/scripts/install-hooks.mjs +135 -0
- package/skills/engineering/resolve-issues/scripts/install-hooks.test.mjs +79 -0
- package/skills/engineering/resolve-issues/scripts/issue-tree.mjs +162 -0
- package/skills/engineering/resolve-issues/scripts/issue-tree.test.mjs +107 -0
- package/skills/engineering/resolve-issues/scripts/manual-invocation.test.mjs +14 -0
- package/skills/engineering/resolve-issues/scripts/model-catalog.mjs +9 -0
- package/skills/engineering/resolve-issues/scripts/next-actions-capacity.test.mjs +149 -0
- package/skills/engineering/resolve-issues/scripts/next-actions.mjs +856 -0
- package/skills/engineering/resolve-issues/scripts/next-actions.test.mjs +915 -0
- package/skills/engineering/resolve-issues/scripts/plan-sync.mjs +269 -0
- package/skills/engineering/resolve-issues/scripts/plan-sync.test.mjs +156 -0
- package/skills/engineering/resolve-issues/scripts/preflight-models.mjs +736 -0
- package/skills/engineering/resolve-issues/scripts/preflight-models.test.mjs +448 -0
- package/skills/engineering/resolve-issues/scripts/ready-check.mjs +185 -0
- package/skills/engineering/resolve-issues/scripts/ready-check.test.mjs +217 -0
- package/skills/engineering/resolve-issues/scripts/rehydrate.mjs +98 -0
- package/skills/engineering/resolve-issues/scripts/rehydrate.test.mjs +91 -0
- package/skills/engineering/resolve-issues/scripts/review-verdict.mjs +509 -0
- package/skills/engineering/resolve-issues/scripts/review-verdict.test.mjs +1060 -0
- package/skills/engineering/resolve-issues/scripts/size-check.mjs +492 -0
- package/skills/engineering/resolve-issues/scripts/size-check.test.mjs +458 -0
- package/skills/engineering/resolve-release/LICENSE +3 -0
- package/skills/engineering/resolve-release/SKILL.md +215 -0
- package/skills/engineering/resolve-release/agents/openai.yaml +8 -0
- package/skills/engineering/resolve-release/flows/cloud-run-canary.md +13 -0
- package/skills/engineering/resolve-release/flows/cloud-run.md +7 -0
- package/skills/engineering/resolve-release/flows/root-tag-npm.md +13 -0
- package/skills/engineering/resolve-release/flows/workspace-npm.md +22 -0
- package/skills/engineering/resolve-release/references/canary.md +51 -0
- package/skills/engineering/resolve-release/references/candidate.md +41 -0
- package/skills/engineering/resolve-release/references/cut.md +131 -0
- package/skills/engineering/resolve-release/references/dark-launch.md +66 -0
- package/skills/engineering/resolve-release/references/flows.md +150 -0
- package/skills/engineering/resolve-release/references/preflight.md +154 -0
- package/skills/engineering/resolve-release/references/prepared-metadata.md +260 -0
- package/skills/engineering/resolve-release/references/promotion.md +82 -0
- package/skills/engineering/resolve-release/references/publish.md +232 -0
- package/skills/engineering/resolve-release/references/workspace-npm.md +103 -0
- package/skills/engineering/resolve-release/release-check.mjs +93 -0
- package/skills/engineering/resolve-release/scripts/apply.mjs +212 -0
- package/skills/engineering/resolve-release/scripts/apply.test.mjs +99 -0
- package/skills/engineering/resolve-release/scripts/dark-flags.mjs +134 -0
- package/skills/engineering/resolve-release/scripts/dark-flags.test.mjs +100 -0
- package/skills/engineering/resolve-release/scripts/flow.mjs +500 -0
- package/skills/engineering/resolve-release/scripts/flow.test.mjs +340 -0
- package/skills/engineering/resolve-release/scripts/green-head.mjs +231 -0
- package/skills/engineering/resolve-release/scripts/green-head.test.mjs +101 -0
- package/skills/engineering/resolve-release/scripts/npm-version-absence.mjs +138 -0
- package/skills/engineering/resolve-release/scripts/npm-version-absence.test.mjs +426 -0
- package/skills/engineering/resolve-release/scripts/plan-npm.test.mjs +659 -0
- package/skills/engineering/resolve-release/scripts/plan-toml-boundary.test.mjs +317 -0
- package/skills/engineering/resolve-release/scripts/plan-uv.test.mjs +291 -0
- package/skills/engineering/resolve-release/scripts/plan.mjs +806 -0
- package/skills/engineering/resolve-release/scripts/plan.test.mjs +428 -0
- package/skills/engineering/rush-issues/LICENSE +3 -0
- package/skills/engineering/rush-issues/SKILL.md +58 -0
- package/skills/engineering/rush-issues/agents/openai.yaml +8 -0
- package/skills/engineering/rush-issues/rehydrate.mjs +10 -0
- package/skills/engineering/rush-issues/release-check.mjs +93 -0
- package/skills/engineering/rush-release/LICENSE +3 -0
- package/skills/engineering/rush-release/SKILL.md +35 -0
- package/skills/engineering/rush-release/agents/openai.yaml +8 -0
- package/skills/engineering/rush-release/release-check.mjs +93 -0
- package/skills/engineering/test-quality/LICENSE +3 -0
- package/skills/engineering/test-quality/SKILL.md +79 -0
- package/skills/engineering/test-quality/references/audit.md +80 -0
- package/skills/engineering/test-quality/references/lint.md +24 -0
- package/skills/engineering/test-quality/references/principles.md +143 -0
- package/skills/engineering/test-quality/references/testing-conventions.md +9 -0
- package/skills/engineering/test-quality/release-check.mjs +93 -0
- package/skills/engineering/test-quality/scripts/lint-tests.mjs +574 -0
- package/skills/engineering/test-quality/scripts/lint-tests.test.mjs +591 -0
- package/skills/engineering/test-quality/scripts/mock-policy-config.mjs +176 -0
- package/skills/engineering/test-quality/scripts/mock-policy-config.test.mjs +119 -0
- package/skills/engineering/test-quality/scripts/persist-conventions-core.mjs +117 -0
- package/skills/engineering/test-quality/scripts/persist-conventions.mjs +17 -0
- package/skills/engineering/test-quality/scripts/persist-conventions.test.mjs +104 -0
- package/skills/risk-compliance/compliance-audit/LICENSE +3 -0
- package/skills/risk-compliance/compliance-audit/SKILL.md +439 -0
- package/skills/risk-compliance/compliance-audit/references/findings-schema.md +293 -0
- package/skills/risk-compliance/compliance-audit/references/normalization-rules.md +45 -0
- package/skills/risk-compliance/compliance-audit/references/vars-checklist.md +1068 -0
- package/skills/risk-compliance/compliance-audit/references/vars-findings-schema.md +398 -0
- package/skills/risk-compliance/compliance-audit/release-check.mjs +93 -0
- package/skills/risk-compliance/compliance-audit/scripts/compliance-audit.test.mjs +14 -0
- package/skills/risk-compliance/compliance-audit/scripts/export_tracker_xlsx.py +221 -0
- package/skills/risk-compliance/compliance-audit/scripts/reconcile_tracker.py +458 -0
- package/skills/risk-compliance/compliance-audit/scripts/test_export_tracker_xlsx.py +97 -0
- package/skills/risk-compliance/compliance-audit/scripts/test_validate_tracker.py +157 -0
- package/skills/risk-compliance/compliance-audit/scripts/validate_tracker.py +829 -0
- package/skills/risk-compliance/contract-compare/LICENSE +3 -0
- package/skills/risk-compliance/contract-compare/SKILL.md +199 -0
- package/skills/risk-compliance/contract-compare/references/comparison-dimensions.md +209 -0
- package/skills/risk-compliance/contract-compare/release-check.mjs +93 -0
- package/skills/risk-compliance/contract-review/LICENSE +3 -0
- package/skills/risk-compliance/contract-review/SKILL.md +240 -0
- package/skills/risk-compliance/contract-review/references/review-criteria.md +223 -0
- package/skills/risk-compliance/contract-review/release-check.mjs +93 -0
- package/skills/risk-compliance/doc-authenticity/LICENSE +3 -0
- package/skills/risk-compliance/doc-authenticity/SKILL.md +160 -0
- package/skills/risk-compliance/doc-authenticity/agents/openai.yaml +8 -0
- package/skills/risk-compliance/doc-authenticity/manual-invocation.test.mjs +12 -0
- package/skills/risk-compliance/doc-authenticity/references/agreement.md +66 -0
- package/skills/risk-compliance/doc-authenticity/references/bank-statement.md +150 -0
- package/skills/risk-compliance/doc-authenticity/references/forensic-signals.md +157 -0
- package/skills/risk-compliance/doc-authenticity/references/image-signals.md +114 -0
- package/skills/risk-compliance/doc-authenticity/references/invoice.md +66 -0
- package/skills/risk-compliance/doc-authenticity/references/issuer-profiles.md +86 -0
- package/skills/risk-compliance/doc-authenticity/references/verdict-and-report.md +95 -0
- package/skills/risk-compliance/doc-authenticity/references/verdict.schema.json +81 -0
- package/skills/risk-compliance/doc-authenticity/release-check.mjs +93 -0
- package/skills/risk-compliance/doc-authenticity/scripts/image_forensics.py +294 -0
- package/skills/risk-compliance/doc-authenticity/scripts/pdf_forensics.py +401 -0
- package/skills/risk-compliance/doc-authenticity/scripts/validate_codes.py +224 -0
- package/skills/risk-compliance/doc-authenticity/scripts/validate_verdict.py +308 -0
- package/skills/risk-compliance/doc-authenticity/scripts/validate_verdict.test.mjs +212 -0
- package/skills/risk-compliance/fraud-analysis/LICENSE +3 -0
- package/skills/risk-compliance/fraud-analysis/SKILL.md +114 -0
- package/skills/risk-compliance/fraud-analysis/references/archetypes/authorized-payment-scam.md +41 -0
- package/skills/risk-compliance/fraud-analysis/references/archetypes/first-party-fraud.md +44 -0
- package/skills/risk-compliance/fraud-analysis/references/archetypes/third-party-fraud.md +27 -0
- package/skills/risk-compliance/fraud-analysis/references/contexts/bank-transfer.md +24 -0
- package/skills/risk-compliance/fraud-analysis/references/contexts/card-payment.md +30 -0
- package/skills/risk-compliance/fraud-analysis/references/contexts/payment-collection.md +20 -0
- package/skills/risk-compliance/fraud-analysis/references/contexts/payout.md +20 -0
- package/skills/risk-compliance/fraud-analysis/references/feature-engineering.md +158 -0
- package/skills/risk-compliance/fraud-analysis/references/mechanisms/account-takeover.md +36 -0
- package/skills/risk-compliance/fraud-analysis/references/report-rationale.md +45 -0
- package/skills/risk-compliance/fraud-analysis/references/report-template.md +190 -0
- package/skills/risk-compliance/fraud-analysis/references/review-checklist.md +175 -0
- package/skills/risk-compliance/fraud-analysis/references/taxonomy.md +79 -0
- package/skills/risk-compliance/fraud-analysis/references/terminology.md +108 -0
- package/skills/risk-compliance/fraud-analysis/references/workflow.md +175 -0
- package/skills/risk-compliance/fraud-analysis/release-check.mjs +93 -0
- package/skills/risk-compliance/payment-analysis/LICENSE +3 -0
- package/skills/risk-compliance/payment-analysis/SKILL.md +180 -0
- package/skills/risk-compliance/payment-analysis/references/auth-rate-actions.md +30 -0
- package/skills/risk-compliance/payment-analysis/references/chargebacks.md +208 -0
- package/skills/risk-compliance/payment-analysis/references/chinese-polish.md +51 -0
- package/skills/risk-compliance/payment-analysis/references/event-layers.md +127 -0
- package/skills/risk-compliance/payment-analysis/references/fx.md +59 -0
- package/skills/risk-compliance/payment-analysis/references/journey.md +79 -0
- package/skills/risk-compliance/payment-analysis/references/metrics.md +67 -0
- package/skills/risk-compliance/payment-analysis/references/report-template.md +119 -0
- package/skills/risk-compliance/payment-analysis/references/terminology.md +95 -0
- package/skills/risk-compliance/payment-analysis/references/visualization.md +56 -0
- package/skills/risk-compliance/payment-analysis/release-check.mjs +93 -0
- package/skills/risk-compliance/report-writing/LICENSE +3 -0
- package/skills/risk-compliance/report-writing/SKILL.md +220 -0
- package/skills/risk-compliance/report-writing/references/audit-report-template.md +121 -0
- package/skills/risk-compliance/report-writing/references/external-assessment-template.md +167 -0
- package/skills/risk-compliance/report-writing/references/management-report-template.md +145 -0
- package/skills/risk-compliance/report-writing/references/vars-report-template.md +224 -0
- package/skills/risk-compliance/report-writing/release-check.mjs +93 -0
- package/skills/risk-compliance/similar-domain/LICENSE +3 -0
- package/skills/risk-compliance/similar-domain/SKILL.md +203 -0
- package/skills/risk-compliance/similar-domain/references/entities.md +67 -0
- package/skills/risk-compliance/similar-domain/references/fingerprints.md +134 -0
- package/skills/risk-compliance/similar-domain/references/pivots.md +82 -0
- package/skills/risk-compliance/similar-domain/references/report-template.md +93 -0
- package/skills/risk-compliance/similar-domain/references/scoring.md +130 -0
- package/skills/risk-compliance/similar-domain/references/terminology.md +41 -0
- package/skills/risk-compliance/similar-domain/references/workflow.md +85 -0
- package/skills/risk-compliance/similar-domain/release-check.mjs +93 -0
- package/skills/risk-compliance/tld-detection/LICENSE +3 -0
- package/skills/risk-compliance/tld-detection/SKILL.md +245 -0
- package/skills/risk-compliance/tld-detection/agents/openai.yaml +9 -0
- package/skills/risk-compliance/tld-detection/references/chinese-polish.md +55 -0
- package/skills/risk-compliance/tld-detection/references/clean.md +51 -0
- package/skills/risk-compliance/tld-detection/references/clustering.md +235 -0
- package/skills/risk-compliance/tld-detection/references/decision.md +189 -0
- package/skills/risk-compliance/tld-detection/references/fx-conversion.md +232 -0
- package/skills/risk-compliance/tld-detection/references/report-template.md +272 -0
- package/skills/risk-compliance/tld-detection/references/streams.md +141 -0
- package/skills/risk-compliance/tld-detection/references/terminology.md +95 -0
- package/skills/risk-compliance/tld-detection/references/workflow.md +95 -0
- package/skills/risk-compliance/tld-detection/release-check.mjs +93 -0
- package/skills/risk-compliance/tld-detection/scripts/detect_ladders.py +390 -0
- package/skills/risk-compliance/tld-detection/scripts/detect_ladders.test.mjs +14 -0
- package/skills/risk-compliance/tld-detection/scripts/detect_streams.py +650 -0
- package/skills/risk-compliance/tld-detection/scripts/detect_streams.test.mjs +14 -0
- package/skills/risk-compliance/tld-detection/tests/test_detect_ladders.py +134 -0
- package/skills/risk-compliance/tld-detection/tests/test_detect_streams.py +520 -0
|
@@ -0,0 +1,571 @@
|
|
|
1
|
+
"""Tests for data_catalog.py. Run: python3 test_data_catalog.py"""
|
|
2
|
+
from __future__ import annotations
|
|
3
|
+
|
|
4
|
+
import contextlib
|
|
5
|
+
import importlib.util
|
|
6
|
+
import subprocess
|
|
7
|
+
import io
|
|
8
|
+
import json
|
|
9
|
+
import sys
|
|
10
|
+
import tempfile
|
|
11
|
+
import textwrap
|
|
12
|
+
import unittest
|
|
13
|
+
from pathlib import Path
|
|
14
|
+
|
|
15
|
+
HERE = Path(__file__).resolve().parent
|
|
16
|
+
sys.path.insert(0, str(HERE))
|
|
17
|
+
import data_catalog as dc # noqa: E402
|
|
18
|
+
|
|
19
|
+
PY_SCRIPT = '''
|
|
20
|
+
"""Build dwd.customer_daily."""
|
|
21
|
+
from catalog_fields import Field, Table
|
|
22
|
+
|
|
23
|
+
TARGET_TABLE = "dwd.customer_daily"
|
|
24
|
+
WINDOW_NOTE = "[dt-7d, dt)"
|
|
25
|
+
|
|
26
|
+
CATALOG_TABLE = Table(
|
|
27
|
+
"dwd.customer_daily",
|
|
28
|
+
grain="one row per (dt, cust_id)",
|
|
29
|
+
en="Daily customer collection rollup.",
|
|
30
|
+
zh="客户每日收款汇总。",
|
|
31
|
+
notes=("Amounts in USD via dim_forex.",),
|
|
32
|
+
)
|
|
33
|
+
KEYS = (
|
|
34
|
+
Field("dt", en="Snapshot date.", zh="快照日期。", source="Run parameter `dt`."),
|
|
35
|
+
)
|
|
36
|
+
CATALOG_FIELDS = (
|
|
37
|
+
*KEYS,
|
|
38
|
+
Field(
|
|
39
|
+
"coll_amt_7d_usd",
|
|
40
|
+
en="Collection amount | last 7 days.",
|
|
41
|
+
zh="近 7 天收款金额。",
|
|
42
|
+
source="dwd_transaction POSTED collections, "
|
|
43
|
+
"sum of txn_amount_usd.",
|
|
44
|
+
window=WINDOW_NOTE,
|
|
45
|
+
unit="USD",
|
|
46
|
+
),
|
|
47
|
+
)
|
|
48
|
+
PUBLISHED_COLUMNS = tuple(f.name for f in CATALOG_FIELDS)
|
|
49
|
+
'''
|
|
50
|
+
|
|
51
|
+
SQL_SCRIPT = """\
|
|
52
|
+
-- @table ads.merchant_monthly
|
|
53
|
+
-- grain: one row per (month, merchant_id)
|
|
54
|
+
-- en: Monthly merchant volume.
|
|
55
|
+
-- zh: 商户月度交易量。
|
|
56
|
+
-- notes: Built monthly; Excludes test merchants
|
|
57
|
+
-- @field merchant_id
|
|
58
|
+
-- en: Merchant id.
|
|
59
|
+
-- zh: 商户 ID。
|
|
60
|
+
-- source: dim_merchant.merchant_id
|
|
61
|
+
-- @field volume_usd
|
|
62
|
+
-- en: Settled volume in the month.
|
|
63
|
+
-- zh: 当月结算金额。
|
|
64
|
+
-- source: dwd_settlement settled rows,
|
|
65
|
+
-- summed amount_usd
|
|
66
|
+
-- unit: USD
|
|
67
|
+
|
|
68
|
+
INSERT OVERWRITE TABLE ads.merchant_monthly
|
|
69
|
+
WITH s AS (SELECT merchant_id, amount_usd FROM dwd_settlement WHERE status = 'SETTLED, final')
|
|
70
|
+
SELECT s.merchant_id, SUM(s.amount_usd) AS volume_usd
|
|
71
|
+
FROM s GROUP BY s.merchant_id;
|
|
72
|
+
"""
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
def make_repo(files: dict, config: dict | None = None) -> Path:
|
|
76
|
+
root = Path(tempfile.mkdtemp(prefix="data-catalog-test-"))
|
|
77
|
+
(root / ".git").mkdir()
|
|
78
|
+
for name, text in files.items():
|
|
79
|
+
path = root / name
|
|
80
|
+
path.parent.mkdir(parents=True, exist_ok=True)
|
|
81
|
+
path.write_text(textwrap.dedent(text) if name.endswith(".py") else text, encoding="utf-8")
|
|
82
|
+
if config is not None:
|
|
83
|
+
(root / dc.CONFIG_FILE).write_text(json.dumps({**{"version": 1, "output": "docs/catalog"}, **config}), encoding="utf-8")
|
|
84
|
+
return root
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
def run(root: Path, *argv: str) -> tuple[int, str, str]:
|
|
88
|
+
out, err = io.StringIO(), io.StringIO()
|
|
89
|
+
with contextlib.redirect_stdout(out), contextlib.redirect_stderr(err):
|
|
90
|
+
code = dc.main(["--root", str(root), *argv])
|
|
91
|
+
return code, out.getvalue(), err.getvalue()
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
BILINGUAL = {"scripts": ["jobs/**/*.py", "sql/**/*.sql"], "languages": ["en", "zh"]}
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
class GenerateTest(unittest.TestCase):
|
|
98
|
+
def test_python_and_sql_metadata_render_pages_and_index(self):
|
|
99
|
+
root = make_repo({"jobs/dwd/customer_daily.py": PY_SCRIPT, "sql/merchant_monthly.sql": SQL_SCRIPT}, BILINGUAL)
|
|
100
|
+
code, out, err = run(root, "generate")
|
|
101
|
+
self.assertEqual(code, 0, err)
|
|
102
|
+
page = (root / "docs/catalog/dwd.customer_daily.md").read_text(encoding="utf-8")
|
|
103
|
+
self.assertTrue(page.startswith(dc.GENERATED_MARK))
|
|
104
|
+
self.assertIn("- **Script:** [jobs/dwd/customer_daily.py](../../jobs/dwd/customer_daily.py)", page)
|
|
105
|
+
self.assertIn("| Field | English | 中文 | Source | Window | Unit |", page)
|
|
106
|
+
# starred KEYS come first, `|` is escaped, implicit concatenation and module constants resolve
|
|
107
|
+
self.assertIn("| `dt` | Snapshot date. | 快照日期。 | Run parameter `dt`. | | |", page)
|
|
108
|
+
self.assertIn("| `coll_amt_7d_usd` | Collection amount \\| last 7 days. | 近 7 天收款金额。 | "
|
|
109
|
+
"dwd_transaction POSTED collections, sum of txn_amount_usd. | [dt-7d, dt) | USD |", page)
|
|
110
|
+
sql_page = (root / "docs/catalog/ads.merchant_monthly.md").read_text(encoding="utf-8")
|
|
111
|
+
self.assertIn("| `volume_usd` | Settled volume in the month. | 当月结算金额。 | "
|
|
112
|
+
"dwd_settlement settled rows, summed amount_usd | USD |", sql_page)
|
|
113
|
+
self.assertNotIn("Window", sql_page)
|
|
114
|
+
self.assertIn("- Excludes test merchants", sql_page)
|
|
115
|
+
index = (root / "docs/catalog/README.md").read_text(encoding="utf-8")
|
|
116
|
+
self.assertLess(index.index("ads.merchant_monthly"), index.index("dwd.customer_daily"))
|
|
117
|
+
self.assertIn("| [`dwd.customer_daily`](dwd.customer_daily.md) | Daily customer collection rollup. | "
|
|
118
|
+
"one row per (dt, cust_id) | 2 |", index)
|
|
119
|
+
|
|
120
|
+
def test_check_passes_when_current_and_fails_after_a_definition_changes(self):
|
|
121
|
+
root = make_repo({"jobs/dwd/customer_daily.py": PY_SCRIPT}, BILINGUAL)
|
|
122
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
123
|
+
self.assertEqual(run(root, "generate", "--check")[0], 0)
|
|
124
|
+
script = root / "jobs/dwd/customer_daily.py"
|
|
125
|
+
script.write_text(script.read_text(encoding="utf-8").replace("Snapshot date.", "Partition date."), encoding="utf-8")
|
|
126
|
+
code, _, err = run(root, "generate", "--check")
|
|
127
|
+
self.assertEqual(code, 1)
|
|
128
|
+
self.assertIn("stale: docs/catalog/dwd.customer_daily.md", err)
|
|
129
|
+
self.assertNotIn("Partition date.", (root / "docs/catalog/dwd.customer_daily.md").read_text(encoding="utf-8"))
|
|
130
|
+
|
|
131
|
+
def test_removing_metadata_makes_the_page_an_orphan_that_generate_removes(self):
|
|
132
|
+
root = make_repo({"jobs/dwd/customer_daily.py": PY_SCRIPT}, BILINGUAL)
|
|
133
|
+
run(root, "generate")
|
|
134
|
+
(root / "docs/catalog/hand-written.md").write_text("# kept\n", encoding="utf-8")
|
|
135
|
+
(root / "jobs/dwd/customer_daily.py").write_text("x = 1\n", encoding="utf-8")
|
|
136
|
+
code, _, err = run(root, "generate", "--check")
|
|
137
|
+
self.assertEqual(code, 1)
|
|
138
|
+
self.assertIn("orphan: docs/catalog/dwd.customer_daily.md", err)
|
|
139
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
140
|
+
self.assertFalse((root / "docs/catalog/dwd.customer_daily.md").exists())
|
|
141
|
+
self.assertTrue((root / "docs/catalog/hand-written.md").exists())
|
|
142
|
+
|
|
143
|
+
def test_missing_language_text_fails_with_location_and_writes_nothing(self):
|
|
144
|
+
script = PY_SCRIPT.replace('zh="近 7 天收款金额。",', "")
|
|
145
|
+
root = make_repo({"jobs/dwd/customer_daily.py": script}, BILINGUAL)
|
|
146
|
+
code, _, err = run(root, "generate")
|
|
147
|
+
self.assertEqual(code, 1)
|
|
148
|
+
self.assertRegex(err, r"jobs/dwd/customer_daily\.py:\d+: Field 'coll_amt_7d_usd' is missing `zh`")
|
|
149
|
+
self.assertFalse((root / "docs/catalog").exists())
|
|
150
|
+
|
|
151
|
+
def test_literal_contract_missing_a_field_is_an_error_and_extra_fields_only_warn(self):
|
|
152
|
+
script = PY_SCRIPT.replace("PUBLISHED_COLUMNS = tuple(f.name for f in CATALOG_FIELDS)",
|
|
153
|
+
'PUBLISHED_COLUMNS = ("coll_amt_7d_usd", "payout_amt_7d_usd")')
|
|
154
|
+
root = make_repo({"jobs/dwd/customer_daily.py": script}, BILINGUAL)
|
|
155
|
+
code, _, err = run(root, "generate")
|
|
156
|
+
self.assertEqual(code, 1)
|
|
157
|
+
self.assertIn("PUBLISHED_COLUMNS has column(s) with no Field: payout_amt_7d_usd", err)
|
|
158
|
+
self.assertIn("Field(s) not in PUBLISHED_COLUMNS: dt", err)
|
|
159
|
+
|
|
160
|
+
def test_sql_select_is_the_contract_for_its_comment_block(self):
|
|
161
|
+
added = SQL_SCRIPT.replace("SUM(s.amount_usd) AS volume_usd", "SUM(s.amount_usd) AS volume_usd, COUNT(*) AS txn_cnt")
|
|
162
|
+
root = make_repo({"sql/merchant_monthly.sql": added}, BILINGUAL)
|
|
163
|
+
code, _, err = run(root, "generate", "--check")
|
|
164
|
+
self.assertEqual(code, 1)
|
|
165
|
+
self.assertIn("sql/merchant_monthly.sql:1: the SELECT writing ads.merchant_monthly outputs column(s) "
|
|
166
|
+
"with no definition: txn_cnt", err)
|
|
167
|
+
dropped = SQL_SCRIPT.replace(", SUM(s.amount_usd) AS volume_usd", "")
|
|
168
|
+
root = make_repo({"sql/merchant_monthly.sql": dropped}, BILINGUAL)
|
|
169
|
+
code, _, err = run(root, "generate")
|
|
170
|
+
self.assertEqual(code, 1)
|
|
171
|
+
self.assertIn("definition(s) for column(s) the SELECT does not output: volume_usd", err)
|
|
172
|
+
|
|
173
|
+
def test_sql_inside_a_documented_python_script_without_a_contract_is_checked(self):
|
|
174
|
+
script = PY_SCRIPT.replace("PUBLISHED_COLUMNS = tuple(f.name for f in CATALOG_FIELDS)", '''
|
|
175
|
+
SQL = """
|
|
176
|
+
INSERT OVERWRITE TABLE dwd.customer_daily
|
|
177
|
+
SELECT dt, SUM(amt) AS coll_amt_7d_usd, COUNT(*) AS coll_cnt_7d FROM dwd.txn GROUP BY dt
|
|
178
|
+
"""
|
|
179
|
+
''')
|
|
180
|
+
root = make_repo({"jobs/a.py": script}, BILINGUAL)
|
|
181
|
+
code, _, err = run(root, "generate")
|
|
182
|
+
self.assertEqual(code, 1)
|
|
183
|
+
self.assertIn("outputs column(s) with no definition: coll_cnt_7d", err)
|
|
184
|
+
|
|
185
|
+
def test_expression_metadata_and_imported_field_lists_are_rejected(self):
|
|
186
|
+
expr = PY_SCRIPT.replace('en="Snapshot date."', 'en=f"Snapshot {1}"')
|
|
187
|
+
root = make_repo({"jobs/a.py": expr}, BILINGUAL)
|
|
188
|
+
code, _, err = run(root, "generate")
|
|
189
|
+
self.assertEqual(code, 1)
|
|
190
|
+
self.assertIn("metadata must be a string literal", err)
|
|
191
|
+
imported = PY_SCRIPT.replace(" *KEYS,\n", " *other.KEYS,\n")
|
|
192
|
+
root = make_repo({"jobs/a.py": imported}, BILINGUAL)
|
|
193
|
+
self.assertIn("imported lists cannot be read", run(root, "generate")[2])
|
|
194
|
+
|
|
195
|
+
def test_same_table_in_two_scripts_is_an_error(self):
|
|
196
|
+
root = make_repo({"jobs/a.py": PY_SCRIPT, "jobs/b.py": PY_SCRIPT}, BILINGUAL)
|
|
197
|
+
code, _, err = run(root, "generate")
|
|
198
|
+
self.assertEqual(code, 1)
|
|
199
|
+
self.assertIn("table 'dwd.customer_daily' is also documented in jobs/a.py", err)
|
|
200
|
+
|
|
201
|
+
def test_hidden_directories_are_not_scanned(self):
|
|
202
|
+
root = make_repo({"jobs/a.py": PY_SCRIPT, ".worktree/jobs/a.py": PY_SCRIPT},
|
|
203
|
+
{**BILINGUAL, "scripts": ["**/jobs/*.py"]})
|
|
204
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
class AuditTest(unittest.TestCase):
|
|
208
|
+
def test_reports_undocumented_writers_with_their_columns(self):
|
|
209
|
+
legacy = '''
|
|
210
|
+
TARGET_TABLE = "dwd.legacy"
|
|
211
|
+
PUBLISHED_COLUMNS = ("dt", "cust_id", "amt")
|
|
212
|
+
'''
|
|
213
|
+
root = make_repo({"jobs/legacy.py": legacy, "jobs/helper.py": "def f():\n return 1\n"})
|
|
214
|
+
code, out, _ = run(root, "audit", "--json", "jobs/*.py")
|
|
215
|
+
self.assertEqual(code, 0)
|
|
216
|
+
report = json.loads(out)
|
|
217
|
+
self.assertEqual((report["scanned"], report["writers"], report["tables"], report["documentedTables"]), (2, 1, 1, 0))
|
|
218
|
+
[entry] = report["scripts"]
|
|
219
|
+
self.assertEqual(entry["writes"], [{"table": "dwd.legacy", "evidence": "TARGET_TABLE"}])
|
|
220
|
+
self.assertEqual(entry["columns"], ["dt", "cust_id", "amt"])
|
|
221
|
+
kinds = [f["kind"] for f in entry["findings"]]
|
|
222
|
+
self.assertEqual(kinds, ["no-catalog", "undocumented"])
|
|
223
|
+
|
|
224
|
+
def test_a_table_documented_in_its_builder_does_not_flag_backfill_scripts(self):
|
|
225
|
+
backfill = '''
|
|
226
|
+
"""Backfill: INSERT INTO docs.only_in_docstring SELECT 1"""
|
|
227
|
+
TARGET_TABLE = "dwd.customer_daily"
|
|
228
|
+
'''
|
|
229
|
+
twin = '''
|
|
230
|
+
TARGET_TABLE = "dwd.undocumented"
|
|
231
|
+
'''
|
|
232
|
+
root = make_repo({"jobs/a.py": PY_SCRIPT, "jobs/backfill_a.py": backfill,
|
|
233
|
+
"jobs/b.py": twin, "jobs/backfill_b.py": twin}, BILINGUAL)
|
|
234
|
+
report = {e["script"]: e for e in json.loads(run(root, "audit", "--json")[1])["scripts"]}
|
|
235
|
+
self.assertEqual(report["jobs/backfill_a.py"]["findings"], [])
|
|
236
|
+
self.assertEqual([w["table"] for w in report["jobs/backfill_a.py"]["writes"]], ["dwd.customer_daily"])
|
|
237
|
+
self.assertEqual(report["jobs/b.py"]["findings"][0]["message"],
|
|
238
|
+
"writes dwd.undocumented but carries no CATALOG_TABLE/CATALOG_FIELDS (or -- @table block); "
|
|
239
|
+
"also written by jobs/backfill_b.py (put the metadata in the script that builds the table)")
|
|
240
|
+
|
|
241
|
+
def test_class_attributes_name_the_table_with_their_schema(self):
|
|
242
|
+
script = '''
|
|
243
|
+
class OrdersEtl(Etl):
|
|
244
|
+
dst_db = "dwd"
|
|
245
|
+
dst_tbl = "orders"
|
|
246
|
+
|
|
247
|
+
class Other:
|
|
248
|
+
out_tbl = "scratch"
|
|
249
|
+
out_db = "tmp"
|
|
250
|
+
'''
|
|
251
|
+
root = make_repo({"jobs/orders.py": script})
|
|
252
|
+
[entry] = json.loads(run(root, "audit", "--json", "jobs/*.py")[1])["scripts"]
|
|
253
|
+
self.assertEqual(entry["writes"], [{"table": "dwd.orders", "evidence": "dst_tbl"}])
|
|
254
|
+
[entry] = json.loads(run(root, "audit", "--json", "--table-name", "out_tbl", "--schema-name", "out_db",
|
|
255
|
+
"jobs/*.py")[1])["scripts"]
|
|
256
|
+
self.assertEqual([w["table"] for w in entry["writes"]], ["dwd.orders", "tmp.scratch"])
|
|
257
|
+
|
|
258
|
+
def test_sql_select_list_columns_ignore_cte_columns_comments_and_strings(self):
|
|
259
|
+
sql = """\
|
|
260
|
+
-- INSERT INTO not.this
|
|
261
|
+
INSERT OVERWRITE TABLE ads.daily PARTITION (dt)
|
|
262
|
+
WITH base AS (SELECT a, b AS inner_only FROM src)
|
|
263
|
+
SELECT DISTINCT base.a,
|
|
264
|
+
CASE WHEN b > 0 THEN 'x, y' ELSE 'z' END AS flag,
|
|
265
|
+
sum(b) total,
|
|
266
|
+
coalesce(c, 0),
|
|
267
|
+
t.*
|
|
268
|
+
FROM base JOIN t ON t.a = base.a;
|
|
269
|
+
"""
|
|
270
|
+
root = make_repo({"sql/daily.sql": textwrap.dedent(sql)})
|
|
271
|
+
report = json.loads(run(root, "audit", "--json", "sql/*.sql")[1])
|
|
272
|
+
[entry] = report["scripts"]
|
|
273
|
+
self.assertEqual([w["table"] for w in entry["writes"]], ["ads.daily"])
|
|
274
|
+
self.assertEqual(entry["columns"], ["a", "flag", "total"])
|
|
275
|
+
self.assertFalse(entry["columnsComplete"])
|
|
276
|
+
|
|
277
|
+
def test_sql_inside_python_strings_is_read(self):
|
|
278
|
+
script = '''
|
|
279
|
+
def run(spark, target):
|
|
280
|
+
spark.sql(f"""
|
|
281
|
+
INSERT INTO TABLE {target}
|
|
282
|
+
SELECT cust_id, count(*) AS txn_cnt FROM dwd.txn GROUP BY cust_id
|
|
283
|
+
""")
|
|
284
|
+
df.write.format("hudi").option("hoodie.table.name", "dwd_txn_cnt").save(path)
|
|
285
|
+
'''
|
|
286
|
+
root = make_repo({"jobs/cnt.py": script})
|
|
287
|
+
[entry] = json.loads(run(root, "audit", "--json", "jobs/*.py")[1])["scripts"]
|
|
288
|
+
self.assertEqual([w["table"] for w in entry["writes"]], ["dwd_txn_cnt", "{expr}"])
|
|
289
|
+
self.assertEqual(entry["columns"], ["cust_id", "txn_cnt"])
|
|
290
|
+
|
|
291
|
+
def test_partial_catalog_names_missing_columns_and_thin_definitions(self):
|
|
292
|
+
script = PY_SCRIPT.replace("PUBLISHED_COLUMNS = tuple(f.name for f in CATALOG_FIELDS)",
|
|
293
|
+
'PUBLISHED_COLUMNS = ("dt", "coll_amt_7d_usd", "payout_amt_7d_usd")')
|
|
294
|
+
script = script.replace('en="Snapshot date."', 'en="dt"').replace('zh="近 7 天收款金额。"', 'zh="同上,7 天窗口。"')
|
|
295
|
+
root = make_repo({"jobs/a.py": script}, BILINGUAL)
|
|
296
|
+
[entry] = json.loads(run(root, "audit", "--json")[1])["scripts"]
|
|
297
|
+
findings = {f["kind"]: f["message"] for f in entry["findings"]}
|
|
298
|
+
self.assertEqual(findings["undocumented"], "1 column(s) with no Field: payout_amt_7d_usd")
|
|
299
|
+
self.assertEqual(findings["contract-not-derived"], "PUBLISHED_COLUMNS is a literal list; derive it from CATALOG_FIELDS")
|
|
300
|
+
self.assertEqual(findings["thin-definition"], "definition or source only restates the name: dt")
|
|
301
|
+
self.assertEqual(findings["relative-definition"], 'definition or source points at another row ("same as above"); '
|
|
302
|
+
"each row must stand alone: coll_amt_7d_usd")
|
|
303
|
+
|
|
304
|
+
def test_writing_rule_leads_flag_bloated_rows_and_spare_plain_ones(self):
|
|
305
|
+
shared = "dwd.transaction where status = 'POSTED' and cust_type <> 'TEST' and txn_date < dt"
|
|
306
|
+
rows = "\n".join(
|
|
307
|
+
f''' Field("{name}", en="{en}", zh="{zh}", source="{shared}, {agg}."),'''
|
|
308
|
+
for name, en, zh, agg in [
|
|
309
|
+
("a_cnt", "Number of posted rows whose currency has a dim.forex rate on txn_date.", "近 7 天收款笔数。", "count rows"),
|
|
310
|
+
("b_cnt", "Number of distinct payer banks.", "不同付款银行数。", "count distinct payer_bank"),
|
|
311
|
+
("c_amt", " ".join(["word"] * 31), "近 7 天收款总额。", "sum of amount"),
|
|
312
|
+
])
|
|
313
|
+
script = f'''
|
|
314
|
+
CATALOG_TABLE = Table("dwd.t", grain="One row per id.", en="Table.", zh="表。")
|
|
315
|
+
CATALOG_FIELDS = (
|
|
316
|
+
{rows}
|
|
317
|
+
)
|
|
318
|
+
'''
|
|
319
|
+
root = make_repo({"jobs/t.py": script}, BILINGUAL)
|
|
320
|
+
[entry] = json.loads(run(root, "audit", "--json")[1])["scripts"]
|
|
321
|
+
findings = {f["kind"]: f["message"] for f in entry["findings"]}
|
|
322
|
+
self.assertIn("appears in 3 of 3 rows", findings["repeated-text"])
|
|
323
|
+
self.assertTrue(findings["code-in-description"].endswith(": a_cnt"))
|
|
324
|
+
self.assertTrue(findings["long-definition"].endswith(": c_amt"))
|
|
325
|
+
|
|
326
|
+
def test_abbreviations_are_not_mistaken_for_table_names(self):
|
|
327
|
+
self.assertIsNone(dc.CODE_IN_TEXT_RE.search("Created between 0 a.m. and 6 a.m., e.g. at night."))
|
|
328
|
+
self.assertIsNotNone(dc.CODE_IN_TEXT_RE.search("Rate from dim.forex."))
|
|
329
|
+
|
|
330
|
+
def test_shared_vocabulary_and_plain_units_are_not_flagged(self):
|
|
331
|
+
script = '''
|
|
332
|
+
CATALOG_TABLE = Table("dwd.t", grain="One row per id.", en="Table.", zh="表。",
|
|
333
|
+
notes=("All metrics count posted collections.", "Every metric is 0 if there were no collections."))
|
|
334
|
+
CATALOG_FIELDS = (
|
|
335
|
+
Field("a", en="Number of collections in the last 7 days.", zh="近 7 天收款笔数。",
|
|
336
|
+
source="count of dwd.transaction rows", window="[dt-7d, dt)"),
|
|
337
|
+
Field("b", en="Number of collections in the last 30 days.", zh="近 30 天收款笔数。",
|
|
338
|
+
source="count of dwd.transaction rows", window="[dt-30d, dt)"),
|
|
339
|
+
Field("c", en="Total collected in the last 7 days, in USD.", zh="近 7 天收款总额(USD)。",
|
|
340
|
+
source="sum of dwd.transaction.amount_usd", window="[dt-7d, dt)"),
|
|
341
|
+
)
|
|
342
|
+
PUBLISHED_COLUMNS = tuple(f.name for f in CATALOG_FIELDS)
|
|
343
|
+
'''
|
|
344
|
+
root = make_repo({"jobs/t.py": script}, BILINGUAL)
|
|
345
|
+
[entry] = json.loads(run(root, "audit", "--json")[1])["scripts"]
|
|
346
|
+
self.assertEqual(entry["findings"], [])
|
|
347
|
+
|
|
348
|
+
def test_documented_script_with_derived_contract_has_no_findings(self):
|
|
349
|
+
root = make_repo({"jobs/a.py": PY_SCRIPT}, BILINGUAL)
|
|
350
|
+
report = json.loads(run(root, "audit", "--json")[1])
|
|
351
|
+
self.assertEqual((report["tables"], report["documentedTables"]), (1, 1))
|
|
352
|
+
self.assertEqual(report["scripts"][0]["findings"], [])
|
|
353
|
+
|
|
354
|
+
def test_audit_without_config_or_globs_explains_what_to_pass(self):
|
|
355
|
+
root = make_repo({})
|
|
356
|
+
code, _, err = run(root, "audit")
|
|
357
|
+
self.assertEqual(code, 2)
|
|
358
|
+
self.assertIn("pass globs to audit", err)
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
class ReviewFixTest(unittest.TestCase):
|
|
362
|
+
def test_trailing_slash_in_output_neither_fails_check_nor_deletes_pages(self):
|
|
363
|
+
root = make_repo({"sql/merchant_monthly.sql": SQL_SCRIPT}, {**BILINGUAL, "output": "docs/catalog/"})
|
|
364
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
365
|
+
code, _, err = run(root, "generate", "--check")
|
|
366
|
+
self.assertEqual(code, 0, err)
|
|
367
|
+
self.assertIn("0 written, 0 removed", run(root, "generate")[1])
|
|
368
|
+
self.assertTrue((root / "docs/catalog/ads.merchant_monthly.md").exists())
|
|
369
|
+
|
|
370
|
+
def test_plain_ctas_select_is_the_contract(self):
|
|
371
|
+
sql = SQL_SCRIPT.split("INSERT OVERWRITE")[0] + "CREATE TABLE ads.merchant_monthly AS SELECT merchant_id, volume_usd, extra FROM s;\n"
|
|
372
|
+
root = make_repo({"sql/m.sql": sql}, BILINGUAL)
|
|
373
|
+
code, _, err = run(root, "generate")
|
|
374
|
+
self.assertEqual(code, 1)
|
|
375
|
+
self.assertIn("outputs column(s) with no definition: extra", err)
|
|
376
|
+
|
|
377
|
+
def test_unaliased_expressions_never_fail_ci_on_a_guessed_name(self):
|
|
378
|
+
sql = SQL_SCRIPT.replace("SUM(s.amount_usd) AS volume_usd", "SUM(s.amount_usd) AS volume_usd, s.price * s.qty, CAST(b AS INT) + 1")
|
|
379
|
+
root = make_repo({"sql/m.sql": sql}, BILINGUAL)
|
|
380
|
+
code, _, err = run(root, "generate")
|
|
381
|
+
self.assertEqual(code, 0, err)
|
|
382
|
+
self.assertIn("has `*` or unnamed items; only its named columns are checked", err)
|
|
383
|
+
|
|
384
|
+
def test_an_unrelated_statement_is_never_used_as_the_contract(self):
|
|
385
|
+
sql = SQL_SCRIPT.replace("SELECT s.merchant_id, SUM(s.amount_usd) AS volume_usd", "SELECT *") + \
|
|
386
|
+
"INSERT INTO tmp.stage SELECT zz FROM q;\n"
|
|
387
|
+
root = make_repo({"sql/m.sql": sql}, BILINGUAL)
|
|
388
|
+
code, _, err = run(root, "generate")
|
|
389
|
+
self.assertEqual(code, 0, err)
|
|
390
|
+
self.assertIn("no column contract and no readable SELECT writing ads.merchant_monthly", err)
|
|
391
|
+
|
|
392
|
+
def test_tables_mapping_to_one_page_or_the_index_are_errors(self):
|
|
393
|
+
a = PY_SCRIPT.replace('"dwd.customer_daily",\n grain', '"ads.a_b",\n grain')
|
|
394
|
+
b = PY_SCRIPT.replace('"dwd.customer_daily",\n grain', '"ads.a b",\n grain')
|
|
395
|
+
readme = PY_SCRIPT.replace('"dwd.customer_daily",\n grain', '"README",\n grain')
|
|
396
|
+
root = make_repo({"jobs/a.py": a, "jobs/b.py": b, "jobs/c.py": readme}, BILINGUAL)
|
|
397
|
+
code, _, err = run(root, "generate")
|
|
398
|
+
self.assertEqual(code, 1)
|
|
399
|
+
self.assertIn("map to the same page ads.a_b.md", err)
|
|
400
|
+
self.assertIn("would overwrite the catalog index", err)
|
|
401
|
+
|
|
402
|
+
def test_exclude_globs_match_root_level_files_like_script_globs(self):
|
|
403
|
+
root = make_repo({"a_legacy.py": PY_SCRIPT, "jobs/b.py": PY_SCRIPT.replace("dwd.customer_daily", "dwd.other")},
|
|
404
|
+
{**BILINGUAL, "scripts": ["**/*.py"], "exclude": ["**/*_legacy.py"]})
|
|
405
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
406
|
+
self.assertEqual(sorted(p.name for p in (root / "docs/catalog").iterdir()), ["README.md", "dwd.other.md"])
|
|
407
|
+
|
|
408
|
+
def test_same_short_name_in_another_schema_is_a_different_table(self):
|
|
409
|
+
ods = '''
|
|
410
|
+
TARGET_TABLE = "ods.customer_daily"
|
|
411
|
+
'''
|
|
412
|
+
root = make_repo({"jobs/a.py": PY_SCRIPT, "jobs/ods.py": ods}, BILINGUAL)
|
|
413
|
+
report = {e["script"]: e for e in json.loads(run(root, "audit", "--json")[1])["scripts"]}
|
|
414
|
+
self.assertEqual([f["kind"] for f in report["jobs/ods.py"]["findings"]], ["no-catalog"])
|
|
415
|
+
|
|
416
|
+
def test_audit_ignores_commented_writes_dynamic_names_and_directories(self):
|
|
417
|
+
script = PY_SCRIPT + '''
|
|
418
|
+
# df.write.insertInto("old.dropped_table")
|
|
419
|
+
def run(spark, db, tbl):
|
|
420
|
+
spark.sql(f"INSERT OVERWRITE TABLE {db}.{tbl} SELECT 1")
|
|
421
|
+
spark.sql("INSERT OVERWRITE LOCAL DIRECTORY '/tmp/x' SELECT 1")
|
|
422
|
+
'''
|
|
423
|
+
root = make_repo({"jobs/a.py": script}, BILINGUAL)
|
|
424
|
+
[entry] = json.loads(run(root, "audit", "--json")[1])["scripts"]
|
|
425
|
+
self.assertEqual(sorted(w["table"] for w in entry["writes"]), ["dwd.customer_daily", "{expr}.{expr}"])
|
|
426
|
+
self.assertEqual(entry["findings"], [])
|
|
427
|
+
|
|
428
|
+
def test_python_syntax_error_is_one_finding(self):
|
|
429
|
+
root = make_repo({"jobs/a.py": "CATALOG_TABLE = (\n"}, BILINGUAL)
|
|
430
|
+
[entry] = json.loads(run(root, "audit", "--json")[1])["scripts"]
|
|
431
|
+
self.assertEqual([f["kind"] for f in entry["findings"]], ["invalid-metadata"])
|
|
432
|
+
|
|
433
|
+
def test_sql_block_ends_at_code_and_malformed_directives_fail(self):
|
|
434
|
+
late = SQL_SCRIPT + "-- @field ghost\n-- en: x\n"
|
|
435
|
+
root = make_repo({"sql/m.sql": late}, BILINGUAL)
|
|
436
|
+
self.assertEqual(run(root, "generate")[0], 0)
|
|
437
|
+
self.assertNotIn("ghost", (root / "docs/catalog/ads.merchant_monthly.md").read_text(encoding="utf-8"))
|
|
438
|
+
bad = SQL_SCRIPT.replace("-- @table ads.merchant_monthly", "-- @table ads.merchant_monthly (monthly)")
|
|
439
|
+
root = make_repo({"sql/m.sql": bad}, BILINGUAL)
|
|
440
|
+
code, _, err = run(root, "generate")
|
|
441
|
+
self.assertEqual(code, 1)
|
|
442
|
+
self.assertIn("sql/m.sql:1: write `-- @table <name>`", err)
|
|
443
|
+
|
|
444
|
+
def test_backslash_escaped_quote_keeps_the_select_readable(self):
|
|
445
|
+
sql = SQL_SCRIPT.replace("SUM(s.amount_usd) AS volume_usd", "SUM(s.amount_usd) AS volume_usd, 'it\\'s' AS note")
|
|
446
|
+
root = make_repo({"sql/m.sql": sql}, BILINGUAL)
|
|
447
|
+
code, _, err = run(root, "generate")
|
|
448
|
+
self.assertEqual(code, 1)
|
|
449
|
+
self.assertIn("outputs column(s) with no definition: note", err)
|
|
450
|
+
|
|
451
|
+
def test_init_with_invalid_json_config_exits_2(self):
|
|
452
|
+
root = make_repo({"jobs/a.py": "x = 1\n"})
|
|
453
|
+
(root / dc.CONFIG_FILE).write_text("{oops", encoding="utf-8")
|
|
454
|
+
code, _, err = run(root, "init", "--write")
|
|
455
|
+
self.assertEqual(code, 2)
|
|
456
|
+
self.assertIn("invalid JSON", err)
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
def git_repo(files: dict, config: dict) -> Path:
|
|
460
|
+
root = make_repo(files, config)
|
|
461
|
+
(root / ".git").rmdir()
|
|
462
|
+
for cmd in (["init", "-q"], ["add", "-A"], ["-c", "user.email=t@t", "-c", "user.name=t", "commit", "-qm", "base"]):
|
|
463
|
+
subprocess.run(["git", *cmd], cwd=root, check=True)
|
|
464
|
+
return root
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
def edit(root: Path, name: str, old: str, new: str) -> None:
|
|
468
|
+
path = root / name
|
|
469
|
+
text = path.read_text(encoding="utf-8")
|
|
470
|
+
assert old in text, old
|
|
471
|
+
path.write_text(text.replace(old, new), encoding="utf-8")
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
class DriftTest(unittest.TestCase):
|
|
475
|
+
def test_changed_expression_without_changed_definition_is_reported(self):
|
|
476
|
+
root = git_repo({"sql/m.sql": SQL_SCRIPT}, BILINGUAL)
|
|
477
|
+
self.assertEqual(run(root, "drift")[0], 0)
|
|
478
|
+
edit(root, "sql/m.sql", "SUM(s.amount_usd) AS volume_usd", "SUM(s.amount_usd * 0.9) AS volume_usd")
|
|
479
|
+
code, out, _ = run(root, "drift")
|
|
480
|
+
self.assertEqual(code, 1)
|
|
481
|
+
self.assertIn("sql/m.sql (ads.merchant_monthly)\n - volume_usd: its SELECT expression changed; its definition did not", out)
|
|
482
|
+
self.assertNotIn("filters, joins", out)
|
|
483
|
+
edit(root, "sql/m.sql", "Settled volume in the month.", "Settled volume net of the 10% fee.")
|
|
484
|
+
self.assertEqual(run(root, "drift")[0], 0)
|
|
485
|
+
|
|
486
|
+
def test_changed_filter_flags_the_table_until_a_definition_changes(self):
|
|
487
|
+
root = git_repo({"sql/m.sql": SQL_SCRIPT}, BILINGUAL)
|
|
488
|
+
edit(root, "sql/m.sql", "'SETTLED, final'", "'SETTLED'")
|
|
489
|
+
code, out, _ = run(root, "drift")
|
|
490
|
+
self.assertEqual(code, 1)
|
|
491
|
+
self.assertIn("filters, joins or CTEs changed; no definition changed", out)
|
|
492
|
+
edit(root, "sql/m.sql", "dwd_settlement settled rows,", "dwd_settlement rows with status SETTLED,")
|
|
493
|
+
self.assertEqual(run(root, "drift")[0], 0)
|
|
494
|
+
|
|
495
|
+
def test_dataframe_script_change_without_definition_change_is_reported(self):
|
|
496
|
+
script = PY_SCRIPT + "\ndef build(df):\n return df.filter('status = 1')\n"
|
|
497
|
+
root = git_repo({"jobs/a.py": script}, BILINGUAL)
|
|
498
|
+
edit(root, "jobs/a.py", "status = 1", "status = 2")
|
|
499
|
+
code, out, _ = run(root, "drift")
|
|
500
|
+
self.assertEqual(code, 1)
|
|
501
|
+
self.assertIn("code changed and no definition changed; the columns could not be read", out)
|
|
502
|
+
|
|
503
|
+
def test_definition_only_edit_and_untracked_new_script_are_quiet(self):
|
|
504
|
+
root = git_repo({"jobs/a.py": PY_SCRIPT}, BILINGUAL)
|
|
505
|
+
edit(root, "jobs/a.py", "Snapshot date.", "Snapshot date (UTC).")
|
|
506
|
+
(root / "jobs/new.py").write_text(textwrap.dedent(PY_SCRIPT).replace("dwd.customer_daily", "dwd.new"), encoding="utf-8")
|
|
507
|
+
self.assertEqual(run(root, "drift")[0], 0)
|
|
508
|
+
|
|
509
|
+
def test_base_ref_compares_a_whole_branch(self):
|
|
510
|
+
root = git_repo({"sql/m.sql": SQL_SCRIPT}, BILINGUAL)
|
|
511
|
+
edit(root, "sql/m.sql", "SUM(s.amount_usd) AS volume_usd", "MAX(s.amount_usd) AS volume_usd")
|
|
512
|
+
subprocess.run(["git", "-c", "user.email=t@t", "-c", "user.name=t", "commit", "-qam", "change"], cwd=root, check=True)
|
|
513
|
+
self.assertEqual(run(root, "drift")[0], 0)
|
|
514
|
+
self.assertEqual(run(root, "drift", "--base", "HEAD~1")[0], 1)
|
|
515
|
+
|
|
516
|
+
def test_outside_git_drift_exits_2(self):
|
|
517
|
+
root = make_repo({"sql/m.sql": SQL_SCRIPT}, BILINGUAL)
|
|
518
|
+
(root / ".git").rmdir()
|
|
519
|
+
code, _, err = run(root, "drift")
|
|
520
|
+
self.assertEqual(code, 2)
|
|
521
|
+
self.assertIn("is not a commit", err)
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
class InitTest(unittest.TestCase):
|
|
525
|
+
def test_dry_run_writes_nothing(self):
|
|
526
|
+
root = make_repo({"jobs/dwd/a.py": "x = 1\n"})
|
|
527
|
+
code, out, _ = run(root, "init", "--scripts", "jobs/**/*.py")
|
|
528
|
+
self.assertEqual(code, 0)
|
|
529
|
+
self.assertIn("would write data-catalog.json", out)
|
|
530
|
+
self.assertEqual(sorted(p.name for p in root.iterdir()), [".git", "jobs"])
|
|
531
|
+
|
|
532
|
+
def test_write_sets_up_repo_and_generated_module_accepts_documented_scripts(self):
|
|
533
|
+
root = make_repo({"jobs/dwd/customer_daily.py": PY_SCRIPT, "jobs/dwd/other.py": "x = 1\n",
|
|
534
|
+
"AGENTS.md": "# Agents\n\nExisting rules.\n"})
|
|
535
|
+
code, out, err = run(root, "init", "--scripts", "jobs/**/*.py", "--languages", "en,zh", "--write")
|
|
536
|
+
self.assertEqual(code, 0, err)
|
|
537
|
+
config = json.loads((root / dc.CONFIG_FILE).read_text(encoding="utf-8"))
|
|
538
|
+
self.assertEqual(config["fieldsModule"], "jobs/dwd/catalog_fields.py")
|
|
539
|
+
self.assertEqual((root / dc.ENGINE_PATH).read_text(encoding="utf-8"), (HERE / "data_catalog.py").read_text(encoding="utf-8"))
|
|
540
|
+
workflow = (root / dc.WORKFLOW_PATH).read_text(encoding="utf-8")
|
|
541
|
+
self.assertIn(" - 'jobs/**/*.py'\n", workflow)
|
|
542
|
+
self.assertIn("run: python3 scripts/data-catalog/data_catalog.py generate --check", workflow)
|
|
543
|
+
# agent pointers are persist-conventions.mjs's job; init leaves them alone
|
|
544
|
+
self.assertEqual((root / "AGENTS.md").read_text(encoding="utf-8"), "# Agents\n\nExisting rules.\n")
|
|
545
|
+
self.assertFalse((root / "CLAUDE.md").exists())
|
|
546
|
+
self.assertTrue((root / "docs/catalog/dwd.customer_daily.md").exists())
|
|
547
|
+
# the generated runtime module takes exactly the arguments the engine reads
|
|
548
|
+
spec = importlib.util.spec_from_file_location("catalog_fields", root / config["fieldsModule"])
|
|
549
|
+
module = importlib.util.module_from_spec(spec)
|
|
550
|
+
sys.modules["catalog_fields"] = module # dataclasses resolve string annotations through sys.modules
|
|
551
|
+
self.addCleanup(sys.modules.pop, "catalog_fields", None)
|
|
552
|
+
spec.loader.exec_module(module)
|
|
553
|
+
f = module.Field("x", en="e", zh="z", source="s", window="7d", unit="USD")
|
|
554
|
+
self.assertEqual((f.name, f.zh, f.unit), ("x", "z", "USD"))
|
|
555
|
+
with self.assertRaises(TypeError):
|
|
556
|
+
module.Field("x", en="e", source="s")
|
|
557
|
+
# rerunning is a no-op, and the catalog check passes
|
|
558
|
+
code, out, _ = run(root, "init", "--write")
|
|
559
|
+
self.assertEqual(code, 0)
|
|
560
|
+
self.assertNotIn("write ", out.replace("would write", ""))
|
|
561
|
+
self.assertEqual(run(root, "generate", "--check")[0], 0)
|
|
562
|
+
|
|
563
|
+
def test_bad_language_code_is_refused(self):
|
|
564
|
+
root = make_repo({"jobs/a.py": "x = 1\n"})
|
|
565
|
+
code, _, err = run(root, "init", "--scripts", "jobs/*.py", "--languages", "English", "--write")
|
|
566
|
+
self.assertEqual(code, 2)
|
|
567
|
+
self.assertIn("`languages` must be codes", err)
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
if __name__ == "__main__":
|
|
571
|
+
unittest.main()
|