terramend 0.2.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/LICENSE +661 -0
- package/README.md +145 -0
- package/dist/agents/claude.d.ts +73 -0
- package/dist/agents/claudePretoolGate.d.ts +99 -0
- package/dist/agents/gateServer.d.ts +7 -0
- package/dist/agents/index.d.ts +6 -0
- package/dist/agents/nativeFsDenies.d.ts +28 -0
- package/dist/agents/opencode.d.ts +231 -0
- package/dist/agents/opencodePlugin.d.ts +85 -0
- package/dist/agents/opencodeShared.d.ts +40 -0
- package/dist/agents/postRun.d.ts +132 -0
- package/dist/agents/reviewer.d.ts +38 -0
- package/dist/agents/sessionLabeler.d.ts +97 -0
- package/dist/agents/shared.d.ts +189 -0
- package/dist/agents/subagentModels.d.ts +19 -0
- package/dist/agents/subagentToolGates.d.ts +55 -0
- package/dist/cli.mjs +197426 -0
- package/dist/external.d.ts +227 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +196783 -0
- package/dist/internal/index.d.ts +18 -0
- package/dist/internal.js +1714 -0
- package/dist/lifecycle.d.ts +2 -0
- package/dist/main.d.ts +8 -0
- package/dist/mcp/arkConfig.d.ts +1 -0
- package/dist/mcp/checkSuite.d.ts +25 -0
- package/dist/mcp/checkout.d.ts +77 -0
- package/dist/mcp/comment.d.ts +119 -0
- package/dist/mcp/commitInfo.d.ts +9 -0
- package/dist/mcp/crosswalk.d.ts +105 -0
- package/dist/mcp/dependencies.d.ts +8 -0
- package/dist/mcp/geminiSanitizer.d.ts +28 -0
- package/dist/mcp/git.d.ts +46 -0
- package/dist/mcp/guardrails.d.ts +104 -0
- package/dist/mcp/issue.d.ts +18 -0
- package/dist/mcp/issueComments.d.ts +9 -0
- package/dist/mcp/issueEvents.d.ts +9 -0
- package/dist/mcp/issueInfo.d.ts +9 -0
- package/dist/mcp/labels.d.ts +12 -0
- package/dist/mcp/localContext.d.ts +19 -0
- package/dist/mcp/moduleExtraction.d.ts +71 -0
- package/dist/mcp/moduleTests.d.ts +104 -0
- package/dist/mcp/modules.d.ts +179 -0
- package/dist/mcp/output.d.ts +12 -0
- package/dist/mcp/pathSafety.d.ts +14 -0
- package/dist/mcp/policy.d.ts +48 -0
- package/dist/mcp/pr.d.ts +49 -0
- package/dist/mcp/prInfo.d.ts +9 -0
- package/dist/mcp/providerSchema.d.ts +50 -0
- package/dist/mcp/review.d.ts +199 -0
- package/dist/mcp/reviewComments.d.ts +178 -0
- package/dist/mcp/roots.d.ts +58 -0
- package/dist/mcp/scope.d.ts +15 -0
- package/dist/mcp/selectMode.d.ts +18 -0
- package/dist/mcp/server.d.ts +48 -0
- package/dist/mcp/shared.d.ts +47 -0
- package/dist/mcp/shell.d.ts +37 -0
- package/dist/mcp/staleFix.d.ts +51 -0
- package/dist/mcp/terraform/cost.d.ts +55 -0
- package/dist/mcp/terraform/currency.d.ts +94 -0
- package/dist/mcp/terraform/decisions.d.ts +178 -0
- package/dist/mcp/terraform/findings.d.ts +75 -0
- package/dist/mcp/terraform/plan.d.ts +157 -0
- package/dist/mcp/terraform/scanners.d.ts +131 -0
- package/dist/mcp/terraform/tools.d.ts +63 -0
- package/dist/mcp/terraform/types.d.ts +172 -0
- package/dist/mcp/terraform.d.ts +22 -0
- package/dist/mcp/terratest.d.ts +83 -0
- package/dist/mcp/upload.d.ts +6 -0
- package/dist/models.d.ts +171 -0
- package/dist/modes.d.ts +26 -0
- package/dist/prep/index.d.ts +7 -0
- package/dist/prep/installNodeDependencies.d.ts +2 -0
- package/dist/prep/installPythonDependencies.d.ts +2 -0
- package/dist/prep/types.d.ts +31 -0
- package/dist/reviewQuality.d.ts +64 -0
- package/dist/skills/terraform-best-practices/SKILL.md +369 -0
- package/dist/toolState.d.ts +135 -0
- package/dist/utils/activity.d.ts +40 -0
- package/dist/utils/agent.d.ts +20 -0
- package/dist/utils/agentHangReport.d.ts +38 -0
- package/dist/utils/apiFetch.d.ts +19 -0
- package/dist/utils/apiKeys.d.ts +41 -0
- package/dist/utils/apiUrl.d.ts +20 -0
- package/dist/utils/assets.d.ts +8 -0
- package/dist/utils/billingErrors.d.ts +85 -0
- package/dist/utils/body.d.ts +34 -0
- package/dist/utils/buildTerramendFooter.d.ts +25 -0
- package/dist/utils/byokFallback.d.ts +85 -0
- package/dist/utils/claudeSubscription.d.ts +30 -0
- package/dist/utils/cli.d.ts +10 -0
- package/dist/utils/codexHome.d.ts +29 -0
- package/dist/utils/codexOAuth.d.ts +60 -0
- package/dist/utils/diffCoverage.d.ts +63 -0
- package/dist/utils/errorReport.d.ts +17 -0
- package/dist/utils/exitHandler.d.ts +8 -0
- package/dist/utils/fixDoubleEscapedString.d.ts +1 -0
- package/dist/utils/gitAuth.d.ts +84 -0
- package/dist/utils/gitAuthServer.d.ts +24 -0
- package/dist/utils/github.d.ts +78 -0
- package/dist/utils/globals.d.ts +3 -0
- package/dist/utils/install.d.ts +60 -0
- package/dist/utils/instructions.d.ts +48 -0
- package/dist/utils/leapingComment.d.ts +11 -0
- package/dist/utils/learnings.d.ts +62 -0
- package/dist/utils/learningsTruncate.d.ts +25 -0
- package/dist/utils/lifecycle.d.ts +57 -0
- package/dist/utils/log.d.ts +111 -0
- package/dist/utils/normalizeEnv.d.ts +30 -0
- package/dist/utils/openCodeModels.d.ts +11 -0
- package/dist/utils/overrides.d.ts +40 -0
- package/dist/utils/packageManager.d.ts +49 -0
- package/dist/utils/patchWorkflowRunFields.d.ts +29 -0
- package/dist/utils/payload.d.ts +105 -0
- package/dist/utils/prSummary.d.ts +61 -0
- package/dist/utils/progressComment.d.ts +146 -0
- package/dist/utils/providerErrors.d.ts +31 -0
- package/dist/utils/rangeDiff.d.ts +51 -0
- package/dist/utils/remediationCommand.d.ts +55 -0
- package/dist/utils/retry.d.ts +13 -0
- package/dist/utils/reviewCleanup.d.ts +14 -0
- package/dist/utils/run.d.ts +9 -0
- package/dist/utils/runContext.d.ts +60 -0
- package/dist/utils/runContextData.d.ts +23 -0
- package/dist/utils/runErrorRenderer.d.ts +64 -0
- package/dist/utils/runLifecycle.d.ts +86 -0
- package/dist/utils/runStartupLog.d.ts +15 -0
- package/dist/utils/secrets.d.ts +22 -0
- package/dist/utils/setup.d.ts +90 -0
- package/dist/utils/shell.d.ts +32 -0
- package/dist/utils/skills.d.ts +10 -0
- package/dist/utils/subprocess.d.ts +80 -0
- package/dist/utils/terraformMcp.d.ts +42 -0
- package/dist/utils/time.d.ts +15 -0
- package/dist/utils/timer.d.ts +23 -0
- package/dist/utils/todoTracking.d.ts +16 -0
- package/dist/utils/token.d.ts +39 -0
- package/dist/utils/version.d.ts +2 -0
- package/dist/utils/versioning.d.ts +7 -0
- package/dist/utils/vertex.d.ts +16 -0
- package/dist/utils/workflow.d.ts +13 -0
- package/package.json +119 -0
- package/src/agents/claude.test.ts +1016 -0
- package/src/agents/claude.ts +1246 -0
- package/src/agents/claudePretoolGate.test.ts +28 -0
- package/src/agents/claudePretoolGate.ts +173 -0
- package/src/agents/gateServer.test.ts +204 -0
- package/src/agents/gateServer.ts +124 -0
- package/src/agents/index.ts +10 -0
- package/src/agents/nativeFsDenies.ts +82 -0
- package/src/agents/opencode.test.ts +1440 -0
- package/src/agents/opencode.ts +1312 -0
- package/src/agents/opencodePlugin.ts +222 -0
- package/src/agents/opencodeShared.test.ts +34 -0
- package/src/agents/opencodeShared.ts +121 -0
- package/src/agents/postRun.test.ts +549 -0
- package/src/agents/postRun.ts +535 -0
- package/src/agents/reviewer.ts +104 -0
- package/src/agents/sessionLabeler.test.ts +247 -0
- package/src/agents/sessionLabeler.ts +178 -0
- package/src/agents/shared.test.ts +76 -0
- package/src/agents/shared.ts +292 -0
- package/src/agents/subagentModels.test.ts +113 -0
- package/src/agents/subagentModels.ts +40 -0
- package/src/agents/subagentRegistration.test.ts +41 -0
- package/src/agents/subagentToolGates.ts +114 -0
- package/src/cli.test.ts +129 -0
- package/src/cli.ts +105 -0
- package/src/commands/gha.test.ts +192 -0
- package/src/commands/gha.ts +188 -0
- package/src/commands/mcp.ts +122 -0
- package/src/config.ts +1 -0
- package/src/entry.ts +7 -0
- package/src/entryPost.stdlibOnly.test.ts +109 -0
- package/src/entryPost.ts +99 -0
- package/src/external.test.ts +16 -0
- package/src/external.ts +302 -0
- package/src/index.ts +11 -0
- package/src/internal/index.ts +71 -0
- package/src/lifecycle.ts +2 -0
- package/src/main.test.ts +873 -0
- package/src/main.ts +712 -0
- package/src/mcp/__fixtures__/terramend-scratch-pr-49-review-3485940013.json +110 -0
- package/src/mcp/__fixtures__/terramend-scratch-pr-64-review-3531000326.json +14 -0
- package/src/mcp/__fixtures__/terramend-test-repo-pr-1.diff.json +67 -0
- package/src/mcp/__snapshots__/checkout.test.ts.snap +109 -0
- package/src/mcp/__snapshots__/reviewComments.test.ts.snap +71 -0
- package/src/mcp/arkConfig.ts +7 -0
- package/src/mcp/checkSuite.test.ts +245 -0
- package/src/mcp/checkSuite.ts +255 -0
- package/src/mcp/checkout.test.ts +752 -0
- package/src/mcp/checkout.ts +886 -0
- package/src/mcp/comment.test.ts +772 -0
- package/src/mcp/comment.ts +582 -0
- package/src/mcp/commitInfo.test.ts +127 -0
- package/src/mcp/commitInfo.ts +61 -0
- package/src/mcp/crosswalk.test.ts +106 -0
- package/src/mcp/crosswalk.ts +339 -0
- package/src/mcp/dependencies.test.ts +309 -0
- package/src/mcp/dependencies.ts +189 -0
- package/src/mcp/geminiSanitizer.test.ts +287 -0
- package/src/mcp/geminiSanitizer.ts +207 -0
- package/src/mcp/git.test.ts +1083 -0
- package/src/mcp/git.ts +890 -0
- package/src/mcp/guardrails.test.ts +705 -0
- package/src/mcp/guardrails.ts +465 -0
- package/src/mcp/issue.test.ts +113 -0
- package/src/mcp/issue.ts +73 -0
- package/src/mcp/issueComments.test.ts +69 -0
- package/src/mcp/issueComments.ts +48 -0
- package/src/mcp/issueEvents.test.ts +134 -0
- package/src/mcp/issueEvents.ts +100 -0
- package/src/mcp/issueInfo.test.ts +104 -0
- package/src/mcp/issueInfo.ts +72 -0
- package/src/mcp/labels.test.ts +52 -0
- package/src/mcp/labels.ts +34 -0
- package/src/mcp/localContext.ts +28 -0
- package/src/mcp/localServer.test.ts +75 -0
- package/src/mcp/localServer.ts +131 -0
- package/src/mcp/moduleExtraction.test.ts +261 -0
- package/src/mcp/moduleExtraction.ts +313 -0
- package/src/mcp/moduleTests.test.ts +269 -0
- package/src/mcp/moduleTests.ts +421 -0
- package/src/mcp/modules.test.ts +640 -0
- package/src/mcp/modules.ts +696 -0
- package/src/mcp/output.test.ts +96 -0
- package/src/mcp/output.ts +70 -0
- package/src/mcp/pathSafety.test.ts +44 -0
- package/src/mcp/pathSafety.ts +28 -0
- package/src/mcp/policy.test.ts +282 -0
- package/src/mcp/policy.ts +199 -0
- package/src/mcp/pr.test.ts +387 -0
- package/src/mcp/pr.ts +194 -0
- package/src/mcp/prInfo.test.ts +96 -0
- package/src/mcp/prInfo.ts +91 -0
- package/src/mcp/providerSchema.test.ts +85 -0
- package/src/mcp/providerSchema.ts +175 -0
- package/src/mcp/review.test.ts +936 -0
- package/src/mcp/review.ts +923 -0
- package/src/mcp/reviewComments.test.ts +549 -0
- package/src/mcp/reviewComments.ts +896 -0
- package/src/mcp/roots.test.ts +175 -0
- package/src/mcp/roots.ts +217 -0
- package/src/mcp/scope.test.ts +59 -0
- package/src/mcp/scope.ts +65 -0
- package/src/mcp/security.test.ts +720 -0
- package/src/mcp/selectMode.test.ts +210 -0
- package/src/mcp/selectMode.ts +181 -0
- package/src/mcp/server.test.ts +292 -0
- package/src/mcp/server.ts +403 -0
- package/src/mcp/shared.ts +100 -0
- package/src/mcp/shell.test.ts +520 -0
- package/src/mcp/shell.ts +505 -0
- package/src/mcp/staleFix.test.ts +237 -0
- package/src/mcp/staleFix.ts +277 -0
- package/src/mcp/terraform/cost.ts +163 -0
- package/src/mcp/terraform/currency.test.ts +338 -0
- package/src/mcp/terraform/currency.ts +336 -0
- package/src/mcp/terraform/decisions.ts +527 -0
- package/src/mcp/terraform/findings.ts +333 -0
- package/src/mcp/terraform/plan.ts +348 -0
- package/src/mcp/terraform/scanners.ts +809 -0
- package/src/mcp/terraform/tools.test.ts +1071 -0
- package/src/mcp/terraform/tools.ts +908 -0
- package/src/mcp/terraform/types.ts +305 -0
- package/src/mcp/terraform.test.ts +1957 -0
- package/src/mcp/terraform.ts +23 -0
- package/src/mcp/terratest.test.ts +105 -0
- package/src/mcp/terratest.ts +196 -0
- package/src/mcp/toolFiltering.test.ts +85 -0
- package/src/mcp/upload.test.ts +180 -0
- package/src/mcp/upload.ts +112 -0
- package/src/models.test.ts +300 -0
- package/src/models.ts +708 -0
- package/src/modes.test.ts +107 -0
- package/src/modes.ts +880 -0
- package/src/prep/index.ts +43 -0
- package/src/prep/installNodeDependencies.test.ts +298 -0
- package/src/prep/installNodeDependencies.ts +196 -0
- package/src/prep/installPythonDependencies.test.ts +268 -0
- package/src/prep/installPythonDependencies.ts +199 -0
- package/src/prep/types.ts +38 -0
- package/src/reviewQuality.test.ts +63 -0
- package/src/reviewQuality.ts +134 -0
- package/src/runCli.test.ts +214 -0
- package/src/runCli.ts +282 -0
- package/src/skills/terraform-best-practices/SKILL.md +369 -0
- package/src/toolState.test.ts +45 -0
- package/src/toolState.ts +252 -0
- package/src/utils/activity.test.ts +188 -0
- package/src/utils/activity.ts +210 -0
- package/src/utils/agent.test.ts +251 -0
- package/src/utils/agent.ts +139 -0
- package/src/utils/agentHangReport.test.ts +203 -0
- package/src/utils/agentHangReport.ts +170 -0
- package/src/utils/apiFetch.test.ts +115 -0
- package/src/utils/apiFetch.ts +62 -0
- package/src/utils/apiKeys.test.ts +344 -0
- package/src/utils/apiKeys.ts +206 -0
- package/src/utils/apiUrl.test.ts +30 -0
- package/src/utils/apiUrl.ts +59 -0
- package/src/utils/assets.test.ts +153 -0
- package/src/utils/assets.ts +107 -0
- package/src/utils/billingErrors.test.ts +121 -0
- package/src/utils/billingErrors.ts +189 -0
- package/src/utils/body.test.ts +217 -0
- package/src/utils/body.ts +168 -0
- package/src/utils/buildTerramendFooter.test.ts +38 -0
- package/src/utils/buildTerramendFooter.ts +82 -0
- package/src/utils/byokFallback.test.ts +205 -0
- package/src/utils/byokFallback.ts +128 -0
- package/src/utils/claudeSubscription.test.ts +179 -0
- package/src/utils/claudeSubscription.ts +93 -0
- package/src/utils/cli.ts +31 -0
- package/src/utils/codexHome.test.ts +190 -0
- package/src/utils/codexHome.ts +191 -0
- package/src/utils/codexOAuth.ts +147 -0
- package/src/utils/codexRefreshDetect.test.ts +85 -0
- package/src/utils/codexRefreshDetect.ts +35 -0
- package/src/utils/diffCoverage.test.ts +468 -0
- package/src/utils/diffCoverage.ts +404 -0
- package/src/utils/errorReport.test.ts +135 -0
- package/src/utils/errorReport.ts +83 -0
- package/src/utils/exitHandler.ts +35 -0
- package/src/utils/fixDoubleEscapedString.ts +9 -0
- package/src/utils/ghaCore.ts +13 -0
- package/src/utils/gitAuth.test.ts +322 -0
- package/src/utils/gitAuth.ts +263 -0
- package/src/utils/gitAuthServer.test.ts +260 -0
- package/src/utils/gitAuthServer.ts +182 -0
- package/src/utils/github.test.ts +615 -0
- package/src/utils/github.ts +538 -0
- package/src/utils/globals.ts +9 -0
- package/src/utils/humanEditCapture.test.ts +100 -0
- package/src/utils/humanEditCapture.ts +193 -0
- package/src/utils/install.test.ts +768 -0
- package/src/utils/install.ts +492 -0
- package/src/utils/instructions.test.ts +240 -0
- package/src/utils/instructions.ts +543 -0
- package/src/utils/leapingComment.test.ts +51 -0
- package/src/utils/leapingComment.ts +18 -0
- package/src/utils/learnings.test.ts +87 -0
- package/src/utils/learnings.ts +138 -0
- package/src/utils/learningsTocRender.test.ts +116 -0
- package/src/utils/learningsTruncate.test.ts +39 -0
- package/src/utils/learningsTruncate.ts +42 -0
- package/src/utils/lifecycle.test.ts +195 -0
- package/src/utils/lifecycle.ts +198 -0
- package/src/utils/log.test.ts +402 -0
- package/src/utils/log.ts +432 -0
- package/src/utils/normalizeEnv.test.ts +91 -0
- package/src/utils/normalizeEnv.ts +106 -0
- package/src/utils/openCodeModels.ts +82 -0
- package/src/utils/overrides.test.ts +89 -0
- package/src/utils/overrides.ts +98 -0
- package/src/utils/packageManager.test.ts +321 -0
- package/src/utils/packageManager.ts +257 -0
- package/src/utils/patchWorkflowRunFields.test.ts +92 -0
- package/src/utils/patchWorkflowRunFields.ts +150 -0
- package/src/utils/payload.test.ts +497 -0
- package/src/utils/payload.ts +371 -0
- package/src/utils/postApiFetch.ts +51 -0
- package/src/utils/prSummary.test.ts +224 -0
- package/src/utils/prSummary.ts +147 -0
- package/src/utils/progressComment.ts +261 -0
- package/src/utils/providerErrors.test.ts +315 -0
- package/src/utils/providerErrors.ts +172 -0
- package/src/utils/rangeDiff.test.ts +236 -0
- package/src/utils/rangeDiff.ts +182 -0
- package/src/utils/remediationCommand.test.ts +163 -0
- package/src/utils/remediationCommand.ts +119 -0
- package/src/utils/retry.test.ts +153 -0
- package/src/utils/retry.ts +58 -0
- package/src/utils/reviewCleanup.ts +106 -0
- package/src/utils/run.ts +99 -0
- package/src/utils/runContext.ts +145 -0
- package/src/utils/runContextData.ts +58 -0
- package/src/utils/runErrorRenderer.test.ts +95 -0
- package/src/utils/runErrorRenderer.ts +259 -0
- package/src/utils/runFixture.ts +76 -0
- package/src/utils/runLifecycle.ts +237 -0
- package/src/utils/runStartupLog.ts +60 -0
- package/src/utils/secrets.test.ts +103 -0
- package/src/utils/secrets.ts +177 -0
- package/src/utils/setup.test.ts +509 -0
- package/src/utils/setup.ts +352 -0
- package/src/utils/shell.ts +103 -0
- package/src/utils/skills.test.ts +46 -0
- package/src/utils/skills.ts +67 -0
- package/src/utils/subprocess.test.ts +170 -0
- package/src/utils/subprocess.ts +438 -0
- package/src/utils/terraformMcp.test.ts +63 -0
- package/src/utils/terraformMcp.ts +83 -0
- package/src/utils/time.test.ts +105 -0
- package/src/utils/time.ts +59 -0
- package/src/utils/timer.test.ts +91 -0
- package/src/utils/timer.ts +72 -0
- package/src/utils/todoTracking.test.ts +223 -0
- package/src/utils/todoTracking.ts +167 -0
- package/src/utils/token.test.ts +239 -0
- package/src/utils/token.ts +186 -0
- package/src/utils/version.ts +10 -0
- package/src/utils/versioning.test.ts +34 -0
- package/src/utils/versioning.ts +44 -0
- package/src/utils/vertex.ts +85 -0
- package/src/utils/workflow.ts +25 -0
|
@@ -0,0 +1,640 @@
|
|
|
1
|
+
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
|
2
|
+
import { tmpdir } from "node:os";
|
|
3
|
+
import { join } from "node:path";
|
|
4
|
+
import { afterAll, beforeAll, describe, expect, it } from "vitest";
|
|
5
|
+
import {
|
|
6
|
+
classifyModuleSource,
|
|
7
|
+
collectModuleGraph,
|
|
8
|
+
collectModuleInterface,
|
|
9
|
+
dependencyOrderedModuleDirs,
|
|
10
|
+
isInLocalModule,
|
|
11
|
+
ListModulesTool,
|
|
12
|
+
type ModuleGraph,
|
|
13
|
+
moduleDirExists,
|
|
14
|
+
parseModuleBlocks,
|
|
15
|
+
parseModuleCatalogue,
|
|
16
|
+
parseModuleInterface,
|
|
17
|
+
splitModuleSource,
|
|
18
|
+
TerraformModuleGraphTool,
|
|
19
|
+
TerraformModuleInterfaceTool,
|
|
20
|
+
walkTfFiles,
|
|
21
|
+
} from "#app/mcp/modules";
|
|
22
|
+
import type { ToolContext } from "#app/mcp/server";
|
|
23
|
+
|
|
24
|
+
type ToolResultShape = { content: [{ type: "text"; text: string }]; isError?: boolean };
|
|
25
|
+
|
|
26
|
+
async function runTool(t: { execute?: unknown }, params: unknown): Promise<ToolResultShape> {
|
|
27
|
+
const exec = t.execute as (p: unknown, c: unknown) => Promise<ToolResultShape>;
|
|
28
|
+
return exec(params, {});
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
function makeCtx(payload: { cwd?: string; moduleCatalogue?: string }): ToolContext {
|
|
32
|
+
return { payload } as unknown as ToolContext;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// real source strings copied verbatim from the hepcare repo + the UKHSA
|
|
36
|
+
// data-integration-terraform-modules library it consumes — these are the
|
|
37
|
+
// patterns the parser MUST handle.
|
|
38
|
+
const HEPCARE_GIT =
|
|
39
|
+
"git::https://github.com/UKHSA-Internal/data-integration-terraform-modules.git//aws/kms?ref=kms-v0.1.0";
|
|
40
|
+
const REGISTRY_SUBMODULE = "terraform-aws-modules/cloudwatch/aws//modules/log-group";
|
|
41
|
+
|
|
42
|
+
describe("splitModuleSource", () => {
|
|
43
|
+
it("splits a git source into base, subdir, and ref (the version pin)", () => {
|
|
44
|
+
expect(splitModuleSource(HEPCARE_GIT)).toEqual({
|
|
45
|
+
raw: HEPCARE_GIT,
|
|
46
|
+
base: "git::https://github.com/UKHSA-Internal/data-integration-terraform-modules.git",
|
|
47
|
+
subdir: "aws/kms",
|
|
48
|
+
ref: "kms-v0.1.0",
|
|
49
|
+
kind: "git",
|
|
50
|
+
});
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it("splits a registry submodule path without mistaking // for the scheme", () => {
|
|
54
|
+
expect(splitModuleSource(REGISTRY_SUBMODULE)).toMatchObject({
|
|
55
|
+
base: "terraform-aws-modules/cloudwatch/aws",
|
|
56
|
+
subdir: "modules/log-group",
|
|
57
|
+
ref: null,
|
|
58
|
+
kind: "registry",
|
|
59
|
+
});
|
|
60
|
+
});
|
|
61
|
+
|
|
62
|
+
it("leaves a plain local/registry source untouched", () => {
|
|
63
|
+
expect(splitModuleSource("./modules/cloudwatch_logs")).toMatchObject({
|
|
64
|
+
base: "./modules/cloudwatch_logs",
|
|
65
|
+
subdir: null,
|
|
66
|
+
ref: null,
|
|
67
|
+
kind: "local",
|
|
68
|
+
});
|
|
69
|
+
expect(splitModuleSource("terraform-aws-modules/vpc/aws")).toMatchObject({
|
|
70
|
+
kind: "registry",
|
|
71
|
+
subdir: null,
|
|
72
|
+
});
|
|
73
|
+
});
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
describe("classifyModuleSource (real-world sources)", () => {
|
|
77
|
+
it("classifies the hepcare git library source as git", () => {
|
|
78
|
+
expect(classifyModuleSource(HEPCARE_GIT)).toBe("git");
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
it("classifies a registry submodule path as registry (was previously 'unknown')", () => {
|
|
82
|
+
expect(classifyModuleSource(REGISTRY_SUBMODULE)).toBe("registry");
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it("classifies local, plain registry, git, and remote", () => {
|
|
86
|
+
expect(classifyModuleSource("./modules/vpc")).toBe("local");
|
|
87
|
+
expect(classifyModuleSource("../shared/net")).toBe("local");
|
|
88
|
+
expect(classifyModuleSource("terraform-aws-modules/vpc/aws")).toBe("registry");
|
|
89
|
+
expect(classifyModuleSource("git@github.com:acme/mod.git")).toBe("git");
|
|
90
|
+
expect(classifyModuleSource("s3::https://bucket.s3.amazonaws.com/mod.zip")).toBe("remote");
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
it("returns unknown for an unparseable source", () => {
|
|
94
|
+
expect(classifyModuleSource("")).toBe("unknown");
|
|
95
|
+
expect(classifyModuleSource("just-a-name")).toBe("unknown");
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
describe("parseModuleCatalogue (real-world sources)", () => {
|
|
100
|
+
it("parses a git library entry — name from the subdir, version from the ref", () => {
|
|
101
|
+
const [m] = parseModuleCatalogue(HEPCARE_GIT);
|
|
102
|
+
expect(m).toEqual({ name: "kms", source: HEPCARE_GIT, version: "kms-v0.1.0", kind: "git" });
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
it("parses name=source version and a registry shorthand", () => {
|
|
106
|
+
expect(parseModuleCatalogue("vpc=terraform-aws-modules/vpc/aws ~> 5.0")).toEqual([
|
|
107
|
+
{ name: "vpc", source: "terraform-aws-modules/vpc/aws", version: "~> 5.0", kind: "registry" },
|
|
108
|
+
]);
|
|
109
|
+
const [s3] = parseModuleCatalogue("terraform-aws-modules/s3-bucket/aws");
|
|
110
|
+
expect(s3).toMatchObject({ name: "s3-bucket", version: null, kind: "registry" });
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
it("derives a registry-submodule name from its subdir", () => {
|
|
114
|
+
expect(parseModuleCatalogue(REGISTRY_SUBMODULE)[0]!.name).toBe("log-group");
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
it("handles local paths, newline/comma splitting, and dedup", () => {
|
|
118
|
+
const out = parseModuleCatalogue(
|
|
119
|
+
"./modules/networking\nterraform-aws-modules/vpc/aws, ./modules/networking",
|
|
120
|
+
);
|
|
121
|
+
expect(out).toHaveLength(2);
|
|
122
|
+
expect(out[0]).toMatchObject({
|
|
123
|
+
source: "./modules/networking",
|
|
124
|
+
kind: "local",
|
|
125
|
+
name: "networking",
|
|
126
|
+
});
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
it("returns nothing for empty input", () => {
|
|
130
|
+
expect(parseModuleCatalogue(undefined)).toEqual([]);
|
|
131
|
+
expect(parseModuleCatalogue(" \n , ")).toEqual([]);
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
describe("parseModuleBlocks (real-world)", () => {
|
|
136
|
+
it("extracts a git module's ref as its version (no version attribute)", () => {
|
|
137
|
+
const hcl = `module "kms_uploads" {
|
|
138
|
+
source = "${HEPCARE_GIT}"
|
|
139
|
+
for_each = local.upload_buckets
|
|
140
|
+
}`;
|
|
141
|
+
expect(parseModuleBlocks(hcl)).toEqual([
|
|
142
|
+
{
|
|
143
|
+
name: "kms_uploads",
|
|
144
|
+
source: HEPCARE_GIT,
|
|
145
|
+
version: "kms-v0.1.0",
|
|
146
|
+
subdir: "aws/kms",
|
|
147
|
+
kind: "git",
|
|
148
|
+
declaredIn: "",
|
|
149
|
+
},
|
|
150
|
+
]);
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
it("prefers an explicit version attribute over a ref", () => {
|
|
154
|
+
const hcl = `module "vpc" {
|
|
155
|
+
source = "terraform-aws-modules/vpc/aws"
|
|
156
|
+
version = "~> 5.0"
|
|
157
|
+
}`;
|
|
158
|
+
expect(parseModuleBlocks(hcl)[0]).toMatchObject({
|
|
159
|
+
version: "~> 5.0",
|
|
160
|
+
kind: "registry",
|
|
161
|
+
subdir: null,
|
|
162
|
+
});
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it("parses a local module and brace-matches a nested map", () => {
|
|
166
|
+
const hcl = `module "a" {
|
|
167
|
+
source = "./modules/cloudwatch_logs"
|
|
168
|
+
providers = { aws = aws.useast1 }
|
|
169
|
+
}`;
|
|
170
|
+
expect(parseModuleBlocks(hcl)[0]).toMatchObject({
|
|
171
|
+
name: "a",
|
|
172
|
+
source: "./modules/cloudwatch_logs",
|
|
173
|
+
kind: "local",
|
|
174
|
+
});
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
it("returns nothing when there are no module blocks", () => {
|
|
178
|
+
expect(parseModuleBlocks('resource "aws_s3_bucket" "b" {}')).toEqual([]);
|
|
179
|
+
});
|
|
180
|
+
});
|
|
181
|
+
|
|
182
|
+
describe("isInLocalModule", () => {
|
|
183
|
+
const graph: ModuleGraph = {
|
|
184
|
+
modules: [],
|
|
185
|
+
localModuleDirs: [{ dir: "modules/net", callers: ["main.tf"] }],
|
|
186
|
+
externalCount: 1,
|
|
187
|
+
};
|
|
188
|
+
|
|
189
|
+
it("matches a file inside a local module dir (exact prefix, not substring)", () => {
|
|
190
|
+
expect(isInLocalModule("modules/net/vpc.tf", graph)?.dir).toBe("modules/net");
|
|
191
|
+
expect(isInLocalModule("./modules/net/vpc.tf", graph)?.dir).toBe("modules/net");
|
|
192
|
+
expect(isInLocalModule("modules/network/vpc.tf", graph)).toBeNull();
|
|
193
|
+
expect(isInLocalModule("main.tf", graph)).toBeNull();
|
|
194
|
+
});
|
|
195
|
+
});
|
|
196
|
+
|
|
197
|
+
describe("parseModuleInterface", () => {
|
|
198
|
+
it("parses variables (type, description, required) and outputs", () => {
|
|
199
|
+
const hcl = `
|
|
200
|
+
variable "bucket_name" {
|
|
201
|
+
description = "The bucket name"
|
|
202
|
+
type = string
|
|
203
|
+
}
|
|
204
|
+
variable "tags" {
|
|
205
|
+
type = map(string)
|
|
206
|
+
default = {}
|
|
207
|
+
}
|
|
208
|
+
variable "retention_in_days" {
|
|
209
|
+
type = number
|
|
210
|
+
default = 30
|
|
211
|
+
validation {
|
|
212
|
+
condition = var.retention_in_days > 0
|
|
213
|
+
error_message = "must be positive"
|
|
214
|
+
}
|
|
215
|
+
}
|
|
216
|
+
output "arn" {
|
|
217
|
+
description = "The bucket ARN"
|
|
218
|
+
value = aws_s3_bucket.this.arn
|
|
219
|
+
}`;
|
|
220
|
+
const iface = parseModuleInterface(hcl);
|
|
221
|
+
expect(iface.variables).toEqual([
|
|
222
|
+
{ name: "bucket_name", type: "string", description: "The bucket name", required: true },
|
|
223
|
+
{ name: "tags", type: "map(string)", description: null, required: false },
|
|
224
|
+
{ name: "retention_in_days", type: "number", description: null, required: false },
|
|
225
|
+
]);
|
|
226
|
+
expect(iface.outputs).toEqual([{ name: "arn", description: "The bucket ARN" }]);
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
it("brace-matches a variable with a nested validation/object type", () => {
|
|
230
|
+
const hcl = `variable "cfg" {
|
|
231
|
+
type = object({ name = string, size = number })
|
|
232
|
+
default = { name = "x", size = 1 }
|
|
233
|
+
}`;
|
|
234
|
+
const iface = parseModuleInterface(hcl);
|
|
235
|
+
expect(iface.variables).toHaveLength(1);
|
|
236
|
+
expect(iface.variables[0]).toMatchObject({ name: "cfg", required: false });
|
|
237
|
+
expect(iface.variables[0]!.type).toContain("object(");
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
it("returns empty for HCL with no variables/outputs", () => {
|
|
241
|
+
expect(parseModuleInterface('resource "aws_s3_bucket" "b" {}')).toEqual({
|
|
242
|
+
variables: [],
|
|
243
|
+
outputs: [],
|
|
244
|
+
});
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
it("keeps a variable REQUIRED when only a nested object field is named `default`", () => {
|
|
248
|
+
// regression: a `default = string` FIELD inside `object({…})` must not be
|
|
249
|
+
// mistaken for the variable's `default` attribute (which would mark it optional).
|
|
250
|
+
const hcl = `variable "x" {
|
|
251
|
+
type = object({
|
|
252
|
+
enabled = bool
|
|
253
|
+
default = string
|
|
254
|
+
})
|
|
255
|
+
}`;
|
|
256
|
+
expect(parseModuleInterface(hcl).variables[0]).toMatchObject({ name: "x", required: true });
|
|
257
|
+
});
|
|
258
|
+
|
|
259
|
+
it("still detects a real top-level default (including an empty object)", () => {
|
|
260
|
+
const hcl = `variable "tags" {
|
|
261
|
+
type = map(string)
|
|
262
|
+
default = {}
|
|
263
|
+
}`;
|
|
264
|
+
expect(parseModuleInterface(hcl).variables[0]!.required).toBe(false);
|
|
265
|
+
});
|
|
266
|
+
});
|
|
267
|
+
|
|
268
|
+
describe("walkTfFiles + collectModuleGraph (recursive, multi-root)", () => {
|
|
269
|
+
let root: string;
|
|
270
|
+
|
|
271
|
+
beforeAll(() => {
|
|
272
|
+
// mimic the hepcare layout: a `terraform/` root with a `core/` subdir root
|
|
273
|
+
// and a `modules/cloudwatch_logs` house module.
|
|
274
|
+
root = mkdtempSync(join(tmpdir(), "tf-modgraph-"));
|
|
275
|
+
mkdirSync(join(root, "core"), { recursive: true });
|
|
276
|
+
mkdirSync(join(root, "modules", "cloudwatch_logs"), { recursive: true });
|
|
277
|
+
mkdirSync(join(root, ".terraform", "modules"), { recursive: true });
|
|
278
|
+
writeFileSync(
|
|
279
|
+
join(root, "api_gateway.tf"),
|
|
280
|
+
`module "api_gateway_logs" { source = "./modules/cloudwatch_logs" }`,
|
|
281
|
+
);
|
|
282
|
+
writeFileSync(
|
|
283
|
+
join(root, "core", "main.tf"),
|
|
284
|
+
`module "bootstrap" { source = "git::https://github.com/x/mods.git//aws/bootstrap?ref=v1" }`,
|
|
285
|
+
);
|
|
286
|
+
writeFileSync(
|
|
287
|
+
join(root, "modules", "cloudwatch_logs", "main.tf"),
|
|
288
|
+
`resource "aws_cloudwatch_log_group" "g" {}`,
|
|
289
|
+
);
|
|
290
|
+
// noise that must be skipped:
|
|
291
|
+
writeFileSync(
|
|
292
|
+
join(root, ".terraform", "modules", "junk.tf"),
|
|
293
|
+
`module "skip" { source = "./nope" }`,
|
|
294
|
+
);
|
|
295
|
+
});
|
|
296
|
+
|
|
297
|
+
afterAll(() => {
|
|
298
|
+
rmSync(root, { recursive: true, force: true });
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
it("walks .tf recursively and skips cache dirs", () => {
|
|
302
|
+
const files = walkTfFiles(root).sort();
|
|
303
|
+
expect(files).toContain("api_gateway.tf");
|
|
304
|
+
expect(files).toContain("core/main.tf");
|
|
305
|
+
expect(files).toContain("modules/cloudwatch_logs/main.tf");
|
|
306
|
+
expect(files.some((f) => f.startsWith(".terraform/"))).toBe(false);
|
|
307
|
+
});
|
|
308
|
+
|
|
309
|
+
it("resolves a local module dir and records its caller; classifies the git module external", () => {
|
|
310
|
+
const graph = collectModuleGraph(root);
|
|
311
|
+
expect(graph.localModuleDirs).toEqual([
|
|
312
|
+
{ dir: "modules/cloudwatch_logs", callers: ["api_gateway.tf"] },
|
|
313
|
+
]);
|
|
314
|
+
expect(graph.externalCount).toBe(1); // the git bootstrap module in core/
|
|
315
|
+
// a concern in the house module is fixable at source:
|
|
316
|
+
expect(isInLocalModule("modules/cloudwatch_logs/main.tf", graph)?.callers).toEqual([
|
|
317
|
+
"api_gateway.tf",
|
|
318
|
+
]);
|
|
319
|
+
});
|
|
320
|
+
});
|
|
321
|
+
|
|
322
|
+
describe("dependencyOrderedModuleDirs (§24)", () => {
|
|
323
|
+
const graph = (
|
|
324
|
+
localModuleDirs: { dir: string; callers: string[] }[],
|
|
325
|
+
modules: { source: string; declaredIn: string; kind?: string }[],
|
|
326
|
+
): ModuleGraph => ({
|
|
327
|
+
localModuleDirs,
|
|
328
|
+
externalCount: 0,
|
|
329
|
+
modules: modules.map((m) => ({
|
|
330
|
+
name: "m",
|
|
331
|
+
source: m.source,
|
|
332
|
+
version: null,
|
|
333
|
+
subdir: null,
|
|
334
|
+
kind: (m.kind ?? "local") as ModuleGraph["modules"][number]["kind"],
|
|
335
|
+
declaredIn: m.declaredIn,
|
|
336
|
+
})),
|
|
337
|
+
});
|
|
338
|
+
|
|
339
|
+
it("orders a depended-on module before its dependent", () => {
|
|
340
|
+
// modules/a calls ../b → a depends on b → b must be fixed first.
|
|
341
|
+
const g = graph(
|
|
342
|
+
[
|
|
343
|
+
{ dir: "modules/a", callers: [] },
|
|
344
|
+
{ dir: "modules/b", callers: [] },
|
|
345
|
+
],
|
|
346
|
+
[{ source: "../b", declaredIn: "modules/a/main.tf" }],
|
|
347
|
+
);
|
|
348
|
+
expect(dependencyOrderedModuleDirs(g)).toEqual(["modules/b", "modules/a"]);
|
|
349
|
+
});
|
|
350
|
+
|
|
351
|
+
it("breaks ties between independent modules by path", () => {
|
|
352
|
+
const g = graph(
|
|
353
|
+
[
|
|
354
|
+
{ dir: "modules/z", callers: [] },
|
|
355
|
+
{ dir: "modules/a", callers: [] },
|
|
356
|
+
],
|
|
357
|
+
[],
|
|
358
|
+
);
|
|
359
|
+
expect(dependencyOrderedModuleDirs(g)).toEqual(["modules/a", "modules/z"]);
|
|
360
|
+
});
|
|
361
|
+
|
|
362
|
+
it("ignores module calls declared in a root (not inside a local module)", () => {
|
|
363
|
+
// the call lives in the repo root, so neither module depends on the other.
|
|
364
|
+
const g = graph(
|
|
365
|
+
[
|
|
366
|
+
{ dir: "modules/a", callers: ["main.tf"] },
|
|
367
|
+
{ dir: "modules/b", callers: ["main.tf"] },
|
|
368
|
+
],
|
|
369
|
+
[
|
|
370
|
+
{ source: "./modules/a", declaredIn: "main.tf" },
|
|
371
|
+
{ source: "./modules/b", declaredIn: "main.tf" },
|
|
372
|
+
],
|
|
373
|
+
);
|
|
374
|
+
expect(dependencyOrderedModuleDirs(g)).toEqual(["modules/a", "modules/b"]);
|
|
375
|
+
});
|
|
376
|
+
|
|
377
|
+
it("attributes a block to the MOST-SPECIFIC (nested) owner module", () => {
|
|
378
|
+
// a block in modules/network/subnet calls ../../shared → subnet depends on
|
|
379
|
+
// shared, so shared must precede subnet (the outer modules/network must NOT
|
|
380
|
+
// be credited with the edge).
|
|
381
|
+
const g = graph(
|
|
382
|
+
[
|
|
383
|
+
{ dir: "modules/network", callers: [] },
|
|
384
|
+
{ dir: "modules/network/subnet", callers: [] },
|
|
385
|
+
{ dir: "modules/shared", callers: [] },
|
|
386
|
+
],
|
|
387
|
+
[{ source: "../../shared", declaredIn: "modules/network/subnet/main.tf" }],
|
|
388
|
+
);
|
|
389
|
+
const order = dependencyOrderedModuleDirs(g);
|
|
390
|
+
expect(order.indexOf("modules/shared")).toBeLessThan(order.indexOf("modules/network/subnet"));
|
|
391
|
+
});
|
|
392
|
+
|
|
393
|
+
it("is cycle-safe (appends remaining nodes deterministically)", () => {
|
|
394
|
+
const g = graph(
|
|
395
|
+
[
|
|
396
|
+
{ dir: "modules/a", callers: [] },
|
|
397
|
+
{ dir: "modules/b", callers: [] },
|
|
398
|
+
],
|
|
399
|
+
[
|
|
400
|
+
{ source: "../b", declaredIn: "modules/a/main.tf" },
|
|
401
|
+
{ source: "../a", declaredIn: "modules/b/main.tf" },
|
|
402
|
+
],
|
|
403
|
+
);
|
|
404
|
+
expect(dependencyOrderedModuleDirs(g)).toEqual(["modules/a", "modules/b"]);
|
|
405
|
+
});
|
|
406
|
+
|
|
407
|
+
it("returns an empty list for no local modules", () => {
|
|
408
|
+
expect(dependencyOrderedModuleDirs(graph([], []))).toEqual([]);
|
|
409
|
+
});
|
|
410
|
+
});
|
|
411
|
+
|
|
412
|
+
describe("splitModuleSource (query/ref edge cases)", () => {
|
|
413
|
+
it("decodes a percent-encoded ref", () => {
|
|
414
|
+
expect(splitModuleSource("git::https://h/r.git?ref=v%201").ref).toBe("v 1");
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
it("keeps a malformed percent-encoded ref verbatim", () => {
|
|
418
|
+
expect(splitModuleSource("git::https://h/r.git?ref=%E0%A4%A").ref).toBe("%E0%A4%A");
|
|
419
|
+
});
|
|
420
|
+
|
|
421
|
+
it("returns a null ref for a query without ref=", () => {
|
|
422
|
+
const parsed = splitModuleSource("git::https://h/r.git?depth=1");
|
|
423
|
+
expect(parsed.ref).toBeNull();
|
|
424
|
+
expect(parsed.base).toBe("git::https://h/r.git");
|
|
425
|
+
});
|
|
426
|
+
|
|
427
|
+
it("classifies hg:: as git-family and oci: as remote", () => {
|
|
428
|
+
expect(classifyModuleSource("hg::https://h/r")).toBe("git");
|
|
429
|
+
expect(classifyModuleSource("oci://registry/example/mod")).toBe("remote");
|
|
430
|
+
});
|
|
431
|
+
|
|
432
|
+
it("classifies a Windows drive path as local", () => {
|
|
433
|
+
expect(classifyModuleSource("C:\\modules\\vpc")).toBe("local");
|
|
434
|
+
});
|
|
435
|
+
});
|
|
436
|
+
|
|
437
|
+
describe("parseModuleCatalogue (name/version edge cases)", () => {
|
|
438
|
+
it("derives a registry name from a host-prefixed source without a subdir", () => {
|
|
439
|
+
const [m] = parseModuleCatalogue("registry.example.com/ns/netmod/aws");
|
|
440
|
+
expect(m).toMatchObject({ name: "netmod", kind: "registry" });
|
|
441
|
+
});
|
|
442
|
+
|
|
443
|
+
it("derives a git name from the repo's last path segment (no subdir)", () => {
|
|
444
|
+
const [m] = parseModuleCatalogue("git::https://github.com/acme/networking.git");
|
|
445
|
+
expect(m).toMatchObject({ name: "networking", kind: "git", version: null });
|
|
446
|
+
});
|
|
447
|
+
|
|
448
|
+
it("accepts a >= version constraint after the source", () => {
|
|
449
|
+
const [m] = parseModuleCatalogue("terraform-aws-modules/vpc/aws >= 1.2");
|
|
450
|
+
expect(m).toMatchObject({ version: ">= 1.2", kind: "registry" });
|
|
451
|
+
});
|
|
452
|
+
|
|
453
|
+
it("folds non-version trailing words back into the source", () => {
|
|
454
|
+
const [m] = parseModuleCatalogue("foo bar");
|
|
455
|
+
expect(m).toMatchObject({ source: "foo bar", version: null, kind: "unknown" });
|
|
456
|
+
});
|
|
457
|
+
|
|
458
|
+
it("does not treat a slashed left-hand side of = as a name", () => {
|
|
459
|
+
const [m] = parseModuleCatalogue("my/bad=./x");
|
|
460
|
+
expect(m).toMatchObject({ source: "my/bad=./x", kind: "unknown" });
|
|
461
|
+
});
|
|
462
|
+
});
|
|
463
|
+
|
|
464
|
+
describe("parseModuleBlocks (malformed HCL)", () => {
|
|
465
|
+
it("stops at an unterminated module block", () => {
|
|
466
|
+
expect(parseModuleBlocks('module "x" {\n source = "./m"\n')).toEqual([]);
|
|
467
|
+
});
|
|
468
|
+
|
|
469
|
+
it("skips a module block without a source", () => {
|
|
470
|
+
expect(parseModuleBlocks('module "x" {\n for_each = local.things\n}')).toEqual([]);
|
|
471
|
+
});
|
|
472
|
+
});
|
|
473
|
+
|
|
474
|
+
describe("parseModuleInterface (malformed HCL)", () => {
|
|
475
|
+
it("stops at an unterminated variable block", () => {
|
|
476
|
+
expect(parseModuleInterface('variable "x" {\n type = string\n')).toEqual({
|
|
477
|
+
variables: [],
|
|
478
|
+
outputs: [],
|
|
479
|
+
});
|
|
480
|
+
});
|
|
481
|
+
});
|
|
482
|
+
|
|
483
|
+
describe("walkTfFiles (bounds)", () => {
|
|
484
|
+
let root: string;
|
|
485
|
+
|
|
486
|
+
beforeAll(() => {
|
|
487
|
+
root = mkdtempSync(join(tmpdir(), "tf-walk-"));
|
|
488
|
+
mkdirSync(join(root, "a", "b"), { recursive: true });
|
|
489
|
+
writeFileSync(join(root, "top.tf"), "");
|
|
490
|
+
writeFileSync(join(root, "a", "mid.tf"), "");
|
|
491
|
+
writeFileSync(join(root, "a", "b", "deep.tf"), "");
|
|
492
|
+
writeFileSync(join(root, "notes.txt"), "");
|
|
493
|
+
});
|
|
494
|
+
|
|
495
|
+
afterAll(() => {
|
|
496
|
+
rmSync(root, { recursive: true, force: true });
|
|
497
|
+
});
|
|
498
|
+
|
|
499
|
+
it("respects maxDepth", () => {
|
|
500
|
+
expect(walkTfFiles(root, 0)).toEqual(["top.tf"]);
|
|
501
|
+
const depth1 = walkTfFiles(root, 1).sort();
|
|
502
|
+
expect(depth1).toEqual(["a/mid.tf", "top.tf"]);
|
|
503
|
+
});
|
|
504
|
+
|
|
505
|
+
it("respects the file cap", () => {
|
|
506
|
+
expect(walkTfFiles(root, 8, 1)).toHaveLength(1);
|
|
507
|
+
});
|
|
508
|
+
|
|
509
|
+
it("returns nothing for an unreadable directory", () => {
|
|
510
|
+
expect(walkTfFiles(join(root, "does-not-exist"))).toEqual([]);
|
|
511
|
+
});
|
|
512
|
+
});
|
|
513
|
+
|
|
514
|
+
describe("module tools + fs helpers", () => {
|
|
515
|
+
let root: string;
|
|
516
|
+
let emptyRoot: string;
|
|
517
|
+
|
|
518
|
+
beforeAll(() => {
|
|
519
|
+
root = mkdtempSync(join(tmpdir(), "tf-modtools-"));
|
|
520
|
+
emptyRoot = mkdtempSync(join(tmpdir(), "tf-modtools-empty-"));
|
|
521
|
+
mkdirSync(join(root, "modules", "cloudwatch_logs"), { recursive: true });
|
|
522
|
+
mkdirSync(join(root, "modules", "extra"), { recursive: true });
|
|
523
|
+
writeFileSync(join(root, "modules", "extra", "main.tf"), 'resource "aws_sns_topic" "t" {}');
|
|
524
|
+
writeFileSync(
|
|
525
|
+
join(root, "main.tf"),
|
|
526
|
+
`module "logs" { source = "./modules/cloudwatch_logs" }
|
|
527
|
+
module "extra" { source = "./modules/extra" }
|
|
528
|
+
module "vpc" {
|
|
529
|
+
source = "terraform-aws-modules/vpc/aws"
|
|
530
|
+
version = "~> 5.0"
|
|
531
|
+
}`,
|
|
532
|
+
);
|
|
533
|
+
writeFileSync(
|
|
534
|
+
join(root, "modules", "cloudwatch_logs", "variables.tf"),
|
|
535
|
+
`variable "name" {
|
|
536
|
+
type = string
|
|
537
|
+
description = "log group name"
|
|
538
|
+
}
|
|
539
|
+
variable "retention" {
|
|
540
|
+
type = number
|
|
541
|
+
default = 30
|
|
542
|
+
}
|
|
543
|
+
output "arn" {
|
|
544
|
+
description = "log group arn"
|
|
545
|
+
value = aws_cloudwatch_log_group.g.arn
|
|
546
|
+
}`,
|
|
547
|
+
);
|
|
548
|
+
writeFileSync(join(root, "modules", "cloudwatch_logs", "README.md"), "not terraform");
|
|
549
|
+
// a directory named like a .tf file — collectModuleInterface must skip it
|
|
550
|
+
mkdirSync(join(root, "modules", "cloudwatch_logs", "trap.tf"));
|
|
551
|
+
});
|
|
552
|
+
|
|
553
|
+
afterAll(() => {
|
|
554
|
+
rmSync(root, { recursive: true, force: true });
|
|
555
|
+
rmSync(emptyRoot, { recursive: true, force: true });
|
|
556
|
+
});
|
|
557
|
+
|
|
558
|
+
describe("moduleDirExists", () => {
|
|
559
|
+
it("is true for an existing directory and false otherwise", () => {
|
|
560
|
+
expect(moduleDirExists(root, "modules/cloudwatch_logs")).toBe(true);
|
|
561
|
+
expect(moduleDirExists(root, "modules/nope")).toBe(false);
|
|
562
|
+
expect(moduleDirExists(root, "main.tf")).toBe(false); // a file, not a dir
|
|
563
|
+
});
|
|
564
|
+
});
|
|
565
|
+
|
|
566
|
+
describe("collectModuleInterface", () => {
|
|
567
|
+
it("parses the interface from a module dir, skipping unreadable .tf entries", () => {
|
|
568
|
+
const iface = collectModuleInterface(root, "modules/cloudwatch_logs");
|
|
569
|
+
expect(iface.variables.map((v) => v.name)).toEqual(["name", "retention"]);
|
|
570
|
+
expect(iface.outputs).toEqual([{ name: "arn", description: "log group arn" }]);
|
|
571
|
+
});
|
|
572
|
+
|
|
573
|
+
it("returns an empty interface for a missing dir", () => {
|
|
574
|
+
expect(collectModuleInterface(root, "modules/nope")).toEqual({
|
|
575
|
+
variables: [],
|
|
576
|
+
outputs: [],
|
|
577
|
+
});
|
|
578
|
+
});
|
|
579
|
+
|
|
580
|
+
it("reads the cwd itself when moduleDir is empty", () => {
|
|
581
|
+
const iface = collectModuleInterface(join(root, "modules", "cloudwatch_logs"), "");
|
|
582
|
+
expect(iface.variables).toHaveLength(2);
|
|
583
|
+
});
|
|
584
|
+
});
|
|
585
|
+
|
|
586
|
+
describe("ListModulesTool", () => {
|
|
587
|
+
it("combines the catalogue with discovered house modules", async () => {
|
|
588
|
+
const ctx = makeCtx({
|
|
589
|
+
cwd: root,
|
|
590
|
+
moduleCatalogue: "vpc=terraform-aws-modules/vpc/aws ~> 5.0",
|
|
591
|
+
});
|
|
592
|
+
const result = await runTool(ListModulesTool(ctx), {});
|
|
593
|
+
|
|
594
|
+
const text = result.content[0].text;
|
|
595
|
+
expect(result.isError).toBeUndefined();
|
|
596
|
+
expect(text).toContain("configured: true");
|
|
597
|
+
expect(text).toContain("terraform-aws-modules/vpc/aws");
|
|
598
|
+
expect(text).toContain("modules/cloudwatch_logs");
|
|
599
|
+
expect(text).toContain("exists: true");
|
|
600
|
+
expect(text).toContain("Prefer these modules");
|
|
601
|
+
});
|
|
602
|
+
|
|
603
|
+
it("falls back to the no-catalogue note when nothing is configured or discovered", async () => {
|
|
604
|
+
const result = await runTool(ListModulesTool(makeCtx({ cwd: emptyRoot })), {});
|
|
605
|
+
|
|
606
|
+
const text = result.content[0].text;
|
|
607
|
+
expect(text).toContain("configured: false");
|
|
608
|
+
expect(text).toContain("No catalogue or house modules");
|
|
609
|
+
});
|
|
610
|
+
});
|
|
611
|
+
|
|
612
|
+
describe("TerraformModuleGraphTool", () => {
|
|
613
|
+
it("returns the classified blocks, local dirs, and dependency order", async () => {
|
|
614
|
+
const result = await runTool(TerraformModuleGraphTool(makeCtx({ cwd: root })), {});
|
|
615
|
+
|
|
616
|
+
const text = result.content[0].text;
|
|
617
|
+
expect(result.isError).toBeUndefined();
|
|
618
|
+
expect(text).toContain("ok: true");
|
|
619
|
+
expect(text).toContain("declared_in");
|
|
620
|
+
expect(text).toContain("main.tf");
|
|
621
|
+
expect(text).toContain("external_module_count: 1");
|
|
622
|
+
expect(text).toContain("modules/cloudwatch_logs");
|
|
623
|
+
});
|
|
624
|
+
});
|
|
625
|
+
|
|
626
|
+
describe("TerraformModuleInterfaceTool", () => {
|
|
627
|
+
it("reports the module's variables, outputs, and required inputs", async () => {
|
|
628
|
+
const result = await runTool(TerraformModuleInterfaceTool(makeCtx({ cwd: root })), {
|
|
629
|
+
module_dir: "modules/cloudwatch_logs",
|
|
630
|
+
});
|
|
631
|
+
|
|
632
|
+
const text = result.content[0].text;
|
|
633
|
+
expect(result.isError).toBeUndefined();
|
|
634
|
+
expect(text).toContain("ok: true");
|
|
635
|
+
expect(text).toContain("module_dir: modules/cloudwatch_logs");
|
|
636
|
+
expect(text).toContain("required_variables[1]: name");
|
|
637
|
+
expect(text).toContain("arn");
|
|
638
|
+
});
|
|
639
|
+
});
|
|
640
|
+
});
|