mirror of
https://github.com/opentofu/opentofu.git
synced 2025-02-25 18:45:20 -06:00
4fa77727b5
* Add metadata functions command skeleton * Export functions as JSON via cli command * Add metadata command * Add tests to jsonfunction package * WIP: Add metadata functions test * Change return_type & type in JSON to json.RawMessage This enables easier deserialisation of types when parsing the JSON. * Skip is_nullable when false * Update cli docs with metadata command * Use tfdiags to report function marshal errors * Ignore map, list and type functions * Test Marshal function with diags * Test metadata functions command output * Simplify type marshaling by using cty.Type * Add static function signatures for can and try * Update internal/command/jsonfunction/function_test.go Co-authored-by: kmoe <5575356+kmoe@users.noreply.github.com> --------- Co-authored-by: kmoe <5575356+kmoe@users.noreply.github.com>
72 lines
1.9 KiB
Go
72 lines
1.9 KiB
Go
package command
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/mitchellh/cli"
|
|
)
|
|
|
|
func TestMetadataFunctions_error(t *testing.T) {
|
|
ui := new(cli.MockUi)
|
|
c := &MetadataFunctionsCommand{
|
|
Meta: Meta{
|
|
Ui: ui,
|
|
},
|
|
}
|
|
|
|
// This test will always error because it's missing the -json flag
|
|
if code := c.Run(nil); code != 1 {
|
|
t.Fatalf("expected error, got:\n%s", ui.OutputWriter.String())
|
|
}
|
|
}
|
|
|
|
func TestMetadataFunctions_output(t *testing.T) {
|
|
ui := new(cli.MockUi)
|
|
m := Meta{Ui: ui}
|
|
c := &MetadataFunctionsCommand{Meta: m}
|
|
|
|
if code := c.Run([]string{"-json"}); code != 0 {
|
|
t.Fatalf("wrong exit status %d; want 0\nstderr: %s", code, ui.ErrorWriter.String())
|
|
}
|
|
|
|
var got functions
|
|
gotString := ui.OutputWriter.String()
|
|
err := json.Unmarshal([]byte(gotString), &got)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if len(got.Signatures) < 100 {
|
|
t.Fatalf("expected at least 100 function signatures, got %d", len(got.Signatures))
|
|
}
|
|
|
|
// check if one particular stable function is correct
|
|
gotMax, ok := got.Signatures["max"]
|
|
wantMax := "{\"description\":\"`max` takes one or more numbers and returns the greatest number from the set.\",\"return_type\":\"number\",\"variadic_parameter\":{\"name\":\"numbers\",\"type\":\"number\"}}"
|
|
if !ok {
|
|
t.Fatal(`missing function signature for "max"`)
|
|
}
|
|
if string(gotMax) != wantMax {
|
|
t.Fatalf("wrong function signature for \"max\":\ngot: %q\nwant: %q", gotMax, wantMax)
|
|
}
|
|
|
|
stderr := ui.ErrorWriter.String()
|
|
if stderr != "" {
|
|
t.Fatalf("expected empty stderr, got:\n%s", stderr)
|
|
}
|
|
|
|
// test that ignored functions are not part of the json
|
|
for _, v := range ignoredFunctions {
|
|
_, ok := got.Signatures[v]
|
|
if ok {
|
|
t.Fatalf("found ignored function %q inside output", v)
|
|
}
|
|
}
|
|
}
|
|
|
|
type functions struct {
|
|
FormatVersion string `json:"format_version"`
|
|
Signatures map[string]json.RawMessage `json:"function_signatures,omitempty"`
|
|
}
|