Merge lp:~kwmonroe/charms/trusty/ibm-java/may-2016 into lp:~ibmcharmers/charms/trusty/ibm-java/source

[Kevin W Monroe]

Updates from May 17 review:

- reduce verbosity (charms.reactive is too verbose with set +x)
- better checks to determine if sdk or jre is installed
- safer removal of ibm java
- manage javac alternative when the sdk is installed
- update expect script in case our sftp host does not require a password
- remove unneeded install-type logic since the user configures a specific package which does not necessarily match any configured install-type.
- update readme to reflect above changes

[lp:~kwmonroe/charms/trusty/ibm-java/may-2016]

9. By Kevin W Monroe on 2016-05-18

use correct path in /etc/profile

[Matt Bruzek (mbruzek)]

I have not run this code, but this change looks good to me. +1 from my side!

The IBM charming team should review this proposal and if they agree, merge it into the ibm-java layer source.

review: Approve

=== modified file 'README.md'
--- README.md	2016-02-29 18:53:01 +0000
+++ README.md	2016-05-18 02:37:35 +0000
@@ -1,14 +1,11 @@
-
-# Charm for IBM Java 1.8.0
-
-### Overview
-
-IBM Java
+# IBM Java 1.8.0
+
+## Overview
 
 The IBM implementation of the Java platform provides a development toolkit and
 an application runtime environment.
 
-IBM supply two installable packages depending on platform: The Software
+IBM supplies two installable packages depending on platform: The Software
 Developers Kit (SDK) and the Java Runtime Environment (JRE). The key components
 in this charm are
 
@@ -19,136 +16,120 @@
 - J9 Virtual Machine (JVM) - The IBM J9 virtual machine (JVM) is the
     platform-specific component that runs a Java program.
 
