lando-ui is a Flask-based web application that serves as a graphical user interface to lando-api. It is separate from the latter to isolate the logic of automatic landings from its interface(s).
Please read the general Conduit contribution guidelines before getting into the specifics of lando-ui.
- docker and docker-compose (on OS X and Windows you should use the full Docker for Mac or Docker for Windows systems, respectively)
pyinvoke
- Because
pyinvoke
currently has no backwards-compatibility guarantees, it is suggested that you install exactly version 0.21.0 viapip
:pip install invoke==0.21.0
orpip install --user invoke==0.21.0
. - You can use a virtualenv instead of installing it system wide, but you should create the virtualenv outside of the lando-ui source directory so that the linter doesn't check the virtualenv files.
- If you are running Windows, you will need a special file in your user
directory (typically
C:\Users\<username>\
) called.invoke.yml
. It should contain the following:run: shell: C:\Windows\System32\cmd.exe
- Because
As Flask requires a real server name to use session cookies, you
will need to make an entry in your host config or a local DNS server.
On Linux and MacOS, the hosts file is located at /etc/hosts
; on
Windows, it is located at C:\Windows\System32\Drivers\etc\hosts
.
The format is the same on all three OSs, requiring the addition of the
following line:
127.0.0.1 lando-ui.test
If you are using Docker Machine, you will need to replace
127.0.0.1
with the IP of your Docker Machine host. Note that you
should use 127.0.0.1
on Windows if you use the full Docker for Windows
installation.
After updating your hosts file (no reboot is required), in a terminal
simply run docker-compose up
in the root lando-ui directory. On
Windows, we recommend using Git Bash, which provides a Linux-like
terminal interface.
After a while, you will see within docker-compose's output a line like this:
lando-ui_1 | * Running on http://0.0.0.0:7777/ (Press CTRL+C to quit)
At this point, you should be able to visit
http://lando-ui.test:7777/
in your browser.
lando-ui requires an instance of lando-api to talk to in order to
anything interesting. The default configuration sets the location of
lando-api to http://lando-api.test:8888
, which is the default for a
local installation of lando-api.
lando-ui's tests use pytest
with pytest-flask
, executed within a
Docker container. The tests are located in ./tests/
. You can run
all of them via invoke
:
$ invoke test
Subsets of the tests, e.g. linters, and other commands are also available. Run
invoke -l
to see all tasks.
We use Auth0 to authenticate application users. You will need to sign up for a personal Auth0 account to manually test code landing workflows and protected pages.
After signing up you must create an Auth0 Client for lando-ui testing. See the Auth0 docs for details on how to do this.
Once you have created the lando-ui Client in your Auth0 management dashboard, go
to the Client Settings
page and configure the following:
Client Type: Regular Web Application
Token Endpoint Authentication Method: POST
Allowed Callback URLs: http://lando-ui.test:7777/redirect_uri, http://lando-ui.test/redirect_uri
Allowed Web Origins: (leave blank)
Allowed Logout URLs: http://lando-ui.test:7777/signout, http://lando-ui.test/signout
Allowed Origins (CORS): (leave blank)
- Click
Show Advanced Settings
on theClient Settings
page, then select theOAuth
tab:JsonWebToken Signature Algorithm: HS256
Create an Auth0 API (click API
in the Auth0 left side bar)
Name: lando-api
Identifier/URI: http://lando-api.test
- Go to the new API's
Scopes
tab and add a scope:Name: lando
Description: Bearer has authorized Lando to land code on their behalf
Create a docker-compose.override.yml
file in repository's root directory with
the following:
version: '2'
services:
lando-ui:
environment:
- OIDC_DOMAIN=your personal auth0 domain with no http prefix
- OIDC_CLIENT_ID=your Auth0 Client ID (from the Client Settings page)
- OIDC_CLIENT_SECRET=your Auth0 Client Secret (from the Client Settings page)
- LANDO_API_OIDC_IDENTIFIER=the identifier you gave to the API you made (e.g. http://lando-api.test)
Restart the lando-ui service with docker-compose.
Visit http://lando-ui.test:7777/
in your browser. You should now be able to
use the lando-ui "Log in" and "Log out" buttons with your personal email
account.
You need to change some settings in the lando-api service to make the
Land button in lando-ui function. See the LOCALDEV_MOCK
environment variables in the lando-api docker-compose.yml for details.