dw_dev | Potentially Useful Do-Everything Script (Reply)

[BTW: I am editing this post as the script is updated so refer back for further edits.]

I'm just a newbie at developing - submitted my first patch today - and one of the things one has to do to get up and running is to read about 5 tons of documentation and figure out workflows. Since I was having lots of potentially useful scripts suggested to me by developers and by the wiki and since I am at heart a toolmaker I put them all together and documented everything to the best of my ability.

I think this works but it's way past my bedtime right now and I haven't tested every single combination so if it eats your code, your data, or your firstborn child be in on your own head. OTOH I think it should work right!

#!/bin/bash
#
# Ricky's Dreamwidth Do-Anything Script
# For current version see: http://dw-dev.dreamwidth.org/94822.html
#
# Last updated 22 April 2013
#

#
# CHANGES
# 22/4/13 - Extended 'git' help page
# 20/4/13 - Fix 'upgrade' command again. Oops. I think it works now?
#         - Added 'hardreset' command with tons of warnings
#         - Added 'upgradebranch' command and help info
#         - Added/updated various help texts
#         - Abstract out $SCRIPTNAME variable
#         - Added 'git' command
#         - Added abstract stuff for storing/restoring current git branch
# 25/9/12 - Update 'upgrade' command following xb95's post http://dw-dev.dreamwidth.org/124731.html
# 10/9/12 - Update everything for git - deleted unpatch, makepatch, sync commands. Updated tidy, upgrade, help commands.
#         - Add 'checkconfig' option
#         - Now restores initial directory before exitting
#         - Added 'free' and 'nonfree' commands to save Afuna's poor fingers a few keystrokes
# 28/10/11 - Unpatch now really does cope with specific directory names (I should abstract out the interpolation code)
# 22/10/11 - Unpatch now copes with specific directory names
#         - Tidy really totally works
#         - Upgrade no longer starts apache
# 13/9/11 - Fixed 'tidy' command so it actually works!
# 11/9/11 - Added 'unpatch', 'errlog' and 'errlogs' commands.
#           'makepatch' command now accepts filename on command line.
# 2/9/11  - Added 'up' and 'down' commands.
#           Removed check before restarting Apache, seems excessive.
# 29/8/11 - Upgrade now deletes files not present in repository
#           Clarified warning text displayed before upgrading.
#

# When verbose is set extra 'help' text is printed.
verbose="1"

# Name to use for any patch which is not given a specific name
default_patchname="~/default.patch"

inquire ()  {
    # Usage: inquire "Prompt string" [force]
    # use 'force' keyword to force an answer, otherwise answer defaults to Yes if user presses enter

if [ "$2" = 'force' ]; # must explicitly type the answer
    then
        force=YES
        echo  -n "$1 [y/n]? "
    else
        force=NO
        echo  -n "$1 [Y/n]? "
    fi

read answer
    #echo "Force is $force";
    
    finish="-1"
    while [ "$finish" == '-1' ]; do
        if [[ "$force" == 'NO' && "$answer" == '' ]];
        then
	    #echo "Defaulting to 'yes'."
            finish="1"; # Empty answer OK because force is off
        else
	    #echo "Not defaulting..."
            case $answer in
                y | Y | yes | YES | Yes ) 
		    finish="1";;
                n | N | no | NO | No ) 
		    echo 'Exiting.';
		    exit;;
                *) 
                   finish="-1";
                   echo -n 'Invalid response - please reenter: ';
                   read answer;;
             esac
        fi
    done
}

update-db () {
    echo "Now updating databases ..."
    $LJHOME/bin/upgrading/update-db.pl -r -p --innodb && \
    $LJHOME/bin/upgrading/update-db.pl -r --cluster=all --innodb && \
    $LJHOME/bin/upgrading/texttool.pl load
}

# TODO put stop-apache and start-apache commands in here as functions

SCRIPTNAME=`basename $0`

# Save initial directory for possible restoration later
OLDDIR=$PWD
NODIRRESTORE=0 # Change to 1 for no directory restoration ever

# Save initial git branch for possible restoration later
OLDBRANCH=`git rev-parse --symbolic-full-name --abbrev-ref HEAD`
NOBRANCHRESTORE=0 # Change to 1 for no branch restoration ever
if [ $OLDBRANCH == "HEAD" ]; then
    # Detached head state - no restoring possible
    NOBRANCHRESTORE=1
fi

CMD=$1
case $CMD in

up)
    # Start Apache
    echo "Starting Apache..."
    start-apache
    if [ $verbose == 1 ]; then 
        echo "Remember to stop Apache with the '$SCRIPTNAME down' command when you're finished hacking."
        echo "Leaving Apache running slows down the server a touch for everybody else."
    fi
    ;;

down)
    # Stop Apache
    echo "Stopping Apache and any instances of worker-manager..."
    stop-apache
    killall worker-manager
    ;;

restart|r|bounce|b|bap)
    # Restart Apache
    #inquire "Do you wish to restart apache?"
    
    echo "Restarting Apache ..."
    stop-apache
    sleep 3
    start-apache
    if [ $verbose == 1 ]; then 
        echo "Remember to stop Apache with the '$SCRIPTNAME down' command when you're finished hacking."
        echo "Leaving Apache running slows down the server a touch for everybody else."
    fi
    ;;

upgrade)
    # Upgrade code from repositories and rebuild DBs
    echo "WARNING: Upgrading your dreamhack may delete local code changes."
    if [ $verbose == 1 ]; then 
        echo "To save any uncommitted code changes, you can commit them or use the 'git stash' command. Use 'git stash help' for details."
    fi

