Merged v0.11 into master

Author: Paolo

HACKING.md

@@ -1,8 +1,8 @@
-**Test Plan**
+### Test Plan
 
-When you make changes ensure at the very minimum you should test the following:
+For any changes that are made, the following should be considered the bare minimum to be tested:
 
-```
+```sh
 auter --disable         # deletes /var/lib/auter/enabled, prints "auter disabled"
 auter --status          # prints "auter is currently disabled"
 auter --enable          # touches /var/lib/auter/enabled, prints "auter enabled"
@@ -14,14 +14,14 @@ man auter               # check the contents of the man page
 
 If you don't have any updates available do this:
 
-```
+```sh
 yum install zsh
 yum downgrade zsh
 ```
 
-Prepare custom scripts:
+Use the following to setup auter's pre/post scripts:
 
-```
+```sh
 echo 'logger custom pre prep script ran' > /etc/auter/pre-prep.d/pre_prep_script
 echo 'logger custom post prep script ran' > /etc/auter/post-prep.d/post_prep_script
 echo 'logger custom pre apply script ran' > /etc/auter/pre-apply.d/pre_apply_script
@@ -31,40 +31,115 @@ echo 'logger custom post reboot script ran' > /etc/auter/post-reboot.d/post_rebo
 chmod +x /etc/auter/*.d/*script
 ```
 
-Now there will be at least one update:
+#### Basic guidelines for testing:
 
