Application Log Statements Output

.travis.yml

@@ -4,14 +4,14 @@ podfile: Example/Podfile
 osx_image: xcode9
 before_install:
 - gem install cocoapods # Since Travis is not always on latest version
-
+- gem install xcpretty-travis-formatter # Tidy up Xcode Logs to make it easier to read when the build fails
 script:
 # OCSlimProject Example Acceptance Tests (iOS, macOS)
-- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProject_Example -destination 'platform=iOS Simulator,name=iPhone X' -destination-timeout 300 test
-- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProject_ExampleMac test
+- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProject_Example -destination 'platform=iOS Simulator,name=iPhone X' -destination-timeout 300 test | xcpretty -f `xcpretty-travis-formatter`
+- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProject_ExampleMac test | xcpretty -f `xcpretty-travis-formatter`
 # OCSlimProjectTestBundleSupport Pod Unit Tests (iOS, macOS)
-- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProjectTestBundleSupportTests -destination 'platform=iOS Simulator,name=iPhone X' test
-- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProjectTestBundleSupportTestsMac test
+- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProjectTestBundleSupportTests -destination 'platform=iOS Simulator,name=iPhone X' test | xcpretty -f `xcpretty-travis-formatter`
+- set -o pipefail && xcodebuild -workspace Example/OCSlimProject.xcworkspace -scheme OCSlimProjectTestBundleSupportTestsMac test | xcpretty -f `xcpretty-travis-formatter`
 # Pod Lib Lint (unavailable on xcode 8)
 #- pod lib lint OCSlimProject.podspec --allow-warnings
 #- pod lib lint OCSlimProjectTestBundleSupport.podspec --use-libraries --allow-warnings

Example/OCSlimProject.xcodeproj/project.pbxproj

@@ -1425,7 +1425,7 @@
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				INFOPLIST_FILE = OCSlimProject_AcceptanceTestsMac/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.12;
 				PRODUCT_BUNDLE_IDENTIFIER = "net.stringerstheory.OCSlimProject-AcceptanceTestsMac";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = macosx;
@@ -1441,7 +1441,7 @@
 				CODE_SIGN_IDENTITY = "-";
 				INFOPLIST_FILE = OCSlimProject_AcceptanceTestsMac/Info.plist;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
-				MACOSX_DEPLOYMENT_TARGET = 10.11;
+				MACOSX_DEPLOYMENT_TARGET = 10.12;
 				PRODUCT_BUNDLE_IDENTIFIER = "net.stringerstheory.OCSlimProject-AcceptanceTestsMac";
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SDKROOT = macosx;

Example/OCSlimProject_AcceptanceTests/FixtureExample.swift

@@ -1,5 +1,5 @@
 import Foundation
-
+import os.log
 @objc(FixtureExample)
 
 class FixtureExample : NSObject, SlimDecisionTable {
@@ -16,7 +16,7 @@ class FixtureExample : NSObject, SlimDecisionTable {
         // 2. Run your SUT
         // 3. Take values from the SUT and return via outputs
     }
-    
+
     //MARK: Outputs
 
     var output: NSString? {
@@ -31,5 +31,29 @@ class FixtureExample : NSObject, SlimDecisionTable {
             }
         }
     }
+
+
+    //MARK: Calling Methods
+
+    func log() -> Bool {
+
+        // Only prints to a running Xcode console
+
+        print("*WARNING* Swift's print function on iOS only print to the Xcode console not to logs.")
+
+        // Use NSLog to print to the system log as a default message type
+
+        NSLog("NSLog() statement")
+
+        // Use os_log to print to the system log with related type  (recommended)
+
+        if #available(iOS 10.0, *) {
+            os_log("os_log() .default log statement", type: .default)
+            os_log("os_log() .info log statement", type: .info)
+            os_log("os_log() .error log statement", type: .error)
+        }
+
+        return true
+    }
 
-}
+}

Example/OCSlimProject_AcceptanceTestsMac/FixtureExample.swift

@@ -1,4 +1,5 @@
 import Foundation
+import os.log
 
 @objc(FixtureExample)
 
@@ -31,5 +32,23 @@ class FixtureExample : NSObject, SlimDecisionTable {
             }
         }
     }
+
+    //MARK: Calling Methods
+
+    func log() -> Bool {
+
+        // Logging Examples
+
+        print("Swift print() (OSX only)")
+        NSLog("NSLog() statement (recommended)")
+
+        // os_log is unsupported
+
+        if #available(OSX 10.12, *) {
+            os_log("*WARNING* os_log() statements such as this one are not captured on OS X")
+        }
+
+        return true
+    }
 
-}
+}

Pod/Support/OSX/RunTestsTargetWithSlimPort

@@ -2,19 +2,73 @@
 source $1
 ENVIRONMENT_SRC=$1
 SLIM_PORT=$2
