Add getenv to template function map (#213)

* Add getenv to template function map

Author: SeBBBe

docs/settingup.md

@@ -2347,6 +2347,7 @@ The following functions are supported:
 * `hostname`: Hostname of the local machine.
 * `timestamp`: Timestamp in `yyyyMMddhhmmss` format.
 * `uuid`: Generate an uuid.
+* `env`: Retrieve a specific environment variable. Takes one argument - the name of the environment variable to expand.
 
 ### Example
 ```json
@@ -2379,6 +2380,16 @@ The following functions are supported:
     }
 }
 
+```
+
+```json
+{
+  "action": "createbookmark",
+  "settings": {
+    "title": "{{env \"TITLE\"}}",
+    "description": "This bookmark contains some interesting selections"
+  }
+}
 ```
 </details>
 

generatedocs/data/extra/sessionvariables/description.md

@@ -24,6 +24,7 @@ The following functions are supported:
 * `hostname`: Hostname of the local machine.
 * `timestamp`: Timestamp in `yyyyMMddhhmmss` format.
 * `uuid`: Generate an uuid.
+* `env`: Retrieve a specific environment variable. Takes one argument - the name of the environment variable to expand.
 
 ### Example
 ```json
@@ -56,5 +57,15 @@ The following functions are supported:
     }
 }
 
+```
+
+```json
+{
+  "action": "createbookmark",
+  "settings": {
+    "title": "{{env \"TITLE\"}}",
+    "description": "This bookmark contains some interesting selections"
+  }
+}
 ```
 </details>

generatedocs/generated/documentation.go

@@ -455,7 +455,7 @@ var (
 
 	Extra = map[string]common.DocEntry{
 		"sessionvariables": {
-			Description: "\n## Session variables\n\nThis section describes the session variables that can be used with some of the actions.\n\n<details>\n<summary><a name=\"session_variables\"></a>Session variables</summary>\n\nSome action parameters support session variables. A session variable is defined by putting the variable, prefixed by a dot, within double curly brackets, such as `{{.UserName}}`.\n\nThe following session variables are supported in actions:\n\n* `UserName`: The simulated username. This is not the same as the authenticated user, but rather how the username was defined by [Login settings](#login_settings).  \n* `Session`: The enumeration of the currently simulated session.\n* `Thread`: The enumeration of the currently simulated \"thread\" or \"concurrent user\".\n\nThe following variable is supported in the filename of the log file:\n\n* `ConfigFile`: The filename of the config file, without file extension.\n\nThe following functions are supported:\n\n* `now`: Evaluates Golang [time.Now()](https://golang.org/pkg/time/). \n* `hostname`: Hostname of the local machine.\n* `timestamp`: Timestamp in `yyyyMMddhhmmss` format.\n* `uuid`: Generate an uuid.\n\n### Example\n```json\n{\n    \"action\": \"ElasticCreateApp\",\n    \"label\": \"Create new app\",\n    \"settings\": {\n        \"title\": \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\",\n        \"stream\": \"mystream\",\n        \"groups\": [\n            \"mygroup\"\n        ]\n    }\n},\n{\n    \"label\": \"OpenApp\",\n    \"action\": \"OpenApp\",\n    \"settings\": {\n        \"appname\": \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\"\n    }\n},\n{\n    \"action\": \"elasticexportapp\",\n    \"label\": \"Export app\",\n    \"settings\": {\n        \"appmode\" : \"name\",\n        \"app\" : \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\",\n        \"savetofile\": true,\n        \"exportname\": \"Exported app {{.Thread}}-{{.Session}} {{now.UTC}}\"\n    }\n}\n\n```\n</details>\n",
+			Description: "\n## Session variables\n\nThis section describes the session variables that can be used with some of the actions.\n\n<details>\n<summary><a name=\"session_variables\"></a>Session variables</summary>\n\nSome action parameters support session variables. A session variable is defined by putting the variable, prefixed by a dot, within double curly brackets, such as `{{.UserName}}`.\n\nThe following session variables are supported in actions:\n\n* `UserName`: The simulated username. This is not the same as the authenticated user, but rather how the username was defined by [Login settings](#login_settings).  \n* `Session`: The enumeration of the currently simulated session.\n* `Thread`: The enumeration of the currently simulated \"thread\" or \"concurrent user\".\n\nThe following variable is supported in the filename of the log file:\n\n* `ConfigFile`: The filename of the config file, without file extension.\n\nThe following functions are supported:\n\n* `now`: Evaluates Golang [time.Now()](https://golang.org/pkg/time/). \n* `hostname`: Hostname of the local machine.\n* `timestamp`: Timestamp in `yyyyMMddhhmmss` format.\n* `uuid`: Generate an uuid.\n* `env`: Retrieve a specific environment variable. Takes one argument - the name of the environment variable to expand.\n\n### Example\n```json\n{\n    \"action\": \"ElasticCreateApp\",\n    \"label\": \"Create new app\",\n    \"settings\": {\n        \"title\": \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\",\n        \"stream\": \"mystream\",\n        \"groups\": [\n            \"mygroup\"\n        ]\n    }\n},\n{\n    \"label\": \"OpenApp\",\n    \"action\": \"OpenApp\",\n    \"settings\": {\n        \"appname\": \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\"\n    }\n},\n{\n    \"action\": \"elasticexportapp\",\n    \"label\": \"Export app\",\n    \"settings\": {\n        \"appmode\" : \"name\",\n        \"app\" : \"CreateApp {{.Thread}}-{{.Session}} ({{.UserName}})\",\n        \"savetofile\": true,\n        \"exportname\": \"Exported app {{.Thread}}-{{.Session}} {{now.UTC}}\"\n    }\n}\n\n```\n\n```json\n{\n  \"action\": \"createbookmark\",\n  \"settings\": {\n    \"title\": \"{{env \\\"TITLE\\\"}}\",\n    \"description\": \"This bookmark contains some interesting selections\"\n  }\n}\n```\n</details>\n",
 			Examples:    "",
 		},
 	}

generatedocs/pkg/doccompiler/testdata/base/data/extra/sessionvariables/description.md

@@ -24,6 +24,7 @@ The following functions are supported:
 * `hostname`: Hostname of the local machine.
 * `timestamp`: Timestamp in `yyyyMMddhhmmss` format.
 * `uuid`: Generate an uuid.
+* `env`: Retrieve a specific environment variable. Takes one argument - the name of the environment variable to expand.
 
 ### Example
 ```json
@@ -56,5 +57,15 @@ The following functions are supported:
     }
 }
 
+```
+
+```json
+{
+  "action": "createbookmark",
+  "settings": {
+    "title": "{{env \"TITLE\"}}",
+    "description": "This bookmark contains some interesting selections"
+  }
+}
 ```
 </details>