forked from kartoza/prj.app
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fabfile.py
344 lines (292 loc) · 11.8 KB
/
fabfile.py
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
#!/bin/python
# ~/fabfile.py
# A Fabric file for carrying out various administrative tasks.
# Tim Sutton, Jan 2013
# To use this script make sure you have fabric and fabtools.
# pip install fabric fabtools
import os
import getpass
from fabric.api import task, env, fastprint, cd, run, sudo, local, prompt
from fabric.contrib.project import rsync_project
from fabric.contrib.files import exists, sed
from fabric.colors import red, blue, green
from fabtools import require
from fabtools.deb import update_index
# Don't remove even though its unused
# noinspection PyUnresolvedReferences
from fabtools.vagrant import vagrant
# noinspection PyUnresolvedReferences
from fabgis.dropbox import setup_dropbox, setup_dropbox_daemon
from fabgis.django import setup_apache, build_pil, set_media_permissions
from fabgis.git import update_git_checkout
from fabgis.virtualenv import setup_venv
from fabgis.common import setup_env, show_environment
from fabgis.postgres import (
create_user,
get_postgres_dump,
restore_postgres_dump,
setup_postgis_2,
create_postgis_2_template)
def get_vars():
"""Helper method to get standard deployment vars.
:returns: A tuple containing the following:
* base_path: Workspace dir e.g. ``/home/foo/python``
* code_path: Project dir e.g. ``/home/foo/python/visual_changelog``
* git_url: Url for git checkout - use http for read only checkout
* repo_alias: Name of checkout folder e.g. ``visual_changelog``
* site_name: Name for the web site e.g. ``visual_changelog``
:rtype: tuple
"""
setup_env()
site_name = 'visual_changelog'
base_path = os.path.abspath(os.path.join(
env.fg.home, 'dev', 'python'))
git_url = 'http://github.com/timlinux/visual_changelog.git'
repo_alias = 'visual_changelog'
code_path = os.path.abspath(os.path.join(base_path, repo_alias))
return base_path, code_path, git_url, repo_alias, site_name
@task
def update_venv(code_path):
"""Update the virtual environment to ensure it has node etc. installed.
:param code_path: Directory in which project is located.
:type code_path: str
e.g.::
fab -H localhost update_venv:/home/timlinux/dev/python/visual_changelog
"""
setup_venv(code_path, requirements_file='REQUIREMENTS.txt')
#yuglify needed by django-compress needs to have node installed which
# is provided by virtual-node in the REQUIREMENTS file above,
# but we still need to install yuglify manually since we cant add it
# using REQUIREMENTS.
# See also https://github.com/elbaschid/virtual-node
# for more info on how virtualnode works
with cd(code_path):
run('venv/bin/npm -g install yuglify')
build_pil(code_path)
@task
def setup_postgres_user():
"""Set up the postgresql instance."""
create_user('wsgi', '')
@task
def upload_postgres_dump(dump_path):
"""Upload the dump found in dump_path and restore it to the server.
.. note existing data on the server will be destroyed.
:param dump_path: Local file containing dump to be restored.
:type dump_path; str
"""
restore_postgres_dump(
'changelog',
user='wsgi',
password='',
ignore_permissions=True,
file_name=dump_path)
@task
def update_apache():
"""Update the apache configuration prompting for github account info.
.. note:: The config file is taken from the local system.
"""
code_path = os.path.dirname(__file__)
git_url = 'https://api.github.com/repos/timlinux/visual_changelog/issues'
git_user = prompt(
'Please enter the github user account that issues submitted via the\n'
'web ui should be created as. This will be written into the apache\n'
'configuration file under /etc/apache2/sites-available so you\n'
'should take appropriate security measures.\nUser :\n')
git_password = getpass.getpass()
domain = 'changelog.linfiniti.com'
setup_apache(
site_name='visual_changelog',
code_path=code_path,
domain=domain,
github_url=git_url,
github_password=git_password,
github_user=git_user)
@task
def deploy():
"""Initialise or update the git clone - you can safely rerun this.
e.g. to update the server
fab -H <host> deploy
"""
# Ensure we have a mailserver setup for our domain
# Note that you may have problems if you intend to run more than one
# site from the same server
setup_env()
show_environment()
setup_postgis_2()
base_path, code_path, git_url, repo_alias, site_name = get_vars()
fastprint('Checking out %s to %s as %s' % (git_url, base_path, repo_alias))
update_git_checkout(base_path, git_url, repo_alias)
update_index()
require.postfix.server(site_name)
update_apache(code_path, site_name)
require.deb.package('libpq-dev')
require.deb.package('libgeos-c1')
require.deb.package('vim')
update_venv(code_path)
with cd(os.path.join(code_path, 'django_project')):
run('../venv/bin/python manage.py syncdb --noinput ')
run('../venv/bin/python manage.py migrate')
set_db_permissions()
# if we are testing under vagrant, deploy our local media and db
if 'vagrant' in env.fg.home:
with cd(code_path):
run('cp /vagrant/visual_changelog.db .')
run('touch django_project/core/wsgi.py')
sync_media_to_server()
collectstatic()
fastprint('*******************************************\n')
fastprint(red(' Don\'t forget set ALLOWED_HOSTS in '))
fastprint(' django_project/core/settings/prod.py')
fastprint(' to the domain name for the site.')
fastprint('*******************************************\n')
@task
def freshen():
"""Freshen the server with latest git copy and touch wsgi.
.. note:: Preferred normal way of doing this is rather to use the
sync_project_to_server task and not to checkout from git.
"""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
git_url = 'http://github.com/timlinux/visual_changelog.git'
update_git_checkout(base_path, git_url, repo_alias)
with cd(os.path.join(code_path, 'django_project')):
run('touch core/wsgi.py')
collectstatic()
fastprint('*******************************************\n')
fastprint(red(' Don\'t forget set ALLOWED_HOSTS in \n'))
fastprint(' django_project/core/settings/prod.py\n')
fastprint(' to the domain name for the site.\n')
fastprint('*******************************************\n')
@task
def sync_media_to_server():
"""Sync media to server from local filesystem."""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
remote_path = os.path.join(code_path, 'django_project', 'media')
local_path = os.path.join(
os.path.dirname(__file__), 'django_project', 'media/')
rsync_project(
remote_path,
local_dir=local_path,
exclude=['*.pyc', '*.py', '.DS_Store'])
# Now our sqlite db
remote_path = os.path.join(
code_path, 'resources', 'sqlite', 'visual_changelog.db')
local_path = os.path.join(
os.path.dirname(__file__), 'resources/sqlite/visual_changelog.db')
rsync_project(
remote_path,
local_dir=local_path,
exclude=['*.pyc', '*.py', '.DS_Store'])
set_media_permissions(code_path)
set_db_permissions()
@task
def sync_project_to_server():
"""Synchronize project with webserver ignoring venv and sqlite db..
This is a handy way to get your secret key to the server too...
"""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
rsync_project(
base_path,
delete=False,
exclude=[
'*.pyc',
'.git',
'.DS_Store',
'visual_changelog.db',
'venv',
'django_project/static'])
with cd(os.path.join(code_path, 'django_project')):
run('touch core/wsgi.py')
set_media_permissions(code_path)
set_db_permissions()
collectstatic()
fastprint(blue('Your server is now in synchronised to your local project'))
@task
def server_to_debug_mode():
"""Put the server in debug mode (normally not recommended)."""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
config_file = os.path.join(
code_path, 'django_project', 'core', 'settings', 'project.py')
sed(
config_file,
'DEBUG = TEMPLATE_DEBUG = False',
'DEBUG = TEMPLATE_DEBUG = True')
with cd(os.path.join(code_path, 'django_project')):
run('touch core/wsgi.py')
set_db_permissions()
collectstatic()
fastprint(red('Warning: your server is now in DEBUG mode!'))
@task
def server_to_production_mode():
"""Put the server in production mode (recommended)."""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
config_file = os.path.join(
code_path, 'django_project', 'core', 'settings', 'project.py')
sed(
config_file,
'DEBUG = TEMPLATE_DEBUG = True',
'DEBUG = TEMPLATE_DEBUG = False')
with cd(os.path.join(code_path, 'django_project')):
run('touch core/wsgi.py')
set_db_permissions()
collectstatic()
fastprint(blue('Note: your server is now in PRODUCTION mode!'))
@task
def set_db_permissions():
"""Set the db so user wsgi has all permissions.
"""
user = 'wsgi'
dbname = 'changelog'
grant_sql = 'GRANT ALL ON schema public to %s;' % user
# assumption is env.repo_alias is also database name
run('psql %s -c "%s"' % (dbname, grant_sql))
grant_sql = (
'GRANT ALL ON ALL TABLES IN schema public to %s;' % user)
# assumption is env.repo_alias is also database name
run('psql %s -c "%s"' % (dbname, grant_sql))
grant_sql = (
'GRANT ALL ON ALL SEQUENCES IN schema public to %s;' % user)
run('psql %s -c "%s"' % (dbname, grant_sql))
@task
def get_live_db():
"""Get the live db - will overwrite your local copy."""
get_postgres_dump('changelog')
@task
def get_live_media():
"""Get the live media - will overwrite your local copy."""
base_path, code_path, git_url, repo_alias, site_name = get_vars()
path = '%s/django_project/media' % code_path
if not exists(path):
run('mkdir %s' % path)
local('rsync -ave ssh %s:%s/django_project/media/* django_project/media/'
% (env['host_string'], code_path))
@task
def collectstatic():
"""Collect static using proper path for django-compressor / yuglify.
.. note:: We are using python-node to run node in a virtual environment.
Node is needed for yuglify, which is in turn needed by
django-compressor which combines all js resources into a single file
and all css into a single file. These are 'compiled' but yuglify.
Yuglify does not appear in the path properly thus we explicitly
ensure the path points to the node_modules dir before running
collectstatic.
All the above will prevent run time errors like:
[Django] ERROR: Failed to submit message: u"ValueError: The file
'css/contrib.css' could not be found with <pipeline.storage.
PipelineCachedStorage object at 0x7f0df18b3ad0>."
"""
command = ('PATH=$PATH:../node_modules/yuglify/bin/:../venv/bin/ '
'../venv/bin/python manage.py collectstatic --noinput')
base_path, code_path, git_url, repo_alias, site_name = get_vars()
with cd(os.path.join(code_path, 'django_project')):
run(command)
@task
def update_migrations():
"""Apply any pending south migrations.
"""
command = ('../venv/bin/python manage.py migrate changes')
base_path, code_path, git_url, repo_alias, site_name = get_vars()
with cd(os.path.join(code_path, 'django_project')):
run(command)
run('touch core/wsgi.py')
fastprint(green('Note: your server is now has the latest SOUTH '
'migrations applied.'))