Great CMS

CMS for the GREAT platform - the Department for International Trade (DIT)

Development

Installing

$ git clone https://github.com/uktrade/great-cms
$ cd great-cms
$ [create and activate virtual environment]
$ make install_requirements
$ make ARGUMENTS=migrate manage

Requirements

Python 3.6
Postgres 10
Redis
Any browser based on Chromium and Chrome driver

Install virtualenv

pip 18 is required. Refer to the pip website for more info.

$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
$ python get-pip.py pip==18

Configuration

Secrets such as API keys and environment specific configurations are placed in conf/env/secrets-do-not-commit - a file that is not added to version control. To create a template secrets file with dummy values run make secrets.

Commands

Command	Description
make clean	Delete pyc files
make pytest	Run all tests
make pytest test_foo.py	Run all tests in file called test_foo.py
make pytest -- --last-failed`	Run the last tests to fail
make pytest -- -k foo	Run the test called foo
make pytest --	Run arbitrary pytest command
make test_load	Run load tests
make flake8	Run linting
make manage	Run arbitrary management command
make webserver	Run the development web server
make requirements	Compile the requirements file
make install_requirements	Installed the compile requirements file
make css	Compile scss to css
make secrets	Create your secret env var file
make database	Drop and recrete the database
make boostrap_great	Create required database records so the CMS works
make create_tours	Create required Page tours
make recreate	Runs: database, boostrap_great, create_pages, create_tours in one go

Setting up the local database

$ make database

make database drops then recreates the local database.

Setting up the Chrome Driver

Download Chrome driver from the official site https://chromedriver.chromium.org/
Place the binary on you PATH

Running browser tests in "headfull" mode

In case you'd like to run all browser tests in "headfull" mode, then simply set HEADLESS env var to false:

HEADLESS=false make ARGUMENTS="-m browser" pytest

You can also use regular pytest filters:

HEADLESS=false make ARGUMENTS="-k test_anonymous_user_should" pytest

Getting started

$ make ARGUMENTS=bootstrap_great manage

It creates the Great domestic empty homepage and assigns it to the site root. It also creates a superuser test with password password, for local development.

Image storage

Local development uses django.core.files.storage.FileSystemStorage

/etc/hosts file entry

UI clients on local expect the CMS to be reachable at the address http://cms.trade.great.

 Add 127.0.0.1 greatcms.trade.great

You can test this works by attempting to visit http://greatcms.trade.great:8020/admin in your browser.

Session

Signed cookies are used as the session backend to avoid using a database. We therefore must avoid storing non-trivial data in the session, because the browser will be exposed to the data.

React components

To add new react components:

Add the file to javascript/src/ e.g. javascript/src/myFile.js
Update javascript/src/bundle.js e.g,

import myFile from './myFile';

export default {
    ...,
    myFile
};

Run npm run build
The new component is now available on window.ditMVP.myFile

Node version

Make sure to use NodeJS 12.16.1 or greater

Code formatting

We are using eslint with recommended settings and prettier

Are you using Visual Studio Code? Install Prettier plugin for auto formatting of your code: https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

Staff SSO

On local machine, SSO is turned off by default. If you need to enable, set the FEATURE_ENFORCE_STAFF_SSO_ENABLED to true. You also need to set:

STAFF_SSO_AUTHBROKER_URL
AUTHBROKER_CLIENT_ID
AUTHBROKER_CLIENT_SECRET

Speak to webops or a team mate for the above values.

Load tests

We're using locust to run load tests against local instance of the service and in-memory SQLite.
See Django database documentation for more details.

To run them with default settings use:

make test_load

This target, will spawn a local instance of the service and tear it down after tests are finished.

You can control the execution with env vars:

LOCUST_FILE=tests/load/mvp_home.py NUM_USERS=10 HATCH_RATE=2 RUN_TIME=30s make test_load

Known issues

Local development environment: If you try to get to a URL (i.e. /markets/) and you get an error similar to "AttributeError AttributeError: 'User' object has no attribute 'session_id'"/'company' et al, you need to go to /django-admin/ and logout from the top right hand side. This is a temporary workaround to resolve an incompatibility between great-cms and directory-sso.

Helpful links

Related projects:

https://github.com/uktrade?q=directory

https://github.com/uktrade?q=great

webbyfox/great-cms