Merge lp:~jaywink/diaspora-ppa/diaspora-develop-setup into lp:~diaspora-ppa/diaspora-ppa/diaspora-metapackage-trunk

[Jason Robinson]

=== modified file 'debian/changelog'
--- debian/changelog	2012-10-13 21:10:34 +0000
+++ debian/changelog	2012-10-16 19:20:29 +0000
@@ -1,3 +1,10 @@
+diaspora (0.0.1.1) precise; urgency=low
+
+  * Development environment setup and control implemented
+  * Bump version to match latest upstream
+
+ -- Jason Robinson <[e-mail]>  Tue, 16 Oct 2012 22:14:40 +0300
+
 diaspora (0.0.1ubuntu6) precise; urgency=low
 
   * Added bundler gem installation to diasporactrl install rvm

=== modified file 'scripts/diasporactrl'
--- scripts/diasporactrl	2012-10-13 21:10:34 +0000
+++ scripts/diasporactrl	2012-10-16 19:20:29 +0000
@@ -1,7 +1,61 @@
 #!/bin/bash
-# Control script for Diaspora*
-#
-#
+# Control script for Diaspora* social network
+#
+# Launchpad: https://launchpad.net/diaspora-ppa
+# Diaspora* project: http://diasporaproject.org
+#
+# Licensed under AGPLv3
+#
+# TODO's:
+# - Prod env setup (using diaspora master source from PPA)
+# - Remove environments on remove script
+# - Remove environment command
+#
+
+# Usage information
+print_usage() {
+    echo ""
+    echo "Diaspora* control script for Ubuntu"
+    echo "-----------------------------------"
+    echo ""
+    echo "Usage: diasporactrl command [options]"
+    echo ""
+    echo "Commands:"
+    echo "  install rvm"
+    echo "        Installs Ruby RVM under current user or if"
+    echo "        run with sudo, user can be chosen."
+    echo "  remove rvm"
+    echo "        Removes RVM and all installed gems under it."
+    echo "  setup develop <name>"
+    echo "        Set up a development environment <name>. Name must be"
+    echo "        a valid folder name as environment will be created under"
+    echo "        current path in a sub-directory."
+    echo "        Development environment is based on Diaspora* Github"
+    echo "        development branch head."
+    echo "  setup stable <name>"
+    echo "        Not implemented yet. This command will in future be used"
+    echo "        to set up a stable production environment."
+    echo "  setup database"
+    echo "        Set up database for environment in current folder."
+    echo "        Used to finish an environment installation if database"
+    echo "        credentials were not given during environment setup."
+    echo "  start"
+    echo "        Start Diaspora* environment in current folder (development"
+    echo "        environments)."
+    echo "  stop"
+    echo "        Stop Diaspora* environment that was previously started in"
+    echo "        this folder."
+    echo ""
+    echo "Author: Jason Robinson <[e-mail]>"
+    echo "Find me on Diaspora* at [e-mail]"
+    echo ""
+    echo "Code for this script is maintained at Launchpad:"
+    echo "https://code.launchpad.net/diaspora-ppa"
+    echo ""
+    echo "Please file bugs on Launchpad. Discussion on Diaspora* packaging"
+    echo "efforts happens at http://loom.io/groups/282"
+    echo ""
+}
 
 # RVM installation
 install_rvm() {
@@ -18,7 +72,14 @@
 # Activate RVM for user
 activate_rvm() {
     if [ -n "$1" ]; then
-        su - $1 -c "source /home/$1/.rvm/scripts/rvm"
+        if [ `whoami` = "root" ]; then
+            su - $1 -c "source /home/$1/.rvm/scripts/rvm"
+        elif [ `whoami` = $1 ]; then
+            source /home/$1/.rvm/scripts/rvm
+        else
+            echo "Cannot activate RVM for another user without being root!"
+            exit 1
+        fi
     else
         echo "Cannot activate RVM for null username!"
         exit 1
@@ -120,6 +181,211 @@
     fi
 }
 
+# Get Diaspora system user
+get_diaspora_user() {
+    username=""
+    if [ `whoami` != "root" ]; then
+        # we are a user
+        if [ -d "$HOME/.diaspora" ]; then
+            username=`whoami`
+        else
+            # also check if installed with sudo for another user
+            if [ -e "/etc/diaspora/.diaspora_user" ]; then
+                username=`cat /etc/diaspora/.diaspora_user`
+            fi
+        fi
+    else
+        # we are root
+        # See if D* user has been set
+        if [ -e "/etc/diaspora/.diaspora_user" ]; then
+            username=`cat /etc/diaspora/.diaspora_user`
+        fi
+    fi
+}
+
+# Set configuration variables for environment in current directory
+set_config() {
+    key="ENVIRONMENT_$1"
+    if [ ! -e ".diasporactrlrc" ]; then
+        # Are we in a Diaspora* environment folder?
+        if [ ! -e ".rvmrc" ]; then
+            echo "set_config(): We are not in a Diaspora* environment folder!"
+            echo "Error in script?"
+            exit 1
+        fi
+        touch ".diasporactrlrc"
+    fi
+    
+    if [ $(grep -c "export $key=$2" .diasporactrlrc) -ne 0 ]; then
+        # conf item exists, replace it
+        sed -i "s/$key/$(echo $2 | sed -e 's/[\/&]/\\&/g')/g" .diasporactrlrc
+    else
+        # new conf item
+        echo "export $key=$2" >> .diasporactrlrc
+    fi
+}
+
+# Skip database setup
+skip_database_setup() {
+    echo ""
+    echo "You have chosen to skip database credential setup or one"
+    echo "or more values were null. Please do this step later by editing"
+    echo "the following file:"
+    echo "`pwd`/config/database.yml"
+    echo ""
+    echo "Press enter to continue"
+    read enterkey
+}
+
+# Run DB init actions
+run_db_init() {
+    if [ "$1" = "development" ]; then
+        echo ""
+        echo "Setting up database in development mode.."
+        echo ""
+        bundle exec rake db:create
+        bundle exec rake db:schema:load
+        echo ""
+        echo "DB setup complete!"
+        echo ""
+    fi
+}
+
+# Print startup instructions
+print_startup_instructions() {
+    echo ""
+    echo "To run the environment, change to the environment folder and"
+    echo "execute the following command:"
+    echo "diasporactrl start"
+    echo ""
+    echo "This will start a background server process which you can then"
+    echo "stop with the command:"
+    echo "diasporactrl stop"
+    echo ""
+}
+
+# Create dev environment logic
+create_dev_environment() {
+    echo ""
+    echo "Beginning installation of development environment"
+    echo ""
+    
+    if [ -d $1 ]; then
+        echo "Directory $1 exists! We need to create a directory for the environment,"
+        echo "please choose another name or run in another location."
+        exit 1
+    fi
+    
+    git clone git://github.com/diaspora/diaspora.git $1
+    
+    if [ $? -ne 0 ]; then
+        echo "Something wrong in git clone command, please check the error output and retry."
+        exit 1
+    fi
+    
+    # save environment name to ~/.diaspora folder
+    echo `pwd`/$1 >> $HOME/.diaspora/envs_development
+    
+    echo ""
+    echo "I will now move to the dev environment directory. This will trigger a question"
+    echo "from Ruby RVM about trusting the .rvmrc file provided by Diaspora*. You must answer"
+    echo "yes to this question in order to have all the required Ruby gems set up properly."
+    echo ""
+    echo -n "Please press enter to continue"
+    read key
+    
+    cd $1
+    
+    # user accepts .rvmrc, rvm does stuff
+    
+    # continue with installation, mysql supported only at the moment, it has been
+    # pulled via dependencies
+    
+    # install gems
+    DB="mysql" bundle install
+    
+    if [ $? -ne 0 ]; then
+        echo "Something wrong from bundler, please check the error output and retry."
+        exit 1
+    fi
+    
+    # configure
+    # set a localhost url (this also creates the config file for this env)
+    set_config "ENVIRONMENT_URL" "https://127.0.0.1:3000/"
+    
+    # copy script_server config // will be changed soon in 0.0.2
+    cp config/script_server.yml.example config/script_server.yml
+    
+    # database config
+    cp config/database.yml.example config/database.yml
+    echo ""
+    echo "Database (MySQL) username/password needs to be set up. The database user"
+    echo "needs rights to create a new database for this environment. You either"
+    echo "set this information up later or do it now."
+    echo ""
+    echo -n "Would you like to set up the database information now? (Y/n) "
+    read yesorno
+    if [ "$yesorno" != "Y" ]; then
+        # get database info
+        echo -n "DB: Please type database username? "
+        read dbusername
+        echo -n "DB: Please type database password? "
+        read dbpassword
+        if [ -z "$dbusername" ] || [ -z "$dbpassword" ]; then
+            # one or both values empty - skip
+            skip_database_setup
+            dbconfigured=false
+        else
+            # save values
+            replacestr="username: \"$dbusername\""
+            sed -i "s/username: \"root\"/$(echo $replacestr | sed -e 's/[\/&]/\\&/g')/g" config/database.yml
+            replacestr="password: \"$dbpassword\""
+            sed -i "s/password: \"\"/$(echo $replacestr | sed -e 's/[\/&]/\\&/g')/g" config/database.yml
+            
+            # TODO: ask if user would like these to be saved in .diaspora folder for later use
+            
+            # set db name to unique, so we can set up multiple envs
+            # TODO: add random number
+            sed -i "s/diaspora_development/diaspora_$1/g" config/database.yml
+            dbconfigured=true
+        fi
+    else
+        skip_database_setup
+        dbconfigured=false
+    fi
+    
+    # Some generic conf variables
+    set_config "SETTINGS_POD_NAME" "Diaspora* $1"
+    set_config "SETTINGS_ENABLE_REGISTRATIONS" "true"
+    
+    # some fixes to get D* running without a config file, can be removed after this is fixed:
+    # https://github.com/diaspora/diaspora/issues/3661
+    # we don't do these via set_config because it would append ENVIRONMENT_
+    echo "export HEROKU=true" >> .diasporactrlrc
+    echo "export SECRET_TOKEN=58c7770115469e64ce3ff1f802cefc5e77d41694e8f64cd5408ab6b1a764babe0f9b8ae6e0a81d6b" >> .diasporactrlrc
+    cp config/diaspora.yml.example config/diaspora.yml
+    
+    # Run DB stuff if DB config was done
+    if [ "$dbconfigured" = "true" ]; then
+        source .diasporactrlrc
+        run_db_init "development"
+    else
+        echo ""
+        echo "DB has not been set up since we do not have credentials."
+        echo "Please edit config/database.yml and once done run the following:"
+        echo "diasporactrl setup database development"
+        echo ""
+    fi
+    
+    echo ""
+    echo "Environment $1 in `pwd` has been created!"
+    echo "For developer guidelines, please make sure to read:"
+    echo "https://github.com/diaspora/diaspora/wiki/Git-Workflow"
+    echo ""
+    
+    print_startup_instructions
+}
+
 case "$1" in
     install)
         case "$2" in
