def _create_app(self) -> Iterator[Flask]:
"""Create and configure a new app instance for each test."""
# create a temporary file to isolate the database for each test
db_fd, db_path = tempfile.mkstemp()
# create the app with common test config
app = create_app({"TESTING": True, "DATABASE": db_path})
# create the database and load test data
with app.app_context():
init_db()
get_db().executescript(_data_sql)
# Yield the app
'''
This can be outside the `with` block too, but we need to
call `close_db` before exiting current context
Otherwise windows will have trouble removing the temp file
that doesn't happen on unices though, which is nice
'''
yield app
## Close the db
close_db()
## Cleanup temp file
os.close(db_fd)
os.remove(db_path)
def test_get_close_db(self, app: Flask):
with app.app_context():
db = get_db()
assert db is get_db()
try:
db.execute("SELECT 1")
except sqlite3.ProgrammingError as e:
self.assertIn("closed", str(e.args[0]))
def register():
"""Register a new user.
Validates that the username is not already taken. Hashes the
password for security.
"""
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 {0} is already registered.".format(username)
if error is None:
# the name is available, store it in the database and go to
# the login page
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 get_post(id, check_author=True):
"""Get a post and its author by id.
Checks that the id exists and optionally that the current user is
the author.
:param id: id of post to get
:param check_author: require the current user to be the author
:return: the post with author information
:raise 404: if a post with the given id doesn't exist
:raise 403: if the current user isn't the author
"""
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 index():
"""Show all the posts, most recent first."""
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 load_logged_in_user():
"""If a user id is stored in the session, load the user object from
the database into ``g.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 delete():
"""Delete the current user account"""
if request.method == "POST":
db = get_db()
db.execute("DELETE FROM user WHERE id = ?", (g.user["id"], ))
db.commit()
session.clear()
return redirect(url_for("index"))
return render_template("auth/delete.html")
def test_delete(self, app: Flask, client: FlaskClient):
auth = AuthActions(client)
auth.login()
response = client.post("/1/delete")
self.assertLocationHeader(response, "http://localhost/")
with app.app_context():
db = get_db()
post = db.execute("SELECT * FROM post WHERE id = 1").fetchone()
self.assertIsNone(post)
def test_update(self, app: Flask, client: FlaskClient):
auth = AuthActions(client)
auth.login()
self.assertStatus(client.get("/1/update"), 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()
self.assertEqual(post["title"], "updated")
def test_create(self, app: Flask, client: FlaskClient):
auth = AuthActions(client)
auth.login()
self.assertStatus(client.get("/create"), 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]
self.assertEqual(count, 2)
def delete(id):
"""Delete a post.
Ensures that the post exists and that the logged in user is the
author of the post.
"""
get_post(id)
db = get_db()
db.execute("DELETE FROM post WHERE id = ?", (id, ))
db.commit()
return redirect(url_for("blog.index"))
def test_author_required(self, app: Flask, client: FlaskClient):
# 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 = AuthActions(client)
auth.login()
# current user can't modify other user's post
self.assertStatus(client.post("/1/update"), 403)
self.assertStatus(client.post("/1/delete"), 403)
# current user doesn't see edit link
self.assertNotIn(b'href="/1/update"', client.get("/").data)
def test_register(self, app: Flask, client: FlaskClient):
# test that viewing the page renders without template errors
self.assertStatus(client.get("/auth/register"), 200)
# test that successful registration redirects to the login page
response = client.post("/auth/register",
data={
"username": "******",
"password": "******"
})
self.assertLocationHeader(response, "http://localhost/auth/login")
# test that the user was inserted into the database
with app.app_context():
self.assertIsNotNone(get_db().execute(
"select * from user where username = '******'").fetchone())
def update(id):
"""Update a post if the current user is the author."""
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 create():
"""Create a new post for the current user."""
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 login():
"""Log in a registered user by adding the user id to the session."""
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:
# store the user id in a new session and return to the index
session.clear()
session["user_id"] = user["id"]
return redirect(url_for("index"))
flash(error)
return render_template("auth/login.html")