Merge pull request #69 from ba-st/dry_run_option

Add --dry-run option to launchpad start

.docker/gs64/docker-tests.sh

@@ -48,6 +48,16 @@ function assertOutputIncludesMessage() {
   fi
 }
 
+function assertOutputIsEmpty() {
+	local output=$1
+
+	if [ -s "$output" ];then
+		print_error "Expected std$output to be empty when invoked with $LAST_ARGUMENTS"
+		cat "$output"
+		exit 1
+	fi
+}
+
 set -e
 
 if [ $# -eq 0 ]; then
@@ -144,13 +154,25 @@ assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must
 print_success " Missing name, OK"
 run_launchpad_gem launchpad start greeter
 assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must provide one." err
+print_success " Missing name and title, OK"
+
+run_launchpad_gem launchpad start --dry-run greeter --name=Juan --title=Mr
+assertOutputIsEmpty err
+print_success " Dry run with valid parameters, OK"
+run_launchpad_gem launchpad start --dry-run greeter
+assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must provide one." err
+print_success " Dry run with missing parameters, OK"
 print_success "OK"
 
 print_info "Running launchpad start broken test"
 run_launchpad_gem launchpad start broken --raise-error
 assertOutputIncludesMessage "\[INFO\] Obtaining configuration... \[DONE\]" out
 assertOutputIncludesMessage "\[ERROR\] Unexpected startup error: \"Doh!\"" err
 print_success "OK"
+run_launchpad_gem launchpad start --dry-run broken --raise-error
+assertOutputIsEmpty err
+assertOutputIncludesMessage "\[INFO\] Obtaining configuration... \[DONE\]" out
+print_success "Dry run, OK"
 
 print_info "Stopping stone"
 docker stop gs64-stone

.docker/pharo/docker-tests.sh

@@ -48,6 +48,16 @@ function assertOutputIncludesMessage() {
 	fi
 }
 
+function assertOutputIsEmpty() {
+	local output=$1
+
+	if [ -s "$output" ];then
+		print_error "Expected std$output to be empty when invoked with $LAST_ARGUMENTS"
+		cat "$output"
+		exit 1
+	fi
+}
+
 set -e
 
 print_info "Building base image"
@@ -108,13 +118,24 @@ assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must
 print_success " Missing name, OK"
 executeWithArguments docker run launchpad-examples:sut launchpad-start greeter
 assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must provide one." err
+print_success " Missing name and title, OK"
+executeWithArguments docker run launchpad-examples:sut launchpad-start --dry-run greeter --name=Juan --title=Mr
+assertOutputIsEmpty err
+print_success " Dry run with valid parameters, OK"
+executeWithArguments docker run launchpad-examples:sut launchpad-start --dry-run greeter
+assertOutputIncludesMessage "\[ERROR\] \"Name\" parameter not provided. You must provide one." err
+print_success " Dry run with missing parameters, OK"
 print_success "OK"
 
 print_info "Running launchpad-start broken test"
 executeWithArguments docker run launchpad-examples:sut launchpad-start broken --raise-error
 assertOutputIncludesMessage "\[INFO\] Obtaining configuration... \[DONE\]" out
 assertOutputIncludesMessage "\[ERROR\] Unexpected startup error: \"Doh!\"" err
 print_success "OK"
+executeWithArguments docker run launchpad-examples:sut launchpad-start --dry-run broken --raise-error
+assertOutputIsEmpty err
+assertOutputIncludesMessage "\[INFO\] Obtaining configuration... \[DONE\]" out
+print_success "Dry run, OK"
 
 print_info "Running launchpad-start command server test"
 # broken app keeps running when passed and invalid option

docs/explanation/Application-start-up.md

@@ -20,7 +20,7 @@ the logging infrastructure:
   `stdout` on Unix); because there's no way to access the `stderr` handle
   attached to the VM process.
 
-As a second step, it instantiates a `LaunchpadCommandLineProcessingContext` with
+As a second step, it instantiates a `LaunchpadApplicationStartingContext` with
 the command-line and a reference to `stdout`. This context is later available
 in all the required methods and ultimately accessible by the application in its
 `basicStartWithin:` method.

docs/reference/CLI.md

@@ -197,6 +197,7 @@ The `start` sub-command will start the selected application.
 launchpad start [--help|-h] [--debug-mode] [--settings-file=<filename>]
                 [--enable-tcp-command-server=<listeningPort>]
                 [--enable-structured-logging]
