feat(stats): add environment variables to controls URL and template (#202)

* feat(stats): add environment variables to controls URL and template

Author: Youen Péron

CHANGELOG.md

@@ -14,6 +14,10 @@ Types of changes
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities.
 
+## [1.17.0]
+- `Added` Environment variable `PIMO_STATS_TEMPLATE` to control the format of generated stats
+- `Added` Environment variable `PIMO_STATS_URL` to generate a stat file or HTTP POST
+
 ## [1.16.0]
 
 - `Added` flag to declare seed in command line

cmd/pimo/main.go

@@ -63,13 +63,20 @@ var (
 	repeatWhile           string
 	statisticsDestination string
 	statsTemplate         string
+	statsDestinationEnv   = os.Getenv("PIMO_STATS_URL")
+	statsTemplateEnv      = os.Getenv("PIMO_STATS_TEMPLATE")
 )
 
 func main() {
 	rootCmd := &cobra.Command{
 		Use:   "pimo",
 		Short: "Command line to mask data from jsonlines",
-		Long:  `Pimo is a tool to mask private data contained in jsonlines by using masking configurations`,
+		Long: `Pimo is a tool to mask private data contained in jsonlines by using masking configurations
+
+Environment Variables:
+  PIMO_STATS_URL      The URL where statistics will be sent
+  PIMO_STATS_TEMPLATE The template string to format statistics`,
+
 		Version: fmt.Sprintf(`%v (commit=%v date=%v by=%v)
 Copyright (C) 2021 CGI France
 License GPLv3: GNU GPL version 3 <https://gnu.org/licenses/gpl.html>.
@@ -95,8 +102,8 @@ There is NO WARRANTY, to the extent permitted by law.`, version, commit, buildDa
 	rootCmd.PersistentFlags().StringArrayVarP(&maskingOneLiner, "mask", "m", []string{}, "one liner masking")
 	rootCmd.PersistentFlags().StringVar(&repeatUntil, "repeat-until", "", "mask each input repeatedly until the given condition is met")
 	rootCmd.PersistentFlags().StringVar(&repeatWhile, "repeat-while", "", "mask each input repeatedly while the given condition is met")
-	rootCmd.PersistentFlags().StringVar(&statisticsDestination, "stats", "", "generate execution statistics in the specified dump file")
-	rootCmd.PersistentFlags().StringVar(&statsTemplate, "statsTemplate", "", "template string to format stats (to include them you have to specify them as `{{ .Stats }}` like `{\"software\":\"PIMO\",\"stats\":{{ .Stats }}}`)")
+	rootCmd.PersistentFlags().StringVar(&statisticsDestination, "stats", statsDestinationEnv, "generate execution statistics in the specified dump file")
+	rootCmd.PersistentFlags().StringVar(&statsTemplate, "statsTemplate", statsTemplateEnv, "template string to format stats (to include them you have to specify them as `{{ .Stats }}` like `{\"software\":\"PIMO\",\"stats\":{{ .Stats }}}`)")
 
 	rootCmd.AddCommand(&cobra.Command{
 		Use: "jsonschema",

test/suites/dump-statistics.yml

@@ -48,3 +48,29 @@ testcases:
     - result.systemout ShouldContainSubstring {"software":"PIMO","stats"
     - result.systemout ShouldContainSubstring ignoredPaths":0
     - result.systemout ShouldContainSubstring duration
+
+
+- name: dump file with template from env
+  steps:
+  - script: rm -f masking.yml
+  - script: rm -f pimo-stats-template.json
+  - script: |-
+      cat > masking.yml <<EOF
+      version: "1"
+      masking:
+        - selector:
+            jsonpath: "name"
+          mask:
+            add: "Dorothy"
+      EOF
+  - script: |-
+      echo '{ "name": "John" }' | PIMO_STATS_TEMPLATE='{"software":"PIMO","stats":{{ .Stats }}}' PIMO_STATS_URL=pimo-stats-template.json pimo -v 3 --log-json
+    assertions:
+    - result.code ShouldEqual 0
+    - result.systemerr ShouldContainSubstring Statistics exported to file
+  - script: cat pimo-stats-template.json
+    assertions:
+    - result.code ShouldEqual 0
+    - result.systemout ShouldContainSubstring {"software":"PIMO","stats"
+    - result.systemout ShouldContainSubstring ignoredPaths":0
+    - result.systemout ShouldContainSubstring duration