Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update parameters-and-testcases #10

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update parameters-and-testcases #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1d2117
Update parameters-and-testcases
max-i-am Apr 27, 2021
627ca30
Update communication-between-instances
max-i-am Apr 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions writing-test-plans/communication-between-instances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lets create a plan in which one of the plans produces a `struct` which is re-con

### Setting up the`topic`

`Transferrable` is the value type we will be transferring.
`Transferrable` is the value type we will be transferring.

```go
type Transferrable struct {
Expand All @@ -30,7 +30,7 @@ To write to a topic, create a bounded client and use it to publish to the topic

```go
ctx := context.Background()

client := sync.MustBoundClient(ctx, runenv)
defer client.Close()

Expand All @@ -43,7 +43,7 @@ Subscribe to the topic we created earlier and set up a channel to receive the va

```go
tch := make(chan *Transferrable)

_, err = client.Subscribe(ctx, st, tch)
if err != nil {
panic(err)
Expand All @@ -65,6 +65,7 @@ import (
"math/rand"
"time"

"github.com/testground/sdk-go/run"
"github.com/testground/sdk-go/runtime"
"github.com/testground/sdk-go/sync"
)
Expand Down Expand Up @@ -97,16 +98,16 @@ func (t *Transferrable) String() string {
}

func main() {
runtime.Invoke(run)
run.Invoke(runf)
}

func run(runenv *runtime.RunEnv) error {
func runf(runenv *runtime.RunEnv) error {
rand.Seed(time.Now().UnixNano())

ctx := context.Background()
client := sync.MustBoundClient(ctx, runenv)
defer client.Close()

st := sync.NewTopic("transfer-key", &Transferrable{})

// Configure the test
Expand Down Expand Up @@ -135,7 +136,7 @@ func run(runenv *runtime.RunEnv) error {
}
```

Run with multiple instances:
Run with multiple instances:

```text
$ testground run single -p quickstart -t quickstart -b exec:go -r local:exec -i 4
Expand All @@ -144,4 +145,3 @@ $ testground run single -p quickstart -t quickstart -b exec:go -r local:exec -i
{% hint style="info" %}
Notice that instances is set to 4. Four instances will run at the same time.
{% endhint %}

16 changes: 8 additions & 8 deletions writing-test-plans/paramaters-and-testcases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,31 +53,32 @@ As you can see, a test plan a simple executable that conforms to the [simple Tes
package main

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

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

func run(runenv *runtime.RunEnv) error {
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
}
```
Expand All @@ -96,4 +97,3 @@ $ testground run single --plan quickstart \
{% hint style="info" %}
Try using different runners. This command executes the plan with the `local:exec` runner and `exec:go`builder, but it works just as well with the `local:docker` runner or the Kubernetes `cluster:k8s`runner \(for which you will need to use the `docker:go` builder!
{% endhint %}