Preupgrade Assistant contents Packaging guidelines

INI file is checked by %{preupgrade_build} script. If something is missing user is informed.

[preupgrade]
content_title: Short content name
author: Your Name <yname@ydomain.com>
content_description: 'Enter your description here'
+config_file: ++ THIS IS OPTIONAL. IT INFORMS ADMINISTRATOR WHAT FILES ARE AFFECTED+
+check_script: +
+solution: +
applies_to: <specify_package_needs_to_be_on_system. if_not_installed_then_NOT_APPLICABLE> , comma separated
+requires: ++ THIS IS OPTIONAL+

The elements description:

Template for bash check script

#!/bin/bash

. /usr/share/preupgrade/common.sh

#END GENERATED SECTION

# This check can be used if you need root privilegues

+# Copy your config file from RHEL6 (in case of scenario RHEL6_7) +
# to Temporary Directory
CONFIG_FILE="full_path_to_your_config_file"
mkdir -p $VALUE_TMP_PREUPGRADE/cleanconf/$(dirname $CONFIG_FILE)
cp $CONFIG_FILE $VALUE_TMP_PREUPGRADE/cleanconf/$CONFIG_FILE

# Now check you configuration file for options
# and for other stuff related with configuration

# If configuration can be used on target system (like RHEL7 in case of RHEL6_7)
# the exit should be RESULT_PASS

# If configuration can not be used on target system (like RHEL 7 in case of RHEL6_7)
# scenario then result should be RESULT_FAIL. Correction of
# configuration file is provided either by solution script
# or by postupgrade script located in $VALUE_TMP_PREUPGRADE/postupgrade.d/

# if configuration file can be fixed then fix them in temporary directory
# $VALUE_TMP_PREUPGRADE/$CONFIG_FILE and result should be RESULT_FIXED
# More information about this issues should be described in solution.txt file
# as reference to KnowledgeBase article.

grep "Sometext" $CONFIG_FILE
if [ $? -ne 0 ]; then
+    log_info "Config file $CONFIG_FILE will be fixed by solution script"+
+    # postupgrade.d directory from your content is automatically copied by+
+    # preupgrade assistant into $VALUE_TMP_PREUPGRADE/postupgrade.d/ directory+
+    exit $RESULT_FAIL+
fi

exit $RESULT_PASS

Template for python check script

#!/usr/bin/python
+# -- Mode: Python; python-indent: 8; indent-tabs-mode: t -- +

import sys, os, errno
import datetime

from preup.script_api import *

#END GENERATED SECTION
component = "Specify component name used for logging"
# exit functions are exit_{pass,not_applicable, fixed, fail, etc.}
# logging functions are log_{error, warning, info, etc.}
# for logging in-place risk use functions log_{extreme, high, medium, slight}_risk

def main():
+    if os.geteuid() != 0:+
+        sys.stdout.write("Need to be root.\n")+
+        log_slight_risk("The script needs to be run under root account")+
+        exit_error()+


if __name__ == "__main__":
+   set_component(component) +
+   main()+
+   exit_pass()+