Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 3.07 KB

dev_and_test_guide.rst

File metadata and controls

58 lines (42 loc) · 3.07 KB
Raw

Development and Testing

This guide explains how to build the various components, and how to deploy them once built. Note that some of the components being built need to be inserted to a docker image before they can be tested. Thus, once should have an installed environment (see <https://github.com/Open-I-Beam/swift-storlets/blob/master/doc/source/storlets_installation_guide.rst>) before proceeding with the test and deploy steps (which are in fact a subset of the installation steps).

Building

The repo consists of code written in Python, Java and C. We have chose ant to serve as a 'make' tool for all code. The main build task in build.xml is dependent on two other build tasks:

  1. build_storlets task, used above. This task builds all the sample storlets used in the system tests.
  2. build engine task, used for building/packaging the following components:
  1. The storlet middleware and the storlet docker gateway python code. These are build as two packages in a single 'storlets' egg:
  • storlet_middleware
  • storlet_gateway
  1. The SBus code. This is the communication module between the gateway and the Docker container. It has a transport layer written in "C" and 'bindings' to both Java and Python.
  2. The Python written storlet_factory_daemon, which is packaged for installation in a Docker image
  3. The Java SDaemon code, which is the daemon code that loads the Storlets in run time. This code is compiled to a .jar that is later installed in the Docker image.
  4. The Java SCommon code, which has the Storlet interface declaration, as well as the accompanying classes appearing in the interface. This code is copiled to a .jar that is required both in the Docker image as well as for building Storlets.

Deploying

Two additional tasks of interest in our build.xml are the deploy_host_engine and deploy_container_engine. These tasks are based on the Ansible installation scripts and do the following:

  1. deploy_host_engine would get all the code that is relevant to the host side (python middleware and SBus) and deploy it on the hosts, as described in Deploy/playbook/hosts file
  2. deploy_container_engine, would create an updated image of the tenant defined in Deploy/playbook/common.yml and distribute it to all nodes as defined in Deploy/playbook/hosts. Typically, the hosts file will describe an all-in-one type of installation.

Running the Tests

Other than testing, those tests are a good reference for writing and deploying storlets. To run the system tests follow the next steps:

  1. cd to the repo root
  2. run 'ant build_storlets'
  3. cd to SystemTests
  4. Edit the file sys_test_params.py and make sure that the following variables match the installation. If you have used the storlets all-in-one installation, this is already taken care of.
  • DEV_AUTH_IP - The IP of the Keystone authentication endpoint
  • ACCOUNT - The name of the account created for Storlets
  • USER_NAME - The user name created for the account
  • PASSWORD = The above user password
  1. run 'python sys_test.py'