codescan/operations_go119_test.go at master · go-openapi/codescan · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
// SPDX-FileCopyrightText: Copyright 2015-2025 go-swagger maintainers
// SPDX-License-Identifier: Apache-2.0

package codescan

import (
	"testing"

	"github.com/go-openapi/testify/v2/assert"
	"github.com/go-openapi/testify/v2/require"

	"github.com/go-openapi/spec"
)

func TestIndentedYAMLBlock(t *testing.T) {
	sctx, err := newScanCtx(&Options{
		Packages: []string{
			"./goparsing/go119",
		},
		WorkDir: "fixtures",
	})
	require.NoError(t, err)

	var ops spec.Paths
	for _, apiPath := range sctx.app.Operations {
		prs := &operationsBuilder{
			ctx:        sctx,
			path:       apiPath,
			operations: make(map[string]*spec.Operation),
		}
		require.NoError(t, prs.Build(&ops))
	}

	assert.Len(t, ops.Paths, 2)

	po, ok := ops.Paths["/api/v1/somefunc"]
	require.TrueT(t, ok)
	require.NotNil(t, po.Post)
	op := po.Post
	assert.Empty(t, op.Summary)
	assert.EqualT(t, "Do something", op.Description)
	assert.EqualT(t, "someFunc", op.ID)

	assert.MapContainsT(t, op.Extensions, "x-codeSamples")

	samples, ok := op.Extensions["x-codeSamples"].([]any)
	require.TrueT(t, ok)
	require.Len(t, samples, 1)
	sample, ok := samples[0].(map[string]any)
	require.TrueT(t, ok)
	assert.MapContainsT(t, sample, "lang")
	assert.Equal(t, "curl", sample["lang"])

	assert.MapContainsT(t, sample, "source")
	const expectedSource = `curl -u "${LOGIN}:${PASSWORD}" -d '{"key": "value"}' -X POST   "https://{host}/api/v1/somefunc"
curl -u "${LOGIN}:${PASSWORD}" -d '{"key2": "value2"}' -X POST   "https://{host}/api/v1/somefunc"
`
	assert.Equal(t, expectedSource, sample["source"])

	po2, ok := ops.Paths["/api/v1/somefuncTabs"]
	require.TrueT(t, ok)
	require.NotNil(t, po2.Post)
	op2 := po2.Post
	assert.Empty(t, op2.Summary)
	assert.EqualT(t, "Do something", op2.Description)
	assert.EqualT(t, "someFuncTabs", op2.ID)

	assert.MapContainsT(t, op2.Extensions, "x-codeSamples")

	samples2, ok := op2.Extensions["x-codeSamples"].([]any)
	require.TrueT(t, ok)
	require.Len(t, samples2, 1)
	sample2, ok := samples2[0].(map[string]any)
	require.TrueT(t, ok)
	assert.MapContainsT(t, sample2, "lang")
	assert.Equal(t, "curl", sample2["lang"])

	assert.MapContainsT(t, sample2, "source")
	assert.Equal(t, expectedSource, sample2["source"])
}