@@ -133,6 +399,12 @@
                     echo ""
                     read oktocontinue
                     username=`whoami`
+                    
+                    # create home .diaspora dir
+                    if [ ! -d "$HOME/.diaspora" ]; then
+                        mkdir $HOME/.diaspora
+                    fi
+                    
                 else
                     # we are root, let's take a guess or ask user
                     echo "Guessing which user to install RVM to.."
@@ -142,6 +414,12 @@
                     if [ -d "/etc/diaspora" ] && [ ! -e "/etc/diaspora/.diaspora_user" ]; then
                         echo $username > /etc/diaspora/.diaspora_user
                     fi
+                    
+                    # also create home .diaspora dir
+                    if [ ! -d "/home/$username/.diaspora" ]; then
+                        mkdir /home/$username/.diaspora
+                        chown $username /home/$username/.diaspora
+                    fi
                 fi
                     
                 if [ -n "$username" ]; then
@@ -159,13 +437,9 @@
             ;;
             
             *)
-                echo "Unknown install argument"
-                exit 1
-                
+                print_usage
             ;;
-
         esac
-        
         ;;
 
     remove)
@@ -198,18 +472,125 @@
             ;;
             
             *)
-                echo "Unknown remove argument"
+                print_usage
+            ;;
+        esac
+        ;;
+    
+    setup)
+        case "$2" in
+            develop)
+                
+                if [ -z $3 ]; then
+                    echo "Please supply a name for development environment, for example:"
+                    echo "diasporactrl setup develop mydevenv"
+                    exit 1
+                fi
+            
+                echo "Checking for Diaspora* system user information..."
+                get_diaspora_user
+                
+                if [ -n "$username" ]; then
+                    echo "Diaspora* system user is: $username"
+                else
+                    echo "No Diaspora* system user found!"
+                    echo "Did RVM and dependency installation go ok? Try this:"
+                    echo "diasporactrl install rvm"
+                    exit 1
+                fi
+                
+                # no point in supporting creation of dev environments for other users
+                if [ `whoami` != "$username" ]; then
+                    echo "Please set up development environment by running as the Diaspora* system user"
+                    echo "If you want to set one up for this username (`whoami`), run:"
+                    echo "diasporactrl install rvm"
+                    exit 1
+                fi
+                
+                activate_rvm $username
+                create_dev_environment $3
+            ;;
+            
+            stable)
+                echo "Not supported yet! Please do manual setup using these instructions:"
+                echo "https://github.com/diaspora/diaspora/wiki/Notes-on-Installing-and-Running-Diaspora"
                 exit 1
