OpenStack Storage (Swift)
Go to file
Paul Dardeau 7f4139bc26 Added unit tests for ringbuilder command-line utility
Added new unit tests:

test_add_device_old_missing_region
test_create_ring_number_of_arguments
test_add_duplicate_devices
test_rebalance_with_seed
test_set_overload_number_of_arguments
test_main_no_arguments
test_main_single_argument
test_main_with_safe

Modified existing unit tests to create sample ring at start of test.
This change was needed to have unit tests run correctly and demonstrate
code coverage.

test_unknown
test_search_device_number_of_arguments
test_list_parts_number_of_arguments
test_set_weight_number_of_arguments
test_set_info_number_of_arguments
test_remove_device_number_of_arguments
test_set_min_part_hours_number_of_arguments
test_set_replicas_number_of_arguments
test_set_replicas_invalid_value

Updates to handled nested mocks.
Updates to handle no exception case when SystemExit is expected.
PEP8 corrections.

Moved new tests from try blocks to use of assertRaises or call to
run_srb using exp_results with specified exit codes.

Updated run_srb to accept a dictionary of expected results. Specifically,
look for 'valid_exit_codes' to test, default to (0,1).

Change-Id: I4cf3f5f055a9babba140c68a9c7ff90b9c50ea62
2015-11-11 15:09:40 +00:00
bin py3: Replace urllib imports with six.moves.urllib 2015-10-08 15:24:13 +02:00
doc Merge "Compare Swift config checksum in swift-recon --all" 2015-11-10 19:34:17 +00:00
etc Fix missing *-replicator conf sections in deployment guide 2015-10-23 14:58:38 +01:00
examples Add a user variable to templates 2013-09-17 11:46:04 +10:00
swift Merge "Compare Swift config checksum in swift-recon --all" 2015-11-10 19:34:17 +00:00
test Added unit tests for ringbuilder command-line utility 2015-11-11 15:09:40 +00:00
.alltests Script for running unit, func and probe tests at once 2015-10-13 09:10:09 +02:00
.coveragerc Fix .coveragrc to prevent nose tests error 2015-09-21 10:06:29 +01:00
.functests Move the tests from functionalnosetests 2014-01-07 15:58:11 +08:00
.gitignore more probe test refactoring 2015-02-13 16:55:45 -08:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 15:05:49 -04:00
.mailmap authors and changelog update for 2.5.0 2015-10-02 21:28:15 -07:00
.probetests Allow specify arguments to .probetests script 2013-12-24 01:18:19 -08:00
.unittests Fix coverage report for newer versions of coverage 2014-04-24 16:50:03 +00:00
AUTHORS authors and changelog update for 2.5.0 2015-10-02 21:28:15 -07:00
babel.cfg add pybabel setup.py commands and initial .pot 2011-01-27 00:01:24 +00:00
bandit.yaml Adding bandit for security static analysis testing in swift 2015-07-31 07:37:33 +05:30
CHANGELOG authors and changelog update for 2.5.0 2015-10-02 21:28:15 -07:00
CONTRIBUTING.md Add Swift Design Principles to CONTRIBUTING.md 2015-03-27 13:13:31 -04:00
LICENSE Convert LICENSE to use unix style line endings. 2012-12-19 12:48:27 -05:00
MANIFEST.in Add requirements files to the source distribution 2013-06-03 19:26:20 +04:00
README.md added testing notes to the contributing doc 2014-12-04 10:41:11 -05:00
requirements.txt On py3, use dnspython3 dependency, not dnspython 2015-11-05 15:56:24 +01:00
setup.cfg versioned writes middleware 2015-08-07 14:11:32 -04:00
setup.py taking the global reqs that we can 2014-05-21 09:37:22 -07:00
test-requirements.txt Merge "Adding bandit for security static analysis testing in swift" 2015-08-12 20:55:16 +00:00
tox.ini Enable H234 check (assertEquals is deprecated, use assertEqual) 2015-10-12 07:40:17 +00:00

Swift

A distributed object storage system designed to scale from a single machine to thousands of servers. Swift is optimized for multi-tenancy and high concurrency. Swift is ideal for backups, web and mobile content, and any other unstructured data that can grow without bound.

Swift provides a simple, REST-based API fully documented at http://docs.openstack.org/.

Swift was originally developed as the basis for Rackspace's Cloud Files and was open-sourced in 2010 as part of the OpenStack project. It has since grown to include contributions from many companies and has spawned a thriving ecosystem of 3rd party tools. Swift's contributors are listed in the AUTHORS file.

Docs

To build documentation install sphinx (pip install sphinx), run python setup.py build_sphinx, and then browse to /doc/build/html/index.html. These docs are auto-generated after every commit and available online at http://docs.openstack.org/developer/swift/.

For Developers

The best place to get started is the "SAIO - Swift All In One". This document will walk you through setting up a development cluster of Swift in a VM. The SAIO environment is ideal for running small-scale tests against swift and trying out new features and bug fixes.

You can run unit tests with .unittests and functional tests with .functests.

If you would like to start contributing, check out these notes to help you get started.

Code Organization

  • bin/: Executable scripts that are the processes run by the deployer
  • doc/: Documentation
  • etc/: Sample config files
  • swift/: Core code
    • account/: account server
    • common/: code shared by different modules
      • middleware/: "standard", officially-supported middleware
      • ring/: code implementing Swift's ring
    • container/: container server
    • obj/: object server
    • proxy/: proxy server
  • test/: Unit and functional tests

Data Flow

Swift is a WSGI application and uses eventlet's WSGI server. After the processes are running, the entry point for new requests is the Application class in swift/proxy/server.py. From there, a controller is chosen, and the request is processed. The proxy may choose to forward the request to a back- end server. For example, the entry point for requests to the object server is the ObjectController class in swift/obj/server.py.

For Deployers

Deployer docs are also available at http://docs.openstack.org/developer/swift/. A good starting point is at http://docs.openstack.org/developer/swift/deployment_guide.html

You can run functional tests against a swift cluster with .functests. These functional tests require /etc/swift/test.conf to run. A sample config file can be found in this source tree in test/sample.conf.

For Client Apps

For client applications, official Python language bindings are provided at http://github.com/openstack/python-swiftclient.

Complete API documentation at http://docs.openstack.org/api/openstack-object-storage/1.0/content/


For more information come hang out in #openstack-swift on freenode.

Thanks,

The Swift Development Team