Skip to content

sshpass install prompt (linux) and codestyle #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meepoSenpai wants to merge 3 commits into
base: master
Choose a base branch
from
Open

sshpass install prompt (linux) and codestyle #14

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f24fc7
deploy script will check if the programs are installed before prompti…
Feb 26, 2018
eb3a299
Added the update flag, so that freshmen could potentially update the …
Feb 26, 2018
dfded1c
Linux users should now also be prompted to install sshpass. And some …
Feb 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
245 changes: 172 additions & 73 deletions deploy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import os
import sys
import json
import shutil
import signal
import platform
import subprocess
Expand All @@ -32,11 +33,16 @@

# our imports
import tmuxify
from ip_check import *
from ip_check import ip_check

__author__ = 'Paul Genssler and Lutz Thies'
__copyright__ = 'Copyright (c) 2017'
__credits__ = ['Felix Döring', 'Paul Genssler', 'Lutz Thies', 'Felix Wittwer']
__credits__ = [
'Felix Döring',
'Paul Genssler',
'Lutz Thies',
'Felix Wittwer',
"Ian Alexander List"]

__license__ = 'MIT'
__version__ = '1.3.3'
Expand All @@ -46,10 +52,10 @@

# static global variables
ROBOLAB_SERVER = 'http://robolab.inf.tu-dresden.de/files/'
home = os.path.dirname(os.path.abspath(__file__))
src_path = os.path.join(os.path.abspath(os.path.join(home, os.pardir)), 'src')
settings_path = os.path.join(home, '.bin', 'settings.json')
bin_path = os.path.join(home, '.bin')
HOME = os.path.dirname(os.path.abspath(__file__))
SRC_PATH = os.path.join(os.path.abspath(os.path.join(HOME, os.pardir)), 'src')
SETTINGS_PATH = os.path.join(HOME, '.bin', 'settings.json')
BIN_PATH = os.path.join(HOME, '.bin')
settings = dict()


Expand All @@ -58,57 +64,63 @@ class Windows:
def __init__(self, settings):
self.ip = settings['ip']
self.password = settings['password']
self.pscp = os.path.join(bin_path, 'pscp.exe')
self.putty = os.path.join(bin_path, 'putty.exe')

# check for pscp
if not os.path.exists(self.pscp):
url = ROBOLAB_SERVER + 'pscp.exe'
with urllib.request.urlopen(url) as download,\
open(self.pscp, 'wb') as file:
file.write(download.read())

# check for putty
if not os.path.exists(self.putty):
url = ROBOLAB_SERVER + 'putty.exe'
with urllib.request.urlopen(url) as download,\
open(self.putty, 'wb') as file:
file.write(download.read())
self.pscp = os.path.join(BIN_PATH, 'pscp.exe')
self.putty = os.path.join(BIN_PATH, 'putty.exe')

# check for the backup command
self.backupfile = os.path.join(bin_path, 'backup.txt')
self.backupfile = os.path.join(BIN_PATH, 'backup.txt')
if not os.path.exists(self.backupfile):
with open(self.backupfile, 'w') as new_backup:
new_backup.write(raw_backup.format(''))

# check the file containing the command that will be executed
self.execfile = os.path.join(bin_path, 'exec.txt')
self.execfile = os.path.join(BIN_PATH, 'exec.txt')
with open(self.execfile, 'w') as new_exec:
new_exec.write(tmuxify.build_call(settings['password']))

@staticmethod
def backup():
subprocess.call([os.path.join(bin_path, 'putty.exe'), '-pw',
subprocess.call([os.path.join(BIN_PATH, 'putty.exe'), '-pw',
settings['password'], '-ssh',
'robot@{}'.format(settings['ip']), '-m',
os.path.join(bin_path, 'backup.txt'), '-t'])
os.path.join(BIN_PATH, 'backup.txt'), '-t'])
print('Done')

