Skip to content

paramaters-and-testcases.md

Latest commit

 

History

History
99 lines (75 loc) · 3.08 KB

paramaters-and-testcases.md

File metadata and controls

99 lines (75 loc) · 3.08 KB

Parameters and test cases

Adding an additional test case

Parameters and test cases are defined in the manifest.toml file of every test plan. Let's have a look once again at the quickstart/manifest.toml file and add two test cases to the bottom of the file:

{% code title="$TESTGROUND_HOME/plans/quickstart/manifest.toml" %}

...


[[testcases]]
name = "smallbrain"
instances = { min = 1, max = 200, default = 1 }

  [testcases.params]
  word = { type = "string", default = "never" }
  num = { type = "int", default = 2 }
  feature = { type = "bool", default = false }

[[testcases]]
name = "bigbrain"

  [testcases.params]
  word = { type = "string", default = "always" }
  num = { type = "int", default = 10000000 }
  feature = { type = "bool", default = false }

{% endcode %}

{% hint style="info" %} Feel free to add your own galaxybrain test case as well! {% endhint %}

You can confirm that the testground client is able to parse the manifest, and enumerate the cases it declares:

$ testground plan list --testcases | grep quickstart
quickstart    smallbrain
quickstart    bigbrain

We would like to take these two cases out for a spin. First, let's prepare our code. Open our quickstart plan program and deal with these parameters!

{% hint style="warning" %} This snippet is routing both test cases to the same function. In practice, you will want to run different logic for each test case! {% endhint %}

As you can see, a test plan a simple executable that conforms to the simple Testground contract, which the SDK facilitates. This makes it super easy to debug and develop. There's beauty in simplicity!

{% code title="$TESTGROUND_HOME/plans/quickstart/main.go" %}

package main

import (
  "github.com/ipfs/testground/sdk/run"
	"github.com/ipfs/testground/sdk/runtime"
)

func main() {
	run.InvokeMap(map[string]interface{}{
		"bigbrain": 	runf,
		"smallbrain": runf,
	})
}

func runf(runenv *runtime.RunEnv) error {
  var (
    num 		= runenv.IntParam("num")
  	word 		= runenv.StringParam("word")
  	feature = runenv.BooleanParam("feature")
  )

	runenv.RecordMessage("I am a %s test case.", runenv.TestCase)
	runenv.RecordMessage("I store my files on %d servers.", num)
	runenv.RecordMessage("I %s run tests on my P2P code.", word)

	if feature {
		runenv.RecordMessage("I use IPFS!")
	}

	return nil
}

{% endcode %}

The time has come now to run these test cases. Let's run it!

$ testground run single --plan quickstart \
                        --testcase smallbrain \
                        --builder exec:go \
                        --run local:exec \
                        --instances 1

{% hint style="info" %} Try using different runners. This command executes the plan with the local:exec runner and exec:gobuilder, but it works just as well with the local:docker runner or the Kubernetes cluster:k8srunner (for which you will need to use the docker:go builder! {% endhint %}