Coverage for tests / test_cli / test_doc.py: 100%

1import os 7 ctx1abcdefg

2import subprocess 7 ctx1abcdefg

3import sys 7 ctx1abcdefg

4from pathlib import Path 7 ctx1abcdefg

5 

6 

7def test_doc(): 7 ctx1abcdefg

8 result = subprocess.run( 7 ctx1abcdefg

9 [ 

10 sys.executable, 

11 "-m", 

12 "coverage", 

13 "run", 

14 "-m", 

15 "typer", 

16 "tests.assets.cli.multi_app", 

17 "utils", 

18 "docs", 

19 "--name", 

20 "multiapp", 

21 ], 

22 capture_output=True, 

23 encoding="utf-8", 

24 ) 

25 docs_path: Path = Path(__file__).parent.parent / "assets/cli/multiapp-docs.md" 7 ctx1abcdefg

26 docs = docs_path.read_text() 7 ctx1abcdefg

27 assert docs in result.stdout 7 ctx1abcdefg

28 assert "**Arguments**" in result.stdout 7 ctx1abcdefg

29 

30 

31def test_doc_output(tmp_path: Path): 7 ctx1abcdefg

32 out_file: Path = tmp_path / "out.md" 7 ctx1abcdefg

33 result = subprocess.run( 7 ctx1abcdefg

34 [ 

35 sys.executable, 

36 "-m", 

37 "coverage", 

38 "run", 

39 "-m", 

40 "typer", 

41 "tests.assets.cli.multi_app", 

42 "utils", 

43 "docs", 

44 "--name", 

45 "multiapp", 

46 "--output", 

47 str(out_file), 

48 ], 

49 capture_output=True, 

50 encoding="utf-8", 

51 ) 

52 docs_path: Path = Path(__file__).parent.parent / "assets/cli/multiapp-docs.md" 7 ctx1abcdefg

53 docs = docs_path.read_text() 7 ctx1abcdefg

54 written_docs = out_file.read_text() 7 ctx1abcdefg

55 assert docs in written_docs 7 ctx1abcdefg

56 assert "Docs saved to:" in result.stdout 7 ctx1abcdefg

57 

58 

59def test_doc_title_output(tmp_path: Path): 7 ctx1abcdefg

60 out_file: Path = tmp_path / "out.md" 7 ctx1abcdefg

61 result = subprocess.run( 7 ctx1abcdefg

62 [ 

63 sys.executable, 

64 "-m", 

65 "coverage", 

66 "run", 

67 "-m", 

68 "typer", 

69 "tests.assets.cli.multi_app", 

70 "utils", 

71 "docs", 

72 "--name", 

73 "multiapp", 

74 "--title", 

75 "Awesome CLI", 

76 "--output", 

77 str(out_file), 

78 ], 

79 capture_output=True, 

80 encoding="utf-8", 

81 ) 

82 docs_path: Path = Path(__file__).parent.parent / "assets/cli/multiapp-docs-title.md" 7 ctx1abcdefg

83 docs = docs_path.read_text() 7 ctx1abcdefg

84 written_docs = out_file.read_text() 7 ctx1abcdefg

85 assert docs in written_docs 7 ctx1abcdefg

86 assert "Docs saved to:" in result.stdout 7 ctx1abcdefg

87 

88 

89def test_doc_no_rich(): 7 ctx1abcdefg

90 result = subprocess.run( 7 ctx1abcdefg

91 [ 

92 sys.executable, 

93 "-m", 

94 "coverage", 

95 "run", 

96 "-m", 

97 "typer", 

98 "tests.assets.cli.multi_app_norich", 

99 "utils", 

100 "docs", 

101 "--name", 

102 "multiapp", 

103 ], 

104 capture_output=True, 

105 encoding="utf-8", 

106 ) 

107 docs_path: Path = Path(__file__).parent.parent / "assets/cli/multiapp-docs.md" 7 ctx1abcdefg

108 docs = docs_path.read_text() 7 ctx1abcdefg

109 assert docs in result.stdout 7 ctx1abcdefg

110 assert "**Arguments**" in result.stdout 7 ctx1abcdefg

111 

112 

113def test_doc_not_existing(): 7 ctx1abcdefg

114 result = subprocess.run( 7 ctx1abcdefg

115 [ 

116 sys.executable, 

117 "-m", 

118 "coverage", 

119 "run", 

120 "-m", 

121 "typer", 

122 "no_typer", 

123 "utils", 

124 "docs", 

125 ], 

126 capture_output=True, 

127 encoding="utf-8", 

128 ) 

129 assert "Could not import as Python module:" in result.stderr 7 ctx1abcdefg

130 

131 

132def test_doc_no_typer(): 7 ctx1abcdefg

133 result = subprocess.run( 7 ctx1abcdefg

134 [ 

135 sys.executable, 

136 "-m", 

137 "coverage", 

138 "run", 

139 "-m", 

140 "typer", 

141 "tests/assets/cli/empty_script.py", 

142 "utils", 

143 "docs", 

144 ], 

145 capture_output=True, 

146 encoding="utf-8", 

147 ) 

148 assert "No Typer app found" in result.stderr 7 ctx1abcdefg

149 

150 

151def test_doc_file_not_existing(): 7 ctx1abcdefg

152 result = subprocess.run( 7 ctx1abcdefg

153 [ 

154 sys.executable, 

155 "-m", 

156 "coverage", 

157 "run", 

158 "-m", 

159 "typer", 

160 "assets/cli/not_existing.py", 

161 "utils", 

162 "docs", 

163 ], 

164 capture_output=True, 

165 encoding="utf-8", 

166 ) 

167 assert "Not a valid file or Python module:" in result.stderr 7 ctx1abcdefg

168 

169 

170def test_doc_html_output(tmp_path: Path): 7 ctx1abcdefg

171 out_file: Path = tmp_path / "out.md" 7 ctx1abcdefg

172 result = subprocess.run( 7 ctx1abcdefg

173 [ 

174 sys.executable, 

175 "-m", 

176 "coverage", 

177 "run", 

178 "-m", 

179 "typer", 

180 "tests.assets.cli.rich_formatted_app", 

181 "utils", 

182 "docs", 

183 "--title", 

184 "Awesome CLI", 

185 "--output", 

186 str(out_file), 

187 ], 

188 capture_output=True, 

189 encoding="utf-8", 

190 env={**os.environ, "PYTHONIOENCODING": "utf-8"}, 

191 ) 

192 docs_path: Path = ( 7 ctx1abcdefg

193 Path(__file__).parent.parent / "assets" / "cli" / "richformattedapp-docs.md" 

194 ) 

195 docs = docs_path.read_text(encoding="utf-8") 7 ctx1abcdefg

196 written_docs = out_file.read_text(encoding="utf-8") 7 ctx1abcdefg

197 assert docs in written_docs 7 ctx1abcdefg

198 assert "Docs saved to:" in result.stdout 7 ctx1abcdefg