def test_get_close_db(app):
with app.app_context():
db = get_db()
assert db is get_db()
with pytest.raises(sqlite3.ProgrammingError) as e:
db.execute('SELECT 1')
assert 'closed' in str(e)
def app():
db_fd, db_path = tempfile.mkstemp()
app = create_app({
'TESTING': True,
'DATABASE': db_path,
})
with app.app_context():
init_db()
get_db().executescript(_data_sql)
yield app
os.close(db_fd)
os.unlink(db_path)
def delete(id):
get_post(id)
db = get_db()
db.execute('DELETE FROM post WHERE id = ?', (id, ))
db.commit()
return redirect(url_for('blog.index'))
def register():
"""Register a user.
@bp.route associates the register url with this function.
request.form is a special type of dict mapping submitted form keys
and values.
"""
if request.method == 'POST':
username = request.form['username']
password = request.form['password']
db = get_db()
error = None
if not username:
error = 'Username is required.'
elif not password:
error = 'Password is required.'
elif db.execute('SELECT id FROM user WHERE username = ?',
(username, )).fetchone() is not None:
error = 'User {} is already registered.'.format(username)
if error is None:
db.execute('INSERT INTO user (username, password) VALUES (?, ?)',
(username, generate_password_hash(password)))
db.commit()
return redirect(url_for('auth.login'))
flash(error)
return render_template('auth/register.html')
def index():
db = get_db()
posts = db.execute('SELECT p.id, title, body, created, author_id, username'
' FROM post p JOIN user u ON p.author_id = u.id'
' ORDER BY created DESC').fetchall()
return render_template('blog/index.html', posts=posts)
def login():
if request.method == 'POST':
username = request.form['username']
password = request.form['password']
db = get_db()
error = None
# The user is queried first and stored in a variable for later use.
user = db.execute('SELECT * FROM user WHERE username = ?',
(username, )).fetchone()
if user is None:
error = 'Incorrect username.'
# check_password_hash() hashes the submitted password in the same way as the stored hash and securely compares them. If they match, the password is valid.
elif not check_password_hash(user['password'], password):
error = 'Incorrect password.'
# session is a dict that stores data across requests.
if error is None:
session.clear()
# When validation succeeds, the user’s id is stored in a new session.
# The data is stored in a cookie that is sent to the browser, and the browser then sends it back with subsequent requests.
session['user_id'] = user['id']
return redirect(url_for('index'))
flash(error)
return render_template('auth/login.html')
def login():
"""Handle a user login.
session is a dict that stores data across requests. This data is stored
in a cookie that is sent to the browser. The data is signed securely.
"""
if request.method == 'POST':
username = request.form['username']
password = request.form['password']
db = get_db()
error = None
user = db.execute('SELECT * FROM user WHERE username = ?',
(username, )).fetchone()
if user is None:
error = 'Incorrect username.'
elif not check_password_hash(user['password'], password):
error = 'Incorrect password.'
if error is None:
session.clear()
# Now that the ID is stored in the session, it will be
# available on subsequent requests.
session['user_id'] = user['id']
return redirect(url_for('index'))
flash(error)
return render_template('auth/login.html')
def load_logged_in_user():
user_id = session.get('user_id')
if user_id is None:
g.user = None
else:
g.user = get_db().execute('SELECT * FROM user WHERE id = ?',
(user_id, )).fetchone()
def load_logged_in_user():
user_id = session.get('user_id')
# If there is no user id, or if the id doesn’t exist, g.user will be None.
if user_id is None:
g.user = None
else:
g.user = get_db().execute('SELECT * FROM user WHERE id = ?',
(user_id, )).fetchone()
def test_create(client, auth, app):
auth.login()
assert client.get('/create').status_code == 200
client.post('/create', data={'title': 'created', 'body': ''})
with app.app_context():
db = get_db()
count = db.execute('SELECT COUNT(id) FROM post').fetchone()[0]
assert count == 2
def test_delete(client, auth, app):
auth.login()
response = client.post('/1/delete')
assert response.headers['Location'] == 'http://localhost/'
with app.app_context():
db = get_db()
post = db.execute('SELECT * FROM post WHERE id = 1').fetchone()
assert post is None
def test_update(client, auth, app):
auth.login()
assert client.get('/1/update').status_code == 200
client.post('/1/update', data={'title': 'updated', 'body': ''})
with app.app_context():
db = get_db()
post = db.execute('SELECT * FROM post WHERE id = 1').fetchone()
assert post['title'] == 'updated'
def app():
# Creates and opens a temporary file, returning the file object and the path to it.
db_fd, db_path = tempfile.mkstemp()
# The app fixture will call the factory and pass test_config to configure the application
# and database for testing instead of using your local development configuration.
app = create_app({
# Tells Flask that the app is in test mode.
'TESTIING': True,
# The DATABASE path is overridden so it points to this temporary path instead of the instance folder.
'DATABASE': db_path,
})
with app.app_context():
init_db()
get_db().executescript(_data_sql)
yield app
os.close(db_fd)
os.unlink(db_path)
def get_post(id, check_author=True):
post = get_db().execute(
'SELECT p.id, title, body, created, author_id, username'
' FROM post p JOIN user u ON p.author_id = u.id'
' WHERE p.id = ?', (id, )).fetchone()
if post is None:
abort(404, "Post id {0} doesn't exist.".format(id))
if check_author and post['author_id'] != g.user['id']:
abort(403)
return post
def test_author_required(app, client, auth):
# change the post author to another user
with app.app_context():
db = get_db()
db.execute('UPDATE post SET author_id = 2 WHERE id = 1')
db.commit()
auth.login()
# current user can't modify other user's post
assert client.post('/1/update').status_code == 403
assert client.post('/1/delete').status_code == 403
# current user doesn't see edit link
assert b'href="/1/update"' not in client.get('/').data
def test_register(client, app):
# Check for a rendering error (200 means success)
assert client.get('/auth/register').status_code == 200
response = client.post('/auth/register',
data={
'username': '******',
'password': '******'
})
# Headers will have a Location header with the login URL on redirect.
assert 'http://localhost/auth/login' == response.headers['Location']
# Verify that user is in the database.
with app.app_context():
assert get_db().execute(
"select * from user where username = '******'", ).fetchone() is not None
def test_register(client, app):
# Makes a GET request and returns the Response object returned by Flask.
# Test that the page renders successfully, a simple request is made and checked for a 200 OK status_code.
# If rendering failed, Flask would return a 500 Internal Server Error code.
assert client.get('/auth/register').status_code == 200
# Makes a POST request, converting the data dict into form data.
response = client.post(
# data contains the body of the response as bytes.
# If you expect a certain value to render on the page, check that it’s in data. Bytes must be compared to bytes.
'/auth/register', data = {'username' : 'a', 'password' : 'a'}
)
# headers will have a Location header with the login URL when the register view redirects to the login view.
assert 'http://localhost/auth/login' == response.headers['Location']
with app.app_context():
assert get_db().execute(
"select * from user where username = '******'"
).fetchone() is not None
def create():
if request.method == 'POST':
title = request.form['title']
body = request.form['body']
error = None
if not title:
error = 'Title is required.'
if error is not None:
flash(error)
else:
db = get_db()
db.execute(
'INSERT INTO post (title, body, author_id)'
' VALUES (?, ?, ?)', (title, body, g.user['id']))
db.commit()
return redirect(url_for('blog.index'))
return render_template('blog/create.html')
def update(id):
post = get_post(id)
if request.method == 'POST':
title = request.form['title']
body = request.form['body']
error = None
if not title:
error = 'Title is required.'
if error is not None:
flash(error)
else:
db = get_db()
db.execute('UPDATE post SET title = ?, body = ?'
' WHERE id = ?', (title, body, id))
db.commit()
return redirect(url_for('blog.index'))
return render_template('blog/update.html', post=post)
def register():
if request.method == 'POST':
# Request.form is a special type of dict mapping submitted form keys and values
username = request.form['username']
password = request.form['password']
db = get_db()
error = None
# Validate that username is not empty
if not username:
error = 'Username is required.'
# Validate that username is not empty
elif not password:
error = 'Password is required.'
# Validate that username is not already registered by querying the database and checking if a result is returned.
elif db.execute('SELECT id FROM user WHERE username = ?', (username, )
# fetchone() returns one row from the query.
).fetchone() is not None:
error = f'User {username} is already registered'
if error is None:
# If validation succeeds, insert the new user data into the database.
# generate_password_hash() is used to securely hash the password, and that hash is stored.
db.execute('INSERT INTO user (username, password) VALUES (?, ?)',
(username, generate_password_hash(password)))
# Since this query modifies data, db.commit() needs to be called afterwards to save the changes.
db.commit()
# After storing the user, they are redirected to the login page.
return redirect(url_for('auth.login'))
# If validation fails, the error is shown to the user.
# flash() stores messages that can be retrieved when rendering the template.
flash(error)
# When the user initially navigates to auth/register, or there was a validation error, an HTML page with the registration form should be shown.
return render_template('auth/register.html')