-APPLICATION_PATH=${TARGET_BUILD_DIR}/${EXECUTABLE_PATH}
+EXECUTABLE_PATH=${TARGET_BUILD_DIR}/${EXECUTABLE_PATH}
+APP_PATH=${TARGET_BUILD_DIR}/${PRODUCT_NAME}.app
 
-run_test_system() {
-	echo "Test System Executable Folder Path: $APPLICATION_PATH"
-	$APPLICATION_PATH $SLIM_PORT
-	return $?
-}
+# Main Subroutines
 
 main() {
-	echo "== OCSlimProject: RunSlimTestTargetWithSlimPort~OSX:$SLIM_PORT =="
-	echo "Test System Executable Environment: $ENVIRONMENT_SRC"
+	log "RunSlimTestTargetWithSlimPort~macOSX"
+	log "Fitnesse Slim Port: $SLIM_PORT"
+	log "Xcode Build Product $APP_PATH"
 	run_test_system
 	exit $?
 }
 
-main
+run_test_system() {
+
+	local LOGFILE=$(get_log_file_path)
+	launch_osx_app $LOGFILE
+	write_logs_to_console $LOGFILE
+	return $?
+}
+
+launch_osx_app() {
+	log "Launching '${PRODUCT_NAME}.app'"
+	local LOGFILE=$1
+	log "macOS System log started" > $LOGFILE 
+	$EXECUTABLE_PATH $SLIM_PORT >> $LOGFILE 2>&1
+	log "macOS System log ended" >> $LOGFILE
+}
+
+## Logging Subroutines
+
+write_logs_to_console() {
+	local LOGFILE=$1
+	log "Reading log file: $LOGFILE"
+	cat $LOGFILE 
+}
+
+get_log_file_path() {
+	local LOGDIR="Logs"
+	local LOGPATH="$(pwd)/$LOGDIR"
+	local LOGFILENAME="$(date +%Y%m%d-%H%M%S).log"
+	local LOGFILE="$LOGPATH/$LOGFILENAME"
+	mkdir -p $LOGPATH
+	echo $LOGFILE
+}
+
+tidy_zero_line_app_log_file(){
+	# Check number of lines in logfile before returning a log file
+	if [ ! $(grep -c '' $1) ]; then
+		rm $1
+		return 0
+	else
+		return 1
+	fi
+}
+
+# Logging Subroutined
+
+log() {
+	echo "[OCSP_RUN] INFO: $1"
+}
+
+error() {
+	>&2 echo "[OCSP_RUN] ERROR: $1"
+	exit 1
+}
+
+# Main Routine
+
+main

Pod/Support/SharedSupport/FitNesseRoot/OCSlimProjectExamplePage/TestPage/content.txt

@@ -1,13 +1,32 @@
 !1 OCSlimProject Example Test Page
-
-Below is a simple Decision Table based Acceptance Test. It sends input to an instance of a Fixture which is implemented in your Xcode project. This is done by adding a class of the same name e.g. 'FixtureExample.swift' to your Acceptance Test target. 
+Below is a simple Decision Table based Acceptance Test. It sends input to an instance of a Fixture which is implemented in your Xcode project. This is done by adding a class of the same name e.g. 'FixtureExample.swift' to your Acceptance Test target.
 
 The first column 'input' will set a property of the same name. The expected 'output?' denoted by columns with '?' at the end of the property name are returned by your Fixture and verified against the expected value in that column.
 
 Click 'Test' to run this page and see this in action. After that check out ''!-FixtureExample.swift-!'' in your Xcode project to see the 'FixtureExample.swift' implementation.
 
-|Fixture Example|
-|input |output? |
-|foo   |bar     |
-|bar   |baz     |
+!2 Simple Decision Table Example
+| Fixture Example |
+| input | output? |
+| foo | bar |
+| bar | baz |
+
+!2 Logging Example
+| script | Fixture Example |
+| ensure | log |
+
+!3 Logging
+
+* Find log files for each test run in the current directory ./Logs/<DATE>.log. 
+* Log statements are reported in the 'Execution Log' (see the button after running a test located in the top right navigation).
+* Test runs that generate no log statements will not generate a log file.
 
+!4 iOS:
+* NSLog()
+* os_log()
+* print() does not work!
+
+!4 macOS X:
+* NSLog()
+* print()
+* os_log() does not work!

Pod/Support/SharedSupport/ocsp-generate-fitnesse-test-system-template.sh

@@ -7,10 +7,20 @@ ERROR_LOG_FILE=%s
 $TEST_RUNNER_SCRIPT $ENV_FILE_PATH $SLIM_PORT 2> >(tee $ERROR_LOG_FILE >&2)
 
 ERROR_LOG_NO_WHITESPACE=$(more "$ERROR_LOG_FILE" | sed 's/ *$//')
-
+
+log() {
+	echo "[OCSP_RUN] INFO: $1"
+}
+
+error() {
+	>&2 echo "[OCSP_RUN] ERROR: $1"
+	exit 1
+}
+
 if [ -z "$ERROR_LOG_NO_WHITESPACE" ]; then 
 	rm $ERROR_LOG_FILE
