Tidy up install scripts and add commenting in all scripts. Final preps before this moves to the live repo of the Nginx Bad Bot Blocker

Author: mitchellkrogza

.travis.yml

@@ -24,47 +24,22 @@ addons:
       - realpath
       - mailutils
 before_install:
-  #- echo 'Africa/Johannesburg' | sudo tee /etc/timezone
-  #- sudo dpkg-reconfigure --frontend noninteractive tzdata
   - export TZ=Africa/Johannesburg
 install:
   - sudo add-apt-repository -y ppa:nginx/stable
   - sudo apt-get update
   - sudo apt-get install -y --force-yes nginx-extras
-  #- travis-ci/install-nginx2.sh
 script:
   - travis-ci/install-nginx2.sh
   - curl -vsf 'http://localhost:9000/index.php' &> /dev/stdout
   - curl -A "googlebot" http://localhost:9000/index.php &> /dev/stdout
-  #- cat /tmp/error.log
   - STATUSCODE=$(curl -A "80legs" http://localhost:9000/index.php &> /dev/stderr --write-out "%{http_code}") | if test $STATUSCODE 52; then exit 0; fi
   - STATUSCODE=$(curl -A "masscan" http://localhost:9000/index.php &> /dev/stderr --write-out "%{http_code}") | if test $STATUSCODE 52; then exit 0; fi
   - STATUSCODE=$(curl -I http://localhost:9000/index.php -e http://100dollars-seo.com &> /dev/stderr --write-out "%{http_code}") | if test $STATUSCODE 52; then exit 0; fi
   - STATUSCODE=$(curl -I http://localhost:9000/index.php -e http://zx6.ru &> /dev/stderr --write-out "%{http_code}") | if test $STATUSCODE 52; then exit 0; fi
   - travis-ci/changefile.sh
 
 before_deploy:
-#- git remote -v
-#- git remote add origin https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git
-#- git config --global user.email "builds@travis-ci.com"
-#- git config --global user.name "Travis CI"
-#- git config --global user.email "${GIT_EMAIL}"
-#- git config --global user.name "${GIT_NAME}"
-#- git config --global push.default simple
-#- export GIT_TAG=v1.0.$TRAVIS_BUILD_NUMBER
-#- sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
-#- cat $TRAVIS_BUILD_DIR/globalblacklist.conf
-#- git commit -am "Travis Test Passed"
-#- git commit -a
-#- cd $TRAVIS_BUILD_DIR
-#- git add $TRAVIS_BUILD_DIR/globalblacklist.conf
-#- git commit -m "Build $TRAVIS_BUILD_NUMBER"
-#- git commit -am "Build $TRAVIS_BUILD_NUMBER"
-#- git tag $GIT_TAG -a -m "Tag Generated from TravisCI for build $TRAVIS_BUILD_NUMBER"
-#- git push origin master && git push origin master --tags
-#- git pull origin https://${GH_TOKEN}@github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration
-#- git push https://${GH_TOKEN}@github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration --all
-#- ls -aR
 - sh -x travis-ci/deploy2.sh
 deploy:
   provider: releases
@@ -78,7 +53,6 @@ deploy:
   on:
     repo: mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration
     tags: false
-    #all_branches: true
     branches:
       except:
         - "/^v[0-9]/"

travis-ci/changefile.sh

@@ -2,44 +2,30 @@
 YEAR=$(date +"%Y")
 MONTH=$(date +"%m")
 cd $TRAVIS_BUILD_DIR
+
 #Remove Remotes Added by TravisCI
 git remote rm origin
+
 #Add Remote with Secure Key
 git remote add origin https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git
+
 #List Remotes ONLY DURING testing - do not do this on live repo / possible key leak
 #git remote -v
-#ls -la $TRAVIS_BUILD_DIR
-#ls -la $TRAVIS_BUILD_DIR/.git
-#git fetch origin master
-#git pull origin master
-#ls -la $TRAVIS_BUILD_DIR/.git
-#echo "Check permissions on git HEAD / get dir listing of travis build dir"
+
+# Set Git Variables
 git config --global user.email "${GIT_EMAIL}"
 git config --global user.name "${GIT_NAME}"
 git config --global push.default simple
+
+# Make sure we have master branch checked out in Git
 git checkout master
-#export GIT_TAG=V2.$YEAR-$MONTH.$TRAVIS_BUILD_NUMBER
-#msg="Tag Generated from TravisCI for build $TRAVIS_BUILD_NUMBER"
-#echo "$msg" >> $TRAVIS_BUILD_DIR/build.txt
+
+# Modify our file and make sure Travis is owner
 sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
 sudo chown travis:travis $TRAVIS_BUILD_DIR/globalblacklist.conf
+
+# Add the modified file to the and commit it
 git add $TRAVIS_BUILD_DIR/globalblacklist.conf
 git commit -am "V3.$YEAR.$MONTH.$TRAVIS_BUILD_NUMBER [ci skip]"
-#git add -A .
-#git add $TRAVIS_BUILD_DIR/build.txt
-#git commit -m "Update build version file with $TRAVIS_BUILD_NUMBER"
-
-#YEAR=$(date +"%Y")
-#MONTH=$(date +"%m")
-#sudo git remote -v
-#sudo git remote rm origin
-#sudo git config --global user.email "${GIT_EMAIL}"
-#sudo git config --global user.name "${GIT_NAME}"
-#sudo git config --global push.default simple
-#export GIT_TAG=v1.0.$TRAVIS_BUILD_NUMBER
-#msg="Tag Generated from TravisCI for build $TRAVIS_BUILD_NUMBER"
-#echo "$msg" >> $TRAVIS_BUILD_DIR/build.txt
-#git add $TRAVIS_BUILD_DIR/build.txt
-#sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
-#sudo git add $TRAVIS_BUILD_DIR/globalblacklist.conf
-#sudo git commit -m "Build $GIT_TAG"
+
+# Travis now moves to the before_deploy: section of .travis.yml

travis-ci/deploy2.sh

@@ -1,75 +1,20 @@
 #!/bin/bash
 YEAR=$(date +"%Y")
 MONTH=$(date +"%m")
+
+# Make Sure we are in the Build Directory
 cd $TRAVIS_BUILD_DIR
-#git clone --depth=50 --branch=master https://github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration.git mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration
-#git reset --hard $sha1
-#git checkout master
-#git config --global user.email "${GIT_EMAIL}"
-#git config --global user.name "${GIT_NAME}"
-#git config --global push.default simple
-#git status
-#git fetch origin master
-#git diff origin/master
-#git branch
-#git checkout $TRAVIS_BRANCH
-#git branch
-#sudo git remote add origin https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git
-#git fetch --tags
-#msg="Tag $GIT_TAG Generated from TravisCI for build $TRAVIS_BUILD_NUMBER"
-#if git tag $GIT_TAG -a -m "$msg" 2>/dev/null; then
-#sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
-#sudo chown travis:travis $TRAVIS_BUILD_DIR/globalblacklist.conf
-#git add $TRAVIS_BUILD_DIR/globalblacklist.conf
-#git add .
-#git add $TRAVIS_BUILD_DIR/build.txt
+
+# Create our Version Number
 export GIT_TAG=V3.$YEAR-$MONTH.$TRAVIS_BUILD_NUMBER
-#git tag detached-commit -f
+
+# Tag our release
 git tag $GIT_TAG -a -m "V3.$YEAR.$MONTH.$TRAVIS_BUILD_NUMBER"
-#git commit -am "Update build version file $GIT_TAG with $TRAVIS_BUILD_NUMBER"
+
+# Push our commit and tags back to the repo
 sudo git push origin master && git push origin master --tags
-#git push https://${GH_TOKEN}@github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration --all
-ls -aR
-#cat $TRAVIS_BUILD_DIR/globalblacklist.conf
-#ls -la $TRAVIS_BUILD_DIR
-#git branch -a
-#echo $TRAVIS_BRANCH
-#else echo Tag already exists!; fi
 
-#YEAR=$(date +"%Y")
-#MONTH=$(date +"%m")
-#sudo git remote add origin https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git
-#sudo git config --global user.email "${GIT_EMAIL}"
-#sudo git config --global user.name "${GIT_NAME}"
-#sudo git config --global push.default simple
-#export GIT_TAG=V2.$YEAR-$MONTH.$TRAVIS_BUILD_NUMBER
-#export GIT_TAG=v1.0.$TRAVIS_BUILD_NUMBER
-#git fetch --tags
-#msg="Build $GIT_TAG"
-#if git tag $GIT_TAG -a -m "$msg" 2>/dev/null; then
-#sudo git tag $GIT_TAG -a -m "Build $GIT_TAG"
-#sudo git push origin master && git push origin master --tags
+# Uncomment to list all git folders and modified files etc
 #ls -aR
-#else echo Tag already exists!; fi
 
-#- git remote -v
-#- git remote add origin https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git
-#- git config --global user.email "builds@travis-ci.com"
-#- git config --global user.name "Travis CI"
-#- git config --global user.email "${GIT_EMAIL}"
-#- git config --global user.name "${GIT_NAME}"
-#- git config --global push.default simple
-#- export GIT_TAG=v1.0.$TRAVIS_BUILD_NUMBER
-#- sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
-#- cat $TRAVIS_BUILD_DIR/globalblacklist.conf
-#- git commit -am "Travis Test Passed"
-#- git commit -a
-#- cd $TRAVIS_BUILD_DIR
-#- git add $TRAVIS_BUILD_DIR/globalblacklist.conf
-#- git commit -m "Build $TRAVIS_BUILD_NUMBER"
-#- git commit -am "Build $TRAVIS_BUILD_NUMBER"
-#- git tag $GIT_TAG -a -m "Tag Generated from TravisCI for build $TRAVIS_BUILD_NUMBER"
-#- git push origin master && git push origin master --tags
-#- git pull origin https://${GH_TOKEN}@github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration
-#- git push https://${GH_TOKEN}@github.com/mitchellkrogza/Travis-CI-Nginx-for-Testing-Nginx-Configuration --all
-#- ls -aR
+# Now TravisCI moves into the deploy: section of TravisCI - see .travis.yml

travis-ci/install-nginx2.sh

@@ -2,109 +2,65 @@
 # Travis CI Bash Script for Installing Nginx on Travis CI and Testing Configurations
 # https://github.com/mitchellkrogza
 
-#set -e
 set -x
-#set -v
-
-#DIR=$(realpath $(dirname "$0"))
-#USER=$(whoami)
-#PHP_VERSION=$(phpenv version-name)
-#ROOT=$(realpath "$DIR/..")
-#PORT=9000
-#SERVER="/tmp/php.sock"
-
-#function tpl {
-#    sed \
-#        -e "s|{DIR}|$DIR|g" \
-#        -e "s|{USER}|$USER|g" \
-#        -e "s|{PHP_VERSION}|$PHP_VERSION|g" \
-#        -e "s|{ROOT}|$ROOT|g" \
-#        -e "s|{PORT}|$PORT|g" \
-#        -e "s|{SERVER}|$SERVER|g" \
-#        < $1 > $2
-#}
-
-# Make some working directories.
-#mkdir "$DIR/nginx"
-#mkdir "$DIR/nginx/sites-enabled"
-#mkdir "$DIR/var"
-
-# Configure the PHP handler.
-#if [ "$PHP_VERSION" = 'hhvm' ] || [ "$PHP_VERSION" = 'hhvm-nightly' ]
-#then
-#    HHVM_CONF="$DIR/nginx/hhvm.ini"
-
-#    tpl "$DIR/hhvm.tpl" "$HHVM_CONF"
-
-#    cat "$HHVM_CONF"
-
-#    hhvm \
-#        --mode=daemon \
-#        --config="$HHVM_CONF"
-#else
-#    PHP_FPM_BIN="$HOME/.phpenv/versions/$PHP_VERSION/sbin/php-fpm"
-#    PHP_FPM_CONF="$DIR/nginx/php-fpm.conf"
-
-    # Build the php-fpm.conf.
-#    tpl "$DIR/php-fpm.tpl" "$PHP_FPM_CONF"
-
-    # Start php-fpm
-#    "$PHP_FPM_BIN" --fpm-config "$PHP_FPM_CONF"
-#fi
-
-# Build the default nginx config files.
-#tpl "$DIR/nginx.tpl" "$DIR/nginx/nginx.conf"
-#tpl "$DIR/fastcgi.tpl" "$DIR/nginx/fastcgi.conf"
-#tpl "$DIR/defaultsite.tpl" "$DIR/nginx/sites-enabled/defaultsite.conf"
-
-# Start nginx.
-#nginx -c "$DIR/nginx/nginx.conf"
-#echo $TRAVIS_BUILD_DIR
-# Check Date
-date
+
+# Check Date - I only used this for testing to make sure I had set timezone correctly
+# See .travis.yml file in the before_install section on how to set your timezone on TravisCI
+#date
+
+# Start Getting Nginx Ready for Testing the Nginx Bad Bot Blocker
+
+# Delete default site created by Nginx Installation
 sudo rm /etc/nginx/sites-available/default
+
+# Download the Nginx Bad Bot Blocker files from the Live Repository
 sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/install-ngxblocker -O /usr/sbin/install-ngxblocker
 sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/setup-ngxblocker -O /usr/sbin/setup-ngxblocker
 sudo wget https://raw.githubusercontent.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker/master/update-ngxblocker -O /usr/sbin/update-ngxblocker
+
+# Set our install and setup scripts to be executable
 sudo chmod +x /usr/sbin/install-ngxblocker
 sudo chmod +x /usr/sbin/setup-ngxblocker
 sudo chmod +x /usr/sbin/update-ngxblocker
+
+# Run Install-NgxBlocker
 cd /usr/sbin
 sudo ./install-ngxblocker -x
+
+# Copy our default.vhost file into Nginx /sites-available/
 sudo cp $TRAVIS_BUILD_DIR/travis-ci/default.vhost /etc/nginx/sites-available/default.vhost
+
+# Link the vhost file into Nginx /sites-enabled/ and reload nginx
 sudo ln -s /etc/nginx/sites-available/default.vhost /etc/nginx/sites-enabled/default.vhost
+sudo service nginx reload
+
+# Run setup-ngxblocker
 cd /usr/sbin
-# Below for Verbose Testing of setup-ngxblocker
-#sudo sh -x ./setup-ngxblocker -x
 sudo ./setup-ngxblocker -x
+
+# NOTE: for Verbose Testing of any shell scripts use below format adding sh -x before running the script
+# this helps a lot inside the TravisCI environment to see where a shell script may be failing 
+#sudo sh -x ./setup-ngxblocker -x
+
+# Load our Nginx.conf file and reload Nginx
 sudo nginx -c /etc/nginx/nginx.conf
 sudo service nginx reload
-#sudo nginx -t &> /dev/stdout
-#cat /etc/nginx/nginx.conf
-#sudo nginx -V
-#sudo netstat -peanut
+
+# Copy our index.php file into the default site's root folder
 sudo cp $TRAVIS_BUILD_DIR/www/index.php /var/www/html/index.php
+
+# Run update-ngxblocker test
 cd /usr/sbin
 sudo ./update-ngxblocker
+
+# Reload nginx
 sudo service nginx reload
+
+# Set all our other setup and deploy scripts to be executable
 sudo chmod +x $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
 sudo chmod +x $TRAVIS_BUILD_DIR/travis-ci/deploy.sh
 sudo chmod +x $TRAVIS_BUILD_DIR/travis-ci/before-deploy.sh
 sudo chmod +x $TRAVIS_BUILD_DIR/travis-ci/deploy2.sh
 sudo chmod +x $TRAVIS_BUILD_DIR/travis-ci/changefile.sh
-#sudo $TRAVIS_BUILD_DIR/travis-ci/modify-globalblacklist.sh
-#cd $TRAVIS_BUILD_DIR
-#sudo git remote -v
-#sudo git remote rm origin
-#cat $TRAVIS_BUILD_DIR/globalblacklist.conf
-#sudo git config --global user.email "${GIT_EMAIL}"
-#sudo git config --global user.name "${GIT_NAME}"
-#sudo git config --global push.default simple
-#sudo export GIT_TAG=v1.0.$TRAVIS_BUILD_NUMBER
-#msg="Build $TRAVIS_BUILD_NUMBER"
-#echo "$msg" >> $TRAVIS_BUILD_DIR/build.txt
-#sudo git add $TRAVIS_BUILD_DIR/globalblacklist.conf
-#sudo git commit -m "Build $TRAVIS_BUILD_NUMBER"
-
-#sudo sed --version
-#sudo apt-cache policy dash
+
+# Travis now goes into the rest of the tests in the script: section of .travis.yml