20632486505

Committed 01 Jan 2026 04:21AM UTC coverage: 43.231% (-37.1%) from 80.281%

Build # 20632486505

Build Type

Pull #22962

github

Committed by

web-flow

Commit Message

Merge 08d5c63b0 into f52ab6675

Pull Request Pull Request #22962: Bump the gha-deps group across 1 directory with 6 updates

Run Details

26122 of 60424 relevant lines covered (43.23%)

0.86 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

56.94

/src/python/pants/backend/docker/lint/hadolint/rules_integration_test.py

# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

from textwrap import dedent
from typing import Any

import pytest

from pants.backend.docker.lint.hadolint.rules import HadolintFieldSet, HadolintRequest
from pants.backend.docker.lint.hadolint.rules import rules as hadolint_rules
from pants.backend.docker.rules import rules as docker_rules
from pants.backend.docker.target_types import DockerImageTarget
from pants.core.goals import package
from pants.core.goals.lint import LintResult, Partitions
from pants.core.util_rules import config_files, external_tool, source_files
from pants.engine.addresses import Address
from pants.engine.target import Target
from pants.testutil.rule_runner import QueryRule, RuleRunner


@pytest.fixture
def rule_runner() -> RuleRunner:
    return RuleRunner(
        rules=[
            *config_files.rules(),
            *docker_rules(),
            *external_tool.rules(),
            *hadolint_rules(),
            *package.rules(),
            *source_files.rules(),
            QueryRule(Partitions, [HadolintRequest.PartitionRequest]),
            QueryRule(LintResult, [HadolintRequest.Batch]),
        ],
        target_types=[DockerImageTarget],
    )


GOOD_FILE = "FROM python:3.8"
BAD_FILE = "FROM python"


def run_hadolint(
    rule_runner: RuleRunner, targets: list[Target], *, extra_args: list[str] | None = None
) -> tuple[LintResult, ...]:
    rule_runner.set_options(
        extra_args or (),
        env_inherit={"PATH"},
    )
    partitions = rule_runner.request(
        Partitions[HadolintFieldSet, Any],
        [HadolintRequest.PartitionRequest(tuple(HadolintFieldSet.create(tgt) for tgt in targets))],
    )
    results = []
    for partition in partitions:
        result = rule_runner.request(
            LintResult,
            [HadolintRequest.Batch("", partition.elements, partition.metadata)],
        )
        results.append(result)
    return tuple(results)


def assert_success(
    rule_runner: RuleRunner, target: Target, *, extra_args: list[str] | None = None
) -> None:
    result = run_hadolint(rule_runner, [target], extra_args=extra_args)
    assert len(result) == 1
    assert result[0].exit_code == 0
    assert not result[0].stdout
    assert not result[0].stderr


def test_passing(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"Dockerfile": GOOD_FILE, "BUILD": "docker_image(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t"))
    assert_success(rule_runner, tgt)


