new_pvk_tool

A new AMIV PVK tool using Eve and authenticating users with AMIVAPI.

Frontend

The frontend is build using mithril and uses the webpack build system.

In order to bundle all files and use the development server, you first need to install node andnpm.

Afterwards, you can use the following commands:

# Install dependencies and build system
npm install

# Start development server
# (As soon as its running, open `localhost:9000` in your browser)
npm start

# The development server reloads if you change anything, if it does not, use:
sudo npm start

# Check coding style
npm run lint

# Bundle files for production
npm run build

Backend

The backend is implemented using Eve, a python framework built on Flask that allows to create REST APIs with incredible ease (We use the same framework for AMIVAPI).

How to help developing

To get started, you should first check out the Eve Quickstart to get an idea about how the framework works. This should only take you around 10 minutes.

Afterwards, start with the file app.py to get into the PVK Tool code and keep the Eve and Flask docs at hand, if you need to look anything up.

If you add any features, don't forget to write tests! But don't worry, it's very easy to set them up -- take a look at the tests directory.

Running the tests locally

• First of all, you need MongoDB installed and running locally.

  Next, create the test user: Add the user pvk_user with password pvk_pass and readWrite permission to the pvk_test database.

  On Linux or similar, you can use this one-liner:

  mongo pvk_test --eval 'db.createUser({user:"pvk_user",pwd:"pvk_pass",roles:["readWrite"]});'

• Secondly, install tox (a python test automation tool), e.g. using pip install tox.

• Now you can run the tests from the Backend direcotry with:

  tox

  The tests itself are executed with py.test. You can pass any parameters to pytest afer two dashes, e.g. like this:

  tox -- -x

• Per default, integration tests with amivapi are skipped, since they require valid amivapi tokens.

  The api tests can be included by provide tokens for a user (not in the PVK Admins group) and an admin (in the PVK Admins group)

  # Replace <usertoken> and <admintoken> (including <>) with your tokens
  tox -- --usertoken <usertoken> --admintoken <admintoken>

  An easy way to aquire the tokens is curl:

  curl -X POST -Fusername <user> -Fpassword <pass> amiv-api.ethz.ch/sessions

Development server reset

We have a development server running. The script reset_development_server.py completely resets its data. (Everything gets deleted and re-created) Install requests (e.g. using pip install requests) to use it.