docs-v2/content/flux/v0/stdlib/testing/assertequals.md

2.3 KiB

title description menu weight flux/v0/tags
testing.assertEquals() function `testing.assertEquals()` tests whether two streams of tables are identical.
flux_v0_ref
name parent identifier
testing.assertEquals testing testing/assertEquals
101
tests

testing.assertEquals() tests whether two streams of tables are identical.

If equal, the function outputs the tested data stream unchanged. If unequal, the function returns an error.

assertEquals can be used to perform in-line tests in a query.

Function type signature
(<-got: stream[A], name: string, want: stream[A]) => stream[A]

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

name

({{< req >}}) Unique assertion name.

got

Data to test. Default is piped-forward data (<-).

want

({{< req >}}) Expected data to test against.

Examples

Test if streams of tables are different

import "sampledata"
import "testing"

want = sampledata.int()
got = sampledata.float() |> toInt()

testing.assertEquals(name: "test_equality", got: got, want: want)

Test if streams of tables are different mid-script

import "testing"

want =
    from(bucket: "backup-example-bucket")
        |> range(start: -5m)

from(bucket: "example-bucket")
    |> range(start: -5m)
    |> testing.assertEquals(want: want)