@intentius/chant-lexicon-docker 0.124.97 → 0.124.99
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/dist/codegen/docs-cli.d.ts +0 -1
- package/dist/codegen/docs.d.ts +0 -1
- package/dist/codegen/generate-cli.d.ts +0 -1
- package/dist/codegen/generate-compose.d.ts +0 -1
- package/dist/codegen/generate-dockerfile.d.ts +0 -1
- package/dist/codegen/generate.d.ts +0 -1
- package/dist/codegen/naming.d.ts +0 -1
- package/dist/codegen/package.d.ts +0 -1
- package/dist/codegen/patches.d.ts +0 -1
- package/dist/codegen/versions.d.ts +0 -1
- package/dist/compose-key.d.ts +0 -1
- package/dist/composites/catalog.d.ts +0 -1
- package/dist/composites/docker-otel-collector.d.ts +0 -1
- package/dist/composites/docker-web-service.d.ts +0 -1
- package/dist/composites/index.d.ts +0 -1
- package/dist/coverage.d.ts +0 -1
- package/dist/default-labels.d.ts +0 -1
- package/dist/detect.d.ts +0 -1
- package/dist/dockerfile-order.d.ts +0 -1
- package/dist/export-resources.d.ts +0 -1
- package/dist/generated/index.d.ts +0 -1
- package/dist/generated/runtime.d.ts +0 -1
- package/dist/import/adapter.d.ts +0 -1
- package/dist/import/adapter.js +4 -2
- package/dist/import/embedded.d.ts +0 -1
- package/dist/import/engine.d.ts +0 -1
- package/dist/import/generator.d.ts +9 -2
- package/dist/import/generator.js +23 -1
- package/dist/import/live-export.d.ts +0 -1
- package/dist/import/parser.d.ts +0 -1
- package/dist/import/testdata/tar.d.ts +0 -1
- package/dist/index.d.ts +0 -1
- package/dist/integrity.json +2 -2
- package/dist/interpolation.d.ts +0 -1
- package/dist/lint/audit-catalog.d.ts +0 -1
- package/dist/lint/audit-lineage.d.ts +0 -1
- package/dist/lint/post-synth/add-url-checksum.d.ts +0 -1
- package/dist/lint/post-synth/apt-no-recommends.d.ts +0 -1
- package/dist/lint/post-synth/apt-update-alone.d.ts +0 -1
- package/dist/lint/post-synth/cache-busting-copy.d.ts +0 -1
- package/dist/lint/post-synth/copy-from-stage.d.ts +0 -1
- package/dist/lint/post-synth/docker-helpers.d.ts +0 -1
- package/dist/lint/post-synth/index.d.ts +0 -1
- package/dist/lint/post-synth/no-latest-image.d.ts +0 -1
- package/dist/lint/post-synth/no-root-user.d.ts +0 -1
- package/dist/lint/post-synth/prefer-copy.d.ts +0 -1
- package/dist/lint/post-synth/relative-workdir.d.ts +0 -1
- package/dist/lint/post-synth/repeated-cmd.d.ts +0 -1
- package/dist/lint/post-synth/root-after-user.d.ts +0 -1
- package/dist/lint/post-synth/ssh-port-exposed.d.ts +0 -1
- package/dist/lint/post-synth/unused-global-arg.d.ts +0 -1
- package/dist/lint/post-synth/unused-volume.d.ts +0 -1
- package/dist/lint/rules/data/deprecated-images.d.ts +0 -1
- package/dist/lint/rules/data/known-base-images.d.ts +0 -1
- package/dist/lint/rules/index.d.ts +0 -1
- package/dist/lint/rules/no-latest-tag.d.ts +0 -1
- package/dist/lint/rules/per-kind-order.d.ts +0 -1
- package/dist/list-artifacts.d.ts +0 -1
- package/dist/lsp/completions.d.ts +0 -1
- package/dist/lsp/hover.d.ts +0 -1
- package/dist/manifest.json +1 -1
- package/dist/package-cli.d.ts +0 -1
- package/dist/plugin.d.ts +0 -1
- package/dist/serializer.d.ts +0 -1
- package/dist/spec/fetch-compose.d.ts +0 -1
- package/dist/spec/fetch-engine.d.ts +0 -1
- package/dist/spec/parse-compose.d.ts +0 -1
- package/dist/spec/parse-engine.d.ts +0 -1
- package/dist/validate-cli.d.ts +0 -1
- package/dist/validate.d.ts +0 -1
- package/dist/variables.d.ts +0 -1
- package/package.json +4 -5
- package/dist/codegen/docs-cli.d.ts.map +0 -1
- package/dist/codegen/docs.d.ts.map +0 -1
- package/dist/codegen/generate-cli.d.ts.map +0 -1
- package/dist/codegen/generate-compose.d.ts.map +0 -1
- package/dist/codegen/generate-dockerfile.d.ts.map +0 -1
- package/dist/codegen/generate.d.ts.map +0 -1
- package/dist/codegen/naming.d.ts.map +0 -1
- package/dist/codegen/package.d.ts.map +0 -1
- package/dist/codegen/patches.d.ts.map +0 -1
- package/dist/codegen/versions.d.ts.map +0 -1
- package/dist/compose-key.d.ts.map +0 -1
- package/dist/composites/catalog.d.ts.map +0 -1
- package/dist/composites/docker-otel-collector.d.ts.map +0 -1
- package/dist/composites/docker-web-service.d.ts.map +0 -1
- package/dist/composites/index.d.ts.map +0 -1
- package/dist/coverage.d.ts.map +0 -1
- package/dist/default-labels.d.ts.map +0 -1
- package/dist/detect.d.ts.map +0 -1
- package/dist/dockerfile-order.d.ts.map +0 -1
- package/dist/export-resources.d.ts.map +0 -1
- package/dist/generated/index.d.ts.map +0 -1
- package/dist/generated/runtime.d.ts.map +0 -1
- package/dist/import/adapter.d.ts.map +0 -1
- package/dist/import/embedded.d.ts.map +0 -1
- package/dist/import/engine.d.ts.map +0 -1
- package/dist/import/generator.d.ts.map +0 -1
- package/dist/import/live-export.d.ts.map +0 -1
- package/dist/import/parser.d.ts.map +0 -1
- package/dist/import/testdata/tar.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/interpolation.d.ts.map +0 -1
- package/dist/lint/audit-catalog.d.ts.map +0 -1
- package/dist/lint/audit-lineage.d.ts.map +0 -1
- package/dist/lint/post-synth/add-url-checksum.d.ts.map +0 -1
- package/dist/lint/post-synth/apt-no-recommends.d.ts.map +0 -1
- package/dist/lint/post-synth/apt-update-alone.d.ts.map +0 -1
- package/dist/lint/post-synth/cache-busting-copy.d.ts.map +0 -1
- package/dist/lint/post-synth/copy-from-stage.d.ts.map +0 -1
- package/dist/lint/post-synth/docker-helpers.d.ts.map +0 -1
- package/dist/lint/post-synth/index.d.ts.map +0 -1
- package/dist/lint/post-synth/no-latest-image.d.ts.map +0 -1
- package/dist/lint/post-synth/no-root-user.d.ts.map +0 -1
- package/dist/lint/post-synth/prefer-copy.d.ts.map +0 -1
- package/dist/lint/post-synth/relative-workdir.d.ts.map +0 -1
- package/dist/lint/post-synth/repeated-cmd.d.ts.map +0 -1
- package/dist/lint/post-synth/root-after-user.d.ts.map +0 -1
- package/dist/lint/post-synth/ssh-port-exposed.d.ts.map +0 -1
- package/dist/lint/post-synth/unused-global-arg.d.ts.map +0 -1
- package/dist/lint/post-synth/unused-volume.d.ts.map +0 -1
- package/dist/lint/rules/data/deprecated-images.d.ts.map +0 -1
- package/dist/lint/rules/data/known-base-images.d.ts.map +0 -1
- package/dist/lint/rules/index.d.ts.map +0 -1
- package/dist/lint/rules/no-latest-tag.d.ts.map +0 -1
- package/dist/lint/rules/per-kind-order.d.ts.map +0 -1
- package/dist/list-artifacts.d.ts.map +0 -1
- package/dist/lsp/completions.d.ts.map +0 -1
- package/dist/lsp/hover.d.ts.map +0 -1
- package/dist/package-cli.d.ts.map +0 -1
- package/dist/plugin.d.ts.map +0 -1
- package/dist/serializer.d.ts.map +0 -1
- package/dist/spec/fetch-compose.d.ts.map +0 -1
- package/dist/spec/fetch-engine.d.ts.map +0 -1
- package/dist/spec/parse-compose.d.ts.map +0 -1
- package/dist/spec/parse-engine.d.ts.map +0 -1
- package/dist/validate-cli.d.ts.map +0 -1
- package/dist/validate.d.ts.map +0 -1
- package/dist/variables.d.ts.map +0 -1
- package/src/codegen/__snapshots__/okf.test.ts.snap +0 -555
- package/src/codegen/docs-cli.ts +0 -10
- package/src/codegen/docs.ts +0 -171
- package/src/codegen/generate-cli.ts +0 -36
- package/src/codegen/generate-compose.ts +0 -21
- package/src/codegen/generate-dockerfile.ts +0 -21
- package/src/codegen/generate.test.ts +0 -115
- package/src/codegen/generate.ts +0 -258
- package/src/codegen/naming.test.ts +0 -81
- package/src/codegen/naming.ts +0 -54
- package/src/codegen/okf.test.ts +0 -36
- package/src/codegen/package.ts +0 -59
- package/src/codegen/patches.ts +0 -42
- package/src/codegen/versions.ts +0 -46
- package/src/compose-key.ts +0 -31
- package/src/composites/catalog.test.ts +0 -39
- package/src/composites/catalog.ts +0 -118
- package/src/composites/docker-otel-collector.ts +0 -83
- package/src/composites/docker-web-service.test.ts +0 -34
- package/src/composites/docker-web-service.ts +0 -75
- package/src/composites/index.ts +0 -9
- package/src/coverage.test.ts +0 -33
- package/src/coverage.ts +0 -54
- package/src/default-labels.test.ts +0 -85
- package/src/default-labels.ts +0 -72
- package/src/detect.ts +0 -7
- package/src/dockerfile-order.ts +0 -20
- package/src/docs-examples.test.ts +0 -141
- package/src/export-resources.ts +0 -90
- package/src/generated/index.d.ts +0 -407
- package/src/generated/index.ts +0 -410
- package/src/generated/runtime.ts +0 -4
- package/src/import/adapter.ts +0 -99
- package/src/import/embedded-live.test.ts +0 -248
- package/src/import/embedded.ts +0 -83
- package/src/import/engine.ts +0 -107
- package/src/import/generator.test.ts +0 -134
- package/src/import/generator.ts +0 -202
- package/src/import/live-export.test.ts +0 -271
- package/src/import/live-export.ts +0 -359
- package/src/import/parser.test.ts +0 -137
- package/src/import/parser.ts +0 -269
- package/src/import/roundtrip.test.ts +0 -257
- package/src/import/testdata/configs-secrets.yaml +0 -15
- package/src/import/testdata/full.yaml +0 -43
- package/src/import/testdata/names-and-fields.yaml +0 -44
- package/src/import/testdata/simple.yaml +0 -9
- package/src/import/testdata/tar.ts +0 -24
- package/src/import/testdata/webapp.yaml +0 -41
- package/src/index.ts +0 -32
- package/src/interpolation.test.ts +0 -41
- package/src/interpolation.ts +0 -76
- package/src/lint/audit-catalog.ts +0 -28
- package/src/lint/audit-lineage.ts +0 -48
- package/src/lint/post-synth/add-url-checksum.ts +0 -38
- package/src/lint/post-synth/apt-no-recommends.ts +0 -43
- package/src/lint/post-synth/apt-update-alone.ts +0 -39
- package/src/lint/post-synth/cache-busting-copy.ts +0 -65
- package/src/lint/post-synth/copy-from-stage.ts +0 -54
- package/src/lint/post-synth/docker-helpers.ts +0 -194
- package/src/lint/post-synth/index.ts +0 -33
- package/src/lint/post-synth/no-latest-image.ts +0 -36
- package/src/lint/post-synth/no-root-user.ts +0 -38
- package/src/lint/post-synth/post-synth.test.ts +0 -330
- package/src/lint/post-synth/prefer-copy.ts +0 -53
- package/src/lint/post-synth/relative-workdir.ts +0 -38
- package/src/lint/post-synth/repeated-cmd.ts +0 -35
- package/src/lint/post-synth/root-after-user.ts +0 -44
- package/src/lint/post-synth/ssh-port-exposed.ts +0 -68
- package/src/lint/post-synth/unused-global-arg.ts +0 -38
- package/src/lint/post-synth/unused-volume.ts +0 -49
- package/src/lint/rules/data/deprecated-images.ts +0 -28
- package/src/lint/rules/data/known-base-images.ts +0 -20
- package/src/lint/rules/index.ts +0 -6
- package/src/lint/rules/no-latest-tag.ts +0 -63
- package/src/lint/rules/per-kind-order.ts +0 -130
- package/src/lint/rules/rules.test.ts +0 -170
- package/src/list-artifacts.test.ts +0 -141
- package/src/list-artifacts.ts +0 -164
- package/src/lsp/completions.test.ts +0 -40
- package/src/lsp/completions.ts +0 -21
- package/src/lsp/hover.test.ts +0 -35
- package/src/lsp/hover.ts +0 -39
- package/src/package-cli.ts +0 -25
- package/src/plugin.test.ts +0 -121
- package/src/plugin.ts +0 -268
- package/src/serializer.test.ts +0 -545
- package/src/serializer.ts +0 -444
- package/src/skills/chant-docker-patterns.md +0 -222
- package/src/skills/chant-docker.md +0 -156
- package/src/spec/fetch-compose.ts +0 -35
- package/src/spec/fetch-engine.ts +0 -25
- package/src/spec/parse-compose.ts +0 -195
- package/src/spec/parse-engine.ts +0 -59
- package/src/typecheck.e2e.test.ts +0 -125
- package/src/typed-props.test.ts +0 -60
- package/src/validate-cli.ts +0 -19
- package/src/validate.test.ts +0 -16
- package/src/validate.ts +0 -44
- package/src/variables.test.ts +0 -32
- package/src/variables.ts +0 -47
- /package/{src → dist}/generated/lexicon-docker.json +0 -0
|
@@ -1,194 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared YAML traversal utilities for Docker post-synth checks.
|
|
3
|
-
*/
|
|
4
|
-
|
|
5
|
-
export { getPrimaryOutput } from "@intentius/chant/lint/post-synth";
|
|
6
|
-
import { splitDockerfileInstructions } from "../../import/parser";
|
|
7
|
-
|
|
8
|
-
export interface ParsedService {
|
|
9
|
-
name: string;
|
|
10
|
-
image?: string;
|
|
11
|
-
ports?: string[];
|
|
12
|
-
volumes?: string[];
|
|
13
|
-
build?: { dockerfile?: string; context?: string };
|
|
14
|
-
depends_on?: string[];
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* Extract services section from serialized docker-compose.yml.
|
|
19
|
-
*/
|
|
20
|
-
export function extractServices(yaml: string): Map<string, ParsedService> {
|
|
21
|
-
const services = new Map<string, ParsedService>();
|
|
22
|
-
|
|
23
|
-
const servicesIdx = yaml.search(/^services:\s*$/m);
|
|
24
|
-
if (servicesIdx === -1) return services;
|
|
25
|
-
|
|
26
|
-
const afterServices = yaml.slice(servicesIdx + yaml.slice(servicesIdx).indexOf("\n") + 1);
|
|
27
|
-
// Stop at next top-level key
|
|
28
|
-
const endMatch = afterServices.search(/^[a-z]/m);
|
|
29
|
-
const servicesContent = endMatch === -1 ? afterServices : afterServices.slice(0, endMatch);
|
|
30
|
-
|
|
31
|
-
// Split by service entries (2-space indent + name:)
|
|
32
|
-
const sections = servicesContent.split(/\n(?= [a-z][a-z0-9_-]*:)/);
|
|
33
|
-
|
|
34
|
-
for (const section of sections) {
|
|
35
|
-
const nameMatch = section.match(/^\s{2}([a-z][a-z0-9_-]*):/);
|
|
36
|
-
if (!nameMatch) continue;
|
|
37
|
-
|
|
38
|
-
const name = nameMatch[1];
|
|
39
|
-
const svc: ParsedService = { name };
|
|
40
|
-
|
|
41
|
-
const imageMatch = section.match(/^\s{4}image:\s+(.+)$/m);
|
|
42
|
-
if (imageMatch) svc.image = imageMatch[1].trim().replace(/^['"]|['"]$/g, "");
|
|
43
|
-
|
|
44
|
-
const portsMatch = section.match(/^\s{4}ports:\n((?:\s{6}- .+\n?)+)/m);
|
|
45
|
-
if (portsMatch) {
|
|
46
|
-
svc.ports = [];
|
|
47
|
-
for (const line of portsMatch[1].split("\n")) {
|
|
48
|
-
const item = line.match(/^\s{6}-\s+['"]?(.+?)['"]?$/);
|
|
49
|
-
if (item) svc.ports.push(item[1].trim());
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
const volsMatch = section.match(/^\s{4}volumes:\n((?:\s{6}- .+\n?)+)/m);
|
|
54
|
-
if (volsMatch) {
|
|
55
|
-
svc.volumes = [];
|
|
56
|
-
for (const line of volsMatch[1].split("\n")) {
|
|
57
|
-
const item = line.match(/^\s{6}-\s+['"]?(.+?)['"]?$/);
|
|
58
|
-
if (item) svc.volumes.push(item[1].trim());
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
services.set(name, svc);
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
return services;
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
/**
|
|
69
|
-
* Extract named volumes from the top-level volumes: section.
|
|
70
|
-
*/
|
|
71
|
-
export function extractNamedVolumes(yaml: string): Set<string> {
|
|
72
|
-
const volumes = new Set<string>();
|
|
73
|
-
|
|
74
|
-
const volumesIdx = yaml.search(/^volumes:\s*$/m);
|
|
75
|
-
if (volumesIdx === -1) return volumes;
|
|
76
|
-
|
|
77
|
-
const afterVolumes = yaml.slice(volumesIdx + yaml.slice(volumesIdx).indexOf("\n") + 1);
|
|
78
|
-
const endMatch = afterVolumes.search(/^[a-z]/m);
|
|
79
|
-
const volumesContent = endMatch === -1 ? afterVolumes : afterVolumes.slice(0, endMatch);
|
|
80
|
-
|
|
81
|
-
for (const line of volumesContent.split("\n")) {
|
|
82
|
-
const match = line.match(/^\s{2}([a-z][a-z0-9_-]*):/);
|
|
83
|
-
if (match) volumes.add(match[1]);
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
return volumes;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* Check if an image tag represents :latest or is untagged.
|
|
91
|
-
*/
|
|
92
|
-
export function isLatestOrUntagged(image: string): boolean {
|
|
93
|
-
if (!image || image.startsWith("${")) return false;
|
|
94
|
-
if (image.endsWith(":latest")) return true;
|
|
95
|
-
const parts = image.split("/");
|
|
96
|
-
const lastPart = parts[parts.length - 1];
|
|
97
|
-
return !lastPart.includes(":") && !lastPart.includes("@");
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* Get Dockerfile content from SerializerResult files map.
|
|
102
|
-
*/
|
|
103
|
-
export function extractDockerfiles(output: unknown): Map<string, string> {
|
|
104
|
-
const files = new Map<string, string>();
|
|
105
|
-
if (typeof output !== "object" || output === null) return files;
|
|
106
|
-
if (!("files" in output)) return files;
|
|
107
|
-
|
|
108
|
-
const outputFiles = (output as { files: Record<string, string> }).files;
|
|
109
|
-
for (const [name, content] of Object.entries(outputFiles)) {
|
|
110
|
-
if (name.startsWith("Dockerfile")) {
|
|
111
|
-
files.set(name, content);
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
return files;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
// ── Dockerfile structure ──────────────────────────────────────────
|
|
118
|
-
|
|
119
|
-
export interface DockerfileInstr {
|
|
120
|
-
/** Upper-case keyword, e.g. "RUN". */
|
|
121
|
-
instruction: string;
|
|
122
|
-
/** The rest of the instruction as written. */
|
|
123
|
-
value: string;
|
|
124
|
-
}
|
|
125
|
-
|
|
126
|
-
export interface ParsedStage {
|
|
127
|
-
/** 0-based position among the stages. */
|
|
128
|
-
index: number;
|
|
129
|
-
/** The FROM image (or earlier stage) without `--platform` and `AS`. */
|
|
130
|
-
from: string;
|
|
131
|
-
as?: string;
|
|
132
|
-
instructions: DockerfileInstr[];
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
export interface ParsedDockerfile {
|
|
136
|
-
/** ARG instructions before the first FROM. */
|
|
137
|
-
globalArgs: DockerfileInstr[];
|
|
138
|
-
stages: ParsedStage[];
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
/** A Dockerfile's global ARGs and stages, each stage's instructions in order. */
|
|
142
|
-
export function parseDockerfileStages(content: string): ParsedDockerfile {
|
|
143
|
-
const out: ParsedDockerfile = { globalArgs: [], stages: [] };
|
|
144
|
-
for (const instr of splitDockerfileInstructions(content)) {
|
|
145
|
-
if (instr.instruction === "FROM") {
|
|
146
|
-
const words = instr.value.split(/\s+/).filter((w) => !w.startsWith("--"));
|
|
147
|
-
const asAt = words.findIndex((w) => w.toLowerCase() === "as");
|
|
148
|
-
out.stages.push({
|
|
149
|
-
index: out.stages.length,
|
|
150
|
-
from: words[0] ?? "",
|
|
151
|
-
...(asAt > 0 && words[asAt + 1] ? { as: words[asAt + 1] } : {}),
|
|
152
|
-
instructions: [],
|
|
153
|
-
});
|
|
154
|
-
} else if (out.stages.length > 0) {
|
|
155
|
-
out.stages[out.stages.length - 1]!.instructions.push(instr);
|
|
156
|
-
} else if (instr.instruction === "ARG") {
|
|
157
|
-
out.globalArgs.push(instr);
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
return out;
|
|
161
|
-
}
|
|
162
|
-
|
|
163
|
-
/** How a stage is named in a message: `stage "build"` or `stage 2`. */
|
|
164
|
-
export function stageLabel(stage: ParsedStage): string {
|
|
165
|
-
return stage.as ? `stage "${stage.as}"` : `stage ${stage.index + 1}`;
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
/** The first line of an instruction, for a message. */
|
|
169
|
-
export function instrText(instr: DockerfileInstr): string {
|
|
170
|
-
const first = instr.value.split("\n")[0]!.replace(/\s*\\$/, "");
|
|
171
|
-
return `${instr.instruction} ${first}`;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
/** Whether a USER value is root (by name or uid 0, with or without a group). */
|
|
175
|
-
export function isRootUser(value: string): boolean {
|
|
176
|
-
const user = value.trim().split(":")[0]!;
|
|
177
|
-
return user === "root" || user === "0";
|
|
178
|
-
}
|
|
179
|
-
|
|
180
|
-
/** Every generated Dockerfile in a build's outputs, parsed. */
|
|
181
|
-
export function eachDockerfile(outputs: Map<string, unknown>): Array<{ fileName: string; content: string; parsed: ParsedDockerfile }> {
|
|
182
|
-
const out: Array<{ fileName: string; content: string; parsed: ParsedDockerfile }> = [];
|
|
183
|
-
for (const [, output] of outputs) {
|
|
184
|
-
for (const [fileName, content] of extractDockerfiles(output)) {
|
|
185
|
-
out.push({ fileName, content, parsed: parseDockerfileStages(content) });
|
|
186
|
-
}
|
|
187
|
-
}
|
|
188
|
-
return out;
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
/** A RUN value with its line continuations joined, for matching commands. */
|
|
192
|
-
export function commandText(instr: DockerfileInstr): string {
|
|
193
|
-
return instr.value.replace(/\\[ \t]*\n/g, " ");
|
|
194
|
-
}
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
// Code generated by chant generate. DO NOT EDIT.
|
|
2
|
-
import type { PostSynthCheck } from "@intentius/chant/lint/post-synth";
|
|
3
|
-
import { dkrd001 } from "./no-latest-image";
|
|
4
|
-
import { dkrd002 } from "./unused-volume";
|
|
5
|
-
import { dkrd003 } from "./ssh-port-exposed";
|
|
6
|
-
import { dkrd010 } from "./apt-no-recommends";
|
|
7
|
-
import { dkrd011 } from "./prefer-copy";
|
|
8
|
-
import { dkrd012 } from "./no-root-user";
|
|
9
|
-
import { dkrd013 } from "./cache-busting-copy";
|
|
10
|
-
import { dkrd014 } from "./root-after-user";
|
|
11
|
-
import { dkrd015 } from "./repeated-cmd";
|
|
12
|
-
import { dkrd016 } from "./copy-from-stage";
|
|
13
|
-
import { dkrd017 } from "./unused-global-arg";
|
|
14
|
-
import { dkrd018 } from "./relative-workdir";
|
|
15
|
-
import { dkrd019 } from "./add-url-checksum";
|
|
16
|
-
import { dkrd020 } from "./apt-update-alone";
|
|
17
|
-
|
|
18
|
-
export const postSynthChecks: PostSynthCheck[] = [
|
|
19
|
-
dkrd001,
|
|
20
|
-
dkrd002,
|
|
21
|
-
dkrd003,
|
|
22
|
-
dkrd010,
|
|
23
|
-
dkrd011,
|
|
24
|
-
dkrd012,
|
|
25
|
-
dkrd013,
|
|
26
|
-
dkrd014,
|
|
27
|
-
dkrd015,
|
|
28
|
-
dkrd016,
|
|
29
|
-
dkrd017,
|
|
30
|
-
dkrd018,
|
|
31
|
-
dkrd019,
|
|
32
|
-
dkrd020,
|
|
33
|
-
];
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* DKRD001: No Latest Image Tag
|
|
3
|
-
*
|
|
4
|
-
* Detects services using :latest or untagged images in docker-compose.yml.
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import type { PostSynthCheck, PostSynthContext, PostSynthDiagnostic } from "@intentius/chant/lint/post-synth";
|
|
8
|
-
import { getPrimaryOutput, extractServices, isLatestOrUntagged } from "./docker-helpers";
|
|
9
|
-
|
|
10
|
-
export const dkrd001: PostSynthCheck = {
|
|
11
|
-
id: "DKRD001",
|
|
12
|
-
description: "Service uses :latest or untagged image — specify an explicit version tag",
|
|
13
|
-
|
|
14
|
-
check(ctx: PostSynthContext): PostSynthDiagnostic[] {
|
|
15
|
-
const diagnostics: PostSynthDiagnostic[] = [];
|
|
16
|
-
|
|
17
|
-
for (const [_outputName, output] of ctx.outputs) {
|
|
18
|
-
const yaml = getPrimaryOutput(output);
|
|
19
|
-
if (!yaml) continue;
|
|
20
|
-
|
|
21
|
-
const services = extractServices(yaml);
|
|
22
|
-
for (const [name, svc] of services) {
|
|
23
|
-
if (svc.image && isLatestOrUntagged(svc.image)) {
|
|
24
|
-
diagnostics.push({
|
|
25
|
-
checkId: "DKRD001",
|
|
26
|
-
severity: "warning",
|
|
27
|
-
message: `Service "${name}" uses image "${svc.image}" which is :latest or untagged. Use an explicit version tag for reproducible builds.`,
|
|
28
|
-
lexicon: "docker",
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
return diagnostics;
|
|
35
|
-
},
|
|
36
|
-
};
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* DKRD012: No Root User
|
|
3
|
-
*
|
|
4
|
-
* Warns when the container would run as root: the final stage has no USER
|
|
5
|
-
* instruction, or its last USER is root. USER in an earlier stage does not
|
|
6
|
-
* carry into the final image.
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
import type { PostSynthCheck, PostSynthContext, PostSynthDiagnostic } from "@intentius/chant/lint/post-synth";
|
|
10
|
-
import { eachDockerfile, isRootUser, stageLabel } from "./docker-helpers";
|
|
11
|
-
|
|
12
|
-
export const dkrd012: PostSynthCheck = {
|
|
13
|
-
id: "DKRD012",
|
|
14
|
-
description: "Dockerfile's final stage has no USER instruction, or ends on USER root — container runs as root",
|
|
15
|
-
|
|
16
|
-
check(ctx: PostSynthContext): PostSynthDiagnostic[] {
|
|
17
|
-
const diagnostics: PostSynthDiagnostic[] = [];
|
|
18
|
-
|
|
19
|
-
for (const { fileName, parsed } of eachDockerfile(ctx.outputs)) {
|
|
20
|
-
const final = parsed.stages[parsed.stages.length - 1];
|
|
21
|
-
if (!final) continue;
|
|
22
|
-
const users = final.instructions.filter((i) => i.instruction === "USER");
|
|
23
|
-
const last = users[users.length - 1];
|
|
24
|
-
let message: string | undefined;
|
|
25
|
-
if (!last) {
|
|
26
|
-
const anyUser = parsed.stages.some((s) => s.instructions.some((i) => i.instruction === "USER"));
|
|
27
|
-
message = anyUser
|
|
28
|
-
? `${fileName}: The final ${stageLabel(final)} has no USER instruction; a USER in an earlier stage does not carry over. The container will run as root. Add a USER step to the final stage.`
|
|
29
|
-
: `${fileName}: No USER instruction found. The container will run as root. Add a USER instruction to improve security.`;
|
|
30
|
-
} else if (isRootUser(last.value)) {
|
|
31
|
-
message = `${fileName}: The final ${stageLabel(final)} ends on USER ${last.value.trim()}, so the container runs as root. Switch to an unprivileged USER after the root setup steps.`;
|
|
32
|
-
}
|
|
33
|
-
if (message) diagnostics.push({ checkId: "DKRD012", severity: "warning", message, lexicon: "docker" });
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
return diagnostics;
|
|
37
|
-
},
|
|
38
|
-
};
|
|
@@ -1,330 +0,0 @@
|
|
|
1
|
-
import { describe, test, expect } from "vitest";
|
|
2
|
-
import type { PostSynthContext } from "@intentius/chant/lint/post-synth";
|
|
3
|
-
import { dkrd001 } from "./no-latest-image";
|
|
4
|
-
import { dkrd002 } from "./unused-volume";
|
|
5
|
-
import { dkrd003 } from "./ssh-port-exposed";
|
|
6
|
-
import { dkrd010 } from "./apt-no-recommends";
|
|
7
|
-
import { dkrd011 } from "./prefer-copy";
|
|
8
|
-
import { dkrd012 } from "./no-root-user";
|
|
9
|
-
import { dkrd013 } from "./cache-busting-copy";
|
|
10
|
-
import { dkrd014 } from "./root-after-user";
|
|
11
|
-
import { dkrd015 } from "./repeated-cmd";
|
|
12
|
-
import { dkrd016 } from "./copy-from-stage";
|
|
13
|
-
import { dkrd017 } from "./unused-global-arg";
|
|
14
|
-
import { dkrd018 } from "./relative-workdir";
|
|
15
|
-
import { dkrd019 } from "./add-url-checksum";
|
|
16
|
-
import { dkrd020 } from "./apt-update-alone";
|
|
17
|
-
|
|
18
|
-
// ── Helpers ─────────────────────────────────────────────────────────
|
|
19
|
-
|
|
20
|
-
function makeCtx(yaml: string): PostSynthContext {
|
|
21
|
-
return {
|
|
22
|
-
outputs: new Map([["docker", yaml]]),
|
|
23
|
-
entities: new Map(),
|
|
24
|
-
buildResult: {
|
|
25
|
-
outputs: new Map([["docker", yaml]]),
|
|
26
|
-
entities: new Map(),
|
|
27
|
-
warnings: [],
|
|
28
|
-
errors: [],
|
|
29
|
-
sourceFileCount: 1,
|
|
30
|
-
},
|
|
31
|
-
};
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
function makeDockerfileCtx(dockerfileName: string, content: string): PostSynthContext {
|
|
35
|
-
const result = {
|
|
36
|
-
primary: "services:\n app:\n image: myapp:1.0\n",
|
|
37
|
-
files: { [dockerfileName]: content },
|
|
38
|
-
};
|
|
39
|
-
return {
|
|
40
|
-
outputs: new Map([["docker", result as unknown as string]]),
|
|
41
|
-
entities: new Map(),
|
|
42
|
-
buildResult: {
|
|
43
|
-
outputs: new Map([["docker", result as unknown as string]]),
|
|
44
|
-
entities: new Map(),
|
|
45
|
-
warnings: [],
|
|
46
|
-
errors: [],
|
|
47
|
-
sourceFileCount: 1,
|
|
48
|
-
},
|
|
49
|
-
};
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
// ── DKRD001: no-latest-image ─────────────────────────────────────
|
|
53
|
-
|
|
54
|
-
describe("DKRD001: no-latest-image", () => {
|
|
55
|
-
test("flags :latest image", () => {
|
|
56
|
-
const yaml = `services:\n api:\n image: nginx:latest\n`;
|
|
57
|
-
const diags = dkrd001.check(makeCtx(yaml));
|
|
58
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
59
|
-
expect(diags[0].checkId).toBe("DKRD001");
|
|
60
|
-
expect(diags[0].severity).toBe("warning");
|
|
61
|
-
expect(diags[0].message).toContain("nginx:latest");
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
test("flags untagged image", () => {
|
|
65
|
-
const yaml = `services:\n api:\n image: nginx\n`;
|
|
66
|
-
const diags = dkrd001.check(makeCtx(yaml));
|
|
67
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
68
|
-
expect(diags[0].checkId).toBe("DKRD001");
|
|
69
|
-
});
|
|
70
|
-
|
|
71
|
-
test("does not flag versioned image", () => {
|
|
72
|
-
const yaml = `services:\n api:\n image: nginx:1.25-alpine\n`;
|
|
73
|
-
const diags = dkrd001.check(makeCtx(yaml));
|
|
74
|
-
expect(diags).toHaveLength(0);
|
|
75
|
-
});
|
|
76
|
-
});
|
|
77
|
-
|
|
78
|
-
// ── DKRD002: unused-volume ──────────────────────────────────────
|
|
79
|
-
|
|
80
|
-
describe("DKRD002: unused-volume", () => {
|
|
81
|
-
test("flags unused named volume", () => {
|
|
82
|
-
const yaml = `services:\n api:\n image: myapp:1.0\n\nvolumes:\n mydata:\n`;
|
|
83
|
-
const diags = dkrd002.check(makeCtx(yaml));
|
|
84
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
85
|
-
expect(diags[0].checkId).toBe("DKRD002");
|
|
86
|
-
expect(diags[0].message).toContain("mydata");
|
|
87
|
-
});
|
|
88
|
-
|
|
89
|
-
test("does not flag volume that is mounted", () => {
|
|
90
|
-
const yaml = `services:\n api:\n image: myapp:1.0\n volumes:\n - mydata:/data\n\nvolumes:\n mydata:\n`;
|
|
91
|
-
const diags = dkrd002.check(makeCtx(yaml));
|
|
92
|
-
expect(diags).toHaveLength(0);
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
test("no volumes section returns empty", () => {
|
|
96
|
-
const yaml = `services:\n api:\n image: myapp:1.0\n`;
|
|
97
|
-
const diags = dkrd002.check(makeCtx(yaml));
|
|
98
|
-
expect(diags).toHaveLength(0);
|
|
99
|
-
});
|
|
100
|
-
});
|
|
101
|
-
|
|
102
|
-
// ── DKRD003: ssh-port-exposed ───────────────────────────────────
|
|
103
|
-
|
|
104
|
-
describe("DKRD003: ssh-port-exposed", () => {
|
|
105
|
-
test("flags port 22 exposure", () => {
|
|
106
|
-
const yaml = `services:\n bastion:\n image: ubuntu:22.04\n ports:\n - "22:22"\n`;
|
|
107
|
-
const diags = dkrd003.check(makeCtx(yaml));
|
|
108
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
109
|
-
expect(diags[0].checkId).toBe("DKRD003");
|
|
110
|
-
expect(diags[0].severity).toBe("error");
|
|
111
|
-
});
|
|
112
|
-
|
|
113
|
-
test("does not flag other ports", () => {
|
|
114
|
-
const yaml = `services:\n api:\n image: myapp:1.0\n ports:\n - "8080:8080"\n`;
|
|
115
|
-
const diags = dkrd003.check(makeCtx(yaml));
|
|
116
|
-
expect(diags).toHaveLength(0);
|
|
117
|
-
});
|
|
118
|
-
|
|
119
|
-
test("does not flag localhost-bound port 22", () => {
|
|
120
|
-
const yaml = `services:\n bastion:\n image: ubuntu:22.04\n ports:\n - "127.0.0.1:22:22"\n`;
|
|
121
|
-
const diags = dkrd003.check(makeCtx(yaml));
|
|
122
|
-
expect(diags).toHaveLength(0);
|
|
123
|
-
});
|
|
124
|
-
});
|
|
125
|
-
|
|
126
|
-
// ── DKRD010: apt-no-recommends ──────────────────────────────────
|
|
127
|
-
|
|
128
|
-
describe("DKRD010: apt-no-recommends", () => {
|
|
129
|
-
test("flags apt-get install without --no-install-recommends", () => {
|
|
130
|
-
const dockerfile = `FROM ubuntu:22.04\nRUN apt-get update && apt-get install -y curl\n`;
|
|
131
|
-
const diags = dkrd010.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
132
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
133
|
-
expect(diags[0].checkId).toBe("DKRD010");
|
|
134
|
-
expect(diags[0].severity).toBe("warning");
|
|
135
|
-
});
|
|
136
|
-
|
|
137
|
-
test("does not flag with --no-install-recommends", () => {
|
|
138
|
-
const dockerfile = `FROM ubuntu:22.04\nRUN apt-get update && apt-get install -y --no-install-recommends curl\n`;
|
|
139
|
-
const diags = dkrd010.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
140
|
-
expect(diags).toHaveLength(0);
|
|
141
|
-
});
|
|
142
|
-
|
|
143
|
-
test("does not flag non-apt RUN", () => {
|
|
144
|
-
const dockerfile = `FROM node:20-alpine\nRUN npm ci\n`;
|
|
145
|
-
const diags = dkrd010.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
146
|
-
expect(diags).toHaveLength(0);
|
|
147
|
-
});
|
|
148
|
-
});
|
|
149
|
-
|
|
150
|
-
// ── DKRD011: prefer-copy ────────────────────────────────────────
|
|
151
|
-
|
|
152
|
-
describe("DKRD011: prefer-copy", () => {
|
|
153
|
-
test("flags ADD with local file", () => {
|
|
154
|
-
const dockerfile = `FROM ubuntu:22.04\nADD src/ /app/\n`;
|
|
155
|
-
const diags = dkrd011.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
156
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
157
|
-
expect(diags[0].checkId).toBe("DKRD011");
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
test("does not flag ADD with URL", () => {
|
|
161
|
-
const dockerfile = `FROM ubuntu:22.04\nADD https://example.com/file.tar.gz /tmp/\n`;
|
|
162
|
-
const diags = dkrd011.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
163
|
-
expect(diags).toHaveLength(0);
|
|
164
|
-
});
|
|
165
|
-
|
|
166
|
-
test("does not flag ADD with archive", () => {
|
|
167
|
-
const dockerfile = `FROM ubuntu:22.04\nADD src.tar.gz /app/\n`;
|
|
168
|
-
const diags = dkrd011.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
169
|
-
expect(diags).toHaveLength(0);
|
|
170
|
-
});
|
|
171
|
-
});
|
|
172
|
-
|
|
173
|
-
// ── DKRD012: no-root-user ────────────────────────────────────────
|
|
174
|
-
|
|
175
|
-
describe("DKRD012: no-root-user", () => {
|
|
176
|
-
test("flags Dockerfile without USER instruction", () => {
|
|
177
|
-
const dockerfile = `FROM node:20-alpine\nRUN npm ci\nCMD ["node", "index.js"]\n`;
|
|
178
|
-
const diags = dkrd012.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
179
|
-
expect(diags.length).toBeGreaterThanOrEqual(1);
|
|
180
|
-
expect(diags[0].checkId).toBe("DKRD012");
|
|
181
|
-
expect(diags[0].severity).toBe("warning");
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
test("does not flag Dockerfile with USER instruction", () => {
|
|
185
|
-
const dockerfile = `FROM node:20-alpine\nRUN npm ci\nUSER node\nCMD ["node", "index.js"]\n`;
|
|
186
|
-
const diags = dkrd012.check(makeDockerfileCtx("Dockerfile.app", dockerfile));
|
|
187
|
-
expect(diags).toHaveLength(0);
|
|
188
|
-
});
|
|
189
|
-
});
|
|
190
|
-
|
|
191
|
-
describe("DKRD012: final stage", () => {
|
|
192
|
-
const run = (lines: string[]) => dkrd012.check(makeDockerfileCtx("Dockerfile.app", lines.join("\n") + "\n"));
|
|
193
|
-
|
|
194
|
-
test("flags a final stage with no USER when only an earlier stage sets one", () => {
|
|
195
|
-
const diags = run(["FROM node:20-alpine AS build", "USER node", "RUN npm ci", "FROM node:20-alpine", "CMD node index.js"]);
|
|
196
|
-
expect(diags).toHaveLength(1);
|
|
197
|
-
expect(diags[0].message).toContain("final stage 2 has no USER");
|
|
198
|
-
});
|
|
199
|
-
|
|
200
|
-
test("flags a final stage that ends on USER root", () => {
|
|
201
|
-
const diags = run(["FROM debian:12-slim", "USER app", "USER 0:0", "CMD x"]);
|
|
202
|
-
expect(diags).toHaveLength(1);
|
|
203
|
-
expect(diags[0].message).toContain("ends on USER 0:0");
|
|
204
|
-
});
|
|
205
|
-
|
|
206
|
-
test("does not flag USER root for setup followed by a non-root USER", () => {
|
|
207
|
-
expect(run(["FROM debian:12-slim", "USER root", "RUN apt-get update", "USER app", "CMD x"])).toHaveLength(0);
|
|
208
|
-
});
|
|
209
|
-
});
|
|
210
|
-
|
|
211
|
-
const df = (lines: string[]) => makeDockerfileCtx("Dockerfile.app", lines.join("\n") + "\n");
|
|
212
|
-
|
|
213
|
-
describe("DKRD013: cache-busting copy", () => {
|
|
214
|
-
test("flags COPY . . before npm ci", () => {
|
|
215
|
-
const diags = dkrd013.check(df(["FROM node:20-alpine", "WORKDIR /app", "COPY . .", "RUN npm ci", "RUN npm run build"]));
|
|
216
|
-
expect(diags).toHaveLength(1);
|
|
217
|
-
expect(diags[0].message).toContain("COPY . . comes before RUN npm ci");
|
|
218
|
-
});
|
|
219
|
-
|
|
220
|
-
test("flags pip install -r and go mod download, across a continuation", () => {
|
|
221
|
-
expect(dkrd013.check(df(["FROM python:3.12-slim", "COPY . /app", "RUN pip install --no-cache-dir \\", " -r /app/requirements.txt"]))).toHaveLength(1);
|
|
222
|
-
expect(dkrd013.check(df(["FROM golang:1.23", "COPY ./ ./", "RUN go mod download"]))).toHaveLength(1);
|
|
223
|
-
});
|
|
224
|
-
|
|
225
|
-
test("does not flag manifests copied first, COPY --from, or a package added by name", () => {
|
|
226
|
-
expect(dkrd013.check(df(["FROM node:20-alpine", "COPY package*.json ./", "RUN npm ci", "COPY . .", "RUN npm run build"]))).toHaveLength(0);
|
|
227
|
-
expect(dkrd013.check(df(["FROM node:20-alpine", "COPY --from=build /app .", "RUN npm ci"]))).toHaveLength(0);
|
|
228
|
-
expect(dkrd013.check(df(["FROM node:20-alpine", "COPY . .", "RUN npm install -g serve"]))).toHaveLength(0);
|
|
229
|
-
});
|
|
230
|
-
});
|
|
231
|
-
|
|
232
|
-
describe("DKRD014: root-only RUN after USER", () => {
|
|
233
|
-
test("flags apt-get after a non-root USER", () => {
|
|
234
|
-
const diags = dkrd014.check(df(["FROM debian:12-slim", "USER app", "RUN apt-get update && apt-get install -y curl"]));
|
|
235
|
-
expect(diags).toHaveLength(1);
|
|
236
|
-
expect(diags[0].message).toContain("runs as USER app");
|
|
237
|
-
});
|
|
238
|
-
|
|
239
|
-
test("does not flag root setup before USER, USER root, or sudo", () => {
|
|
240
|
-
expect(dkrd014.check(df(["FROM debian:12-slim", "RUN useradd app", "USER app", "RUN whoami"]))).toHaveLength(0);
|
|
241
|
-
expect(dkrd014.check(df(["FROM debian:12-slim", "USER app", "USER root", "RUN chown app /data", "USER app"]))).toHaveLength(0);
|
|
242
|
-
expect(dkrd014.check(df(["FROM debian:12-slim", "USER app", "RUN sudo apt-get install -y curl"]))).toHaveLength(0);
|
|
243
|
-
});
|
|
244
|
-
|
|
245
|
-
test("a USER in one stage does not carry into the next", () => {
|
|
246
|
-
expect(dkrd014.check(df(["FROM debian:12-slim AS a", "USER app", "FROM debian:12-slim", "RUN apt-get install -y curl"]))).toHaveLength(0);
|
|
247
|
-
});
|
|
248
|
-
});
|
|
249
|
-
|
|
250
|
-
describe("DKRD015: repeated CMD or ENTRYPOINT", () => {
|
|
251
|
-
test("flags two CMDs in a stage", () => {
|
|
252
|
-
const diags = dkrd015.check(df(["FROM alpine:3.20", 'CMD ["a"]', "RUN true", 'CMD ["b"]']));
|
|
253
|
-
expect(diags).toHaveLength(1);
|
|
254
|
-
expect(diags[0].message).toContain('2 CMD instructions; only the last (CMD ["b"])');
|
|
255
|
-
});
|
|
256
|
-
|
|
257
|
-
test("does not flag one CMD per stage", () => {
|
|
258
|
-
expect(dkrd015.check(df(["FROM alpine:3.20 AS a", "CMD a", "FROM alpine:3.20", "ENTRYPOINT x", "CMD b"]))).toHaveLength(0);
|
|
259
|
-
});
|
|
260
|
-
});
|
|
261
|
-
|
|
262
|
-
describe("DKRD016: COPY --from stage", () => {
|
|
263
|
-
test("flags a stage that is only defined later", () => {
|
|
264
|
-
const diags = dkrd016.check(df(["FROM alpine:3.20 AS final", "COPY --from=build /out /out", "FROM alpine:3.20 AS build"]));
|
|
265
|
-
expect(diags).toHaveLength(1);
|
|
266
|
-
expect(diags[0].message).toContain('names stage "build", which is not defined until later');
|
|
267
|
-
});
|
|
268
|
-
|
|
269
|
-
test("flags a name no stage has", () => {
|
|
270
|
-
const diags = dkrd016.check(df(["FROM alpine:3.20 AS build", "FROM alpine:3.20", "COPY --from=biuld /out /out"]));
|
|
271
|
-
expect(diags).toHaveLength(1);
|
|
272
|
-
expect(diags[0].message).toContain('pulls an image called "biuld"');
|
|
273
|
-
});
|
|
274
|
-
|
|
275
|
-
test("does not flag earlier stages by name or index, or tagged images", () => {
|
|
276
|
-
expect(dkrd016.check(df([
|
|
277
|
-
"FROM alpine:3.20 AS build",
|
|
278
|
-
"FROM alpine:3.20",
|
|
279
|
-
"COPY --from=build /a /a",
|
|
280
|
-
"COPY --from=0 /b /b",
|
|
281
|
-
"COPY --from=nginx:1.27 /etc/nginx /etc/nginx",
|
|
282
|
-
]))).toHaveLength(0);
|
|
283
|
-
});
|
|
284
|
-
});
|
|
285
|
-
|
|
286
|
-
describe("DKRD017: unused global ARG", () => {
|
|
287
|
-
test("flags an ARG before FROM that nothing uses", () => {
|
|
288
|
-
const diags = dkrd017.check(df(["ARG UNUSED=1", "FROM alpine:3.20"]));
|
|
289
|
-
expect(diags).toHaveLength(1);
|
|
290
|
-
expect(diags[0].message).toContain("ARG UNUSED");
|
|
291
|
-
});
|
|
292
|
-
|
|
293
|
-
test("does not flag an ARG used in FROM or declared again in a stage", () => {
|
|
294
|
-
expect(dkrd017.check(df(["ARG NODE_VERSION=20", "FROM node:${NODE_VERSION}-alpine"]))).toHaveLength(0);
|
|
295
|
-
expect(dkrd017.check(df(["ARG VERSION=1", "FROM alpine:3.20", "ARG VERSION", "RUN echo $VERSION"]))).toHaveLength(0);
|
|
296
|
-
});
|
|
297
|
-
});
|
|
298
|
-
|
|
299
|
-
describe("DKRD018: relative WORKDIR", () => {
|
|
300
|
-
test("flags a relative WORKDIR before any absolute one", () => {
|
|
301
|
-
const diags = dkrd018.check(df(["FROM alpine:3.20", "WORKDIR app"]));
|
|
302
|
-
expect(diags).toHaveLength(1);
|
|
303
|
-
expect(diags[0].message).toContain("WORKDIR app is relative");
|
|
304
|
-
});
|
|
305
|
-
|
|
306
|
-
test("does not flag a relative WORKDIR after an absolute one", () => {
|
|
307
|
-
expect(dkrd018.check(df(["FROM alpine:3.20", "WORKDIR /src", "WORKDIR app"]))).toHaveLength(0);
|
|
308
|
-
});
|
|
309
|
-
});
|
|
310
|
-
|
|
311
|
-
describe("DKRD019: ADD URL without checksum", () => {
|
|
312
|
-
test("flags ADD of an https URL without --checksum", () => {
|
|
313
|
-
expect(dkrd019.check(df(["FROM alpine:3.20", "ADD https://example.com/tool.tgz /tmp/"]))).toHaveLength(1);
|
|
314
|
-
});
|
|
315
|
-
|
|
316
|
-
test("does not flag --checksum or a local file", () => {
|
|
317
|
-
expect(dkrd019.check(df(["FROM alpine:3.20", "ADD --checksum=sha256:abc https://example.com/tool.tgz /tmp/", "ADD local.tgz /tmp/"]))).toHaveLength(0);
|
|
318
|
-
});
|
|
319
|
-
});
|
|
320
|
-
|
|
321
|
-
describe("DKRD020: apt-get update alone", () => {
|
|
322
|
-
test("flags update in one RUN and install in a later one", () => {
|
|
323
|
-
const diags = dkrd020.check(df(["FROM debian:12-slim", "RUN apt-get update", "RUN apt-get install -y --no-install-recommends curl"]));
|
|
324
|
-
expect(diags).toHaveLength(1);
|
|
325
|
-
});
|
|
326
|
-
|
|
327
|
-
test("does not flag update and install in one RUN", () => {
|
|
328
|
-
expect(dkrd020.check(df(["FROM debian:12-slim", "RUN apt-get update \\", " && apt-get install -y --no-install-recommends curl"]))).toHaveLength(0);
|
|
329
|
-
});
|
|
330
|
-
});
|
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* DKRD011: Prefer COPY over ADD
|
|
3
|
-
*
|
|
4
|
-
* ADD has surprising behavior (auto-extracts archives, fetches URLs).
|
|
5
|
-
* Use COPY when you just need to copy local files.
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
import type { PostSynthCheck, PostSynthContext, PostSynthDiagnostic } from "@intentius/chant/lint/post-synth";
|
|
9
|
-
import { extractDockerfiles } from "./docker-helpers";
|
|
10
|
-
|
|
11
|
-
function looksLikeUrl(src: string): boolean {
|
|
12
|
-
return src.startsWith("http://") || src.startsWith("https://") || src.startsWith("ftp://");
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
function looksLikeArchive(src: string): boolean {
|
|
16
|
-
return /\.(tar|tar\.gz|tgz|tar\.bz2|tar\.xz|zip)$/i.test(src);
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
export const dkrd011: PostSynthCheck = {
|
|
20
|
-
id: "DKRD011",
|
|
21
|
-
description: "Prefer COPY over ADD when not fetching URLs or extracting archives",
|
|
22
|
-
|
|
23
|
-
check(ctx: PostSynthContext): PostSynthDiagnostic[] {
|
|
24
|
-
const diagnostics: PostSynthDiagnostic[] = [];
|
|
25
|
-
|
|
26
|
-
for (const [_outputName, output] of ctx.outputs) {
|
|
27
|
-
const dockerfiles = extractDockerfiles(output);
|
|
28
|
-
|
|
29
|
-
for (const [fileName, content] of dockerfiles) {
|
|
30
|
-
const lines = content.split("\n");
|
|
31
|
-
for (const line of lines) {
|
|
32
|
-
const trimmed = line.trim();
|
|
33
|
-
if (/^ADD\s+/.test(trimmed)) {
|
|
34
|
-
// Extract src argument (first token after ADD)
|
|
35
|
-
const parts = trimmed.replace(/^ADD\s+/, "").split(/\s+/);
|
|
36
|
-
const src = parts[0];
|
|
37
|
-
|
|
38
|
-
if (!looksLikeUrl(src) && !looksLikeArchive(src)) {
|
|
39
|
-
diagnostics.push({
|
|
40
|
-
checkId: "DKRD011",
|
|
41
|
-
severity: "info",
|
|
42
|
-
message: `${fileName}: Use COPY instead of ADD when not fetching URLs or extracting archives. ADD "${src}" could be COPY.`,
|
|
43
|
-
lexicon: "docker",
|
|
44
|
-
});
|
|
45
|
-
}
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
return diagnostics;
|
|
52
|
-
},
|
|
53
|
-
};
|