System Variable usage tutorial

[thiagonobrega]

This task intends to provide a simple tutorial to the hyperdrive team on the usage of System Variable.

[thiagonobrega]

All HyperDrive config parameters must be implemented considering the system variables. For example, if we want to turn on the validation for the external URL, we must use a system variable to check which validation method the system admin intends to use.

In the example above, the HyperDrive must use the HYPERDRIVE_URL_VALIDATION variable. The usage of system variables depends on the dev OS. The following commands illustrate how to set system variables in different OS:

In windows:

>$ env:HYPERDRIVE_URL_VALIDATION="BASIC"

In linux:

$ export HYPERDRIVE_URL_VALIDATION=BASIC

How to access system variable

To access the system variable, use the os module.

import
os.environ['HYPERDRIVE_URL_VALIDATION']

It is important to mention that the export variable must be executed in the same terminal of the testing environment. For example, the following command starts the Hyperdrive in a Linux system.

$ cd hyperdrive
$ pip install -r requirements
$ cd app
$ export HYPERDRIVE_URL_VALIDATION=BASIC
$ python api_server.py

Notice that the export HYPERDRIVE_URL_VALIDATION=BASIC is invoked before the server.

The Docker version do not consider system variables.