-User guides and security guides to support this release are available for
-Online viewing [User Guide](http://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/welcome/welcome_javasdk_version.html)
-
-Any late breaking news can be found in the following
-[IBM support technote](http://www.ibm.com/support/docview.wss?uid=swg21672834)
-
-### Download of Product Binaries 
-
-Download your licensed IBM Java 1.8.0 software for Ubuntu.
-
-You can download product binaries from
-[IBM developerWorks](https://www.ibm.com/developerworks/java/jdk/index.html)
-
-
-#### Usage
-
-To install the downloaded binaries you must agree to the IBM license.
+User and security guides to support this release are available for in the [User Guide](http://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/welcome/welcome_javasdk_version.html).
+
+Late breaking news can be found in the [IBM support technote](http://www.ibm.com/support/docview.wss?uid=swg21672834).
+
+
+## Download of Product Binaries
+
+Download your licensed IBM Java 1.8.0 software for Ubuntu from
+[IBM developerWorks](https://www.ibm.com/developerworks/java/jdk/index.html).
+
+
+## Usage
+
+To install the downloaded binaries, you must agree to the IBM license.
 
 IBM Java is a subordinate charm that can be related to any existing services
-which consumes IBM Java as this charm relates via java interface.
+which require a java interface.
 
 Run the following to deploy this charm:
 
 	juju deploy ibm-java
 
-Here is the simple deployment scenario wherein IBM Java being installed on the ubuntu-devenv unit:
+Here is a simple deployment scenario where IBM Java is installed on the
+`ubuntu-devenv` unit:
 
-	juju deploy cs:~kwmonroe/trusty/ubuntu-devenv
+	juju deploy cs:trusty/ubuntu-devenv
 	juju add-relation ubuntu-devenv ibm-java
 
-In the above deployment scenario ubuntu-devenv and ibm-java charms are related via java interface.
-
-At this point the charm will wait until the user accepts the license. If you
-agree to the license, run the following command:
-
-Set all required config values like the SFTP server,  package name, directory 
-in SFTP server where package is kept, username and password to connect to 
-SFTP host and checksum value to proceed with installation, by using 
-juju set command. To provide these run the following command: 
-
-	juju set ibm-java accept-ibm-java-license=True
-
-If not,
+In the above deployment scenario, ubuntu-devenv and ibm-java charms are related
+via the java interface. At this point, the charm will wait until the user
+accepts the license and provides required configuration.
+
+Set all required config values such as the SFTP server, package name, remote
+directory where the installable package is hosted, username and password to
+connect to the SFTP host, and checksum value to proceed with installation. To
+provide these run the following command:
 
 	juju set ibm-java accept-ibm-java-license=True \
-        host=<Web server host name> \
-        package_dir=<Fully qualified Package path, do not add the package name > \
-        username=<User name of the repository host> \
-        password=<Password of the repository host> \
-        javasdk_file_name=<IBM Java Package name> \
-        javasdk_path_name=<IBM Java target Installation Directory> \
-        java-major=<IBM Java Major version of java> \
-        install-type=<IBM Java type of install to perform. Valid options are 'jre' or 'full'>
-
-
-Once deployed, you can use IBM Java to run any Java workloads. To verify java is installed or not 
-get into the containter where IBM Java is installed and run the below command.
-
-	java -version
-
-To get into the container run the below commmand.
-
-	juju ssh <machine-id where IBM Java is installed>
-
-
-### Uninstallation of ibm-java
-
-Setting the accept-ibm-java-license to False will uninstall the product. 
+        host=<sftp server host name> \
+        package_dir=<remote package path, do not add the package name> \
+        java_file_name=<java installer file name> \
+        username=<User name for the sftp host> \
+        password=<Password for the sftp host> \
+        java_path_name=<target installation directory (defaults to /opt/ibm/java)>
+
+
+Once deployed, you can use IBM Java to run any Java workloads. Verify that
+java is installed correctly with:
+
+	juju run --service=ibm-java 'java -version'
+
+Access the machine running IBM Java with:
+
+	juju ssh ibm-java/0
+
+
+## Uninstalling IBM Java
+
+Setting the `accept-ibm-java-license` to `False` will uninstall the product:
 
 	juju set ibm-java accept-ibm-java-license=False
 
 
-### Configuration
+## Configuration
 
 - **accept-ibm-java-license** Before you can use or install IBM Java,
-    you must accept the terms of International License
+    you must accept the terms of the International License
     Agreement for Non-Warranted Programs and additional license information.
     Please read the license agreement carefully
-   [IBM Java SDK License](http://www-03.ibm.com/software/sla/sladb.nsf/displaylis/B0D11A46C1BE8BB585257E3B00660B2C?OpenDocument). Set the value of accept-ibm-java-license to True if you agree to IBM Java license.
-
-**The IBM Java software cannot be installed until the terms and
-conditions are accepted.  The charm will not function correctly until the
-this configuration option is set to True.**
-
-- **host** The web server host name from which IBM Java SDK installation packages 
+   [IBM Java SDK License](http://www-03.ibm.com/software/sla/sladb.nsf/displaylis/B0D11A46C1BE8BB585257E3B00660B2C?OpenDocument). Set the value of accept-ibm-java-license to True if you agree
+   to the IBM Java license.
+
+  **IBM Java software cannot be installed until the terms and conditions are
+  accepted.  The charm will not function correctly until the this configuration
+  option is set to True.**
+
+- **host** The sftp server host name from which IBM Java installation packages
     can be downloaded.
 
-- **package_dir** The package directory path in the web server.
-
-- **username** User name of the webserver host.
-
-- **password** Password of the webserver host.
+- **package_dir** The remote directory containing the IBM Java installation package.
 
 - **java_file_name** The IBM Java Package name. If not set, it is
-    assigned to the default package name for power or x86_64 based machine.
-
-- **java_path_name** The IBM Java SDK target installation directory. If not
-    set, it will be assigned to the default value "/opt/ibm/java".
-
-- **sha** Checksum value to check integrity of IBM Java package. The Charm
-    uses sha1sum to check the integrity. If empty, it does not carry out the
-    integrity check. Use `sha1sum <Package Location/Package Name> | cut -d" " -f1`
-    to find out Checksum value for downloaded package. Cryptographic value
-    should be altered by the user only when the package name is change. Else it
-    should not be altered.
-
-- **install-type** Type of install to perform. Valid options are 'jre' or 'full'. 
-    The default is 'jre', which will install the IBM Java Runtime Environment (JRE). 
-    Setting this to 'full' will install the IBM Java Development Kit in addition to the JRE.
-
-### IBM Java Information
+    assigned to the default package name for power or x86_64 based machines.
+
+- **username** User name of the sftp host.
+
+- **password** Password of the sftp host.
+
+- **java_path_name** The IBM Java target installation directory. If not
+    set, it will be assigned to the default value `/opt/ibm/java`.
+
+- **sha** Checksum value to check integrity of the downloaded IBM Java
+    installaer package. This charm uses sha1sum to verify the integrity.
+
+## IBM Java Information
 
 ### General Information
 
-Details about IBM Java available [Here](http://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/welcome/welcome_javasdk_version.html)
+Details about IBM Java available [Here](http://www.ibm.com/support/knowledgecenter/SSYKE2_8.0.0/welcome/welcome_javasdk_version.html).
 
 ### Download Information
 
-Information on procuring IBM Java product is available at the [Product Page](http://www.ibm.com/developerworks/java/jdk/linux/download.html)
+Information on procuring IBM Java is available at the [Product Page](http://www.ibm.com/developerworks/java/jdk/linux/download.html).
 
-A development version IBM Java is available [Here](http://www.ibm.com/software/products/en/mobilefirstfoundation)
+A development version of IBM Java is available [Here](http://www.ibm.com/software/products/en/mobilefirstfoundation).
 
 ### License Information
 
-License information for IBM Java can be viewed [Here](http://www-03.ibm.com/software/sla/sladb.nsf/displaylis/B0D11A46C1BE8BB585257E3B00660B2C?OpenDocument)
-
-### Known Limitations
-
-This charm makes use of Juju Status commands, and requires juju 1.24 or greater
-
-### Contact Information
-
-For issues with this charm, please contact [IBM Juju Support Team](mailto:[e-mail])
+License information for IBM Java can be viewed [Here](http://www-03.ibm.com/software/sla/sladb.nsf/displaylis/B0D11A46C1BE8BB585257E3B00660B2C?OpenDocument).
+
+## Known Limitations
+
+This charm makes use of Juju status commands, and requires juju 1.25 or greater.
+
+## Contact Information
+
+For issues with this charm, please contact the [IBM Juju Support Team](mailto:[e-mail]).

=== modified file 'config.yaml'
--- config.yaml	2016-02-29 18:53:01 +0000
+++ config.yaml	2016-05-18 02:37:35 +0000
@@ -55,11 +55,3 @@
       the integrity check. Refer README file to find out Checksum value for
       downloaded package. Cryptographic value should be altered by the user
       only when the package name is change. Else it should not be altered.
-  install-type:
-    type: string
-    default: jre
-    description: |
-      Type of install to perform. Valid options are 'jre' or 'full'. The
-      default is 'jre', which will install the IBM Java Runtime Environment
-      (JRE). Setting this to 'full' will install the IBM Java Development
-      Kit in addition to the JRE.

=== modified file 'files/sftp_get.sh'
--- files/sftp_get.sh	2016-02-29 18:17:24 +0000
+++ files/sftp_get.sh	2016-05-18 02:37:35 +0000
@@ -9,10 +9,25 @@
 set r_dir [lindex $argv 3]
 set localpath [lindex $argv 4]
 
-set timeout 90
+set timeout 600
 spawn sftp -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null $user@$host:$r_dir $localpath
-expect "password:"
-send "$password\n"
-set timeout 3000
-catch wait result
-exit [lindex $result 3]
+expect {
+  timeout {
+    send_user "\nFailed to execute sftp\n"
+    exit 1
+  }
+  eof {
+    exit 0
+  }
+  "*assword:"
+}
+send "$password\r"
+expect {
+  timeout {
+    send_user "\nFailed to download in time\n"
+    exit 1
+  }
+  eof {
+    exit 0
+  }
+}

=== modified file 'reactive/ibm-java'
--- reactive/ibm-java	2016-05-12 06:49:51 +0000
+++ reactive/ibm-java	2016-05-18 02:37:35 +0000
@@ -1,8 +1,6 @@
 #!/bin/bash
-
-set -ex
-
 source charms.reactive.sh
+set -e
 
 ARCHIVE_DIR=$CHARM_DIR/files/archives
 
@@ -18,14 +16,10 @@
 DEFAULT_INSTALLER_SDK_SHA=""
 if [ "$ARCHITECTURE" = "x86_64" ]; then
 	DEFAULT_INSTALLER_FILE_SDK="ibm-java-x86_64-sdk-8.0-2.0.bin"
-	DEFAULT_INSTALLER_FILE_JRE="ibm-java-x86_64-jre-8.0-2.0.bin"
 	DEFAULT_INSTALLER_SDK_SHA="71b3bf11ac6e04d8d697cca80ea00ab841f3ea57"
-	DEFAULT_INSTALLER_JRE_SHA="ef0845dd42704b3ae956efdd113ff0d317582baf"
 elif [ "$ARCHITECTURE" = "ppc64le" ]; then
 	DEFAULT_INSTALLER_FILE_SDK="ibm-java-ppc64le-sdk-8.0-2.0.bin"
-	DEFAULT_INSTALLER_FILE_JRE="ibm-java-ppc64le-jre-8.0-2.0.bin"
 	DEFAULT_INSTALLER_SDK_SHA="73a12fd8491d8d18d2ad809a77d8bfde747cb899"
-	DEFAULT_INSTALLER_JRE_SHA="0211e889166d4eee871cbb2d36e17d5cd5c9271f"
 else
 	status-set blocked "IBM Java: Platform not supported"
 fi
@@ -37,24 +31,20 @@
 # Check whether IBM Java is installed
 function is_javasdk_installed()
 {
-
-	if  [ -d $JAVA_INSTALL_PATH/bin ]; then
+	if  [ -f "$JAVA_INSTALL_PATH/bin/javac" ]; then
 		echo "True"
 	else
 		echo "False"
 	fi
-
 }
 
 function is_jre_installed()
 {
-
-	if  [ -d $JAVA_INSTALL_PATH/jre/bin ]; then
+	if  [ -f "$JAVA_INSTALL_PATH/jre/bin/java" ]; then
 		echo "True"
 	else
 		echo "False"
 	fi
-
 }
 
 
@@ -64,19 +54,20 @@
 # function is called.
 function remove_java_software()
 {
-
 	javasdk_installed=`is_javasdk_installed`
 	jre_installed=`is_jre_installed`
-	if  [ $javasdk_installed == "True" ]; then
-		$JAVA_INSTALL_PATH/_uninstall/uninstall
-		rm -rf $JAVA_INSTALL_PATH
-		sed --in-place "\|$JAVA_INSTALL_PATH|d" /etc/profile
-		update-alternatives --remove "java" "$JAVA_INSTALL_PATH/bin/java"
-	elif [ $jre_installed == "True" ]; then
-		$JAVA_INSTALL_PATH/_uninstall/uninstall
-		rm -rf $JAVA_INSTALL_PATH
-		sed --in-place "\|$JAVA_INSTALL_PATH|d" /etc/profile
-		update-alternatives --remove "java" "$JAVA_INSTALL_PATH/jre/bin/java"
+	if [ -d "$JAVA_INSTALL_PATH" ]; then
+		$JAVA_INSTALL_PATH/_uninstall/uninstall
+		rm -rf $JAVA_INSTALL_PATH
+		if  [ $javasdk_installed == "True" ]; then
+			sed --in-place "s|$JAVA_INSTALL_PATH/bin:||" /etc/profile
+			update-alternatives --remove "javac" "$JAVA_INSTALL_PATH/bin/javac"
+		if [ $jre_installed == "True" ]; then
+			sed --in-place "s|$JAVA_INSTALL_PATH/jre/bin:||" /etc/profile
+			update-alternatives --remove "java" "$JAVA_INSTALL_PATH/jre/bin/java"
+		fi
+	else
+		juju-log "JAVA_INSTALL_PATH not found; could not remove java software"
 	fi
 }
 
@@ -86,7 +77,7 @@
 {
 	#Exit if URL to download package is null
 	if [ "$USERNAME" == "" -o "$PASSWORD" == "" -o "$HOST" == "" -o "$PACKAGE_DIR" == "" ]; then
-		status-set blocked "IBM Java: Failed to download files from repository. Please provide vales for host,package_dir,username and password in config.yaml"
+		status-set blocked "IBM Java: Failed to download files from repository. Please provide values for host,package_dir,username and password in config.yaml"
 		exit 0
 	fi
 
@@ -100,15 +91,10 @@
 
 	# Get the package name to check whether the user wants to install a different package
 	cfg_pkg_name=`config-get java_file_name`
-	install_type=$(config-get 'install-type')
 
 	# Set package name to a predefined value if the user has not provided a package name
 	if [ "$cfg_pkg_name" == "" ]; then
-		if [[ ${install_type} == "full" ]]; then
-			cfg_pkg_name=${DEFAULT_INSTALLER_FILE_SDK}
-		else
-			cfg_pkg_name=${DEFAULT_INSTALLER_FILE_JRE}
-		fi
+		cfg_pkg_name=${DEFAULT_INSTALLER_FILE_SDK}
 	fi
 
 	# The user has configured a different package name
@@ -116,7 +102,7 @@
 		#Download the new IBM Java package
 		status-set maintenance "Downloading IBM Java installer"
 		$CHARM_DIR/files/sftp_get.sh $USERNAME $PASSWORD $HOST $PACKAGE_DIR/$cfg_pkg_name $ARCHIVE_DIR
-		if [ $? == 0 ]; then
+		if [ $? -eq 0 ]; then
 			status-set maintenance "IBM Java: Downloaded IBM Java package."
 			chmod -R 777 $ARCHIVE_DIR/*
 			# Remove previously downloaded and installed IBM Java software
@@ -134,11 +120,7 @@
 	# Check integrity of downloaded package
 	SHA=`config-get sha`
 	if [ "$SHA" == "" ]; then
-		if [[ ${install_type} == "full" ]]; then
-			SHA=${DEFAULT_INSTALLER_SDK_SHA}
-		else
-			SHA=${DEFAULT_INSTALLER_JRE_SHA}
-		fi
+		SHA=${DEFAULT_INSTALLER_SDK_SHA}
 	fi
 	if [ "$SHA" != "`sha1sum $ARCHIVE_DIR/$cfg_pkg_name | cut -d" " -f1`" ]; then
 		status-set blocked "SHA mismatch; set 'sha' to the sha1sum of ${cfg_pkg_name}"
@@ -150,8 +132,7 @@
 # Check Environment Variables for IBM Java
 function check_javapath()
 {
-	cd /etc
-	if grep -q "$JAVA_INSTALL_PATH" profile
+	if grep -q "$JAVA_INSTALL_PATH" /etc/profile
 	then
 		echo "True"
 	else
@@ -179,7 +160,6 @@
 @when 'java.connected' 'license.accepted'
 @when_not 'java.installed'
 function install() {
-	install_type=$(config-get 'install-type')
 	if [[ ! -d $ARCHIVE_DIR ]]; then
 		mkdir $ARCHIVE_DIR
 	fi
@@ -191,42 +171,38 @@
 	set_java_path=`check_javapath`
 	if [ $set_java_path == "False" ]; then
 		cd /etc
-		echo "export PATH=$JAVA_INSTALL_PATH/bin:$JAVASDK_INSTALL_PATH/jre/bin:$PATH" >> profile
-		source /etc/profile
-	else
-		source /etc/profile
-	fi
-	
-	if [[ ${install_type} == "full" ]]; then
-		update-alternatives --install "/usr/bin/java" "java" "$JAVA_INSTALL_PATH/bin/java" 1
-		update-alternatives --set "java" "$JAVA_INSTALL_PATH/bin/java"
-	else
-		update-alternatives --install "/usr/bin/java" "java" "$JAVA_INSTALL_PATH/jre/bin/java" 1
-		update-alternatives --set "java" "$JAVA_INSTALL_PATH/jre/bin/java"
-	fi
-	
-	# Send relation data
-	java_home=$(readlink -f /usr/bin/java | sed "s:/bin/java::")
-	java_version=$(java -version 2>&1 | grep -i version | head -1 | awk -F '"' {'print $2'})
-	relation_call --state=java.connected set_ready $java_home $java_version
-
-	set_state 'java.installed'
-	status-set active "IBM Java ${java_version} installed"
+		echo "export PATH=$JAVA_INSTALL_PATH/bin:$JAVA_INSTALL_PATH/jre/bin:$PATH" >> profile
+		source /etc/profile
+	else
+		source /etc/profile
+	fi
+
+	update-alternatives --install "/usr/bin/java" "java" "$JAVA_INSTALL_PATH/jre/bin/java" 1
+	update-alternatives --set "java" "$JAVA_INSTALL_PATH/jre/bin/java"
+	if [ $javasdk_installed == "True" ]; then
+		update-alternatives --install "/usr/bin/javac" "javac" "$JAVA_INSTALL_PATH/bin/javac" 1
+		update-alternatives --set "javac" "$JAVA_INSTALL_PATH/bin/javac"
+	fi
+
 	java -version
-	if [ $? == 0 ]; then
-		if [[ ${install_type} == "full" ]]; then
+	if [ $? -eq 0 ]; then
+		# Send relation data
+		java_home=$(readlink -f /usr/bin/java | sed "s:/bin/java::")
+		java_version=$(java -version 2>&1 | grep -i version | head -1 | awk -F '"' {'print $2'})
+		relation_call --state=java.connected set_ready $java_home $java_version
+
+		set_state 'java.installed'
+		if [ $javasdk_installed == "True" ]; then
 			status-set active "Ready: IBM Java SDK $java_version"
 		else
 			status-set active "Ready: IBM Java Runtime Environment $java_version"
 		fi
 	else
-		if [[ ${install_type} == "full" ]]; then
-			update-alternatives --remove "java" "$JAVA_INSTALL_PATH/bin/java"
-			status-set blocked "IBM Java: Error while installing IBM Java SDK"
-		else
-			update-alternatives --remove "java" "$JAVA_INSTALL_PATH/jre/bin/java"
-			status-set blocked "IBM Java: Error while installing IBM Java Runtime Environment"
+		update-alternatives --remove "java" "$JAVA_INSTALL_PATH/jre/bin/java"
+		if [ $javasdk_installed == "True" ]; then
+			update-alternatives --remove "javac" "$JAVA_INSTALL_PATH/bin/javac"
 		fi
+		status-set blocked "IBM Java: Error while installing IBM Java"
 	fi
 }
 
@@ -234,7 +210,6 @@
 @when 'config.changed'
 function check_version() {
 	if charms.reactive is_state 'config.changed.java_path_name' || \
-           charms.reactive is_state 'config.changed.install-type' || \
            charms.reactive is_state 'config.changed.java_file_name' || \
            charms.reactive is_state 'config.changed.sha'; then
 		status-set maintenance "Uninstalling all IBM Java versions before installing new one"