Coverage for tests/test_completion/test_completion.py: 100%

1import os 9 ctx1cabdefghi

2import subprocess 9 ctx1cabdefghi

3import sys 9 ctx1cabdefghi

4from pathlib import Path 9 ctx1cabdefghi

5 

6from docs_src.commands.index import tutorial001 as mod 9 ctx1cabdefghi

7 

8from ..utils import needs_bash, needs_linux, requires_completion_permission 9 ctx1cabdefghi

9 

10 

11@needs_bash 9 ctx1cabdefghi

12@needs_linux 9 ctx1cabdefghi

13def test_show_completion(): 8 ctx1abdefghi

14 result = subprocess.run( 3 ctx1cab

15 [ 

16 "bash", 

17 "-c", 

18 f"'{sys.executable}' -m coverage run '{mod.__file__}' --show-completion", 

19 ], 

20 capture_output=True, 

21 encoding="utf-8", 

22 env={**os.environ, "SHELL": "/bin/bash", "_TYPER_COMPLETE_TESTING": "True"}, 

23 ) 

24 assert "_TUTORIAL001.PY_COMPLETE=complete_bash" in result.stdout 3 ctx1cab

25 

26 

27@needs_bash 9 ctx1cabdefghi

28@needs_linux 9 ctx1cabdefghi

29@requires_completion_permission 9 ctx1cabdefghi

30def test_install_completion(): 8 ctx1abdefghi

31 bash_completion_path: Path = Path.home() / ".bashrc" 3 ctx1cab

32 text = "" 3 ctx1cab

33 if bash_completion_path.is_file(): # pragma: no cover 3 ctx1cab

34 text = bash_completion_path.read_text() 3 ctx1cab

35 result = subprocess.run( 3 ctx1cab

36 [ 

37 "bash", 

38 "-c", 

39 f"'{sys.executable}' -m coverage run '{mod.__file__}' --install-completion", 

40 ], 

41 capture_output=True, 

42 encoding="utf-8", 

43 env={**os.environ, "SHELL": "/bin/bash", "_TYPER_COMPLETE_TESTING": "True"}, 

44 ) 

45 new_text = bash_completion_path.read_text() 3 ctx1cab

46 bash_completion_path.write_text(text) 3 ctx1cab

47 assert "source" in new_text 3 ctx1cab

48 assert str(Path(".bash_completions/tutorial001.py.sh")) in new_text 3 ctx1cab

49 assert "completion installed in" in result.stdout 3 ctx1cab

50 assert "Completion will take effect once you restart the terminal" in result.stdout 3 ctx1cab

51 

52 

53def test_completion_invalid_instruction(): 9 ctx1cabdefghi

54 result = subprocess.run( 9 ctx1cabdefghi

55 [sys.executable, "-m", "coverage", "run", mod.__file__], 

56 capture_output=True, 

57 encoding="utf-8", 

58 env={ 

59 **os.environ, 

60 "_TUTORIAL001.PY_COMPLETE": "sourcebash", 

61 }, 

62 ) 

63 assert result.returncode != 0 9 ctx1cabdefghi

64 assert "Invalid completion instruction." in result.stderr 9 ctx1cabdefghi

65 

66 

67def test_completion_source_bash(): 9 ctx1cabdefghi

68 result = subprocess.run( 9 ctx1cabdefghi

69 [sys.executable, "-m", "coverage", "run", mod.__file__], 

70 capture_output=True, 

71 encoding="utf-8", 

72 env={ 

73 **os.environ, 

74 "_TUTORIAL001.PY_COMPLETE": "source_bash", 

75 }, 

76 ) 

77 assert ( 9 ctx1cabdefghi

78 "complete -o default -F _tutorial001py_completion tutorial001.py" 

79 in result.stdout 

80 ) 

81 

82 

83def test_completion_source_invalid_shell(): 9 ctx1cabdefghi

84 result = subprocess.run( 9 ctx1cabdefghi

85 [sys.executable, "-m", "coverage", "run", mod.__file__], 

86 capture_output=True, 

87 encoding="utf-8", 

88 env={ 

89 **os.environ, 

90 "_TUTORIAL001.PY_COMPLETE": "source_xxx", 

91 }, 

92 ) 

93 assert "Shell xxx not supported." in result.stderr 9 ctx1cabdefghi

94 

95 

96def test_completion_source_invalid_instruction(): 9 ctx1cabdefghi

97 result = subprocess.run( 9 ctx1cabdefghi

98 [sys.executable, "-m", "coverage", "run", mod.__file__], 

99 capture_output=True, 

100 encoding="utf-8", 

101 env={ 

102 **os.environ, 

103 "_TUTORIAL001.PY_COMPLETE": "explode_bash", 

104 }, 

105 ) 

106 assert 'Completion instruction "explode" not supported.' in result.stderr 9 ctx1cabdefghi

107 

108 

109def test_completion_source_zsh(): 9 ctx1cabdefghi

110 result = subprocess.run( 9 ctx1cabdefghi

111 [sys.executable, "-m", "coverage", "run", mod.__file__], 

112 capture_output=True, 

113 encoding="utf-8", 

114 env={ 

115 **os.environ, 

116 "_TUTORIAL001.PY_COMPLETE": "source_zsh", 

117 }, 

118 ) 

119 assert "compdef _tutorial001py_completion tutorial001.py" in result.stdout 9 ctx1cabdefghi

120 

121 

122def test_completion_source_fish(): 9 ctx1cabdefghi

123 result = subprocess.run( 9 ctx1cabdefghi

124 [sys.executable, "-m", "coverage", "run", mod.__file__], 

125 capture_output=True, 

126 encoding="utf-8", 

127 env={ 

128 **os.environ, 

129 "_TUTORIAL001.PY_COMPLETE": "source_fish", 

130 }, 

131 ) 

132 assert "complete --command tutorial001.py --no-files" in result.stdout 9 ctx1cabdefghi

133 

134 

135def test_completion_source_powershell(): 9 ctx1cabdefghi

136 result = subprocess.run( 9 ctx1cabdefghi

137 [sys.executable, "-m", "coverage", "run", mod.__file__], 

138 capture_output=True, 

139 encoding="utf-8", 

140 env={ 

141 **os.environ, 

142 "_TUTORIAL001.PY_COMPLETE": "source_powershell", 

143 }, 

144 ) 

145 assert ( 9 ctx1cabdefghi

146 "Register-ArgumentCompleter -Native -CommandName tutorial001.py -ScriptBlock $scriptblock" 

147 in result.stdout 

148 ) 

149 

150 

151def test_completion_source_pwsh(): 9 ctx1cabdefghi

152 result = subprocess.run( 9 ctx1cabdefghi

153 [sys.executable, "-m", "coverage", "run", mod.__file__], 

154 capture_output=True, 

155 encoding="utf-8", 

156 env={ 

157 **os.environ, 

158 "_TUTORIAL001.PY_COMPLETE": "source_pwsh", 

159 }, 

160 ) 

161 assert ( 9 ctx1cabdefghi

162 "Register-ArgumentCompleter -Native -CommandName tutorial001.py -ScriptBlock $scriptblock" 

163 in result.stdout 

164 )