@pytest.mark.platform_specific_behavior
def test_failing(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t"))
    result = run_hadolint(rule_runner, [tgt])
    assert len(result) == 1
    assert result[0].exit_code == 1
    assert "Dockerfile:1 " in result[0].stdout


def test_multiple_targets(rule_runner: RuleRunner) -> None:
    rule_runner.write_files(
        {
            "Dockerfile.good": GOOD_FILE,
            "Dockerfile.bad": BAD_FILE,
            "BUILD": dedent(
                """
                docker_image(name="good", source="Dockerfile.good")
                docker_image(name="bad", source="Dockerfile.bad")
                """
            ),
        }
    )
    tgts = [
        rule_runner.get_target(
            Address("", target_name="good", relative_file_path="Dockerfile.good")
        ),
        rule_runner.get_target(Address("", target_name="bad", relative_file_path="Dockerfile.bad")),
    ]
    result = run_hadolint(rule_runner, tgts)
    assert len(result) == 1
    assert result[0].exit_code == 1
    assert "Dockerfile.good" not in result[0].stdout
    assert "Dockerfile.bad:1 " in result[0].stdout


def test_config_files(rule_runner: RuleRunner) -> None:
    rule_runner.write_files(
        {
            ".hadolint.yaml": "ignored: [DL3006, DL3061, DL3011]",
            "a/Dockerfile": BAD_FILE,
            "a/BUILD": "docker_image()",
            "b/Dockerfile": BAD_FILE,
            "b/BUILD": "docker_image()",
            "c/BUILD": "docker_image()",
            "c/Dockerfile": "EXPOSE 123456",
        }
    )
    tgts = [
        rule_runner.get_target(Address("a")),
        rule_runner.get_target(Address("b")),
    ]
    result = run_hadolint(rule_runner, tgts)
    assert len(result) == 1
    assert result[0].exit_code == 0
    assert "a/Dockerfile" not in result[0].stdout
    assert "b/Dockerfile " not in result[0].stdout

    tgt = rule_runner.get_target(Address("c"))
    assert_success(rule_runner, tgt, extra_args=["--hadolint-config=.hadolint.yaml"])


def test_passthrough_args(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t"))
    assert_success(rule_runner, tgt, extra_args=["--hadolint-args=--ignore DL3006"])


def test_skip(rule_runner: RuleRunner) -> None:
    rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})
    tgt = rule_runner.get_target(Address("", target_name="t"))
    result = run_hadolint(rule_runner, [tgt], extra_args=["--hadolint-skip"])
    assert not result