+                [--dry-run]
                 <app> [<parameters>]
 ```
 
@@ -247,7 +248,7 @@ $ launchpad start greeter
                 launchpad-start - Start the selected application
   SYNOPSYS
                 launchpad start [--help|-h] [--debug-mode]
-                  [--settings-file=<filename>] <app> [<parameters>]
+                  [--settings-file=<filename>] [--dry-run] <app> [<parameters>]
   DESCRIPTION
                 Start the application selected via <app>.
 
@@ -268,6 +269,10 @@ $ launchpad start greeter
                         This option can occur several times to configure more
                         than one settings file. Supported file settings formats
                         are INI and JSON.
+                --dry-run
+                        Perform a dry run of the application.
+                        All the configuration will be loaded (and validated),
+                        but the application will not start.
   ```
 
 - `debug-mode` Enable the debugging mode.
@@ -290,3 +295,5 @@ $ launchpad start greeter
   can be used to send commands controlling the application using a TCP port.
 - `--enable-structured-logging` Enable structured logging. When enabled the log
   will be emitted in JSON format.
+- `--dry-run` Perform a dry run of the application. All the configuration will
+  be loaded (and validated), but the application will not start.

source/Launchpad-Applications/LaunchpadApplication.class.st

@@ -188,16 +188,14 @@ LaunchpadApplication >> stackTraceDumper [
 LaunchpadApplication >> startWithin: context [
 
 	mode
-		value: [ 
+		value: [
 			commandServer start.
 			LogRecord emitInfo: self class summary.
-			self
-				logConfigurationWithin: context;
-				basicStartWithin: context
+			self logConfigurationWithin: context.
+			context run: [ self basicStartWithin: context ]
 			]
-		onErrorDo: [ :error | 
-			LogRecord emitError:
-				( 'Unexpected startup error: "<1s>"' expandMacrosWith: error messageText ).
+		onErrorDo: [ :error |
+			LogRecord emitError: ( 'Unexpected startup error: "<1s>"' expandMacrosWith: error messageText ).
 			self stackTraceDumper dumpStackTraceFor: error.
 			self exitFailure
 			]

source/Launchpad-Commands-Pharo/LaunchpadStartApplicationCommand.extension.st

@@ -1,6 +1,6 @@
-Extension { #name : #LaunchpadStartApplicationCommand }
+Extension { #name : 'LaunchpadStartApplicationCommand' }
 
-{ #category : #'*Launchpad-Commands-Pharo' }
+{ #category : '*Launchpad-Commands-Pharo' }
 LaunchpadStartApplicationCommand >> enableTCPCommandServerListeningOn: listeningPort [
 
 	commandServer := TCPCommandServer listeningOn: listeningPort.

source/Launchpad-Commands-Pharo/LaunchpadTCPCommandServerOption.class.st

@@ -1,65 +1,67 @@
 Class {
-	#name : #LaunchpadTCPCommandServerOption,
-	#superclass : #LaunchpadOption,
+	#name : 'LaunchpadTCPCommandServerOption',
+	#superclass : 'LaunchpadOption',
 	#instVars : [
 		'command'
 	],
-	#category : #'Launchpad-Commands-Pharo'
+	#category : 'Launchpad-Commands-Pharo',
+	#package : 'Launchpad-Commands-Pharo'
 }
 
-{ #category : #'instance creation' }
+{ #category : 'instance creation' }
 LaunchpadTCPCommandServerOption class >> for: aCommand [
 
 	^ self new initializeFor: aCommand
 ]
 
-{ #category : #testing }
+{ #category : 'testing' }
 LaunchpadTCPCommandServerOption class >> isExtendedStartingOption [
 
 	^ true
 ]
 
-{ #category : #testing }
+{ #category : 'testing' }
 LaunchpadTCPCommandServerOption >> canHandle: argument [
 
 	^ argument beginsWith: '--' , self name , '='
 ]
 
-{ #category : #evaluating }
+{ #category : 'evaluating' }
 LaunchpadTCPCommandServerOption >> evaluateWithin: context handling: argument [
 
 	| listeningPort |
 
 	listeningPort := ( argument withoutFirst: self name size + 3 ) asNumber.
-	command enableTCPCommandServerListeningOn: listeningPort
+	command enableTCPCommandServerListeningOn: listeningPort.
+	^ context
 ]
 
-{ #category : #initialization }
+{ #category : 'initialization' }
 LaunchpadTCPCommandServerOption >> initializeFor: aCommand [
 
 	command := aCommand
 ]
 
-{ #category : #accessing }
+{ #category : 'accessing' }
 LaunchpadTCPCommandServerOption >> name [
 
 	^ 'enable-tcp-command-server'
 ]
 
-{ #category : #printing }
+{ #category : 'printing' }
 LaunchpadTCPCommandServerOption >> printHelpOn: stream [
 
 	super printHelpOn: stream.
 	self printSuffixOn: stream
 ]
 
-{ #category : #printing }
+{ #category : 'printing' }
 LaunchpadTCPCommandServerOption >> printSuffixOn: stream [
 
 	stream nextPutAll: '=<listeningPort>'
 ]
 
-{ #category : #accessing }
+{ #category : 'accessing' }
 LaunchpadTCPCommandServerOption >> summary [
 
 	^ 'Enable a TCP command server. This can be used to send commands controlling the application using a TCP port.'

source/Launchpad-Commands-Pharo/TCPCommandServer.class.st

@@ -1,48 +1,49 @@
 Class {
-	#name : #TCPCommandServer,
-	#superclass : #CommandServer,
+	#name : 'TCPCommandServer',
+	#superclass : 'CommandServer',
 	#instVars : [
 		'listeningPort',
 		'commmands',
 		'connectionSocket',
 		'serverProcess'
 	],
-	#category : #'Launchpad-Commands-Pharo'
+	#category : 'Launchpad-Commands-Pharo',
+	#package : 'Launchpad-Commands-Pharo'
 }
 
-{ #category : #'instance creation' }
+{ #category : 'instance creation' }
 TCPCommandServer class >> listeningOn: port [
 
 	^ self new initializeListeningOn: port
 ]
 
-{ #category : #private }
+{ #category : 'private' }
 TCPCommandServer >> initializeConnectionSocket [
 
 	connectionSocket := Socket newTCP
 ]
 
-{ #category : #initialize }
+{ #category : 'initialize' }
 TCPCommandServer >> initializeListeningOn: port [
 
 	listeningPort := port.
 	commmands := Dictionary new.
 	self initializeConnectionSocket
 ]
 
-{ #category : #accessing }
+{ #category : 'accessing' }
 TCPCommandServer >> listeningPort [
 
 	^ listeningPort
 ]
 
-{ #category : #registering }
+{ #category : 'registering' }
 TCPCommandServer >> registerCommandNamed: commandName executing: aBlock [
 
 	commmands at: commandName put: aBlock
 ]
 
-{ #category : #private }
+{ #category : 'private' }
 TCPCommandServer >> serverLoop [
 
 	^ [ 
@@ -57,7 +58,7 @@ TCPCommandServer >> serverLoop [
 	  ] repeat
 ]
 
-{ #category : #controlling }
+{ #category : 'controlling' }
 TCPCommandServer >> start [
 
 	LogRecord emitInfo:
@@ -74,7 +75,7 @@ TCPCommandServer >> start [
 	serverProcess resume
 ]
 
-{ #category : #controlling }
+{ #category : 'controlling' }
 TCPCommandServer >> stop [
 
 	serverProcess ifNotNil: #terminate.

source/Launchpad-Commands-Pharo/package.st

@@ -1 +1 @@
-Package { #name : #'Launchpad-Commands-Pharo' }
+Package { #name : 'Launchpad-Commands-Pharo' }

source/Launchpad-Commands-Tests/LaunchpadApplicationDryRunContextTest.class.st

@@ -0,0 +1,19 @@
+"
+A LaunchpadApplicationDryRunContextTest is a test class for testing the behavior of LaunchpadApplicationDryRunContext
+"
+Class {
+	#name : 'LaunchpadApplicationDryRunContextTest',
+	#superclass : 'TestCase',
+	#category : 'Launchpad-Commands-Tests',
+	#package : 'Launchpad-Commands-Tests'
+}
+
+{ #category : 'tests' }
+LaunchpadApplicationDryRunContextTest >> testConverting [
+
+	| context |
+
+	context := LaunchpadApplicationDryRunContext handling: ( CommandLineArguments withArguments: #(  ) ).
+
+	self assert: context asDryRunContext equals: context
+]