-```
-auter --prep
-    prints "INFO: Running with: ./auter --prep Updates downloaded", /var/lib/auter/last-prep-auter
-    /var/lib/auter/last-prep-default contains update info
-
-auter --apply
-    prints "INFO: Running with: /usr/bin/auter --apply; Applying updates; Updates complete, you may need to reboot for some updates to take effect
-    Run 'yum history info' or 'dnf history info' and verify that update was applied
-    /var/lib/auter/last-update-default contains update info
-
-auter --reboot
-    prints "INFO: Running with: ./auter --reboot; Rebooting server" followed by shutdown message
-    tail /var/log/messages should include text "root: custom pre reboot script ran"
-    cat /etc/cron.d/auter-postreboot-auter should show "@reboot root /usr/bin/auter --postreboot --config auter"
-    5 mins after the reboot, tail /var/log/messages should include text "root: custom post reboot script ran"
+1. Test the commands manually in a normal shell session.
+2. Test for both positive and negative outcomes.
+3. Test the effects of the change in the function. Again, if possible, test success and failure conditions
+4. Test the all functionality in auter that is affected by they code changes.
+
+##### Testing template
+
+This should be completed in all pull requests before being merged.
+
+```md
+### Config settings
+
+AUTOREBOOT="no"
+ONLYINSTALLFROMPREP="yes"
+PREDOWNLOADUPDATES=yes
+
+### <OS test version>
+
+#### auter status
+
+[ pass/fail ] auter --status
+    - Check: /var/lib/auter/enabled exists
+
+[ pass/fail ] auter --disable
+    - Check: /var/lib/auter/enabled does not exist
+
+[ pass/fail ] auter --enable
+    - Check: /var/lib/auter/enabled exists
+
+[ pass/fail ] auter --help
+    - Check: same output when running 'auter' without arguments
+
+[ pass/fail ] auter --version
+    - Check: prints 'auter VERSION'
+
+#### update manually
+
+[ pass/fail ] auter --prep
+    - Check: prints "INFO: Running with: ./auter --prep Updates downloaded" to stdout
+    - Check: /var/lib/auter/last-prep-default contains update info
+    - Check: updates downloaded to /var/cache/auter/default
+    - Check: pre/post prep scripts ran successfully with messages logged to syslog
+
+[ pass/fail ] auter --apply
+    - Check: prints "INFO: Running with: /usr/bin/auter --apply; Applying updates; Updates complete, you may need to reboot for some updates to take effect" to stdout
+    - Check: expected updates were applied using 'yum history info' or 'dnf history info'
+    - Check: /var/lib/auter/last-update-default contains update info
+    - Check: no upates available after running
+    - Check: pre/post apply scripts ran successfully, messages logged to syslog
+    - Check: no mail is sent to the root user with the stdout from auter
+
+[ pass/fail ] auter --reboot
+    - Check: reboot scheduled in 2 minutes time
+    - Check: prints "INFO: Running with: ./auter --reboot; Rebooting server" followed by shutdown message to stdout
+    - Check: 5 minutes after reboot is complete pre/post reboot scripts ran successfully with messages logged to syslog
+
+#### updates via cron
+
+[ pass/fail ] auter --prep --stdout
+    - Check: updates downloaded to /var/cache/auter/default
+    - Check: pre/post prep scripts ran successfully, messages logged to syslog
+    - Check: output from auter also mailed to root user on CentOS boxes, output logged to syslog on Fedora systems
+
+[ pass/fail ] auter --apply --stdout
+    - Check: no updates available after running
+    - Check: pre/post scripts ran successfully with messages logged to syslog
+    - Check: output from auter also mailed to root user on CentOS boxes, output logged to syslog on Fedora systems
+
+[ pass/fail ] auter --reboot --stdout
+    - Check: server rebooted after 2 minutes
+    - Check: pre/post scripts ran successfully
+    - Check: output from auter also mailed to the root user on CentOS, output logged to syslog on Fedora
+
+#### new functionality testing
+
+[ pass/fail ] <test new functionality added>
+    - Check:
 ```
 
-**Documentation**
+#### Documentation
 
-When making any changes to code, make sure documentation (--help, man page) has been updated to reflect any changes
+When making any changes to code, make sure documentation (--help, man page) has been updated with the new functionality.
 
-**Release Process**
+#### Pull Request Rules
 
-1.  Ensure that all files are updated to the version of the release number you're about to tag.  This includes:
-  - auter
-  - NEWS
-  - auter.spec
+- All pull requests should be made against the develop branch
+- All pull requests MUST be reviewed and approved before merging
+- Pull request reviews and merges MUST be completed by another maintainer
+- Always squash and merge commits prior to submitting a pull request
+- All travis-ci tests should pass before merging
+    - If the spellcheck test fails, adding the problematic words to the dictionary is a valid option
+    - If the shellcheck test fails, you should fix the issues mentioned or add a shellcheck ignore directive to the previous line along with a comment on why it is being ignored
 
-2.  Add notes to auter.spec and NEWS with a list of the changes for this release
+#### Release Process
 
-3.  Push to github
+1. A new issue should be raised with the title of "Prep for <VERSION> Release"
+2. Ensure all required PRs for the new release have been merged to the develop branch
+3. A maintainer with admin rights to the master branch in rackerlabs/auter should create a new branch based from the develop branch:
 
-4.  Tag a release through github
+```sh
+git clone --branch=develop https://github.com/rackerlabs/auter.git rackerlabs/auter
+cd rackerlabs/auter
+git checkout -b Release-<NEW_VERSION>
+git push origin Release-<NEW_VERSION>
+```
 
-5.  Engage with the RPM building process to get RPMs built based on the new tag, and attach those to the github release. 
+4. Any new PRs should be made to the develop branch. The only changes to the Release-<NEW_VERSION> should be fixing of any review issues for that branch.
+5. Full testing for all supported OSs should be carried out and tracked in a github project created for the release. Example: https://github.com/rackerlabs/auter/projects/1
+6. Once all testing has been completed for Release-<NEW_VERSION>, the reviewer should merge the Release-<NEW_VERSION> branch to both master and develop branches.
+7. Tag a new release named <NEW_VERSION> using template <major ver>.<minor ver> (Eg: Release 0.11)

NEWS

@@ -5,6 +5,11 @@ Auter NEWS
  * Removed debugging message that was printed during apt update
  * Added "Valid Options" in auter.conf
  * Added the pre/post prep directories in auter.conf
+ * Added retention and rotation for last-prep-output and last-apply-output files in /var/lib/auter
+ * Corrected file permissions for the auter-postreboot cron file
+ * Added --stdout option to force output to stdout even if there is no active tty
+ * Added a package manager lock file check before prep and apply functions call the package manager
+ * Improved checks to confirm prepared patches are still required
 
 0.10
  * Added pre and post prep script hooks

README.md

@@ -2,6 +2,12 @@
 
 Automatic updates for RHEL, CentOS, Fedora, Ubuntu and Debian Linux servers, with the ability to run pre/post hooks, pre-download packages and reboot after the updates.
 
+**Note about contributions**
+Auter is an open source project and we welcome users to send in feature requests and report any bugs in our issues page. We also welcome any help with maintaining the application and any code contributions.
+
+**What does auter mean?**
+Automatic Update Transaction Execution by Rackspace.
+
 **When to use Auter?**
 
 Updates should be applied regularly to Linux systems in order to apply security and bug fixes. For some of those updates, for example the kernel, or a shared library, a system restart is required for those updates to take effect. Whether you apply those updates manually, or automatically will depend on your requirements.

auter

@@ -27,20 +27,20 @@ declare -r -x PIDFILE="/var/run/auter/auter.pid"
 
 # Set default options - these can be overridden in the config file or with a command line argument
 declare -x -l AUTOREBOOT="no"
-declare -x PACKAGEMANAGEROPTIONS=""
+declare -x -a PACKAGEMANAGEROPTIONS
 declare -x -l PREDOWNLOADUPDATES="yes"
 declare -x -l ONLYINSTALLFROMPREP="no"
 declare -x CONFIGFILE="/etc/auter/auter.conf"
 declare -x DOWNLOADDIR="/var/cache/auter"
 declare -x -i MAXDELAY=3600
 declare -x CONFIGSET="default"
 declare -x ROTATE="5"
-PREPREPSCRIPTDIR="${SCRIPTDIR}/pre-prep.d"
-POSTPREPSCRIPTDIR="${SCRIPTDIR}/post-prep.d"
-PREAPPLYSCRIPTDIR="${SCRIPTDIR}/pre-apply.d"
-POSTAPPLYSCRIPTDIR="${SCRIPTDIR}/post-apply.d"
-PREREBOOTSCRIPTDIR="${SCRIPTDIR}/pre-reboot.d"
-POSTREBOOTSCRIPTDIR="${SCRIPTDIR}/post-reboot.d"
+declare -x PREPREPSCRIPTDIR="${SCRIPTDIR}/pre-prep.d"
+declare -x POSTPREPSCRIPTDIR="${SCRIPTDIR}/post-prep.d"
+declare -x PREAPPLYSCRIPTDIR="${SCRIPTDIR}/pre-apply.d"
+declare -x POSTAPPLYSCRIPTDIR="${SCRIPTDIR}/post-apply.d"
+declare -x PREREBOOTSCRIPTDIR="${SCRIPTDIR}/pre-reboot.d"
+declare -x POSTREBOOTSCRIPTDIR="${SCRIPTDIR}/post-reboot.d"
 
 function default_signal_handling() {
   trap 'rm -f "${PIDFILE}"' SIGINT SIGTERM
@@ -75,11 +75,26 @@ function logit() {
   logger -p info -t auter "$1"
 }
 
+function read_config() {
+  if [[ -f "${CONFIGFILE}" ]]; then
+    source "${CONFIGFILE}"
+  elif [[ "${CUSTOMCONFIG}" ]]; then
+    logit "ERROR: Custom config file ${CONFIGFILE} does not exist"
+    quit 5
+  else
+    logit "WARNING: Using default config values."
+  fi
+
+  # Convert space separated list from the config file to an indexed array
+  # https://github.com/koalaman/shellcheck/wiki/SC2086
+  IFS=' ' read -r -a PACKAGEMANAGEROPTIONS <<< "$PACKAGEMANAGEROPTIONS"
+}
+
 function rotate_file {
   #Rotate old file
   OUTPUT_FILE=$1
-  for i in `seq $(($ROTATE-1)) -1 1`; do
-    [[ -e "${OUTPUT_FILE}.$i" ]] && mv -f "${OUTPUT_FILE}.$i" "${OUTPUT_FILE}.$(($i+1))"
+  for i in $(seq $((ROTATE-1)) -1 1); do
+    [[ -e "${OUTPUT_FILE}.$i" ]] && mv -f "${OUTPUT_FILE}.$i" "${OUTPUT_FILE}.$((i+1))"
   done
 
   # Move base files to basefile.1
@@ -138,7 +153,7 @@ function reboot_server() {
 function post_reboot() {
   logit "INFO: Removed post-reboot hook: /etc/cron.d/auter-postreboot-${CONFIGSET}"
   rm -f "/etc/cron.d/auter-postreboot-${CONFIGSET}"
-  $(tty -s) || sleep 300
+  tty -s || sleep 300
 
   for SCRIPT in "${POSTREBOOTSCRIPTDIR}"/*; do
     run_script "${SCRIPT}" "Post-Reboot"
@@ -147,7 +162,7 @@ function post_reboot() {
 
 function print_status() {
   if [[ -f "${LOCKFILE}" ]] && [[ -f "${PIDFILE}" ]]; then
-    if kill -0 $(cat ${PIDFILE}) &>/dev/null; then
+    if kill -0 "$(cat ${PIDFILE})" &>/dev/null; then
       echo "auter is currently enabled and running"
     else
       echo "auter is currently enabled and pid file exists but process is dead"
@@ -164,12 +179,11 @@ function quit() {
   if [[ -f "${PIDFILE}" ]]; then
     rm -f "${PIDFILE}"
   fi
-  exit $1
+  exit "$1"
 }
 
 function log_last_run() {
-    local LASTRUNTIME=$(date -Iseconds)
-    logit "INFO: Auter successfully ran at ${LASTRUNTIME}"
+    logit "INFO: Auter successfully ran at $(date -Iseconds)"
 }
 
 
@@ -229,7 +243,7 @@ fi
 
 if [[ "${DISABLE}" ]] ; then
   rm -f "${LOCKFILE}"
-  if [[ -f "${PIDFILE}" ]] && ! kill -0 $(cat ${PIDFILE}) &>/dev/null; then
+  if [[ -f "${PIDFILE}" ]] && ! kill -0 "$(cat ${PIDFILE})" &>/dev/null; then
       rm -f "${PIDFILE}"
       logit "INFO: auter disabled and cleared pid file"
   else
@@ -257,14 +271,7 @@ else
   echo "$$" > "${PIDFILE}"
 fi
 
-if [[ -f "${CONFIGFILE}" ]]; then
-  source "${CONFIGFILE}"
-elif [[ "${CUSTOMCONFIG}" ]]; then
-  logit "ERROR: Custom config file ${CONFIGFILE} does not exist"
-  quit 5
-else
-  logit "WARNING: Using default config values."
-fi
+read_config
 
 # CONFIGSET needs to be set if we're using a custom configuration file.
 if [[ -z "${CONFIGSET}" ]]; then
@@ -284,7 +291,7 @@ fi
 logit "INFO: Running with: $0 ${ARGS}"
 
 [[ "${MAXDELAY}" -lt 1 ]] && MAXDELAY=1
-$(tty -s) && MAXDELAY=1 && logit "INFO: Running in an interactive shell, disabling all random sleeps"
+tty -s && MAXDELAY=1 && logit "INFO: Running in an interactive shell, disabling all random sleeps"
 
 # There is an explicit quit here to avoid auter automatically running any
 # other unexpected functions.
@@ -295,8 +302,8 @@ $(tty -s) && MAXDELAY=1 && logit "INFO: Running in an interactive shell, disabli
 
 # The following 3 functions are provided by the previously sourced /usr/lib/auter/auter.module
 # Run the package manager specific check for locks
-[[ "${PREP}" ]] && check_package_manager_lock && prepare_updates
-[[ "${APPLY}" ]] && check_package_manager_lock && apply_updates
+[[ "${PREP}" ]] && prepare_updates
+[[ "${APPLY}" ]] && apply_updates
 
 [[ "${REBOOTCALL}" ]] && reboot_server