python-template/tests/test_scripts.py at main · NWarila/python-template · GitHub

History

225 lines (179 loc) · 8.38 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

"""Smoke tests for check scripts.

Each test runs a check script against a minimal temporary Python project

and verifies exit codes. These tests validate that the scripts are

functional, generic, and produce correct results.

"""

from __future__ import annotations

import subprocess

import sys

from pathlib import Path

def _run_script(

project: Path, script_name: str, *extra_args: str, scripts_dir: str = "scripts"

) -> subprocess.CompletedProcess[str]:

"""Run a check script inside the given project directory."""

script = project / scripts_dir / script_name

return subprocess.run( # noqa: S603 - controlled test invocation of local scripts

[sys.executable, str(script), *extra_args],

cwd=project,

capture_output=True,

text=True,

)

class TestCheckLint:

"""Tests for check_lint.py."""

def test_clean_project_passes(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_lint.py")

assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"

def test_fix_flag_accepted(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_lint.py", "--fix")

assert result.returncode == 0

def test_bad_formatting_fails(self, tmp_project: Path) -> None:

bad_file = tmp_project / "src" / "smoke_project" / "bad.py"

bad_file.write_text("x=1\ny = 2\n")

result = _run_script(tmp_project, "check_lint.py")

assert result.returncode != 0

class TestCheckTypes:

"""Tests for check_types.py."""

def test_clean_project_passes(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_types.py")

assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"

def test_type_error_fails(self, tmp_project: Path) -> None:

bad_file = tmp_project / "src" / "smoke_project" / "bad.py"

bad_file.write_text("def add(a: int, b: int) -> int:\n return a + b\n\nx: str = add(1, 2)\n")

result = _run_script(tmp_project, "check_types.py")

assert result.returncode != 0

class TestCheckTests:

"""Tests for check_tests.py."""

def test_passing_tests_succeed(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_tests.py")

assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"

def test_failing_test_fails(self, tmp_project: Path) -> None:

(tmp_project / "tests" / "test_fail.py").write_text("def test_always_fails() -> None:\n assert False\n")

result = _run_script(tmp_project, "check_tests.py")

assert result.returncode != 0

class TestCheckSecurity:

"""Tests for check_security.py."""

def test_runs_without_error(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_security.py")

# pip-audit may or may not find issues depending on the environment,

# but the script itself should not crash

assert result.returncode in (0, 1)

def test_help_flag(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_security.py", "--help")

assert result.returncode == 0

assert "security" in result.stdout.lower() or "audit" in result.stdout.lower()

class TestCheckSpelling:

"""Tests for check_spelling.py."""

def test_clean_project_passes(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_spelling.py")

assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"

def test_typo_detected(self, tmp_project: Path) -> None:

(tmp_project / "src" / "smoke_project" / "typo.py").write_text(

"# This file has a " + "".join(["t", "eh"]) + " typo in it.\n"

)

result = _run_script(tmp_project, "check_spelling.py")

assert result.returncode != 0

class TestCheckPackage:

"""Tests for check_package.py."""

def test_package_build_succeeds(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "check_package.py")

assert result.returncode == 0, f"stdout: {result.stdout}\nstderr: {result.stderr}"

# dist/ should be cleaned up

assert not (tmp_project / "dist").exists()

def test_no_build_system_skips(self, tmp_project: Path) -> None:

# Remove [build-system] from pyproject.toml

pyproject = tmp_project / "pyproject.toml"

content = pyproject.read_text()

lines = content.split("\n")

filtered = []

skip = False

for line in lines:

if line.startswith("[build-system]"):

skip = True

continue

if skip and line.startswith("["):

skip = False

if not skip:

filtered.append(line)

pyproject.write_text("\n".join(filtered))

result = _run_script(tmp_project, "check_package.py")

assert result.returncode == 0

assert "skipping" in result.stdout.lower() or "skip" in result.stdout.lower()

class TestQa:

"""Tests for qa.py orchestrator."""

def test_help_flag(self, tmp_project: Path) -> None:

result = _run_script(tmp_project, "qa.py", "--help")

assert result.returncode == 0

assert "skip" in result.stdout.lower()

def test_skip_flag(self, tmp_project: Path) -> None:

result = _run_script(

tmp_project,

"qa.py",

"--skip",

"types",

"--skip",

"tests",

"--skip",

"security",

"--skip",

"package",

)

assert "SKIP" in result.stdout

class TestProjectRootWalkUp:

"""Tests that scripts find PROJECT_ROOT from both scripts/ and .github/scripts/.

Before the fix, scripts assumed PROJECT_ROOT = SCRIPT_DIR.parent (one level

up). This broke when running from .github/scripts/ (two levels deep) because

the parent resolved to .github/ instead of the repo root. The walk-up logic

traverses upward until it finds pyproject.toml.

"""

def test_qa_from_scripts_dir(self, tmp_project: Path) -> None:

"""qa.py finds PROJECT_ROOT from the standard scripts/ location."""

result = _run_script(tmp_project, "qa.py", "--help")

assert result.returncode == 0

def test_qa_from_github_scripts_dir(self, tmp_project: Path) -> None:

"""qa.py finds PROJECT_ROOT from the synced .github/scripts/ location."""

result = _run_script(tmp_project, "qa.py", "--help", scripts_dir=".github/scripts")

assert result.returncode == 0

def test_qa_discovers_checks_from_github_scripts(self, tmp_project: Path) -> None:

"""qa.py discovers check_*.py siblings when running from .github/scripts/."""

result = _run_script(

tmp_project,

"qa.py",

"--skip",

"lint",

"--skip",

"types",

"--skip",

"tests",

"--skip",

"security",

"--skip",

"spelling",

"--skip",

"package",

scripts_dir=".github/scripts",

)

# All checks skipped = success; proves the script loaded and found pyproject.toml

assert result.returncode == 0

assert "SKIP" in result.stdout

assert "could not find pyproject.toml" not in result.stderr

def test_no_pyproject_toml_fails(self, tmp_path: Path) -> None:

"""qa.py fails with a clear error when pyproject.toml is missing."""

scripts_dir = tmp_path / "deep" / "nested" / "scripts"

scripts_dir.mkdir(parents=True)

source_qa = Path(__file__).resolve().parent.parent / "scripts" / "qa.py"

(scripts_dir / "qa.py").write_text(source_qa.read_text())

result = subprocess.run( # noqa: S603

[sys.executable, str(scripts_dir / "qa.py"), "--help"],

cwd=tmp_path,

capture_output=True,

text=True,

)

assert result.returncode != 0

assert "could not find pyproject.toml" in result.stderr

def test_deeply_nested_scripts(self, tmp_project: Path) -> None:

"""Walk-up works from an arbitrarily deep location."""

import shutil

deep = tmp_project / "a" / "b" / "c" / "scripts"

shutil.copytree(tmp_project / "scripts", deep)

result = _run_script(tmp_project, "qa.py", "--help", scripts_dir="a/b/c/scripts")

assert result.returncode == 0

python-template/tests/test_scripts.py at main · NWarila/python-template · GitHub

Expand file tree

Breadcrumbs

test_scripts.py

Latest commit

History

Breadcrumbs

test_scripts.py

File metadata and controls