inquire "Do you wish to upgrade your Dreamhack code" force

cd $LJHOME
    git fetch dreamwidth
    # pull changes from dreamwidth
    git checkout develop
    git pull --ff dreamwidth develop
    git checkout master
    git pull --ff dreamwidth master
    # push them to Github forks
    git push origin develop
    git push origin master
    # change to dw-nonfree
    cd $LJHOME/ext/dw-nonfree
    git fetch dreamwidth
    # pull changes from dw-nonfree
    git checkout develop
    git pull --ff dreamwidth develop
    git checkout master
    git pull --ff dreamwidth master
    # push them to Github forks
    git push origin develop
    git push origin master

update-db

if [ $NOBRANCHRESTORE == 0 ]; then 
        echo "Switching back to git branch $OLDBRANCH"
        git checkout $OLDBRANCH
    else
        echo "You are now in git branch $NEWBRANCH"
    fi

echo "You may now wish to run '$SCRIPTNAME upgradebranch' to pull changes into your current branch."
    ;;

upgradebranch|ub)
    if [ $verbose == 1 ]; then 
        echo "This command pulls the latest changes you have downloaded from the develop branch into whatever branch you are currently working, and should be run after '$SCRIPTNAME upgrade'."
        echo "To save any uncommitted code changes, you can commit them or use the 'git stash' command. Use 'git stash help' for details."
    else
        echo "This command pulls already-downloaded changes from develop into your current git branch and should be run after '$SCRIPTNAME upgrade' or equivalent."
    fi
 
    inquire "Do you wish to pull upgraded code into your current branch"

git pull --rebase --ff-only dreamwidth develop
    ;;

hardreset)
    # Upgrade code from repositories and rebuild DBs
    echo "WARNING: Hard resetting your Dreamhack WILL delete anything in $LJHOME which is comitted, checked in, or staged but not part of the official Dreamhost code. "
    echo "    Changes which are stashed will be preserved though."
    if [ $verbose == 1 ]; then 
        echo "    If you feel unsure about this, we suggest you ask somebody on the dreamwidth-dev community for help - we're happy to help you."
    fi
    inquire "Do you wish to HARD RESET your Dreamhack code" force

cd $LJHOME
    git checkout develop
    git fetch dreamwidth
    git reset --hard dreamwidth/master
    git reset --hard dreamwidth/develop

update-db
    ;;

checkconfig|ccfg)
    # Check Configuration
    cd $LJHOME
    bin/checkconfig.pl
    ;;

free)
    cd $LJHOME
    NODIRRESTORE=1
    ;;

nonfree|nf)
    cd $LJHOME/ext/dw-nonfree
    NODIRRESTORE=1
    ;;

update|db)
    # Database update commands
    # When: After editing styles (s2) or made changes to DB schema, run this to make changes live
    inquire "Do you wish to update the database"

update-db
    ;;

tidy)
    # Deletes stray git artififacts
    git clean -f "*.rej" "*.orig"
    ;;

errlog)
    tail ~/apache/logs/error_log
    ;;

errlogs)
    tail -f ~/apache/logs/error_log
    ;;

git|cheatsheet)
   echo "git branch             Show all branches, current branch is asterisked"
   echo "git checkout BRANCH    Switch to branch BRANCH"
   echo "git checkout -b BRANCH Create and switch to new branch BRANCH"
   echo "git status -s          Show files added/removed/modified not committed"
   echo "git diff               Show current unstaged changes"
   echo "git diff --cached      Show current uncommitted changes"
   echo "git stash [pop|show]   Store/restore/show stored uncommitted changes"
   echo ""

echo "More details here: http://wiki.dwscoalition.org/wiki/index.php/Newbie_Guide:_How_To_in_Git"
    ;;

*)
    # Invalid or missing command - prompt again
    echo "Valid commands are:"
    echo "    restart, r, bounce, b"
    echo "        Stops and then immediately restarts Apache. Use after editing .pm files or updating database."
    echo "    up, down"
    echo "        Starts or stops Apache."
    echo "    free, nonfree"
    echo "        Move to the free/nonfree directories."
    echo "    upgrade"
    echo "        Pull all new changes from github."
    echo "    upgradebranch, ub"
    echo "        Grab the changes from the most recent upgrade into your current branch."
    echo "    hardreset"
    echo "        Delete all your local changes and reset your dreamhack's status to match the current development code."
    echo "    update, db"
    echo "        Update databases. Use after editing database schema or S2 code."
    echo "    tidy"
    echo "        Delete stray patching artifiact files in current directory."
    echo "    errlog[s]"
    echo "        Tail [-f] the Apache error logs."
    echo "    git Display git cheat-sheet."

esac

if [ $NODIRRESTORE == 0 ]; then 
    cd $OLDDIR
fi
echo "DW script exiting."

For new folks, you need to copy everything in the text box above and paste it into a new file on your Dreamhack. I suggest you put it in the ~/bin directory and call the file 'dw', because then your system matches mine :). Then you need to make that file executable by typing 'chmod +755 ~/bin/dw' or whatever filename you used. After that you can type 'dw' and it should execute just fine, it'll give you instructions.

I would welcome fixes, constructive criticism, or anything else you have to offer. Feel free to use this in any way you want, etc.

r

Potentially Useful Do-Everything Script

Post a comment in response: