Welcome to Glusto’s documentation!

Glusto is a framework designed to provide features commonly used in a remote/distributed environment via a single and easy-to-access object.

It started out as a port of some shell ssh functions I had written and was meant for use in PyUnit* tests and config scripts for Gluster.

I’ve removed the Gluster specifics from this package. Feel free to give it a go, and please let me know how it works out.

Some of the key concepts and features of Glusto:

• Glusto inherits from multiple classes providing configuration (yaml, json, ini), remote connection (SSH, SCP, RPyC), ANSI color output, logging, and unit test functionality (PyUnit, PyTest, Nose)–presenting them in a single global Class object.
• Glusto also acts as a global class for maintaining state and configuration data across multiple modules and classes.
• Glusto provides a wrapper utility (/usr/bin/glusto) to help make configuration files available to test cases from the command-line.

Adding Glusto utilities to a Python module is as simple as an import.

Example:

To use Glusto in a module:

from glusto.core import Glusto as g

Note

It is no longer necessary to say “Glusto Importo!” out loud before executing scripts using the Glusto module. The import statement is more than sufficient.

User Guide

Table of Contents

• Installing Glusto
  • Installing Glusto Directly from Git via Pip
  • Uninstalling
  • Using Glusto via Docker
  • Cloning the Glusto Github Repo
  • Installing Glusto from a Git Clone
• Configuring Glusto
• Using Glusto
  • Using Glusto in a Module
  • Using Glusto via the Python Interactive Interpreter
  • Using the Glusto CLI Utility
    • Options for Running Unit Tests
• Working With Remote Systems
  • Passwordless SSH with Keys
    • Configuring Glusto to Use Specific Keys
  • Run a Single Command via SSH
  • Run a Single Command on the Localhost
  • Run a Command on More than One Host
    • Run a Command Serially on Multiple Servers
    • Run a Command in Parallel
    • Run a Command Asynchronously
  • Transferring Files To and From Remote Systems
    • Uploading a File
    • Downloading a File
    • Transferring a File from Remote to Remote
  • Listing SSH Connections
  • Closing Connections
    • Closing a Connection
    • Close All Connections
• Using RPyC
  • Passwordless Connections
  • Setting up Connections
    • Setting up a Single Connection
    • Listing Connections
    • Setting up a Connection with a Specific User
    • Setting up Multiple Connections with Different Users
    • Setting up Multiple Connections with the Same User
  • Making RPyC Calls
    • Using the Connection
    • Asynchronous RPyC Calls
  • Running Local Code on the Remote System
  • Going Ape with Monkey-Patching
    • Monkey-patching Standard Out
    • Re-wiring Local and Remote
  • Checking Connections
  • Closing Connections
    • Closing a Single Connection
    • Closing All Connections
  • Undeploying the RPyC Server
• Using Config Files with Glusto
  • Loading Config Files
    • Loading Config Files From the Local Filesystem
    • Loading Config Files from a URL
  • Setting the Glusto Config Dictionary with a Config File
  • Updating the Glusto Config Dictionary with a Config File
  • Displaying Objects in Config File Format
  • Storing Objects in Config File Format
    • Creating an INI Config Format Compatible Object
  • Loading Config from a String
  • Adding Simple Configuration Capability to Your Own Class
    • Making a Class Configurable
    • Displaying the Class Config
    • Loading Config from a File into Class Attributes
    • Storing Attributes of an Instance to File
• Handling Logging with Glusto
  • Default Logging
  • Setting up Logging
  • Sending a Log Event
  • Sending Log Events to Multiple Logfiles
  • Show the Logfiles Attached to a Specific Logger
  • Removing a Log
  • Changing the Level of an Existing Log Handler
  • Changing the Filename of an Existing Log Handler
  • Clearing a Log
  • Temporarily Disable Logging
  • Logging with Color Text
    • Changing the Color of a String
    • Changing the Background Color of a String
    • Changing an ANSI Attribute of a String
    • Combining Colors and Attributes
    • Send Color Text to the Log
    • Enabling Color Logging for Built-In Commands
    • Available Color Values
• Handling Templates with Glusto
  • Create a File from a Template
  • The Template File
  • Template Variables
    • Providing Vars Programmatically
    • Providing Vars in a Config File
  • A Bit About Search Path
• PyUnit (unittest) and Glusto
  • Running Unittests with Glusto
    • Running Unittests via the Python Interpreter Interactive Mode
    • Running Unittests with the CLI Option
    • Running Tests in a Specific Order
    • Running Unittests with the Configuration Options
  • Configuring Glusto for Unittests
    • Base Unittest Options
    • Discover Tests from a Directory
    • Load Tests from a List
    • Load Tests from a Module
    • Load Tests from a Module with Ordered Test List
    • Load a Test Using a Name
    • Load Tests from a List of Names
  • Writing Unittests
    • Example Using setUp and tearDown
    • Example Using setUpClass and tearDownClass
  • To Do
• PyTest and Glusto
  • Running PyTests from the CLI
  • Running PyTest from Python Interactive Interpreter
  • To Do
• Nose and Glusto
  • Running Nosetests from the CLI
  • Running Nosetests from Python Interpreter
  • To Do
• Working with PyTest and Nose
  • PyTest
  • Nose
  • Glusto for Good Measure
  • To Do
• Dynamic Cartesian Product Test Case Creation
  • Using Carteplex
    • An Example Config File
    • Subclassing the CarteTestClass Decorator Class
    • Creating a Custom unittest.TestCase Subclass
    • Using the Decorator
    • Run the Tests
    • ToDo
• Glusto Simple REST Client
  • Making REST API Requests
    • Making a GET Request
    • Making a POST Request
    • Making a PUT Request
    • Making a DELETE Request
  • Handling the Request Response
    • Using the Request Response as Config
• To Do

API

• glusto package
  • Submodules
  • Module contents

Indices and tables

• Index
• Module Index
• Search Page