2.2.0 (#1188)

2.2.0 / 2019-12-22
==================

## Notice
2.2.0 focuses on updating the front end of CTFd to use more modern programming practices and changes some aspects of core CTFd design. If your current installation is using a custom theme or custom plugin with ***any*** kind of JavaScript, it is likely that you will need to upgrade that theme/plugin to be useable with v2.2.0. 

**General**
* Team size limits can now be enforced from the configuration panel
* Access tokens functionality for API usage
* Admins can now choose how to deliver their notifications
    * Toast (new default)
    * Alert
    * Background
    * Sound On / Sound Off
* There is now a notification counter showing how many unread notifications were received
* Setup has been redesigned to have multiple steps
    * Added Description
    * Added Start time and End time,
    * Added MajorLeagueCyber integration
    * Added Theme and color selection
* Fixes issue where updating dynamic challenges could change the value to an incorrect value
* Properly use a less restrictive regex to validate email addresses
* Bump Python dependencies to latest working versions
* Admins can now give awards to team members from the team's admin panel page

**API**
* Team member removals (`DELETE /api/v1/teams/[team_id]/members`) from the admin panel will now delete the removed members's Submissions, Awards, Unlocks

**Admin Panel**
* Admins can now user a color input box to specify a theme color which is injected as part of the CSS configuration. Theme developers can use this CSS value to change colors and styles accordingly.
* Challenge updates will now alert you if the challenge doesn't have a flag
* Challenge entry now allows you to upload files and enter simple flags from the initial challenge creation page

**Themes**
* Significant JavaScript and CSS rewrite to use ES6, Webpack, yarn, and babel
* Theme asset specially generated URLs
    * Static theme assets are now loaded with either .dev.extension or .min.extension depending on production or development (i.e. debug server)
    * Static theme assets are also given a `d` GET parameter that changes per server start. Used to bust browser caches.
* Use `defer` for script tags to not block page rendering
* Only show the MajorLeagueCyber button if configured in configuration
* The admin panel now links to https://help.ctfd.io/ in the top right
* Create an `ezToast()` function to use [Bootstrap's toasts](https://getbootstrap.com/docs/4.3/components/toasts/)
* The user-facing navbar now features icons
* Awards shown on a user's profile can now have award icons
* The default MarkdownIt render created by CTFd will now open links in new tabs
* Country flags can now be shown on the user pages

**Deployment**
* Switch `Dockerfile` from `python:2.7-alpine` to `python:3.7-alpine`
* Add `SERVER_SENT_EVENTS` config value to control whether Notifications are enabled
* Challenge ID is now recorded in the submission log

**Plugins**
* Add an endpoint parameter to `register_plugin_assets_directory()` and `register_plugin_asset()` to control what endpoint Flask uses for the added route

**Miscellaneous**
* `CTFd.utils.email.sendmail()` now allows the caller to specify subject as an argument
    * The subject allows for injecting custom variable via the new `CTFd.utils.formatters.safe_format()` function
* Admin user information is now error checked during setup
* Added yarn to the toolchain and the yarn dev, yarn build, yarn verify, and yarn clean scripts
* Prevent old CTFd imports from being imported

tests/helpers.py

@@ -19,6 +19,7 @@ from CTFd.models import (
     Tracking,
     Unlocks,
     Users,
+    Tokens,
 )
 from CTFd.cache import cache, clear_standings
 from sqlalchemy_utils import drop_database
@@ -50,6 +51,8 @@ class CTFdTestClient(FlaskClient):
             with self.session_transaction() as sess:
                 api_key_headers = Headers({"CSRF-Token": sess.get("nonce")})
                 headers = kwargs.pop("headers", Headers())
+                if isinstance(headers, dict):
+                    headers = Headers(headers)
                 headers.extend(api_key_headers)
                 kwargs["headers"] = headers
         return super(CTFdTestClient, self).open(*args, **kwargs)
@@ -57,6 +60,7 @@ class CTFdTestClient(FlaskClient):
 
 def create_ctfd(
     ctf_name="CTFd",
+    ctf_description="CTF description",
     name="admin",
     email="admin@ctfd.io",
     password="password",
@@ -81,13 +85,22 @@ def create_ctfd(
     app.test_client_class = CTFdTestClient
 
     if setup:
-        app = setup_ctfd(app, ctf_name, name, email, password, user_mode)
+        app = setup_ctfd(
+            app,
+            ctf_name=ctf_name,
+            ctf_description=ctf_description,
+            name=name,
+            email=email,
+            password=password,
+            user_mode=user_mode
+        )
     return app
 
 
 def setup_ctfd(
     app,
     ctf_name="CTFd",
+    ctf_description="CTF description",
     name="admin",
     email="admin@ctfd.io",
     password="password",
@@ -99,6 +112,7 @@ def setup_ctfd(
             with client.session_transaction() as sess:
                 data = {
                     "ctf_name": ctf_name,
+                    "ctf_description": ctf_description,
                     "name": name,
                     "email": email,
                     "password": password,
@@ -423,6 +437,13 @@ def gen_notification(db, title="title", content="content"):
     db.session.commit()
 
 
+def gen_token(db, type="user", user_id=None, expiration=None):
+    token = Tokens(type=type, user_id=user_id, expiration=expiration)
+    db.session.add(token)
+    db.session.commit()
+    return token
+
+
 def simulate_user_activity(db, user):
     gen_tracking(db, user_id=user.id)
     gen_award(db, user_id=user.id)