FilesExpand file tree

main

/

test_check_pr_title.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

68 lines (52 loc) · 2.7 KB

main

/

test_check_pr_title.py

Copy path

Top

File metadata and controls

• Code
• Blame

68 lines (52 loc) · 2.7 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

#!/usr/bin/env python3

import importlib.util

import io

import unittest

from contextlib import redirect_stdout

from pathlib import Path

SPEC = importlib.util.spec_from_file_location("check_pr_title", Path(__file__).with_name("check-pr-title.py"))

check = importlib.util.module_from_spec(SPEC)

SPEC.loader.exec_module(check)

class SubjectShapeTests(unittest.TestCase):

def test_every_listed_type_is_accepted(self):

for kind in check.TYPES:

with self.subTest(kind=kind):

self.assertEqual(check.problems(f"{kind}: tidy one thing"), [])

def test_a_scope_and_a_breaking_marker_are_accepted(self):

self.assertEqual(check.problems("refactor(ai-providers)!: drop the legacy endpoint"), [])

self.assertEqual(check.problems("feat!: drop macOS 12"), [])

self.assertEqual(check.problems("fix(plugin-mongodb): keep binary ids"), [])

def test_an_unknown_type_is_refused(self):

self.assertEqual(len(check.problems("release: v0.77.0")), 1)

self.assertEqual(len(check.problems("feature(editor): add a thing")), 1)

def test_a_plain_sentence_is_refused(self):

self.assertEqual(len(check.problems("Update appcast.xml for v0.76.1")), 1)

def test_a_malformed_scope_is_refused(self):

for title in ("fix(): empty scope", "fix(Editor): capital scope", "fix(editor) : space", "fix (editor): space"):

with self.subTest(title=title):

self.assertEqual(len(check.problems(title)), 1)

def test_a_missing_description_is_refused(self):

self.assertEqual(len(check.problems("fix(editor):")), 1)

self.assertEqual(len(check.problems("fix(editor): ")), 1)

self.assertEqual(len(check.problems("fix(editor):no space")), 1)

class OutputTests(unittest.TestCase):

def run_main(self, *argv):

captured = io.StringIO()

with redirect_stdout(captured):

status = check.main(["check-pr-title.py", *argv])

return status, captured.getvalue()

def test_a_good_title_passes_and_prints_the_subject(self):

status, out = self.run_main("fix(editor): keep the caret")

self.assertEqual(status, 0)

self.assertIn("OK: fix(editor): keep the caret", out)

def test_a_bad_title_fails_with_one_annotation_per_problem(self):

status, out = self.run_main("Fix the editor")

self.assertEqual(status, 1)

self.assertEqual(out.count("::error "), 1)

def test_a_title_cannot_inject_a_workflow_command(self):

status, out = self.run_main("Bad\n::add-mask::secret %")

self.assertEqual(status, 1)

self.assertEqual(len(out.splitlines()), 1)

self.assertIn("%0A::add-mask::secret %25", out)

if __name__ == "__main__":

unittest.main()