+            ;;
+            
+            database)
+                get_diaspora_user
                 
-            ;;
-
+                if [ -n "$username" ]; then
+                    echo "Diaspora* system user is: $username"
+                else
+                    echo "No Diaspora* system user found!"
+                    exit 1
+                fi
+                activate_rvm $username
+                source .diasporactrlrc
+                run_db_init $3
+                print_startup_instructions
+            ;;
+            
+            *)
+                print_usage
+            ;;
         esac
-        
+        ;;
+        
+    start)
+        if [ ! -e .diasporactrlrc ]; then
+            echo ""
+            echo "Not in a Diaspora* environment folder!"
+            echo "tip: .diasporactrlrc missing, it is created by setting an"
+            echo "environment using the command:"
+            echo "diasporactrl setup develop mydevenv"
+            echo ""
+            exit 1
+        fi
+        
+        # load env variables
+        source .diasporactrlrc
+        
+        # start in background
+        script/server >> diasporactrl.log 2>&1 &
+        echo $! >> "diasporactrl.pid"
+        
+        echo ""
+        echo "Started server!"
+        echo "You can check the log file 'diasporactrl.log' and after approx"
+        echo "30 seconds access the environment at http://127.0.0.1:3000"
+        echo ""
+        echo "To stop the server, type:"
+        echo "diasporactrl stop"
+        echo ""
+        ;;
+        
+    stop)
+        if [ ! -e diasporactrl.pid ]; then
+            echo ""
+            echo "Can not find diasporactrl.pid file. Has an environment"
+            echo "been started in this folder?"
+            echo ""
+            exit 1
+        fi
+        
+        # start in background
+        pid2kill=`cat diasporactrl.pid`
+        kill $pid2kill
+        #TODO fix below - currently kills all running instances :)
+        #but then currently only one can be started since port is always 3000
+        kill $(ps aux | grep '[d]iaspora' | awk '{print $2}')
+        
+        rm diasporactrl.pid
+        
+        echo ""
+        echo "Server has been stopped!"
+        echo ""
         ;;
 
     *)
-        echo "Unknown argument"
-        exit 1
+        print_usage
     ;;
 esac