interactive.py
For running Bladerunner interactively.
This file is part of Bladerunner.
Copyright (c) 2014, Activision Publishing, Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of Activision Publishing, Inc. nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
class bladerunner.interactive.BladerunnerInteractive(bladerunner, server)[source]
A class to run a Bladerunner session one command at a time.
Args:
bladerunner: a Bladerunner base object to inherit options from
server: string hostname or IP address to connect to
-
connect(status_return=False)[source]
Initializes the ssh connection object(s).
- Args:
- status_return: boolean to return a status boolean of login success
- Returns:
- False if no connection could be made
-
connect_threaded(callback=None)[source]
Non-blocking call to start a thread for the initial connection.
- Returns:
- a started thread object, running self.connect()
-
end()[source]
End the interactive session.
-
log(message)[source]
Mock “logging”, prints to stdout if debug is set.
-
run(command)[source]
Run the command on the server.
- Returns:
- string results of the command
-
run_threaded(command, callback=None)[source]
Non-blocking call which creates and starts a thread for self.run().
- Args:
- command: string command to send through the interactive session
- Returns:
- a thread object, may need to initially connect to send the command