-	echo "[OCSP_RUN] Slim Test System Exited Normally"
+	log "Slim Test System Exited OK"
+	exit 0
 else
-	echo "[OCSP_RUN] Slim Test System Exited Abnormally With Reported Errors"
+	error "Slim Test System Exited Abnormally With Reported Errors"
 fi

Pod/Support/SharedSupport/ocsp-logger-tests.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+source '../../../assert.sh/assert.sh'
+
+LOGPATH=$(./ocsp-logger.sh new-log-file)
+LOGBASENAME=$(basename $LOGPATH)
+LOGDIR=$(dirname $LOGPATH)
+
+assert_not_empty "$LOGPATH"
+[ "$?" == 1 ] && log_failure "new-log-file should not be empty"
+
+test -d "$LOGDIR"
+assert_eq 0 $?
+[ "$?" == 1 ] && log_failure "new-log-file '$LOGDIR' is not a valid directory"
+
+expected="slim_system.log"
+assert_eq "$LOGBASENAME" "$expected"
+[ "$?" == 1 ] && log_failure "new-log-file '$LOGBASENAME' is not the expected '$expected' filename"
+
+
+

Pod/Support/SharedSupport/ocsp-logger.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+ACTION=LOG_PATH
+
+function main() {
+
+    if [ "$ACTION" == "LOG_PATH" ]; then
+	    local LOGDIR="Logs"
+	    local LOGPATH="$(pwd)/$LOGDIR"
+	    local LOGFILENAME="slim_system.log"
+	    local LOGFILE="$LOGPATH/$LOGFILENAME"
+	    mkdir -p $LOGPATH
+        echo "$LOGFILE"
+    fi
+
+}
+
+main

Pod/Support/iOS/RunTestsTargetWithSlimPort

@@ -27,42 +27,69 @@ get_app_devicetypeid() {
 slim_system_wait() {
 
 	local EXECUTABLE_PID=$(<.simctl.pid)
-
-	log "Waiting for Slim System... ($EXECUTABLE_PID) $(date)"
-
-	while ps -p $EXECUTABLE_PID
+	local INTERVAL=1
+	local COUNT=0
+
+	log_hrule
+	log "Waiting for System Under Test... (ProcessID: $EXECUTABLE_PID)";
+	while ps -p $EXECUTABLE_PID > /dev/null
 	do
-		sleep 1
+		sleep $INTERVAL;
+		((COUNT++))
 	done
-
-	log "Slim System Exited $(date)"
+	log "System Under Test exited (running for $COUNT second(s))"
 }
 
 run_test_system() {
-	log "Start Slim Test Sytem"
-	$MYPATH/simctl $APPLICATION_PATH $SLIM_PORT
+
+	local START_TIME=$(date '+%Y-%m-%d %H:%M:%S')
+	start_slim
+
  	if [ $? == 0 ]; then 
-	 	slim_system_wait; 
+	 	slim_system_wait
+		print_test_system_log $START_TIME
 	else 
-		log "**ABORTING** For details click the red/green 'Execution Log' button in Fitnesse to view stdout and stderr logs"
-	 	error "**ABORTING** Exit Code error detected when executing Slim Test Sytem with ($MYPATH/simctl)"
+		log_simctl_error
 	fi
 }
 
+start_slim() {
+	log "Starting System Under Test"
+	log_hrule
+	$MYPATH/simctl $APPLICATION_PATH $SLIM_PORT
+}
+
+print_test_system_log() {
+	local STARTTIME=$1
+	local LOGFILE=$($MYPATH/simctl log $STARTTIME)
+	log "Reading log file: $LOGFILE"
+	cat $LOGFILE
+}
+
+log_simctl_error() {
+	log "**ABORTING** Slim Test System reported an error. Check the executiong log for more details"
+	error "**ABORTING** Exit Code error detected when executing Slim Test Sytem with ($MYPATH/simctl)"
+}
+
 main() {
-	log "== RunSlimTestTargetWithSlimPort~iOS:$SLIM_PORT $(date)=="
-	log "Info: Test System Suggested SDK: $DEPLOYMENT_TARGET_VALUE"
-	log "Info: Test System Path: $APPLICATION_PATH"
+	log "RunSlimTestTargetWithSlimPort~iOS"
+	log "Fitnesse Slim Port: $SLIM_PORT"
+	log "Xcode Suggested SDK: $DEPLOYMENT_TARGET_VALUE"
+	log "Xcode Build Product: $APPLICATION_PATH"
 	run_test_system 
 	exit $?
 }
 
 log() {
-	echo "[OCSP_RUN] $1"
+	echo "[OCSP_RUN] INFO: $1"
+}
+
+log_hrule() {
+	log "------------------------------------------------"
 }
 
 error() {
-	>&2 echo "[OCSP_RUN] $1"
+	>&2 echo "[OCSP_RUN] ERROR: $1"
 	exit 1
 }