GPII-1885: Implemented isConfigurable and makeConfigurable functions

documentation/SolutionsRegistryFormat.md

@@ -14,13 +14,13 @@ Each entry in the solution registry should have a unique ID (`Solution.id` in th
     "start": [ .. ],
     "stop": [ .. ],
     "isInstalled": [ .. ],
-
+    "isConfigurable": [ ... ],
+    "makeConfigurable": [ ... ]
+
     // Not yet supported. Post-Cloud4All features.
     "install": [ ... ],
     "uninstall": [ ... ],
-    "makeConfigurable": [ ... ],
     "isRunning": [ ... ],
-    "isConfigurable": [ ... ]
 }
 ```
 
@@ -143,6 +143,37 @@ This directive is used to detect whether a solution is installed. If any of thes
 ]
 ```
 
+####isConfigurable
+This is run before configuration to ensure that the application is actually ready to be configured. This is relevant for applications where e.g. a configuration file needs to be present, a wizard needs to be run on the first launch, etc. Each of the blocks will be evaluated, if *any* of them evaluates to true, the solution is considered configurable. The absence of an `isConfigurable` block is also interpreted as the solution being configurable.
+
+If a solution is not configurable, the `makeConfigurable` block will be executed immediately following the `isConfigurable` check (see below).
+
+**Example Entry**:
+```
+"isConfigurable": [
+    {
+        "type": "gpii.lifecycleActions.pathExists",
+        "path": "/tmp/fakemag1.settings.json"
+    }
+]
+```
+
+####makeConfigurable
+Is the actions that need to be taken to make the application configurable (such as running a wizard, creating a default configuration file, adding a new system user, etc). This will be triggered by the system if `isConfigurable` has evaluated to false and run immediately following the `isConfigurable` check.
+
+**Example Entry**:
+```
+"makeConfigurable": [
+    {
+        "type": "gpii.lifecycleActions.createFile",
+        "options": {
+            "filename": "/tmp/fakemag1.settings.json",
+            "content": "{}"
+        }
+    }
+]
+```
+
 *****
 
 ### UNIMPLEMENTED BLOCKS
@@ -161,26 +192,7 @@ To detect whether a solution is running - this is planned to be integrated in th
 ]
 ```
 
-####isConfigurable
-This is run before configuration to ensure that the application is actually ready to be configured. This is relevant for applications where e.g. a configuration file needs to be present, a tutorial needs to be run on the first launch, etc.
-
-**Example Entry**:
-```
-"isConfigurable": [{ 
-    "type": "gpii.reporter.fileExists",
-    "path": "${{environment}.XDG_DATA_HOME}/orca/user-settings.conf""
-}]
-```
-
-####makeConfigurable
-Is the actions that need to be taken to make the application configurable (such as running a wizard, creating a default configuration file, adding a new system user, etc).
 
-**Example Entry**:
-```
-"makeConfigurable": [{
-    "launch" // A special key meaning "start it, wait until isConfigurable is met, and then stop it"
-}]
-```
 
 ####install:
 Used for describing the steps required for installing the application