概要
在前面的章節(jié)里我們專注于在我們的小應(yīng)用程序上一步步的添加功能上。到現(xiàn)在為止我們有了一個帶有數(shù)據(jù)庫的應(yīng)用程序，可以注冊用戶，記錄用戶登陸退出日志以及查看修改配置文件。
在本節(jié)中，我們不為應(yīng)用程序添加任何新功能，相反，我們要尋找一種方法來增加我們已寫代碼的穩(wěn)定性，我們還將創(chuàng)建一個測試框架來幫助我們防止將來程序中出現(xiàn)的失敗和回滾。
讓我們來找bug
在上一章的結(jié)尾談到，我故意在應(yīng)用程序中引入一個bug。接下來讓我描述一下它是什么樣的bug，然后看看當(dāng)我們的程序不按照我們意愿執(zhí)行的時候，它在其中又起了什么樣的影響。
應(yīng)用程序的問題在于，沒有保證用戶昵稱的唯一性。用戶昵稱是由應(yīng)用程序自動初始化的。我們首先會考慮使用OpenID provider給出的用戶的昵稱，然后再考慮使用Email信息中的用戶名部分作為用戶的昵稱。但如果出現(xiàn)重復(fù)的昵稱，則后面的用戶將無法注冊成功。更糟糕的是，在修改用戶配置的表單中，我們允許用戶任意更改他們的昵稱，但我們?nèi)匀粵]有對昵稱沖突進(jìn)行檢查。
當(dāng)我們分析完錯誤產(chǎn)生時應(yīng)用程序的行為之后，我們將會定位這些問題。
Flask 的調(diào)試功能
那么讓我們看看當(dāng)bug被觸發(fā)時，會出現(xiàn)什么現(xiàn)象。
讓我們從創(chuàng)建一個嶄新的數(shù)據(jù)庫，在linux下，執(zhí)行：
|
1
2
|
rm app.db./db_create.py |
在Windows下，執(zhí)行：
|
1
2
|
del app.dbflask/Scripts/python db_create.py |
- 用第一個賬號登陸
- 進(jìn)入用戶信息屬性編輯頁面，將昵稱改為“dup”
- 登出系統(tǒng)
- 用第二個賬號登陸
- 修改第二個賬號的用戶信息屬性，將昵稱改為“dup”
哎喲！sqlalchemy中拋出了一個異常，來看一下錯誤信息:
|
1
2
|
lalchemy.exc.IntegrityErrorIntegrityError: (IntegrityError) column nickname is not unique u'UPDATE user SET nickname=?, about_me=? WHERE user.id = ?' (u'dup', u'', 2) |
錯誤的后面是這個錯誤的堆棧信息，事實(shí)上，這是一個相當(dāng)不錯的錯誤提示，你可以轉(zhuǎn)向任何框架檢查代碼或者在瀏覽器里執(zhí)行正確的表達(dá)式。
這個錯誤信息相當(dāng)明確，我們試圖在數(shù)據(jù)插入一個重復(fù)的昵稱，數(shù)據(jù)庫的昵稱字段是一個衛(wèi)衣鍵，因此這樣的操作是無效的。
除了實(shí)際的錯誤，在我們手頭上還有一個次要的錯誤。如果一個用戶不注意在我們應(yīng)用程序里引起了一個錯誤（這一個錯誤或者任何其他原因引起的異常），應(yīng)用程序?qū)⑾蛩?她暴漏錯誤信息和堆棧信息，而不是暴露給我們。對于我們開發(fā)者來說這是個很好的特性，但是很多時候我們不想讓用戶看到這些信息。
這么長時間以來，我們一直在debug模式下運(yùn)行我們的應(yīng)用程序，我們通過設(shè)置debug=True的參數(shù)來啟用應(yīng)用程序的debug模式。這里我們在運(yùn)行腳本run.py里配置。
當(dāng)我們這樣開發(fā)應(yīng)用是方便的，但是我們需要在生產(chǎn)環(huán)境上關(guān)閉debug模式。 讓我們創(chuàng)建另一個啟動腳本文件設(shè)置關(guān)閉dubug模式(filerunp.py):
|
1
2
3
|
#!flask/bin/pythonfrom app import appapp.run(debug = False) |
現(xiàn)在重新啟動應(yīng)用：
|
1
|
./runp.py |
并且現(xiàn)在再嘗試重命名第二個賬號nickname成‘dup'
這次我們沒有獲取到一個錯誤信息，取而代之，我們得到了一個HTTP 500錯誤碼，這是個內(nèi)部服務(wù)器錯誤。雖然這不容易定位錯誤，但至少沒有暴露我們應(yīng)用程序的任何細(xì)節(jié)給陌生人。當(dāng)調(diào)試關(guān)閉后出現(xiàn)一個異常時，F(xiàn)lask會產(chǎn)生一個500頁面。
雖然這樣好些了，但現(xiàn)在仍存在兩個問題。首先美化問題：默認(rèn)的500頁面很丑陋。第二個問題更重要些，當(dāng)用戶操作失敗時，我們無法獲取到錯誤信息了，因?yàn)殄e誤在后臺默默的處理了。幸運(yùn)的是有個簡單方式來處理這兩個問題。
定制HTTP錯誤處理程序
Flask為應(yīng)用程序提供了一個機(jī)制來安裝他們自己的錯誤頁面，作為例子，讓我們定義兩個最常見的HTTP 404和500錯誤的自定義頁面。定制其他錯誤頁面也是同樣的方式。
使用一個修飾來聲明一個定制的錯誤處理程序 (fileapp/views.py):
|
1
2
3
4
5
6
7
8
|
@app.errorhandler(404)def internal_error(error): return render_template('404.html'), 404 @app.errorhandler(500)def internal_error(error): db.session.rollback() return render_template('500.html'), 500 |
這地方無需多言，因?yàn)樗麄兌际遣谎远鞯摹Ｎㄒ挥腥さ牡胤綍r錯誤500處理中的rollack語句，這個地方是不可缺少的因?yàn)檫@個方法會被當(dāng)做一個異常調(diào)用。如果因?yàn)閿?shù)據(jù)庫錯誤導(dǎo)致一個異常，那么數(shù)據(jù)庫的會話將變成一個無效狀態(tài)，因此我們需要回滾它，以防止一個會話轉(zhuǎn)向一個500錯誤的模板。
這是一個404錯誤在模版
|
1
2
3
4
5
6
7
|
<!-- extend base layout -->{% extends "base.html" %} {% block content %}<h1>File Not Found</h1><p><a href="{{url_for('index')}}">Back</a></p>{% endblock %} |
這是一個500錯誤的模版
|
1
2
3
4
5
6
7
8
|
<!-- extend base layout -->{% extends "base.html" %} {% block content %}<h1>An unexpected error has occurred</h1><p>The administrator has been notified. Sorry for the inconvenience!</p><p><a href="{{url_for('index')}}">Back</a></p>{% endblock %} |
注意，我們會繼續(xù)使用我們base.html 布局， 這樣我們的錯誤頁看起來比較舒服
通過email發(fā)送錯誤日志
為了處理第二個問題我們需要配置應(yīng)用的錯誤報(bào)告機(jī)制。
第一個是每當(dāng)有錯誤發(fā)生時把錯誤日志通過郵件發(fā)送給我們。
首先，我們需要在我們的應(yīng)用配置郵件服務(wù)器和管理員列表 (fileconfig.py):
|
1
2
3
4
5
6
7
8
|
# mail server settingsMAIL_SERVER = 'localhost'MAIL_PORT = 25MAIL_USERNAME = NoneMAIL_PASSWORD = None # administrator list |
當(dāng)然，你要把上面的配置改成你自己的才有意義
Flask 使用通用的Python logging模塊, 所以設(shè)置發(fā)送錯誤日志郵件非常簡單. (fileapp/__init__.py):
|
1
2
3
4
5
6
7
8
9
10
11
|
from config import basedir, ADMINS, MAIL_SERVER, MAIL_PORT, MAIL_USERNAME, MAIL_PASSWORD if not app.debug: import logging from logging.handlers import SMTPHandler credentials = None if MAIL_USERNAME or MAIL_PASSWORD: credentials = (MAIL_USERNAME, MAIL_PASSWORD) mail_handler = SMTPHandler((MAIL_SERVER, MAIL_PORT), 'no-reply@' + MAIL_SERVER, ADMINS, 'microblog failure', credentials) mail_handler.setLevel(logging.ERROR) app.logger.addHandler(mail_handler) |
Note that we are only enabling the emails when we run without debugging.
注意,我們要的非dubug模式下開啟郵件功能.
在沒有郵件服務(wù)器的pc上測試郵件功能也很容易，幸好Python有SMTP的測試排錯的服務(wù)器（SMTP debugging server）。打開一個控制臺窗口，并且運(yùn)行下面的命令：
|
1
|
python -m smtpd -n -c DebuggingServer localhost:25 |
當(dāng)程序運(yùn)行的時候，應(yīng)用接收和發(fā)送郵件會在控制臺窗口中顯示出來。
打印日志到文件
通過郵件接收錯誤日志非常不錯，但是，這是不夠的。有些導(dǎo)致失敗的條件不會觸發(fā)異常并且不是主要的問題，所以我們需要將日志保存到log文件中，在某些情況下，需要日志來進(jìn)行排錯。
出于這個原因，我們的應(yīng)用需要一個日志文件。
開啟文件日志和郵件日志很相似(fileapp/__init__.py):
|
1
2
3
4
5
6
7
8
9
|
if not app.debug: import logging from logging.handlers import RotatingFileHandler file_handler = RotatingFileHandler('tmp/microblog.log', 'a', 1 * 1024 * 1024, 10) file_handler.setFormatter(logging.Formatter('%(asctime)s %(levelname)s: %(message)s [in %(pathname)s:%(lineno)d]')) app.logger.setLevel(logging.INFO) file_handler.setLevel(logging.INFO) app.logger.addHandler(file_handler) app.logger.info('microblog startup') |
日志文件將在tmp目錄下生成，文件名叫microblog.log。我們使用的RotatingFileHandler方法中有個限制日志數(shù)量的參數(shù)。在這種情況下，我們限制了一個日志文件大小為1M，并且把最后的十個文件作為備份。
logging.Formatter類提供了日志信息的定義格式，由于這些信息將寫到一個文件中，我們想獲取到盡可能多的信息，因此除了日志信息和堆棧信息，我們還寫了個時間戳，日志級別和文件名、信息的行號。
為了使日志更有用，我們降低了應(yīng)用程序日志和文件日志處理程序的日志級別，因?yàn)檫@樣我們將有機(jī)會在沒有錯誤情況下把有用信息寫入到日志中。作為一個例子，我們啟動時將日志的級別設(shè)置為信息級別。從現(xiàn)在開始，每次你啟動應(yīng)用程序?qū)⒂涗浤愕恼{(diào)試信息。
當(dāng)我們沒有使用日志時，調(diào)試一個在線和使用中的web服務(wù)時是件非常困難的事，把日志信息寫入到文件中，將是我們診斷和解決問題的一個有用工具，所以現(xiàn)在讓我們準(zhǔn)備好使用這個功能吧。
bug修復(fù)
讓我們來修復(fù)下昵稱重復(fù)的bug.
前面討論過，有兩個地方目前還沒有處理重復(fù)。首先是Flask-Login的after_login處理，這個方法將在用戶成功登陸到系統(tǒng)后調(diào)用，我們需要創(chuàng)建一個新的User實(shí)例。這是受影響的一個代碼片段，我們做了修復(fù) (fileapp/views.py):
|
1
2
3
4
5
6
7
8
|
if user is None: nickname = resp.nickname if nickname is None or nickname == "": nickname = resp.email.split('@')[0] nickname = User.make_unique_nickname(nickname) user = User(nickname = nickname, email = resp.email, role = ROLE_USER) db.session.add(user) db.session.commit() |
我們解決這個問題的方法是讓User類選擇一個唯一的名字給我們，這也是 make_unique_nickname方法所做的(fileapp/models.py):
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
class User(db.Model): # ... @staticmethod def make_unique_nickname(nickname): if User.query.filter_by(nickname = nickname).first() == None: return nickname version = 2 while True: new_nickname = nickname + str(version) if User.query.filter_by(nickname = new_nickname).first() == None: break version += 1 return new_nickname # ... |
這個方法簡單的添加一個計(jì)數(shù)器來生成一個唯一的昵稱名。例如，如果用戶名“miguel”存在，這個方法將建議你使用“miguel2”，但是如果它也存在就會生成“miguel3”···。注意我們把這個方法設(shè)定為靜態(tài)方法，因?yàn)檫@個操作不適用于任何類的實(shí)例。
第二個導(dǎo)致重復(fù)昵稱的地方是編輯頁面視圖函數(shù)，這算是用戶選擇昵稱的一個小惡作劇，正確的方式是不允許用戶輸入重復(fù)名稱，讓用戶更換為另一個名稱。我們通過添加form表單驗(yàn)證來解決這個問題，如果用戶輸入一個無效的昵稱，將會得到一個字段驗(yàn)證失敗信息，添加我們的驗(yàn)證只需重寫form的validate方法 (fileapp/forms.py):
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
class EditForm(Form): nickname = TextField('nickname', validators = [Required()]) about_me = TextAreaField('about_me', validators = [Length(min = 0, max = 140)]) def __init__(self, original_nickname, *args, **kwargs): Form.__init__(self, *args, **kwargs) self.original_nickname = original_nickname def validate(self): if not Form.validate(self): return False if self.nickname.data == self.original_nickname: return True user = User.query.filter_by(nickname = self.nickname.data).first() if user != None: self.nickname.errors.append('This nickname is already in use. Please choose another one.') return False return True |
表單的構(gòu)造函數(shù)增加了一個新的參數(shù)original_nickname，驗(yàn)證方法validate使用這個參數(shù)來判斷昵稱是否修改了，如果沒有修改就直接返回它，如果已經(jīng)修改了，方法會確認(rèn)下新的昵稱在數(shù)據(jù)庫是否已經(jīng)存在。
接下來我們在視圖函數(shù)中添加新的構(gòu)造器參數(shù):
|
1
2
3
4
5
|
@app.route('/edit', methods = ['GET', 'POST'])@login_requireddef edit(): form = EditForm(g.user.nickname) # ... |
完成這個修改我們還必須在表單的模板中啟用錯誤顯示字段 (文件app/templates/edit.html):
|
1
2
3
4
5
6
7
|
<td>Your nickname:</td> <td> {{form.nickname(size = 24)}} {% for error in form.errors.nickname %} <br><span style="color: red;">[{{error}}]</span> {% endfor %} </td> |
現(xiàn)在這個bug已經(jīng)修復(fù)了，阻止了重復(fù)數(shù)據(jù)的出現(xiàn)···除非這些驗(yàn)證方法不能正常工作了。在兩個或者多個線程/進(jìn)程并行存取數(shù)據(jù)庫時，這仍然存在一個潛在的問題，但這些都是以后我們文章討論的主題。
在這里你可以嘗試選擇一個重復(fù)的名稱來看看表單如何處理這些錯誤的。
單元測試框架
先把上面關(guān)于測試的會話放一下，咱們來討論下關(guān)于自動化測試的話題。
隨著應(yīng)用程序規(guī)模的增長，越來越難以確定代碼的改變是否會影響到現(xiàn)有的功能。
傳統(tǒng)的方法防止回歸是一個很好的方式，你通過編寫單元測試來測試應(yīng)用程序所有不同功能，每一個測試集中于一個點(diǎn)來驗(yàn)證結(jié)果是否和預(yù)期的一致。測試程序通過定期的執(zhí)行來確認(rèn)應(yīng)用程序是否在正常工作。當(dāng)測試覆蓋率變大時，你就可以自信的修改和添加新功能，只需通過測試程序來驗(yàn)證下是否影響到了應(yīng)用程序現(xiàn)有功能。
現(xiàn)在我們使用python的unittest測試組件來創(chuàng)建個簡單的測試框架 (tests.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
|
#!flask/bin/pythonimport unittest from config import basedirfrom app import app, dbfrom app.models import User class TestCase(unittest.TestCase): def setUp(self): app.config['TESTING'] = True app.config['CSRF_ENABLED'] = False app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' + os.path.join(basedir, 'test.db') self.app = app.test_client() db.create_all() def tearDown(self): db.session.remove() db.drop_all() def test_avatar(self): avatar = u.avatar(128) expected = 'http://www.gravatar.com/avatar/d4c74594d841139328695756648b6bd6' assert avatar[0:len(expected)] == expected def test_make_unique_nickname(self): db.session.add(u) db.session.commit() nickname = User.make_unique_nickname('john') assert nickname != 'john' db.session.add(u) db.session.commit() nickname2 = User.make_unique_nickname('john') assert nickname2 != 'john' assert nickname2 != nickname if __name__ == '__main__': unittest.main() |
unittest測試組件的討論超出了本文的范圍了，我們這里只需知道TestCase是我們的測試類。setUp和tearDown方法有些特殊，它們分別在每個測試方法前后執(zhí)行，復(fù)雜點(diǎn)的設(shè)置可以包含幾組測試，每個代表一個單元測試，TestCase的子類和每個組都將擁有獨(dú)立的setUp和tearDown方法。
這些特殊的setUp和tearDown方法都是非常通用的，在setUp可以方便的修改配置，例如，我們想測試不同的數(shù)據(jù)庫作為主數(shù)據(jù)庫，在tearDown里面只需簡單設(shè)置下數(shù)據(jù)庫內(nèi)容就可以。
測試作為方法被實(shí)現(xiàn)，一個測試應(yīng)該運(yùn)行一些已知結(jié)果的應(yīng)用程序方法，也應(yīng)當(dāng)能夠斷言出結(jié)果和預(yù)期的不同。
到目前為止，在我們的測試框架里有兩個測試。第一個驗(yàn)證來自于上一篇文章的Gravatar avatar URLs生成的是否正確，注意預(yù)期的avatar被硬編碼在測試中，和User類中返回的對象作比較。
第二個測試驗(yàn)證是test_make_unique_nickname方法，同樣也是在User類中。這個測試有點(diǎn)詳細(xì)，它創(chuàng)建了一個新的用戶并且寫入數(shù)據(jù)庫中，同時確定名字的唯一性。接下來創(chuàng)建第二個用戶，建議使用唯一名稱，你可以嘗試下使用第一個用戶名稱。在第二部分測試預(yù)期結(jié)果是建議使用與之前不同的名稱。
運(yùn)行這個測試套件你只需運(yùn)行tests.py腳本:
|
1
|
./tests.py |
如果出現(xiàn)錯誤信息，你將會在控制臺得到一個報(bào)告。
結(jié)語
今天關(guān)于調(diào)試，錯誤和測試的討論到此為止，我希望這篇文章能對你有用。
老規(guī)矩，如果你有任何評論請寫在下面.
微博應(yīng)用程序的代碼今天修改的更新，你可以在這里下載:
