json

README

JSON utilities for godog test suits

Implements a matcher for JSON encoded structures.

Usage Example:

Feature:

Feature: It should be posible to create and retreive users from the service
    
    Scenario: If should be possible to create a user
        When given the following json dump:
        """
            {"key-0" : "value", "key-1" : {"key-key-1": ["value-0", "value-1"]}}
        """
        Then the path ".key-1.key-key-1[1]" should match "value-1"

Backing code:

import (
    "strings"
    "github.com/DATA-DOG/godog"
    "github.com/DATA-DOG/godog/gherkin"
    "github.com/SKF/go-tests-utility/api/godog/json"
)

type state struct {
    dump []byte
}

func (st *state) setJsonDump(input *gherkin.DocString) error {
    st.dump = []byte(strings.TrimSpace(input.Content))
    return nil
}

func (st *state) matchJson(key, pattern string) error {
    return Match(st.dump, key, pattern)
}

func FeatureContext(s *godog.Suite) {
    st := state{}
    s.Step(`^given the following json dump:$`, st.setJsonDump)
    s.Step(`^the path "([^"]*)" should match "([^"]*)"$`, st.matchJson)
}
    

Documentation

Index

• func ArrayLen(json []byte, path string, length int) error
• func KeyIsMissing(json []byte, path string) error
• func KeyIsPresent(json []byte, path string) error
• func Match(json []byte, path string, pattern string) error
• func MatchNull(json []byte, path string) error
• func Read(json []byte, path string) (result string, err error)
• func ReadStringArr(json []byte, path string) (result []string, err error)

Functions

func ArrayLen

func ArrayLen(json []byte, path string, length int) error

func KeyIsMissing

func KeyIsMissing(json []byte, path string) error

func KeyIsPresent

func KeyIsPresent(json []byte, path string) error

func Match

func Match(json []byte, path string, pattern string) error

func MatchNull

func MatchNull(json []byte, path string) error

func Read

func Read(json []byte, path string) (result string, err error)

func ReadStringArr

func ReadStringArr(json []byte, path string) (result []string, err error)