Enhancement/569 change reuse user randomizer (#24)

*    Make session id count also for reuse user iterations
*    Determinism not broken due to a failed iteration when using reuse user flag
*    Bugfix for determinsm and thinktime actions
*    Randomizer can now be overriden by other by users or future schedulers

Author: DnlLrssn

docs/settingup.md

@@ -726,7 +726,7 @@ Each action executed by `randomaction` is followed by a customizable `thinktime`
       * `uniform`: Random think time with uniform distribution, defined by `mean` and `dev`.
   * `delay`: Delay (seconds), used with type `static`.
   * `mean`: Mean (seconds), used with type `uniform`.
-  * `dev`: Deviation (seconds), used with type `uniform`.
+  * `dev`: Deviation (seconds) from `mean` value, used with type `uniform`.
 * `iterations`: Number of random actions to perform.
 
 ### Random action defaults
@@ -1037,12 +1037,14 @@ Simulate user think time.
     * `uniform`: Random think time with uniform distribution, defined by `mean` and `dev`.
 * `delay`: Delay (seconds), used with type `static`.
 * `mean`: Mean (seconds), used with type `uniform`.
-* `dev`: Deviation (seconds), used with type `uniform`.
+* `dev`: Deviation (seconds) from `mean` value, used with type `uniform`.
 
 ### Examples
 
 #### ThinkTime uniform
 
+This simulates a think time of 10 to 15 seconds.
+
 ```json
 {
      "label": "TimerDelay",
@@ -1057,6 +1059,8 @@ Simulate user think time.
 
 #### ThinkTime constant
 
+This simulates a think time of 5 seconds.
+
 ```json
 {
      "label": "TimerDelay",

generatedocs/data/actions/thinktime/examples.md

@@ -2,6 +2,8 @@
 
 #### ThinkTime uniform
 
+This simulates a think time of 10 to 15 seconds.
+
 ```json
 {
      "label": "TimerDelay",
@@ -16,6 +18,8 @@
 
 #### ThinkTime constant
 
+This simulates a think time of 5 seconds.
+
 ```json
 {
      "label": "TimerDelay",

generatedocs/data/params.json

@@ -525,7 +525,7 @@
         "Mean (seconds), used with type `uniform`."
     ],
     "thinktime.dev": [
-        "Deviation (seconds), used with type `uniform`."
+        "Deviation (seconds) from `mean` value, used with type `uniform`."
     ],
     "unpublishsheet.mode": [
         "",

generatedocs/generated/documentation.go

@@ -161,7 +161,7 @@ var (
         },
         "thinktime": {
             Description: "## ThinkTime action\n\nSimulate user think time.\n\n**Note:** This action does not require an app context (that is, it does not have to be prepended with an `openapp` action).\n",
-            Examples: "### Examples\n\n#### ThinkTime uniform\n\n```json\n{\n     \"label\": \"TimerDelay\",\n     \"action\": \"thinktime\",\n     \"settings\": {\n         \"type\": \"uniform\",\n         \"mean\": 12.5,\n         \"dev\": 2.5\n     } \n} \n```\n\n#### ThinkTime constant\n\n```json\n{\n     \"label\": \"TimerDelay\",\n     \"action\": \"thinktime\",\n     \"settings\": {\n         \"type\": \"static\",\n         \"delay\": 5\n     }\n}\n```\n",
+            Examples: "### Examples\n\n#### ThinkTime uniform\n\nThis simulates a think time of 10 to 15 seconds.\n\n```json\n{\n     \"label\": \"TimerDelay\",\n     \"action\": \"thinktime\",\n     \"settings\": {\n         \"type\": \"uniform\",\n         \"mean\": 12.5,\n         \"dev\": 2.5\n     } \n} \n```\n\n#### ThinkTime constant\n\nThis simulates a think time of 5 seconds.\n\n```json\n{\n     \"label\": \"TimerDelay\",\n     \"action\": \"thinktime\",\n     \"settings\": {\n         \"type\": \"static\",\n         \"delay\": 5\n     }\n}\n```\n",
         },
         "unpublishsheet": {
             Description: "## UnpublishSheet action\n\nUnpublish sheets in the current app.\n",
@@ -318,7 +318,7 @@ var (
         "staticselect.type": { "Selection type","`hypercubecells`: Select in hypercube.","`listobjectvalues`: Select in listbox."  },  
         "staticselect.wrap": { "Wrap selection with Begin / End selection requests (`true` / `false`)."  },  
         "thinktime.delay": { "Delay (seconds), used with type `static`."  },  
-        "thinktime.dev": { "Deviation (seconds), used with type `uniform`."  },  
+        "thinktime.dev": { "Deviation (seconds) from `mean` value, used with type `uniform`."  },  
         "thinktime.mean": { "Mean (seconds), used with type `uniform`."  },  
         "thinktime.type": { "Type of think time","`static`: Static think time, defined by `delay`.","`uniform`: Random think time with uniform distribution, defined by `mean` and `dev`."  },  
         "unpublishsheet.mode": { "","`allsheets`: Unpublish all sheets in the app.","`sheetids`: Only unpublish the sheets specified by the `sheetIds` array."  },  

helpers/distribution.go

@@ -2,12 +2,10 @@ package helpers
 
 import (
 	"fmt"
-	"strconv"
-	"math/rand"
-
 	"github.com/pkg/errors"
 	"github.com/qlik-oss/gopherciser/enummap"
-	"github.com/qlik-oss/gopherciser/randomizer"
+	"strconv"
+	"time"
 )
 
 type (
@@ -34,7 +32,8 @@ const (
 	UniformDistribution
 )
 
-func (value DistributionType) GetEnumMap() *enummap.EnumMap{
+// GetEnumMap of DistributionType
+func (value DistributionType) GetEnumMap() *enummap.EnumMap {
 	enumMap, _ := enummap.NewEnumMap(map[string]int{
 		"static":  int(StaticDistribution),
 		"uniform": int(UniformDistribution),
@@ -62,6 +61,7 @@ func (value DistributionType) MarshalJSON() ([]byte, error) {
 	return []byte(fmt.Sprintf(`"%s"`, str)), nil
 }
 
+// Validate DistributionSettings
 func (settings DistributionSettings) Validate() error {
 	switch settings.Type {
 	case StaticDistribution:
@@ -89,21 +89,22 @@ func (settings DistributionSettings) Validate() error {
 	return nil
 }
 
-func (settings DistributionSettings) GetSample(rnd *randomizer.Randomizer) (float64, error) {
+// RandDuration returns a random duration
+func (settings DistributionSettings) RandDuration(rnd Randomizer) (time.Duration, error) {
 	switch settings.Type {
 	case StaticDistribution:
-		return settings.Delay, nil
+		return time.Duration(settings.Delay * float64(time.Second)), nil
 	case UniformDistribution:
-		min := settings.Mean - settings.Deviation
-		max := settings.Mean + settings.Deviation
-		delay := (rand.Float64() * (max-min)) + min
-		return delay, nil
+		min := time.Duration(float64(time.Second) * (settings.Mean - settings.Deviation))
+		max := time.Duration(float64(time.Second) * (settings.Mean + settings.Deviation))
+		return rnd.RandDuration(min, max)
 	default:
 		return 0, errors.Errorf("distribution type<%d> not yet supported", settings.Type)
 	}
 }
 
-func (settings DistributionSettings) GetMax(rnd *randomizer.Randomizer) (float64, error) {
+// GetMax value
+func (settings DistributionSettings) GetMax() (float64, error) {
 	switch settings.Type {
 	case StaticDistribution:
 		return settings.Delay, nil
@@ -115,7 +116,8 @@ func (settings DistributionSettings) GetMax(rnd *randomizer.Randomizer) (float64
 	}
 }
 
-func (settings DistributionSettings) GetMin(rnd *randomizer.Randomizer) (float64, error) {
+// GetMin value
+func (settings DistributionSettings) GetMin() (float64, error) {
 	switch settings.Type {
 	case StaticDistribution:
 		return settings.Delay, nil
@@ -127,6 +129,7 @@ func (settings DistributionSettings) GetMin(rnd *randomizer.Randomizer) (float64
 	}
 }
 
+// GetActionInfo get information for action details logging
 func (settings DistributionSettings) GetActionInfo() string {
 	switch settings.Type {
 	case StaticDistribution:

helpers/distribution_test.go

@@ -2,10 +2,19 @@ package helpers
 
 import (
 	"testing"
+	"time"
 
 	"github.com/qlik-oss/gopherciser/randomizer"
 )
 
+type Rnd struct {
+	*randomizer.Randomizer
+}
+
+func (rnd *Rnd) Reset(instance, session uint64, onlyinstanceSeed bool) {
+	rnd.Randomizer = randomizer.NewSeededRandomizer(randomizer.GetPredictableSeed(int(instance), int(session)))
+}
+
 func TestDistributionUniform(t *testing.T) {
 	t.Parallel()
 
@@ -28,19 +37,20 @@ func TestDistributionUniform(t *testing.T) {
 		t.Fatalf("Deviation: Expected<0.1> got<%f>", settings.Deviation)
 	}
 
-	rndCompare := randomizer.NewSeededRandomizer(randomizer.GetPredictableSeed(1, 1))
+	rndCompare := &Rnd{}
+	rndCompare.Reset(1, 1, false)
 
-	sample, err := settings.GetSample(rndCompare)
+	sample, err := settings.RandDuration(rndCompare)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	if sample > 0.6 {
-		t.Fatalf("Sample: Expected< < 0.6> got<%f>", sample)
+	if sample > time.Duration(0.6*float64(time.Second)) {
+		t.Fatalf("Sample: Expected< < 0.6s> got<%v>", sample)
 	}
 
-	if sample < 0.4 {
-		t.Fatalf("Sample: Expected< > 0.4> got<%f>", sample)
+	if sample < time.Duration(0.4*float64(time.Second)) {
+		t.Fatalf("Sample: Expected< > 0.4> got<%v>", sample)
 	}
 }
 
@@ -61,13 +71,13 @@ func TestThinkTimeStatic(t *testing.T) {
 		t.Fatalf("Delay: Expected<0.1> got<%f>", settings.Delay)
 	}
 
-	sample, err := settings.GetSample(nil)
+	sample, err := settings.RandDuration(nil)
 	if err != nil {
 		t.Fatal(err)
 	}
 
-	if sample != 0.1 {
-		t.Fatalf("Sample: Expected<0.1> got<%f>", sample)
+	if sample != time.Duration(0.1*float64(time.Second)) {
+		t.Fatalf("Sample: Expected<0.1> got<%v>", sample)
 	}
 }
 

helpers/randomizer.go

@@ -0,0 +1,11 @@
+package helpers
+
+import "time"
+
+type Randomizer interface {
+	Rand(max int) int
+	RandWeightedInt(weights []int) (int, error)
+	RandIntPos(ints []int) (int, int, error)
+	RandDuration(minDuration, maxDuration time.Duration) (time.Duration, error)
+	Reset(instance, session uint64, onlyinstanceSeed bool)
+}

scenario/select.go

@@ -3,6 +3,7 @@ package scenario
 import (
 	"context"
 	"fmt"
+	"github.com/qlik-oss/gopherciser/helpers"
 	"math"
 	"sort"
 	"strconv"
@@ -16,7 +17,6 @@ import (
 	"github.com/qlik-oss/gopherciser/enummap"
 	"github.com/qlik-oss/gopherciser/globals/constant"
 	"github.com/qlik-oss/gopherciser/logger"
-	"github.com/qlik-oss/gopherciser/randomizer"
 	"github.com/qlik-oss/gopherciser/senseobjdef"
 	"github.com/qlik-oss/gopherciser/session"
 )
@@ -465,7 +465,7 @@ func getHyperCubeCardinal(objId string, dimension int, hypercube *enigmahandlers
 	return dimInfo.Cardinal, nil
 }
 
-func getSelectQty(min, max, possible int, rnd *randomizer.Randomizer) int {
+func getSelectQty(min, max, possible int, rnd helpers.Randomizer) int {
 	localMin := min
 	localMax := max
 
@@ -488,7 +488,7 @@ func getSelectQty(min, max, possible int, rnd *randomizer.Randomizer) int {
 	return rnd.Rand(localMax-localMin+1) + localMin
 }
 
-func fillSelectPosFromAll(min, max, cardinal int, rnd *randomizer.Randomizer) ([]int, error) {
+func fillSelectPosFromAll(min, max, cardinal int, rnd helpers.Randomizer) ([]int, error) {
 	if rnd == nil {
 		return nil, errors.Errorf("Randomizer not provided")
 	}
@@ -532,7 +532,7 @@ func fillSelectPosFromAll(min, max, cardinal int, rnd *randomizer.Randomizer) ([
 	return selectPos.Array(), nil
 }
 
-func fillSelectPosFromPossible(min, max int, possible []int, rnd *randomizer.Randomizer) ([]int, error) {
+func fillSelectPosFromPossible(min, max int, possible []int, rnd helpers.Randomizer) ([]int, error) {
 	if rnd == nil {
 		return nil, errors.Errorf("Randomizer not provided")
 	}
@@ -581,7 +581,7 @@ func fillSelectPosFromPossible(min, max int, possible []int, rnd *randomizer.Ran
 	return selectPos.Array(), nil
 }
 
-func fillSelectBinsFromBins(min, max int, bins []string, rnd *randomizer.Randomizer) ([]string, error) {
+func fillSelectBinsFromBins(min, max int, bins []string, rnd helpers.Randomizer) ([]string, error) {
 	if rnd == nil {
 		return nil, errors.Errorf("Randomizer not provided")
 	}

scenario/select_test.go

@@ -8,6 +8,14 @@ import (
 	"github.com/qlik-oss/gopherciser/randomizer"
 )
 
+type Rnd struct {
+	*randomizer.Randomizer
+}
+
+func (rnd *Rnd) Reset(instance, session uint64, onlyinstanceSeed bool) {
+	rnd.Randomizer = randomizer.NewSeededRandomizer(randomizer.GetPredictableSeed(int(instance), int(session)))
+}
+
 func TestSelectUnmarshal(t *testing.T) {
 	t.Parallel()
 
@@ -117,7 +125,8 @@ func TestValidate(t *testing.T) {
 func TestSelectQty(t *testing.T) {
 	t.Parallel()
 
-	rnd := randomizer.NewSeededRandomizer(randomizer.GetPredictableSeedUInt64(1, 2))
+	rnd := &Rnd{}
+	rnd.Reset(1, 2, false)
 
 	v := getSelectQty(2, 5, 5, rnd)
 	validateInt(t, "selectqty", v, 4)
@@ -178,7 +187,8 @@ func TestCutSlice(t *testing.T) {
 func TestFillPos(t *testing.T) {
 	t.Parallel()
 
-	rnd := randomizer.NewSeededRandomizer(randomizer.GetPredictableSeedUInt64(1, 3245345))
+	rnd := &Rnd{}
+	rnd.Reset(1, 3245345, false)
 
 	selectPos, err := fillSelectPosFromAll(3, 6, 5, rnd)
 	if err != nil {

scenario/thinktime.go

@@ -13,8 +13,6 @@ import (
 	"github.com/qlik-oss/gopherciser/session"
 )
 
-const nanosecond float64 = 0.000000001
-
 type (
 	// ThinkTimeSettings think time settings
 	ThinkTimeSettings struct {
@@ -30,13 +28,12 @@ func (settings ThinkTimeSettings) Execute(sessionState *session.State, actionSta
 		sessionState.LogEntry.Log(logger.WarningLevel, "Faking sent message in timer delay failed")
 	}
 
-	seconds, err := settings.DistributionSettings.GetSample(sessionState.Randomizer())
-	delay := time.Duration(int(seconds*1000000000)) * time.Nanosecond
+	delay, err := settings.DistributionSettings.RandDuration(sessionState.Randomizer())
 	if err != nil {
 		actionState.AddErrors(errors.WithStack(err))
 		return
 	}
-	if seconds < nanosecond {
+	if delay < time.Nanosecond {
 		actionState.AddErrors(errors.New("timer delay not set"))
 		return
 	}