Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8a6f4d6b45 | |||
| c25fefa9e3 | |||
| b0795999fe | |||
| aaced9d0e1 | |||
| 4042932240 | |||
| 49ab2befb6 | |||
| fbf6a81e0b | |||
| dabf9f7544 | |||
| dcf173ab61 | |||
| d2c1c2e3ce | |||
| 3fcf916317 | |||
| 67e1890629 | |||
| e1cb541ea5 | |||
| 93e9c8dc24 | |||
| 7cf11986c5 | |||
| 5ca483a904 | |||
| fe7d61e1f7 | |||
| 1398cfe3db | |||
| f63de031f6 | |||
| 46bce5a0a5 | |||
| 0af0f4e8aa | |||
| 08896a18c1 | |||
| ea7c9a1e07 | |||
| 63da59efd5 | |||
| c7d4a1c930 | |||
| 421d0e6f8e | |||
| 5c1fc93ff9 | |||
| 7b5f7ff00b |
@@ -3,6 +3,7 @@ import logging
|
||||
import os
|
||||
from logging.config import dictConfig
|
||||
|
||||
import markdown
|
||||
from flask import Flask, request, send_from_directory
|
||||
|
||||
from ._version import get_versions
|
||||
@@ -31,6 +32,10 @@ def create_app(instance_path=None, test_config=None):
|
||||
|
||||
logger.debug("instance path: %s", app.instance_path)
|
||||
|
||||
# initialize markdown parser from config, but include
|
||||
# extensions our app depends on, like the meta extension
|
||||
app.config['md'] = markdown.Markdown(extensions=app.config['MARKDOWN_EXTENSIONS'] + ['meta'])
|
||||
|
||||
@app.before_request
|
||||
def log_request():
|
||||
logger.info("REQUEST: %s %s", request.method, request.path)
|
||||
|
||||
@@ -32,5 +32,9 @@ class Config(object):
|
||||
},
|
||||
}
|
||||
|
||||
MARKDOWN_EXTENSIONS = ['meta', 'tables']
|
||||
|
||||
DEFAULT_PAGE_STYLE = 'light'
|
||||
|
||||
TITLE_SUFFIX = 'incorporeal.org'
|
||||
MEDIA_DIR = 'media'
|
||||
|
||||
7
incorporealcms/lib.py
Normal file
7
incorporealcms/lib.py
Normal file
@@ -0,0 +1,7 @@
|
||||
"""Miscellaneous helper functions and whatnot."""
|
||||
from flask import current_app as app
|
||||
|
||||
|
||||
def get_meta_str(key):
|
||||
"""Provide the page's metadata for the specified key, or '' if unset."""
|
||||
return " ".join(app.config['md'].Meta.get(key)) if app.config['md'].Meta.get(key) else ""
|
||||
@@ -3,16 +3,16 @@ import datetime
|
||||
import logging
|
||||
import os
|
||||
|
||||
import markdown
|
||||
from flask import Blueprint, Markup, abort
|
||||
from flask import current_app as app
|
||||
from flask import redirect, render_template
|
||||
from flask import make_response, redirect, render_template, request
|
||||
from tzlocal import get_localzone
|
||||
|
||||
from incorporealcms.lib import get_meta_str
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
bp = Blueprint('pages', __name__, url_prefix='/')
|
||||
md = markdown.Markdown(extensions=['meta', 'tables'])
|
||||
|
||||
|
||||
@bp.route('/', defaults={'path': 'index'})
|
||||
@@ -34,13 +34,38 @@ def display_page(path):
|
||||
logger.warning("requested path '%s' (resolved path '%s') not found!", path, resolved_path)
|
||||
abort(404)
|
||||
else:
|
||||
content = Markup(md.convert(entry))
|
||||
logger.debug("file metadata: %s", md.Meta)
|
||||
title = " ".join(md.Meta.get('title')) if md.Meta.get('title') else ""
|
||||
return render_template('base.html', title=title, content=content, navs=parent_navs,
|
||||
content = Markup(app.config['md'].convert(entry))
|
||||
logger.debug("file metadata: %s", app.config['md'].Meta)
|
||||
|
||||
return render('base.html', title=get_meta_str('title'), description=get_meta_str('description'),
|
||||
image=get_meta_str('image'), base_url=request.base_url, content=content, navs=parent_navs,
|
||||
mtime=mtime.strftime('%Y-%m-%d %H:%M:%S %Z'))
|
||||
|
||||
|
||||
def render(template_name_or_list, **context):
|
||||
"""Wrap Flask's render_template.
|
||||
|
||||
* Determine the proper site theme to use in the template and provide it.
|
||||
"""
|
||||
PAGE_STYLES = {
|
||||
'dark': 'css/dark.css',
|
||||
'light': 'css/light.css',
|
||||
}
|
||||
|
||||
selected_style = request.args.get('style', None)
|
||||
if selected_style:
|
||||
user_style = selected_style
|
||||
else:
|
||||
user_style = request.cookies.get('user-style')
|
||||
logger.debug("user style cookie: %s", user_style)
|
||||
context['user_style'] = PAGE_STYLES.get(user_style, PAGE_STYLES.get(app.config['DEFAULT_PAGE_STYLE']))
|
||||
|
||||
resp = make_response(render_template(template_name_or_list, **context))
|
||||
if selected_style:
|
||||
resp.set_cookie('user-style', selected_style)
|
||||
return resp
|
||||
|
||||
|
||||
def resolve_page_file(path):
|
||||
"""Manipulate the request path to find appropriate page file.
|
||||
|
||||
@@ -86,6 +111,6 @@ def generate_parent_navs(path):
|
||||
else:
|
||||
with app.open_instance_resource(resolved_path, 'r') as entry_file:
|
||||
entry = entry_file.read()
|
||||
_ = Markup(md.convert(entry))
|
||||
page_name = " ".join(md.Meta.get('title')) if md.Meta.get('title') else f'/{path}'
|
||||
_ = Markup(app.config['md'].convert(entry))
|
||||
page_name = " ".join(app.config['md'].Meta.get('title')) if app.config['md'].Meta.get('title') else f'/{path}'
|
||||
return generate_parent_navs(parent_path) + [(page_name, f'/{path}')]
|
||||
|
||||
61
incorporealcms/static/css/dark.css
Normal file
61
incorporealcms/static/css/dark.css
Normal file
@@ -0,0 +1,61 @@
|
||||
html {
|
||||
color: #DDD;
|
||||
}
|
||||
|
||||
body {
|
||||
background: black;
|
||||
}
|
||||
|
||||
.site-wrap {
|
||||
background: #111;
|
||||
|
||||
border: 1px solid #222;
|
||||
border-top: none;
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #B31D15;
|
||||
}
|
||||
|
||||
a:link, a:visited {
|
||||
color: #EEE;
|
||||
border-bottom: 1px dotted #EEE;
|
||||
}
|
||||
|
||||
a:hover, a:active {
|
||||
color: #B31D15;
|
||||
border-bottom: 1px dotted #EEE;
|
||||
}
|
||||
|
||||
section.nav, section.styles {
|
||||
color: #BBB;
|
||||
background: #222;
|
||||
border-bottom: 1px solid #222;
|
||||
}
|
||||
|
||||
section.nav a, section.styles a {
|
||||
color: #BBB;
|
||||
}
|
||||
|
||||
table, th, td {
|
||||
border: 1px solid #333;
|
||||
}
|
||||
|
||||
th {
|
||||
background: #333;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
background-color: rgba(120, 120, 120, 0.3);
|
||||
border: 1px solid #222;
|
||||
}
|
||||
|
||||
figure {
|
||||
background: #222;
|
||||
border: 1px solid #333;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
color: #BBB;
|
||||
}
|
||||
61
incorporealcms/static/css/light.css
Normal file
61
incorporealcms/static/css/light.css
Normal file
@@ -0,0 +1,61 @@
|
||||
html {
|
||||
color: #222;
|
||||
}
|
||||
|
||||
body {
|
||||
background: #888;
|
||||
}
|
||||
|
||||
.site-wrap {
|
||||
background: white;
|
||||
|
||||
border: 1px solid #ddd;
|
||||
border-top: none;
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #811610;
|
||||
}
|
||||
|
||||
a:link, a:visited {
|
||||
color: #111;
|
||||
border-bottom: 1px dotted #111;
|
||||
}
|
||||
|
||||
a:hover, a:active {
|
||||
color: #811610;
|
||||
border-bottom: 1px dotted #111;
|
||||
}
|
||||
|
||||
section.nav, section.styles {
|
||||
color: #666;
|
||||
background: #EEE;
|
||||
border-bottom: 1px solid #CCC;
|
||||
}
|
||||
|
||||
section.nav a, section.styles a {
|
||||
color: #666;
|
||||
}
|
||||
|
||||
table, th, td {
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
|
||||
th {
|
||||
background: #eee;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
background-color: rgba(120, 120, 120, 0.1);
|
||||
border: 1px solid #CCC;
|
||||
}
|
||||
|
||||
figure {
|
||||
background: #EFEFEF;
|
||||
border: 1px solid #CCCCCC;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
color: #777777;
|
||||
}
|
||||
@@ -1,16 +1,22 @@
|
||||
html {
|
||||
font-family: sans-serif;
|
||||
padding: 0;
|
||||
padding-bottom: 16px;
|
||||
color: #222;
|
||||
}
|
||||
|
||||
body {
|
||||
margin: 0;
|
||||
text-size-adjust: 100%;
|
||||
-ms-text-size-adjust: 100%;
|
||||
-moz-text-size-adjust: 100%;
|
||||
-webkit-text-size-adjust: 100%;
|
||||
}
|
||||
|
||||
h1,h2,h3,h4,h5,h6 {
|
||||
color: #811610;
|
||||
.site-wrap {
|
||||
max-width: 70pc;
|
||||
min-height: 100vh;
|
||||
margin: 0;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
h1 {
|
||||
@@ -38,46 +44,39 @@ h6 {
|
||||
}
|
||||
|
||||
a:link {
|
||||
color: #222;
|
||||
font-weight: bold;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #222;
|
||||
}
|
||||
|
||||
a:visited {
|
||||
color: #222;
|
||||
font-weight: bold;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #222;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #811610;
|
||||
font-weight: bold;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #222;
|
||||
}
|
||||
|
||||
a:active {
|
||||
color: #811610;
|
||||
font-weight: bold;
|
||||
text-decoration: none;
|
||||
border-bottom: 1px dotted #222;
|
||||
}
|
||||
|
||||
section.nav {
|
||||
color: #666;
|
||||
background: #eee;
|
||||
section.nav, section.styles {
|
||||
font-size: 0.75em;
|
||||
border-bottom: 1px solid #ccc;
|
||||
border-bottom: 1px solid #444;
|
||||
padding: 0.25em 0.5em;
|
||||
}
|
||||
|
||||
section.nav a {
|
||||
color: #666;
|
||||
section.nav a, section.styles a {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
section.styles {
|
||||
float: right;
|
||||
}
|
||||
|
||||
section.content {
|
||||
font-size: 11pt;
|
||||
|
||||
@@ -90,6 +89,7 @@ footer {
|
||||
font-size: 75%;
|
||||
color: #999;
|
||||
padding: 0 1em;
|
||||
padding-bottom: 16px;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
@@ -103,11 +103,73 @@ table, th, td {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
th {
|
||||
background: #eee;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
background-color: rgba(120, 120, 120, 0.1);
|
||||
background-color: rgba(120, 120, 120, 0.3);
|
||||
padding: 1px 10px;
|
||||
}
|
||||
|
||||
.splash {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.splash img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.img-50 {
|
||||
max-width: 50% !important;
|
||||
}
|
||||
|
||||
/* For screens with width smaller than 400px */
|
||||
.figure-left .figure-right {
|
||||
max-width: 95%;
|
||||
float: none;
|
||||
margin-left: 10px;
|
||||
margin-right: 10px;
|
||||
}
|
||||
|
||||
/* For larger screens */
|
||||
@media only screen and (min-width: 400px) {
|
||||
.figure-left {
|
||||
float: left;
|
||||
margin-top: 0;
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.figure-right {
|
||||
float: right;
|
||||
margin-top: 0;
|
||||
margin-right: 0;
|
||||
}
|
||||
}
|
||||
|
||||
figure {
|
||||
max-width: 400px;
|
||||
padding: 5px;
|
||||
margin: 10px;
|
||||
margin-top: 0;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
figure img {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
font-family: "Times New Roman", serif;
|
||||
color: #777777;
|
||||
text-align: center;
|
||||
font-style: italic;
|
||||
line-height: 1.3em;
|
||||
margin-top: 5px;
|
||||
}
|
||||
|
||||
.thumbnail-image {
|
||||
width: 150px;
|
||||
height: auto;
|
||||
margin: 5px;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
BIN
incorporealcms/static/img/bss-square-no-bg.png
Normal file
BIN
incorporealcms/static/img/bss-square-no-bg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 49 KiB |
@@ -1,7 +1,20 @@
|
||||
<!doctype html>
|
||||
<title>{{ title }}{% if title %} - {% endif %}{{ config.TITLE_SUFFIX }}</title>
|
||||
{% if title %}<meta property="og:title" content="{{ title }}">{% endif %}
|
||||
{% if description %}<meta property="og:description" content="{{ description }}">{% endif %}
|
||||
{% if image %}<meta property="og:image" content="{{ image }}">{% endif %}
|
||||
<meta property="og:url" content="{{ base_url }}">
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="{{ url_for('static', filename='css/style.css') }}">
|
||||
<link rel="stylesheet" href="{{ url_for('static', filename=user_style) }}">
|
||||
<link rel="icon" href="{{ url_for('static', filename='img/favicon.png') }}">
|
||||
|
||||
<section class="site-wrap">
|
||||
<section class="styles">
|
||||
<a href="?style=dark">[dark]</a>
|
||||
<a href="?style=light">[light]</a>
|
||||
</section>
|
||||
<section class="nav">
|
||||
{% for nav in navs %}
|
||||
<a href="{{ nav.1 }}">{{ nav.0 }}</a>
|
||||
@@ -14,3 +27,4 @@
|
||||
<footer>
|
||||
<i>Last modified: {{ mtime }}</i>
|
||||
</footer>
|
||||
</section>
|
||||
|
||||
@@ -1,12 +1,23 @@
|
||||
-r requirements.in
|
||||
|
||||
flake8 # flake8 and plugins, for local dev linting in vim
|
||||
# testing runner, test reporting, packages used during testing (e.g. requests-mock), etc.
|
||||
pytest
|
||||
pytest-cov
|
||||
|
||||
# linting and other static code analysis
|
||||
bandit
|
||||
dlint
|
||||
flake8
|
||||
flake8-blind-except
|
||||
flake8-builtins
|
||||
flake8-docstrings
|
||||
flake8-executable
|
||||
flake8-fixme
|
||||
flake8-isort
|
||||
flake8-logging-format
|
||||
flake8-mutable
|
||||
|
||||
# maintenance utilities and tox
|
||||
pip-tools # pip-compile
|
||||
tox # CI stuff
|
||||
tox-wheel # build wheels in tox
|
||||
|
||||
@@ -5,45 +5,58 @@
|
||||
# pip-compile --output-file=requirements/requirements-dev.txt requirements/requirements-dev.in
|
||||
#
|
||||
appdirs==1.4.4 # via virtualenv
|
||||
attrs==20.3.0 # via pytest
|
||||
bandit==1.6.3 # via -r requirements/requirements-dev.in
|
||||
click==7.1.2 # via flask, pip-tools
|
||||
distlib==0.3.0 # via virtualenv
|
||||
coverage==5.3 # via pytest-cov
|
||||
distlib==0.3.1 # via virtualenv
|
||||
dlint==0.11.0 # via -r requirements/requirements-dev.in
|
||||
filelock==3.0.12 # via tox, virtualenv
|
||||
flake8-blind-except==0.1.1 # via -r requirements/requirements-dev.in
|
||||
flake8-builtins==1.5.3 # via -r requirements/requirements-dev.in
|
||||
flake8-docstrings==1.5.0 # via -r requirements/requirements-dev.in
|
||||
flake8-executable==2.0.3 # via -r requirements/requirements-dev.in
|
||||
flake8-isort==3.0.0 # via -r requirements/requirements-dev.in
|
||||
flake8-executable==2.1.0 # via -r requirements/requirements-dev.in
|
||||
flake8-fixme==1.1.1 # via -r requirements/requirements-dev.in
|
||||
flake8-isort==4.0.0 # via -r requirements/requirements-dev.in
|
||||
flake8-logging-format==0.6.0 # via -r requirements/requirements-dev.in
|
||||
flake8==3.8.3 # via -r requirements/requirements-dev.in, flake8-builtins, flake8-docstrings, flake8-executable, flake8-isort
|
||||
flake8-mutable==1.2.0 # via -r requirements/requirements-dev.in
|
||||
flake8==3.8.4 # via -r requirements/requirements-dev.in, dlint, flake8-builtins, flake8-docstrings, flake8-executable, flake8-isort, flake8-mutable
|
||||
flask==1.1.2 # via -r requirements/requirements.in
|
||||
importlib-metadata==1.6.0 # via flake8, markdown, pluggy, tox, virtualenv
|
||||
isort[pyproject]==4.3.21 # via flake8-isort
|
||||
gitdb==4.0.5 # via gitpython
|
||||
gitpython==3.1.11 # via bandit
|
||||
iniconfig==1.1.1 # via pytest
|
||||
isort==5.6.4 # via flake8-isort
|
||||
itsdangerous==1.1.0 # via flask
|
||||
jinja2==2.11.2 # via flask
|
||||
markdown==3.2.2 # via -r requirements/requirements.in
|
||||
markdown==3.3.3 # via -r requirements/requirements.in
|
||||
markupsafe==1.1.1 # via jinja2
|
||||
mccabe==0.6.1 # via flake8
|
||||
packaging==20.4 # via tox
|
||||
pip-tools==5.2.1 # via -r requirements/requirements-dev.in
|
||||
pluggy==0.13.1 # via tox
|
||||
py==1.8.1 # via tox
|
||||
packaging==20.7 # via pytest, tox
|
||||
pbr==5.5.1 # via stevedore
|
||||
pip-tools==5.4.0 # via -r requirements/requirements-dev.in
|
||||
pluggy==0.13.1 # via pytest, tox
|
||||
py==1.9.0 # via pytest, tox
|
||||
pycodestyle==2.6.0 # via flake8
|
||||
pydocstyle==5.0.2 # via flake8-docstrings
|
||||
pydocstyle==5.1.1 # via flake8-docstrings
|
||||
pyflakes==2.2.0 # via flake8
|
||||
pyparsing==2.4.7 # via packaging
|
||||
pytz==2020.1 # via tzlocal
|
||||
six==1.15.0 # via packaging, pip-tools, tox, virtualenv
|
||||
pytest-cov==2.10.1 # via -r requirements/requirements-dev.in
|
||||
pytest==6.1.2 # via -r requirements/requirements-dev.in, pytest-cov
|
||||
pytz==2020.4 # via tzlocal
|
||||
pyyaml==5.3.1 # via bandit
|
||||
six==1.15.0 # via bandit, pip-tools, tox, virtualenv
|
||||
smmap==3.0.4 # via gitdb
|
||||
snowballstemmer==2.0.0 # via pydocstyle
|
||||
testfixtures==6.14.1 # via flake8-isort
|
||||
toml==0.10.1 # via isort, tox
|
||||
tox-wheel==0.4.2 # via -r requirements/requirements-dev.in
|
||||
tox==3.15.2 # via -r requirements/requirements-dev.in, tox-wheel
|
||||
stevedore==3.3.0 # via bandit
|
||||
testfixtures==6.15.0 # via flake8-isort
|
||||
toml==0.10.2 # via pytest, tox
|
||||
tox-wheel==0.6.0 # via -r requirements/requirements-dev.in
|
||||
tox==3.20.1 # via -r requirements/requirements-dev.in, tox-wheel
|
||||
tzlocal==2.1 # via -r requirements/requirements.in
|
||||
versioneer==0.18 # via -r requirements/requirements-dev.in
|
||||
virtualenv==20.0.23 # via tox
|
||||
versioneer==0.19 # via -r requirements/requirements-dev.in
|
||||
virtualenv==20.2.2 # via tox
|
||||
werkzeug==1.0.1 # via flask
|
||||
wheel==0.34.2 # via tox-wheel
|
||||
zipp==3.1.0 # via importlib-metadata
|
||||
wheel==0.36.1 # via tox-wheel
|
||||
|
||||
# The following packages are considered to be unsafe in a requirements file:
|
||||
# pip
|
||||
|
||||
@@ -6,12 +6,10 @@
|
||||
#
|
||||
click==7.1.2 # via flask
|
||||
flask==1.1.2 # via -r requirements/requirements.in
|
||||
importlib-metadata==1.6.0 # via markdown
|
||||
itsdangerous==1.1.0 # via flask
|
||||
jinja2==2.11.2 # via flask
|
||||
markdown==3.2.2 # via -r requirements/requirements.in
|
||||
markdown==3.3.3 # via -r requirements/requirements.in
|
||||
markupsafe==1.1.1 # via jinja2
|
||||
pytz==2020.1 # via tzlocal
|
||||
pytz==2020.4 # via tzlocal
|
||||
tzlocal==2.1 # via -r requirements/requirements.in
|
||||
werkzeug==1.0.1 # via flask
|
||||
zipp==3.1.0 # via importlib-metadata
|
||||
|
||||
@@ -30,6 +30,15 @@ def test_page_without_title_metadata(client):
|
||||
assert b'<h1>this page doesn\'t have a title!</h1>' in response.data
|
||||
|
||||
|
||||
def test_page_with_card_metadata(client):
|
||||
"""Test that a page with opengraph metadata."""
|
||||
response = client.get('/more-metadata')
|
||||
assert response.status_code == 200
|
||||
assert b'<meta property="og:title" content="title for the page">' in response.data
|
||||
assert b'<meta property="og:description" content="description of this page made even longer">' in response.data
|
||||
assert b'<meta property="og:image" content="http://buh.com/test.img">' in response.data
|
||||
|
||||
|
||||
def test_page_has_modified_timestamp(client):
|
||||
"""Test that pages have modified timestamps in them."""
|
||||
response = client.get('/')
|
||||
@@ -52,3 +61,24 @@ def test_that_dir_request_does_not_redirect(client):
|
||||
response = client.get('/subdir/')
|
||||
assert response.status_code == 200
|
||||
assert b'another page' in response.data
|
||||
|
||||
|
||||
def test_setting_selected_style_includes_cookie(client):
|
||||
"""Test that a request with style=foo sets the cookie and renders appropriately."""
|
||||
response = client.get('/')
|
||||
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||
assert style_cookie is None
|
||||
|
||||
response = client.get('/?style=light')
|
||||
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||
assert response.status_code == 200
|
||||
assert b'light.css' in response.data
|
||||
assert b'dark.css' not in response.data
|
||||
assert style_cookie.value == 'light'
|
||||
|
||||
response = client.get('/?style=dark')
|
||||
style_cookie = next((cookie for cookie in client.cookie_jar if cookie.name == 'user-style'), None)
|
||||
assert response.status_code == 200
|
||||
assert b'dark.css' in response.data
|
||||
assert b'light.css' not in response.data
|
||||
assert style_cookie.value == 'dark'
|
||||
|
||||
3
tests/instance/pages/mdash-or-triple-dash.md
Normal file
3
tests/instance/pages/mdash-or-triple-dash.md
Normal file
@@ -0,0 +1,3 @@
|
||||
Test page
|
||||
|
||||
word --- word
|
||||
6
tests/instance/pages/more-metadata.md
Normal file
6
tests/instance/pages/more-metadata.md
Normal file
@@ -0,0 +1,6 @@
|
||||
Title: title for the page
|
||||
Description: description of this page
|
||||
made even longer
|
||||
Image: http://buh.com/test.img
|
||||
|
||||
hello
|
||||
@@ -13,6 +13,32 @@ def test_config():
|
||||
assert create_app(instance_path=instance_path, test_config={"TESTING": True}).testing
|
||||
|
||||
|
||||
def test_markdown_meta_extension_always():
|
||||
"""Test that the markdown meta extension is always loaded, even if not specified."""
|
||||
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
||||
test_config={'MARKDOWN_EXTENSIONS': []})
|
||||
client = app.test_client()
|
||||
response = client.get('/')
|
||||
assert response.status_code == 200
|
||||
assert b'<title>Index - incorporeal.org</title>' in response.data
|
||||
|
||||
|
||||
def test_extra_markdown_extensions_work():
|
||||
"""Test we can load more extensions via config, and that they work."""
|
||||
app = create_app(instance_path=os.path.join(HERE, 'instance'))
|
||||
client = app.test_client()
|
||||
response = client.get('/mdash-or-triple-dash')
|
||||
assert response.status_code == 200
|
||||
assert b'word --- word' in response.data
|
||||
|
||||
app = create_app(instance_path=os.path.join(HERE, 'instance'),
|
||||
test_config={'MARKDOWN_EXTENSIONS': ['smarty']})
|
||||
client = app.test_client()
|
||||
response = client.get('/mdash-or-triple-dash')
|
||||
assert response.status_code == 200
|
||||
assert b'word — word' in response.data
|
||||
|
||||
|
||||
def test_title_override():
|
||||
"""Test that a configuration with a specific title overrides the default."""
|
||||
instance_path = os.path.join(HERE, 'instance')
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
"""Unit test helper methods."""
|
||||
from incorporealcms.pages import generate_parent_navs, is_file_path_actually_dir_path, resolve_page_file
|
||||
from werkzeug.http import dump_cookie
|
||||
|
||||
from incorporealcms.pages import generate_parent_navs, is_file_path_actually_dir_path, render, resolve_page_file
|
||||
|
||||
|
||||
def test_resolve_page_file_dir_to_index():
|
||||
@@ -74,3 +76,25 @@ def test_is_file_path_actually_dir_path_nonsense_dir_is_no(app):
|
||||
"""Test that a directory request is a directory request even if the dir doesn't exist."""
|
||||
with app.app_context():
|
||||
assert not is_file_path_actually_dir_path('/antphnathpnthapnthsnthax/')
|
||||
|
||||
|
||||
def test_render_with_user_dark_theme(app):
|
||||
"""Test that a request with the dark theme selected renders the dark theme."""
|
||||
cookie = dump_cookie("user-style", 'dark')
|
||||
with app.test_request_context(headers={'COOKIE': cookie}):
|
||||
assert b'dark.css' in render('base.html').data
|
||||
assert b'light.css' not in render('base.html').data
|
||||
|
||||
|
||||
def test_render_with_user_light_theme(app):
|
||||
"""Test that a request with the light theme selected renders the light theme."""
|
||||
with app.test_request_context():
|
||||
assert b'light.css' in render('base.html').data
|
||||
assert b'dark.css' not in render('base.html').data
|
||||
|
||||
|
||||
def test_render_with_no_user_theme(app):
|
||||
"""Test that a request with no theme set renders the light theme."""
|
||||
with app.test_request_context():
|
||||
assert b'light.css' in render('base.html').data
|
||||
assert b'dark.css' not in render('base.html').data
|
||||
|
||||
70
tox.ini
70
tox.ini
@@ -4,7 +4,7 @@
|
||||
# and then run "tox" from this directory.
|
||||
|
||||
[tox]
|
||||
envlist = py37,security,lint
|
||||
envlist = begin,py37,py38,coverage,security,lint,bundle
|
||||
|
||||
[testenv]
|
||||
# build a wheel and test it
|
||||
@@ -12,45 +12,59 @@ wheel = true
|
||||
wheel_build_env = build
|
||||
|
||||
# whitelist commands we need
|
||||
whitelist_externals = ln
|
||||
whitelist_externals = cp
|
||||
|
||||
# install everything via requirements-dev.txt, so that developer environment
|
||||
# is the same as the tox environment (for ease of use/no weird gotchas in
|
||||
# local dev results vs. tox results) and also to avoid ticky-tacky maintenance
|
||||
# of "oh this particular env has weird results unless I install foo" --- just
|
||||
# shotgun blast install everything everywhere
|
||||
deps =
|
||||
-rrequirements/requirements-dev.txt
|
||||
|
||||
[testenv:build]
|
||||
# require setuptools when building
|
||||
deps = setuptools
|
||||
|
||||
[testenv:begin]
|
||||
# clean up potential previous coverage runs
|
||||
skip_install = true
|
||||
commands = coverage erase
|
||||
|
||||
[testenv:py37]
|
||||
# run pytest and coverage
|
||||
deps =
|
||||
pytest
|
||||
pytest-cov
|
||||
# run pytest with coverage
|
||||
commands =
|
||||
pytest --cov={envsitepackagesdir}/incorporealcms/ \
|
||||
--cov-report=term-missing --cov-branch --cov-fail-under=90
|
||||
ln -sf {distdir} dist
|
||||
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
|
||||
|
||||
[testenv:py38]
|
||||
# run pytest with coverage
|
||||
commands =
|
||||
pytest --cov-append --cov={envsitepackagesdir}/incorporealcms/ --cov-branch
|
||||
|
||||
[testenv:coverage]
|
||||
# report on coverage runs from above
|
||||
skip_install = true
|
||||
commands =
|
||||
coverage report --fail-under=95 --show-missing
|
||||
|
||||
[testenv:security]
|
||||
# run security checks
|
||||
#
|
||||
# again it seems the most valuable here to run against the packaged code
|
||||
deps =
|
||||
bandit
|
||||
commands =
|
||||
bandit {envsitepackagesdir}/incorporealcms/ -r
|
||||
|
||||
[testenv:lint]
|
||||
# run style checks
|
||||
skip_install = true
|
||||
deps =
|
||||
flake8
|
||||
flake8-blind-except
|
||||
flake8-builtins
|
||||
flake8-docstrings
|
||||
flake8-executable
|
||||
flake8-isort
|
||||
flake8-logging-format
|
||||
commands =
|
||||
flake8
|
||||
- flake8 --disable-noqa --select=E,W,F,C,D,A,G,B,I
|
||||
- flake8 --disable-noqa --ignore= --select=E,W,F,C,D,A,G,B,I,T,M,DUO
|
||||
|
||||
[testenv:bundle]
|
||||
# take extra actions (build sdist, sphinx, whatever) to completely package the app
|
||||
commands =
|
||||
cp -r {distdir} .
|
||||
python setup.py sdist
|
||||
|
||||
[coverage:paths]
|
||||
source =
|
||||
@@ -59,23 +73,29 @@ source =
|
||||
|
||||
[coverage:run]
|
||||
branch = True
|
||||
|
||||
# redundant with pytest --cov above, but this tricks the coverage.xml report into
|
||||
# using the full path, otherwise files with the same name in different paths
|
||||
# get clobbered. maybe appends would fix this, IDK
|
||||
include =
|
||||
.tox/**/incorporealcms/
|
||||
|
||||
omit =
|
||||
**/_version.py
|
||||
|
||||
[flake8]
|
||||
max-line-length = 120
|
||||
enable-extensions = G,M
|
||||
exclude =
|
||||
.tox/
|
||||
versioneer.py
|
||||
_version.py
|
||||
instance/
|
||||
extend-ignore = T101
|
||||
max-complexity = 10
|
||||
max-line-length = 120
|
||||
|
||||
[isort]
|
||||
line_length = 120
|
||||
# only way I could figure out how to make tests/conftest.py happy and have pytest separate from incorporealcms
|
||||
# and if I let them be combined in tox runs, flake8-isort in vim would complain :(
|
||||
forced_separate = incorporealcms
|
||||
|
||||
[pytest]
|
||||
python_files =
|
||||
|
||||
Reference in New Issue
Block a user