libopenapi/datamodel/high/v3/parameter_test.go

// Copyright 2023 Princess B33f Heavy Industries / Dave Shanley
// SPDX-License-Identifier: MIT

package v3

import (
    "github.com/pb33f/libopenapi/datamodel/high/base"
    "github.com/stretchr/testify/assert"
    "strings"
    "testing"
)

func TestParameter_MarshalYAML(t *testing.T) {

    explode := true
    param := Parameter{
        Name:          "chicken",
        In:            "nuggets",
        Description:   "beefy",
        Deprecated:    true,
        Style:         "simple",
        Explode:       &explode,
        AllowReserved: true,
        Example:       "example",
        Examples:      map[string]*base.Example{"example": {Value: "example"}},
        Extensions:    map[string]interface{}{"x-burgers": "why not?"},
    }

    rend, _ := param.Render()

    desired := `name: chicken
in: nuggets
description: beefy
deprecated: true
style: simple
explode: true
allowReserved: true
example: example
examples:
    example:
        value: example
x-burgers: why not?`

    assert.Equal(t, desired, strings.TrimSpace(string(rend)))
}

func TestParameter_IsExploded(t *testing.T) {

    explode := true
    param := Parameter{
        Explode: &explode,
    }

    assert.True(t, param.IsExploded())

    explode = false
    param = Parameter{
        Explode: &explode,
    }

    assert.False(t, param.IsExploded())

    param = Parameter{}

    assert.False(t, param.IsExploded())
}

func TestParameter_IsDefaultFormEncoding(t *testing.T) {

    param := Parameter{}
    assert.True(t, param.IsDefaultFormEncoding())

    param = Parameter{Style: "form"}
    assert.True(t, param.IsDefaultFormEncoding())

    explode := false
    param = Parameter{
        Explode: &explode,
    }
    assert.False(t, param.IsDefaultFormEncoding())

    explode = true
    param = Parameter{
        Explode: &explode,
    }
    assert.True(t, param.IsDefaultFormEncoding())

    param = Parameter{
        Explode: &explode,
        Style:   "simple",
    }
    assert.False(t, param.IsDefaultFormEncoding())
}

func TestParameter_IsDefaultHeaderEncoding(t *testing.T) {

    param := Parameter{}
    assert.True(t, param.IsDefaultHeaderEncoding())

    param = Parameter{Style: "simple"}
    assert.True(t, param.IsDefaultHeaderEncoding())

    explode := false
    param = Parameter{
        Explode: &explode,
        Style:   "simple",
    }
    assert.True(t, param.IsDefaultHeaderEncoding())

    explode = true
    param = Parameter{
        Explode: &explode,
        Style:   "simple",
    }
    assert.False(t, param.IsDefaultHeaderEncoding())

    explode = false
    param = Parameter{
        Explode: &explode,
        Style:   "form",
    }
    assert.False(t, param.IsDefaultHeaderEncoding())
}

func TestParameter_IsDefaultPathEncoding(t *testing.T) {

    param := Parameter{}
    assert.True(t, param.IsDefaultPathEncoding())

}