@staticmethod
def copy_files():
subprocess.call([os.path.join(bin_path, 'pscp.exe'), '-pw',
settings['password'], '-r', src_path,
subprocess.call([os.path.join(BIN_PATH, 'pscp.exe'), '-pw',
settings['password'], '-r', SRC_PATH,
'robot@{ip}:/home/robot/'.format(ip=settings['ip'])])
print('Done')

@staticmethod
def execute():
subprocess.call([os.path.join(bin_path, 'putty.exe'), '-pw',
subprocess.call([os.path.join(BIN_PATH, 'putty.exe'), '-pw',
settings['password'], '-ssh',
'robot@{}'.format(settings['ip']), '-m',
os.path.join(bin_path, 'exec.txt'), '-t'])
os.path.join(BIN_PATH, 'exec.txt'), '-t'])
print('Done')

@staticmethod
def install():
check_internet()
pscp = os.path.join(BIN_PATH, 'pscp.exe')
putty = os.path.join(BIN_PATH, 'putty.exe')

# check for pscp
if not os.path.exists(pscp):
url = ROBOLAB_SERVER + 'pscp.exe'
with urllib.request.urlopen(url) as download,\
open(pscp, 'wb') as file:
file.write(download.read())

# check for putty
if not os.path.exists(putty):
url = ROBOLAB_SERVER + 'putty.exe'
with urllib.request.urlopen(url) as download,\
open(putty, 'wb') as file:
file.write(download.read())


class Unix:

Expand All @@ -117,17 +129,63 @@ def __init__(self, settings):
self.password = settings['password']

# check for backup.sh
self.backupfile = os.path.join(bin_path, 'backup.sh')
self.backupfile = os.path.join(BIN_PATH, 'backup.sh')
if not os.path.exists(self.backupfile):
with open(self.backupfile, 'w') as new_backup:
new_backup.write(raw_backup.format('#!/usr/bin/env bash\n\n'))

@staticmethod
def backup():
with open(os.path.join(BIN_PATH, 'backup.sh'), 'r') as backupinput:
subprocess.call([
'sshpass',
'-p',
settings['password'],
'ssh',
'-o',
'StrictHostKeyChecking=no',
'robot@{}'.format(settings['ip']),
'bash'
],
stdin=backupinput
)
print('Done')

@staticmethod
def copy_files():
try:
subprocess.call([
'sshpass',
'-p',
settings['password'],
'scp',
'-o',
'StrictHostKeyChecking=no',
'-r',
os.path.join(SRC_PATH),
'robot@{}:/home/robot/'.format(settings['ip'])
])
except OSError:
Unix.install()
Unix.copy_files()
print('Done')

@staticmethod
def execute():
subprocess.call(['sshpass', '-p', settings['password'],
'ssh','robot@{}'.format(settings['ip']), '-t',
tmuxify.build_call(settings['password'])])
print('Done')

@staticmethod
def install():
check_internet()
# check for sshpass
try:
with open(os.devnull, 'w') as devnull:
subprocess.call(['sshpass', '-V'], stdout=devnull)
except FileNotFoundError:
if settings['os'] == 'Darwin':
if "darwin" in sys.platform:
try:
print('Installing sshpass')
with open(os.devnull, 'w') as devnull:
Expand All @@ -141,48 +199,41 @@ def __init__(self, settings):
(http://brew.sh)')
sys.exit(1)
else:
print('''Please install sshpass

with apt-get:
sudo apt-get install sshpass
pacmans = {
'yum': ['yum', 'install'],
'apt-get': ['apt-get', 'install'],
'pacman': ['pacman', '-S']
}
pacman_found = False
for pacman in pacmans.keys():
try:
with open(os.devnull, 'r') as devnull:
subprocess.call([pacmans[pacman][0], '-h'],
stdout=devnull)
subprocess.call([
'sudo',
pacmans[pacman][0],
pacmans[pacman][1],
'sshpass'
])
pacman_found = True
except OSError:
continue
if not pacman_found:
print("Your package manager was not found.")
print("Please manually install sshpass and rerun the deploy script")
sys.exit(1)

Further information:
https://gist.github.com/arunoda/7790979''')
sys.exit(1)

@staticmethod
def backup():
with open(os.path.join(bin_path, 'backup.sh'), 'r') as backupinput:
subprocess.call(['sshpass', '-p', settings['password'], 'ssh', '-o',
'StrictHostKeyChecking=no', 'robot@{}'.format(
settings['ip']), 'bash'],
stdin=backupinput)
print('Done')

@staticmethod
def copy_files():
subprocess.call(['sshpass', '-p', settings['password'], 'scp', '-o',
'StrictHostKeyChecking=no', '-r',
os.path.join(src_path),
'robot@{}:/home/robot/'.format(
settings['ip'])])
print('Done')

@staticmethod
def execute():
subprocess.call(['sshpass', '-p', settings['password'],
'ssh','robot@{}'.format(settings['ip']), '-t',
tmuxify.build_call(settings['password'])])
print('Done')


def main(copy=True, backup=False):
# get the settings or create new ones
global settings
if not os.path.exists(settings_path):
if not os.path.exists(SETTINGS_PATH):
first_start()
with open(settings_path) as file:
settings = json.load(file)
with open(SETTINGS_PATH) as s_file:
settings = json.load(s_file)

# get the platform specific routines
print('Remembered OS is', settings['os'])
Expand All @@ -202,24 +253,37 @@ def main(copy=True, backup=False):
system.execute()


def check_internet():
try:
urllib.request.urlopen("http://google.com", timeout=1)
except urllib.request.URLError:
print("You will need to be connected to the internet!")
print("Please ensure an internet connection to download")
print("the essential tools and press Enter to proceed...")
input()


def first_start():
"""
Asks the user for necessary information and stores it
"""
global settings
Windows.install() if "win" in sys.platform else Unix.install()
init_dict = dict()
init_dict['os'] = platform.system()
init_dict['ip'] = ip_check()
init_dict['password'] = getpass('Enter the password of the "robot" user: ')
# create paths and dump the data
os.makedirs(os.path.join(bin_path), exist_ok=True)
with open(settings_path, 'w') as dump_file:
os.makedirs(os.path.join(BIN_PATH), exist_ok=True)
with open(SETTINGS_PATH, 'w') as dump_file:
json.dump(init_dict, dump_file, indent=4)


def abort(signal, frame):
print('\rJob canceled by user!')
sys.exit(0)


signal.signal(signal.SIGINT, abort)

raw_backup = '''{}if [ ! -d ~/src ]
Expand All @@ -238,20 +302,55 @@ def abort(signal, frame):


if __name__ == '__main__':
os.chdir(home)
os.chdir(HOME)
print('RoboLab deploy script', 'v.' + __version__)
parser = argparse.ArgumentParser()
parser.add_argument(
'-c', '--configure', help='reset and create new configuration', action='store_true')
'-c',
'--configure',
help='reset and create new configuration',
action='store_true'
)
parser.add_argument(
'-e', '--execute-only', help='do not copy files', action='store_false', default=True)
'-e',
'--execute-only',
help='do not copy files',
action='store_false',
default=True
)
parser.add_argument(
'-b', '--backup', help='backup files on the brick', action='store_true', default=False)
'-b',
'--backup',
help='backup files on the brick',
action='store_true',
default=False
)
parser.add_argument(
'-U',
'--update',
help='Reload the robolab-deploy',
action='store_true',
default=False
)
args = parser.parse_args()

print('If you need to change the IP address or password, please run\n\
./deploy.py -c')

if not args.update:
main(copy=args.execute_only, backup=args.backup)
else:
for file in os.listdir(os.getcwd()):
filepath = os.path.join(os.getcwd(), file)
if os.path.isfile(filepath):
os.remove(filepath)
else:
shutil.rmtree(filepath)
os.chdir(os.getcwd() + "/../")
os.execv(
sys.executable,
["python3"] + [(str(os.getcwd()) + "/deploy.py")]
)

if args.configure:
first_start()
main(copy=args.execute_only, backup=args.backup)