c91e2932aa
This patch achieves three interrelated changes 1. an update to the ClientInterface, making it more efficient and consistent with other HTTP libraries. PSR-FIG messages have also been added as separate classes, rather than lumped as one. Guzzle functionality has also been moved to its own namespace; 2. the refactoring of `GuzzleClient` to `GuzzleAdapter`, including relevant changes needed for the interface change (1). We now have ADAPTERS that bridge our interfaces with Guzzle's - making that difference much clearer, extensible, less tightly coupled and less brittle; 3. moving "bad request" error handling into its own dedicated space, based on how the new Adapter functionality (2). Previously the client tried to do all the exception logic - but this is not strictly its responsibility. This logic has been shipped out to a base RequestException which instantiates one of its children exception based on the HTTP status code. Although I have attempted to keep the scope of this patch to a minimum, as granular as possible, because the interface is a core internal API, various other files need to be modified to reflect the change. In terms of the other two changes, these are inextricably linked to the interface change, so cannot be teased out into their own patches. Change-Id: Ibc1b50cec125c11d32ee6e4f0dbb395fcaea864e
Running Tests for the PHP-Client bindings
This file explains how to configured your environment for running the PHP-Client automated testing.
The OpenStack bindings offer a few stand-alone tests for testing basic connectivity to OpenStack services, but most tests are of the automated variety.
IMPORTANT: Make sure your settings.ini file is up-to-date! Options have changed!
Stand-alone Tests
Stand-alone tests are designed to verify that certain preconditions of the libary are met.
AuthTest.php
The AuthTest test is a simple commandline program that allows you to verify that your PHP client can successfully connect to OpenStack. To run this test, do the following:
- Begin from the root directory of this project, where you should see
the directories
tests/andsrc/, among others. - Execute the following command on the commandline:
$ php tests/AuthTest.php
This will instruct you to use a more complete version of the command, including:
- USERNAME: The username given to you.
- PASSWORD: The password associated with the username.
- URL: The Endpoint URL.
- TENANT ID: Your users's tenant ID.
All four pieces of information can be found by logging into the console. From there, you can execute a command like this:
$ php tests/AuthTest.php myusername apassword https://region-a.geo-1.identity.hpcloudsvc.com:35357/v2.0/ 1234567
If successfull, it should return details about your username, token, and the services in your service catalog.
Unit Tests
Unit and behavioral tests are built using PHPUnit. Before you can test this package, you will need to install that tool.
Next, you need to create your own settings.ini file to contain your HP
Cloud credentials, along with your preferred testing parameters.
Creating settings.ini
The easiest way to do this is to copy the example settings file, and then make the necessary changes:
$ cd tests/
$ cp example.settings.ini settings.ini
$ edit settings.ini
Running Tests
The test suite uses PHPUnit and can generate a code coverage report if
xdebug is installed. To run the test suite make sure PHPUnit is installed
via composer by using composer install or composer update. Once PHPUnit is
installed execute the following command from the root of the project.
$ ./vendor/bin/phpunit
This should generate output looking something like this:
PHPUnit 4.0.13 by Sebastian Bergmann.
Configuration read from /path/to/openstack-sdk-php/phpunit.xml.dist
............................................................... 63 / 146 ( 43%)
............................................................... 126 / 146 ( 86%)
....................
Time: 4.94 minutes, Memory: 17.50Mb
OK (146 tests, 413 assertions)
Generating code coverage report in Clover XML format ... done
Generating code coverage report in HTML format ... done
If the tests fail, detailed information about the failure will be displayed.
PHPUnit has a wide variety of commandline options. Other sorts of reports and analyses can be done using those.
Writing Tests
Tests should be written according to the PHPUnit documentation. Tests should follow the same coding standards as all other parts of the library.