Write setup script linux (#825)

* Mac setup created

structure of the setup for mac has been implemented, now it just needs debugging and testing to make sure it works.

* Script fixes

fixed some issues surround certain command within the mac setup not working. These should have been fixed now.

* added Documentation

added comments and documentation for the script and it's functions, along with some warnings about use.

* pep8

* Minor fix to yarn command

added a new way of doing the frontend dependencies part of the setup that should solve the unreliability issue.

* pep8++

* pep8++

* Structured linux setup script & minor changes to mac script

written the structure of the linux/ubuntu setup script. There are some additional checks that need to be implemented at some point, like checking if they're using something other than an AMD or intel cpu.

* Testing on Linux & minor-ish changes.

* Minor changes

finished the changes needed from the testing on linux.  The script now installs aimmo on ubuntu, in future this may needed to be expanded to cover other linux distributions. But for now this is fine.

* Minor changes++

* pep8

* pep8++ with small refactor

code has been refactored to hopefully make it easier to understand and to resolve pep8 issues.

* grammar fix in prints

* Major refactor

After some discussion and some pep8 related warnings, i went for a major refactor of the script in terms of it's structure to make it less complex, and hopefully further improve readability.

* More refactor changes

* pep8

* Minor changes

* Minor fix

fixed nodejs not always working

* Fixed dpkg-query not working

* Fixed get_nodejs()

* Removed redundant code and minor fixes

* minor changes

* Minor changes + spelling corrections.

* Whitespace + grammar

aimmo_setup.py

@@ -0,0 +1,333 @@
+import platform
+import subprocess
+import traceback
+
+from subprocess import PIPE, CalledProcessError
+
+
+# First we find and store the OS we are currently on, 0 if we didn't figure out which one
+hostOS = 0
+OStypes = {
+    "mac": 1,
+    "windows": 2,
+    "linux": 3
+}
+valid = {"yes": True, "y": True, "ye": True, "no": False, "n": False}
+
+
+def _cmd(command):
+    '''
+    :param command: command/subprocess to be run, as a string.
+
+    Takes in a command/subprocess, and runs it as if you would
+    inside a terminal. DO NOT USE outside of the AI:MMO-setup script, and DO NOT INCLUDE
+    in any release build, as this function is able to run bash scripts, and can run commands
+    with sudo if specified.
+    '''
+
+    p = subprocess.Popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE, shell=True)
+    (_, _) = p.communicate()
+
+    if p.returncode != 0:
+        raise CalledProcessError
+
+
+def install_yarn(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing Yarn...')
+    if operatingSystem == OStypes['mac']:
+        _cmd('brew install yarn')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('sudo apt-get install yarn')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_pipenv(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing pipenv...')
+    if operatingSystem == OStypes['mac']:
+        _cmd('brew install pipenv')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('pip install pipenv')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_docker(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing Docker...')
+    if operatingSystem == OStypes['mac']:
+        _cmd('brew cask install docker')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('sudo apt-get install docker-ce')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_virtualbox(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing Virtualbox...')
+    if operatingSystem == OStypes['mac']:
+        _cmd('brew cask install virtualbox')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('sudo apt-get install virtualbox')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_minikube(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing minikube...')  # If minikube version changes this will need updating
+    if operatingSystem == OStypes['mac']:
+        _cmd('curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.25.2/minikube-darwin-amd64')
+        _cmd('chmod +x minikube')
+        _cmd('sudo mv minikube /usr/local/bin/')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('curl -Lo minikube https://storage.googleapis.com/minikube/releases/v0.25.2/minikube-linux-amd64')
+        _cmd('chmod +x minikube')
+        _cmd('sudo mv minikube /usr/local/bin/')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_kurbernetes(operatingSystem):
+    '''
+    :param operatingSystem: values from the OStypes dict. (Should be updated to enum once python 3 is available)
+
+    OS dependant, so it must be passed to this function in order to run correctly.
+    '''
+    print('Installing Kubernetes...')  # If kubernetes version changes this will need updating
+    if operatingSystem == OStypes['mac']:
+        _cmd('curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.9.4/bin/darwin/amd64/kubectl')
+        _cmd('chmod +x kubectl')
+        _cmd('sudo mv kubectl /usr/local/bin/')
+    elif operatingSystem == OStypes['linux']:
+        _cmd('sudo snap install kubectl --classic')
+    elif operatingSystem == OStypes['windows']:
+        pass
+    else:
+        raise Exception
+
+
+def install_pip():  # Linux only
+    print('Installing pip...')
+    _cmd('sudo apt-get install python-pip')
+
+
+def install_snap():  # Linux only
+    print('Installing snap...')
+    _cmd('sudo apt install snapd')
+
+
+def install_nodejs():  # Linux only
+    print('Installing Nodejs...')
+    _cmd('sudo apt-get install -y nodejs')
+
+
+def run_pipenv_install():  # OS independent
+    print('Running "pipenv install"...')
+    _cmd('pipenv install')
+
+
+def set_up_frontend_dependencies():  # Mac & Linux only
+    print('Setting up frontend dependencies...')
+    _cmd('cd ./game_frontend | sudo yarn')
+
+
+def check_homebrew():  # Mac only
+    _cmd('brew -v')
+    print('Homebrew Found...')
+
+
+def check_for_cmdtest():  # Linux/Ubuntu only
+    '''
+    This function is for use within the Linux setup section of the script. It checks if
+    the cmdtest package is installed, if it is we ask the user if we can remove it, if yes
+    we remove the package, if not the process continues without removing it.
+    '''
+    p = subprocess.Popen("dpkg-query -W -f='${status}' cmdtest", shell=True, stdout=PIPE)
+    (stdout, _) = p.communicate()
+    if 'unknown' not in stdout:
+        print('Looks like cmdtest is installed on your machine, this can cause issues when installing Yarn.')
+
+        answer = False
+        answered = False
+        while not answered:
+            choice = raw_input('Is it okay if I remove cmdtest? [y/n]').lower()
+            if choice in valid:
+                answer = valid[choice]
+                answered = True
+            else:
+                print("Please answer 'yes' or 'no' ('y' or 'n').")
+        if answer:
+            print('Removing cmdtest...')
+            _cmd('apt-get remove cmdtest')
+        else:
+            print('Continuing without removing cmdtest...')
+
+
+def update_apt_get():  # Linux only
+    print('Updating apt-get...')
+    _cmd('sudo apt-get update')
+
+
+def get_nodejs():  # Linux only
+    print('Getting Nodejs...')
+    _cmd('curl python-software-properties | sudo apt-get install')
+    _cmd('curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -')
+
+
+def add_aimmo_to_hosts_file():  # Mac & Linux only
+    with open("/etc/hosts", "r") as hostfile:
+        data = hostfile.read().replace('\n', '')
+    if "192.168.99.100 local.AI:MMO.codeforlife.education" not in data:
+        print('Adding AI:MMO to /etc/hosts...')
+        _cmd("sudo sh -c 'echo 192.168.99.100 local.aimmo.codeforlife.education >> /etc/hosts'")
+    else:
+        print('AI:MMO already present in /etc/hosts...')
+
+
+def add_parcel_bundler():  # Mac & Linux only
+    print('Adding parcel-bundler globally...')
+    _cmd('yarn global add parcel-bundler')
+
+
+def configure_yarn_repo():  # Linux only
+    print('Configuring Yarn repository...')
+    _cmd('curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -')
+    _cmd('echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list')
+
+
+def mac_setup(hostOS):
+    '''
+    Runs the list of commands, sequentially, needed in order to set up AI:MMO for a Mac.
+    After this has been run the user needs to open Docker to finalise its install,
+    and get the unity package for AI:MMO from AI:MMO-unity.
+    '''
+    try:
+        check_homebrew()
+        install_yarn(hostOS)
+        add_parcel_bundler()
+        set_up_frontend_dependencies()
+        install_pipenv(hostOS)
+        run_pipenv_install()
+        install_docker(hostOS)
+        install_virtualbox(hostOS)
+        install_minikube(hostOS)
+        install_kurbernetes(hostOS)
+
+        print('---------------------------------------------------------------------------------------------------')
+        print("| You now need to get the unity package from the AI:MMO-unity repo, place its contents            |")
+        print('| in aimmo/aimmo/static/unity.  (folder may not exist yet)                                        |')
+        print('| You may also need to open docker, just to finalise the install.                                 |')
+        print('---------------------------------------------------------------------------------------------------')
+        print('| Everything should now be ready for you to use AI:MMO! :D                                        |')
+        print('---------------------------------------------------------------------------------------------------')
+
+    except CalledProcessError as e:
+        print('A command has return an exit code != 0, so something has gone wrong.')
+        traceback.print_exc()
+    except OSError as e:
+        print("Tried to execute a command that didn't exist.")
+        traceback.print_exc()
+    except ValueError as e:
+        print('Tried to execute a command with invalid arguments.')
+        traceback.print_exc()
+    except Exception as e:
+        print("Something went very wrong, maybe I couldn't read hosts? otherwise I have no idea what it was D:")
+        traceback.print_exc()
+
+
+def windows_setup(hostOS):
+    pass
+
+
+def linux_setup(hostOS):
+    try:
+        update_apt_get()
+        get_nodejs()
+        install_nodejs()
+        check_for_cmdtest()
+        configure_yarn_repo()
+        install_yarn(hostOS)
+        add_parcel_bundler()
+        install_pip()
+        install_pipenv(hostOS)
+        set_up_frontend_dependencies()
+        install_kurbernetes(hostOS)
+        install_docker(hostOS)
+        add_aimmo_to_hosts_file()
+
+        print('---------------------------------------------------------------------------------------------------')
+        print("| You now need to get the unity package from the AI:MMO-unity repo, place its contents            |")
+        print('| in aimmo/aimmo/static/unity  (folder may not exist yet)                                         |')
+        print('---------------------------------------------------------------------------------------------------')
+        print('| Everything should now be ready for you to use AI:MMO! :D                                        |')
+        print('---------------------------------------------------------------------------------------------------')
+
+    except CalledProcessError as e:
+        print('Command returned an exit code != 0, so something has gone wrong.')
+        traceback.print_exc()
+    except OSError as e:
+        print("Tried to execute a command that didn't exist.")
+        traceback.print_exc()
+    except ValueError as e:
+        print('Tried to execute a command with invalid arguments')
+        traceback.print_exc()
+    except Exception as e:
+        print("Something went very wrong, maybe I couldn't read hosts? otherwise I have no idea what it was D:")
+        traceback.print_exc()
+
+
+print('---------------------------------------------------------------------------------------------------')
+print('| Welcome to AI:MMO! This script should make your life a little easier,                           |')
+print("| just be kind if it doesn't work.                                                                |")
+print('| You may be asked to enter your password during this setup.                                      |')
+print('---------------------------------------------------------------------------------------------------')
+
+if platform.system() == 'Darwin':
+    hostOS = OStypes["mac"]
+    print('MAC found!')
+    mac_setup(hostOS)
+elif platform.system() == 'Windows':
+    hostOS = OStypes["windows"]
+    print('WINDOWS found!')
+    windows_setup(hostOS)
+elif platform.system() == 'Linux':
+    hostOS = OStypes["linux"]
+    print('LINUX found!')
+    linux_setup(hostOS)
+else:
+    print("Could not detect operating system. Maybe you're using")
+    print('something other than Windows, Mac, or Linux?')