1	# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	2✔
5
6	from textwrap import dedent	2✔
7	from typing import Any	2✔
8
9	import pytest	2✔
10
11	from pants.backend.docker.lint.hadolint.rules import HadolintFieldSet, HadolintRequest	2✔
12	from pants.backend.docker.lint.hadolint.rules import rules as hadolint_rules	2✔
13	from pants.backend.docker.rules import rules as docker_rules	2✔
14	from pants.backend.docker.target_types import DockerImageTarget	2✔
15	from pants.core.goals import package	2✔
16	from pants.core.goals.lint import LintResult, Partitions	2✔
17	from pants.core.util_rules import config_files, external_tool, source_files	2✔
18	from pants.engine.addresses import Address	2✔
19	from pants.engine.target import Target	2✔
20	from pants.testutil.rule_runner import QueryRule, RuleRunner	2✔
21
22
23	@pytest.fixture	2✔
24	def rule_runner() -> RuleRunner:	2✔
25	return RuleRunner(	2✔
26	rules=[
27	*config_files.rules(),
28	*docker_rules(),
29	*external_tool.rules(),
30	*hadolint_rules(),
31	*package.rules(),
32	*source_files.rules(),
33	QueryRule(Partitions, [HadolintRequest.PartitionRequest]),
34	QueryRule(LintResult, [HadolintRequest.Batch]),
35	],
36	target_types=[DockerImageTarget],
37	)
38
39
40	GOOD_FILE = "FROM python:3.8"	2✔
41	BAD_FILE = "FROM python"	2✔
42
43
44	def run_hadolint(	2✔
45	rule_runner: RuleRunner, targets: list[Target], *, extra_args: list[str] \| None = None
46	) -> tuple[LintResult, ...]:
47	rule_runner.set_options(	2✔
48	extra_args or (),
49	env_inherit={"PATH"},
50	)
51	partitions = rule_runner.request(	2✔
52	Partitions[HadolintFieldSet, Any],
53	[HadolintRequest.PartitionRequest(tuple(HadolintFieldSet.create(tgt) for tgt in targets))],
54	)
55	results = []	2✔
56	for partition in partitions:	2✔
57	result = rule_runner.request(	2✔
58	LintResult,
59	[HadolintRequest.Batch("", partition.elements, partition.metadata)],
60	)
61	results.append(result)	2✔
62	return tuple(results)	2✔
63
64
65	def assert_success(	2✔
66	rule_runner: RuleRunner, target: Target, *, extra_args: list[str] \| None = None
67	) -> None:
68	result = run_hadolint(rule_runner, [target], extra_args=extra_args)	×
69	assert len(result) == 1	×
70	assert result[0].exit_code == 0	×
71	assert not result[0].stdout	×
72	assert not result[0].stderr	×
73
74
75	def test_passing(rule_runner: RuleRunner) -> None:	2✔
76	rule_runner.write_files({"Dockerfile": GOOD_FILE, "BUILD": "docker_image(name='t')"})	×
77	tgt = rule_runner.get_target(Address("", target_name="t"))	×
78	assert_success(rule_runner, tgt)	×
79
80
81	@pytest.mark.platform_specific_behavior	2✔
82	def test_failing(rule_runner: RuleRunner) -> None:	2✔
83	rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})	2✔
84	tgt = rule_runner.get_target(Address("", target_name="t"))	2✔
85	result = run_hadolint(rule_runner, [tgt])	2✔
86	assert len(result) == 1	2✔
87	assert result[0].exit_code == 1	2✔
88	assert "Dockerfile:1 " in result[0].stdout	2✔
89
90
91	def test_multiple_targets(rule_runner: RuleRunner) -> None:	2✔
92	rule_runner.write_files(	×
93	{
94	"Dockerfile.good": GOOD_FILE,
95	"Dockerfile.bad": BAD_FILE,
96	"BUILD": dedent(
97	"""
98	docker_image(name="good", source="Dockerfile.good")
99	docker_image(name="bad", source="Dockerfile.bad")
100	"""
101	),
102	}
103	)
104	tgts = [	×
105	rule_runner.get_target(
106	Address("", target_name="good", relative_file_path="Dockerfile.good")
107	),
108	rule_runner.get_target(Address("", target_name="bad", relative_file_path="Dockerfile.bad")),
109	]
110	result = run_hadolint(rule_runner, tgts)	×
111	assert len(result) == 1	×
112	assert result[0].exit_code == 1	×
113	assert "Dockerfile.good" not in result[0].stdout	×
114	assert "Dockerfile.bad:1 " in result[0].stdout	×
115
116
117	def test_config_files(rule_runner: RuleRunner) -> None:	2✔
118	rule_runner.write_files(	×
119	{
120	".hadolint.yaml": "ignored: [DL3006, DL3061, DL3011]",
121	"a/Dockerfile": BAD_FILE,
122	"a/BUILD": "docker_image()",
123	"b/Dockerfile": BAD_FILE,
124	"b/BUILD": "docker_image()",
125	"c/BUILD": "docker_image()",
126	"c/Dockerfile": "EXPOSE 123456",
127	}
128	)
129	tgts = [	×
130	rule_runner.get_target(Address("a")),
131	rule_runner.get_target(Address("b")),
132	]
133	result = run_hadolint(rule_runner, tgts)	×
134	assert len(result) == 1	×
135	assert result[0].exit_code == 0	×
136	assert "a/Dockerfile" not in result[0].stdout	×
137	assert "b/Dockerfile " not in result[0].stdout	×
138
139	tgt = rule_runner.get_target(Address("c"))	×
140	assert_success(rule_runner, tgt, extra_args=["--hadolint-config=.hadolint.yaml"])	×
141
142
143	def test_passthrough_args(rule_runner: RuleRunner) -> None:	2✔
144	rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})	×
145	tgt = rule_runner.get_target(Address("", target_name="t"))	×
146	assert_success(rule_runner, tgt, extra_args=["--hadolint-args=--ignore DL3006"])	×
147
148
149	def test_skip(rule_runner: RuleRunner) -> None:	2✔
150	rule_runner.write_files({"Dockerfile": BAD_FILE, "BUILD": "docker_image(name='t')"})	×
151	tgt = rule_runner.get_target(Address("", target_name="t"))	×
152	result = run_hadolint(rule_runner, [tgt], extra_args=["--hadolint-skip"])	×
153	assert not result	×

pantsbuild / pants / 20632486505

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous