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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
|
import unittest
from unittest import mock
from ghp_import import GhpError # type: ignore
from mkdocs import __version__
from mkdocs.commands import gh_deploy
from mkdocs.exceptions import Abort
from mkdocs.tests.base import load_config
class TestGitHubDeploy(unittest.TestCase):
@mock.patch('subprocess.Popen')
def test_is_cwd_git_repo(self, mock_popeno):
mock_popeno().wait.return_value = 0
self.assertTrue(gh_deploy._is_cwd_git_repo())
@mock.patch('subprocess.Popen')
def test_is_cwd_not_git_repo(self, mock_popeno):
mock_popeno().wait.return_value = 1
self.assertFalse(gh_deploy._is_cwd_git_repo())
@mock.patch('subprocess.Popen')
def test_get_current_sha(self, mock_popeno):
mock_popeno().communicate.return_value = (b'6d98394\n', b'')
self.assertEqual(gh_deploy._get_current_sha('.'), '6d98394')
@mock.patch('subprocess.Popen')
def test_get_remote_url_ssh(self, mock_popeno):
mock_popeno().communicate.return_value = (
b'git@github.com:mkdocs/mkdocs.git\n',
b'',
)
expected = ('git@', 'mkdocs/mkdocs.git')
self.assertEqual(expected, gh_deploy._get_remote_url('origin'))
@mock.patch('subprocess.Popen')
def test_get_remote_url_http(self, mock_popeno):
mock_popeno().communicate.return_value = (
b'https://github.com/mkdocs/mkdocs.git\n',
b'',
)
expected = ('https://', 'mkdocs/mkdocs.git')
self.assertEqual(expected, gh_deploy._get_remote_url('origin'))
@mock.patch('subprocess.Popen')
def test_get_remote_url_enterprise(self, mock_popeno):
mock_popeno().communicate.return_value = (
b'https://notgh.com/mkdocs/mkdocs.git\n',
b'',
)
expected = (None, None)
self.assertEqual(expected, gh_deploy._get_remote_url('origin'))
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch('mkdocs.commands.gh_deploy._get_remote_url', mock.Mock(return_value=(None, None)))
@mock.patch('mkdocs.commands.gh_deploy._check_version', mock.Mock())
@mock.patch('ghp_import.ghp_import', mock.Mock())
def test_deploy(self):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config)
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch('mkdocs.commands.gh_deploy._get_remote_url', mock.Mock(return_value=(None, None)))
@mock.patch('mkdocs.commands.gh_deploy._check_version', mock.Mock())
@mock.patch('ghp_import.ghp_import', mock.Mock())
@mock.patch('os.path.isfile', mock.Mock(return_value=False))
def test_deploy_no_cname(self):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config)
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch(
'mkdocs.commands.gh_deploy._get_remote_url',
mock.Mock(return_value=('git@', 'mkdocs/mkdocs.git')),
)
@mock.patch('mkdocs.commands.gh_deploy._check_version', mock.Mock())
@mock.patch('ghp_import.ghp_import', mock.Mock())
def test_deploy_hostname(self):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config)
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch('mkdocs.commands.gh_deploy._get_remote_url', mock.Mock(return_value=(None, None)))
@mock.patch('mkdocs.commands.gh_deploy._check_version')
@mock.patch('ghp_import.ghp_import', mock.Mock())
def test_deploy_ignore_version_default(self, check_version):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config)
check_version.assert_called_once()
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch('mkdocs.commands.gh_deploy._get_remote_url', mock.Mock(return_value=(None, None)))
@mock.patch('mkdocs.commands.gh_deploy._check_version')
@mock.patch('ghp_import.ghp_import', mock.Mock())
def test_deploy_ignore_version(self, check_version):
config = load_config(
remote_branch='test',
)
gh_deploy.gh_deploy(config, ignore_version=True)
check_version.assert_not_called()
@mock.patch('mkdocs.commands.gh_deploy._is_cwd_git_repo', mock.Mock(return_value=True))
@mock.patch('mkdocs.commands.gh_deploy._get_current_sha', mock.Mock(return_value='shashas'))
@mock.patch('mkdocs.commands.gh_deploy._check_version', mock.Mock())
@mock.patch('ghp_import.ghp_import', mock.Mock(side_effect=GhpError('TestError123')))
def test_deploy_error(self):
config = load_config(
remote_branch='test',
)
with self.assertLogs('mkdocs', level='ERROR') as cm:
with self.assertRaises(Abort):
gh_deploy.gh_deploy(config)
self.assertEqual(
cm.output,
[
'ERROR:mkdocs.commands.gh_deploy:Failed to deploy to GitHub with error: \n'
'TestError123'
],
)
class TestGitHubDeployLogs(unittest.TestCase):
@mock.patch('subprocess.Popen')
def test_mkdocs_newer(self, mock_popeno):
mock_popeno().communicate.return_value = (
b'Deployed 12345678 with MkDocs version: 0.1.2\n',
b'',
)
with self.assertLogs('mkdocs') as cm:
gh_deploy._check_version('gh-pages')
self.assertEqual(
'\n'.join(cm.output),
f'INFO:mkdocs.commands.gh_deploy:Previous deployment was done with MkDocs '
f'version 0.1.2; you are deploying with a newer version ({__version__})',
)
@mock.patch('subprocess.Popen')
def test_mkdocs_older(self, mock_popeno):
mock_popeno().communicate.return_value = (
b'Deployed 12345678 with MkDocs version: 10.1.2\n',
b'',
)
with self.assertLogs('mkdocs', level='ERROR') as cm:
with self.assertRaises(Abort):
gh_deploy._check_version('gh-pages')
self.assertEqual(
'\n'.join(cm.output),
f'ERROR:mkdocs.commands.gh_deploy:Deployment terminated: Previous deployment was made with '
f'MkDocs version 10.1.2; you are attempting to deploy with an older version ({__version__}).'
f' Use --ignore-version to deploy anyway.',
)
@mock.patch('subprocess.Popen')
def test_version_unknown(self, mock_popeno):
mock_popeno().communicate.return_value = (b'No version specified\n', b'')
with self.assertLogs('mkdocs') as cm:
gh_deploy._check_version('gh-pages')
self.assertEqual(
'\n'.join(cm.output),
'WARNING:mkdocs.commands.gh_deploy:Version check skipped: No version specified in previous deployment.',
)
|
