Gluu-Passport Blackbox Testing

Goal

• Automate tests for all the passport flows

How we do it

Creating a stage environment like:

Starting

Clone this reppo to your test server / CI server

Setup

Setting up provider (idp/op) droplet

@TODO

Setting up passport droplet

• Setup your SP static IP (you need a static ip reserved, preffered a floating_ip) and host name

  • In the project root:

    vim setup/setup.properties
    

  • Locate the line with ip=
  • Update with the static IP address
  • Locate the line with hostname=
  • Update with your passport hostname

• Edit setup/templates/passport-central-config.json to configure your passport SPs

• In case you want certificates (recommended):

  • run:

    certbot --apache --agree-tos --force-renewal -m [email protected] -n -d <passporthost>
    

    (replace passporthost for your passport host, i.e. test.gluu.org)
  • compress etc/letsecrypt

    tar -czvf etcletsencrypt.tar /etc/letsencrypt
    

    (so you will have etcletsencrypt.tar in your setup folder)

• On a fresh droplet, create folder test-install-data:

ssh <yourhost> mkdir /test-install-data

• Copy files from setup folder to test-install-data that you just created on your fresh droplet:

scp -r ./setup/* <your-host>:/test-install-data/.

• Login to your droplet and run the prepare.sh file:

cd /
chmod -R 755 test-install-data
cd /test-install/data
./prepare.sh

• Check if flag file freshsnap was created:

ls /root

Starting test server

Just restart (shutdown -r) and gluu-server will be installed w/ testing-data. Follow it on /test-data/gluu.log

Configuration

Use test.conf for configuration. You can pass any file by using option -c <file>.

Configuration details are as given below:

Env	Description
PASSPORT_HOST	Use to set Host for Passport Droplet
PASSPORT_IP	Use to set floating IP for Passport Droplet
LATEST_DEV_SNAPSHOT_ID	It is Dev Passport Snapshot Id from which you want to create droplet for Passport
LATEST_STABLE_SNAPSHOT_ID	It is Stable Passport Snapshot Id from which you want to create droplet for Passport
PROVIDER_HOST	Use to set Host for SAML IDP Provider Droplet
PROVIDER_IP	Use to set floating IP for SAML IDP Provider Droplet
PROVIDER_SNAPSHOT_ID	It is SAML IDP Provider Snapshot Id from which you want to create droplet for SAML IDP Provider
CLIENT_HOST	It is use to set Host for Request Party Client i.e. auth-tdd-client
API_CLIENT_ID	Providers' gluu-server Admin REST API client_id (used for automated user creation/deletion)
API_CLIENT_SECRET	Providers' gluu-server Admin REST API client_secret (used for automated user creation/deletion)

Setting up test suite

Install Xvfb sudo apt install xvfb

Install poetry if you don't have: curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

Install dependencies: poetry install

If you don't have, install Firefox: apt install firefox

Setup ENV on env.sh file

run poetry run env.sh

Options

You can run env.sh with skip options:

• -s: skip droplet creation
• -t: skip tests
• -c <file>: Pass configuration file

Test logs / artifacts

Test Server will collect logs through ssh (ensure you have authorized test server to connectPROVIDER_HOST and PASSPORT_HOST through ssh)

Logs (such as idp-process.log, passport.log, oxauth_script.log, etc) will be stored ar server_artifacts/provider and server_artifacts/passport so they can be analyzed when needed. (i.e. to dig in a failing test case).

Your CI may handle to fetch and/or publish artifacts from this folder.

TO BE

In the near future

This is a nice milestone...