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

1import os 8 ctx1cabdefgh

2import subprocess 8 ctx1cabdefgh

3import sys 8 ctx1cabdefgh

4from pathlib import Path 8 ctx1cabdefgh

5 

6from docs_src.commands.index import tutorial001 as mod 8 ctx1cabdefgh

7 

8from ..utils import needs_bash, needs_linux 8 ctx1cabdefgh

9 

10 

11@needs_bash 8 ctx1cabdefgh

12@needs_linux 8 ctx1cabdefgh

13def test_show_completion(): 7 ctx1abdefgh

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 8 ctx1cabdefgh

28@needs_linux 8 ctx1cabdefgh

29def test_install_completion(): 7 ctx1abdefgh

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

31 text = "" 3 ctx1cab

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

33 text = bash_completion_path.read_text() 3 ctx1cab

34 result = subprocess.run( 3 ctx1cab

35 [ 

36 "bash", 

37 "-c", 

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

39 ], 

40 capture_output=True, 

41 encoding="utf-8", 

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

43 ) 

44 new_text = bash_completion_path.read_text() 3 ctx1cab

45 bash_completion_path.write_text(text) 3 ctx1cab

46 assert "source" in new_text 3 ctx1cab

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

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

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

50 

51 

52def test_completion_invalid_instruction(): 8 ctx1cabdefgh

53 result = subprocess.run( 8 ctx1cabdefgh

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

55 capture_output=True, 

56 encoding="utf-8", 

57 env={ 

58 **os.environ, 

59 "_TUTORIAL001.PY_COMPLETE": "sourcebash", 

60 }, 

61 ) 

62 assert result.returncode != 0 8 ctx1cabdefgh

63 assert "Invalid completion instruction." in result.stderr 8 ctx1cabdefgh

64 

65 

66def test_completion_source_bash(): 8 ctx1cabdefgh

67 result = subprocess.run( 8 ctx1cabdefgh

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

69 capture_output=True, 

70 encoding="utf-8", 

71 env={ 

72 **os.environ, 

73 "_TUTORIAL001.PY_COMPLETE": "source_bash", 

74 }, 

75 ) 

76 assert ( 8 ctx1cabdefgh

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

78 in result.stdout 

79 ) 

80 

81 

82def test_completion_source_invalid_shell(): 8 ctx1cabdefgh

83 result = subprocess.run( 8 ctx1cabdefgh

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

85 capture_output=True, 

86 encoding="utf-8", 

87 env={ 

88 **os.environ, 

89 "_TUTORIAL001.PY_COMPLETE": "source_xxx", 

90 }, 

91 ) 

92 assert "Shell xxx not supported." in result.stderr 8 ctx1cabdefgh

93 

94 

95def test_completion_source_invalid_instruction(): 8 ctx1cabdefgh

96 result = subprocess.run( 8 ctx1cabdefgh

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

98 capture_output=True, 

99 encoding="utf-8", 

100 env={ 

101 **os.environ, 

102 "_TUTORIAL001.PY_COMPLETE": "explode_bash", 

103 }, 

104 ) 

105 assert 'Completion instruction "explode" not supported.' in result.stderr 8 ctx1cabdefgh

106 

107 

108def test_completion_source_zsh(): 8 ctx1cabdefgh

109 result = subprocess.run( 8 ctx1cabdefgh

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

111 capture_output=True, 

112 encoding="utf-8", 

113 env={ 

114 **os.environ, 

115 "_TUTORIAL001.PY_COMPLETE": "source_zsh", 

116 }, 

117 ) 

118 assert "compdef _tutorial001py_completion tutorial001.py" in result.stdout 8 ctx1cabdefgh

119 

120 

121def test_completion_source_fish(): 8 ctx1cabdefgh

122 result = subprocess.run( 8 ctx1cabdefgh

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

124 capture_output=True, 

125 encoding="utf-8", 

126 env={ 

127 **os.environ, 

128 "_TUTORIAL001.PY_COMPLETE": "source_fish", 

129 }, 

130 ) 

131 assert "complete --command tutorial001.py --no-files" in result.stdout 8 ctx1cabdefgh

132 

133 

134def test_completion_source_powershell(): 8 ctx1cabdefgh

135 result = subprocess.run( 8 ctx1cabdefgh

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

137 capture_output=True, 

138 encoding="utf-8", 

139 env={ 

140 **os.environ, 

141 "_TUTORIAL001.PY_COMPLETE": "source_powershell", 

142 }, 

143 ) 

144 assert ( 8 ctx1cabdefgh

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

146 in result.stdout 

147 ) 

148 

149 

150def test_completion_source_pwsh(): 8 ctx1cabdefgh

151 result = subprocess.run( 8 ctx1cabdefgh

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

153 capture_output=True, 

154 encoding="utf-8", 

155 env={ 

156 **os.environ, 

157 "_TUTORIAL001.PY_COMPLETE": "source_pwsh", 

158 }, 

159 ) 

160 assert ( 8 ctx1cabdefgh

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

162 in result.stdout 

163 )