github.com/rzurga/go-swagger@v0.28.1-0.20211109195225-5d1f453ffa3a/codescan/operations_test.go (about)

     1  package codescan
     2  
     3  import (
     4  	"testing"
     5  
     6  	"github.com/go-openapi/spec"
     7  	"github.com/stretchr/testify/require"
     8  
     9  	"github.com/stretchr/testify/assert"
    10  )
    11  
    12  func TestOperationsExpression(t *testing.T) {
    13  	assert.Regexp(t, rxOperation, "swagger:operation DELETE /orders/{id} deleteOrder")
    14  	assert.Regexp(t, rxOperation, "swagger:operation GET /v1.2/something deleteOrder")
    15  }
    16  
    17  func TestOperationsParser(t *testing.T) {
    18  	sctx, err := newScanCtx(&Options{
    19  		Packages: []string{
    20  			"github.com/go-swagger/go-swagger/fixtures/goparsing/classification",
    21  			"github.com/go-swagger/go-swagger/fixtures/goparsing/classification/models",
    22  			"github.com/go-swagger/go-swagger/fixtures/goparsing/classification/operations",
    23  			"github.com/go-swagger/go-swagger/fixtures/goparsing/classification/operations_annotation",
    24  		},
    25  	})
    26  	require.NoError(t, err)
    27  	var ops spec.Paths
    28  	for _, apiPath := range sctx.app.Operations {
    29  		prs := &operationsBuilder{
    30  			ctx:        sctx,
    31  			path:       apiPath,
    32  			operations: make(map[string]*spec.Operation),
    33  		}
    34  		require.NoError(t, prs.Build(&ops))
    35  	}
    36  
    37  	assert.Len(t, ops.Paths, 3)
    38  
    39  	po, ok := ops.Paths["/pets"]
    40  	assert.True(t, ok)
    41  	assert.NotNil(t, po.Get)
    42  	assertAnnotationOperation(t,
    43  		po.Get,
    44  		"getPet",
    45  		"",
    46  		"List all pets",
    47  		[]string{"pets"},
    48  	)
    49  	if po.Get != nil {
    50  		rsp, k := po.Get.Responses.StatusCodeResponses[200]
    51  		if assert.True(t, k) {
    52  			assert.Equal(t, "An paged array of pets", rsp.Description)
    53  		}
    54  		if assert.NotNil(t, po.Get.Responses.Default) {
    55  			assert.Equal(t, "unexpected error", po.Get.Responses.Default.Description)
    56  		}
    57  	}
    58  
    59  	po, ok = ops.Paths["/pets/{id}"]
    60  	assert.True(t, ok)
    61  	assert.NotNil(t, po.Put)
    62  	assertAnnotationOperation(t,
    63  		po.Put,
    64  		"updatePet",
    65  		"Updates the details for a pet.",
    66  		"Some long explanation,\nspanning over multipele lines,\nAKA the description.",
    67  		[]string{"pets"},
    68  	)
    69  	if po.Put != nil {
    70  		rsp, k := po.Put.Responses.StatusCodeResponses[400]
    71  		if assert.True(t, k) {
    72  			assert.Equal(t, "Invalid ID supplied", rsp.Description)
    73  		}
    74  		rsp, k = po.Put.Responses.StatusCodeResponses[404]
    75  		if assert.True(t, k) {
    76  			assert.Equal(t, "Pet not found", rsp.Description)
    77  		}
    78  		rsp, k = po.Put.Responses.StatusCodeResponses[405]
    79  		if assert.True(t, k) {
    80  			assert.Equal(t, "Validation exception", rsp.Description)
    81  		}
    82  	}
    83  
    84  	po, ok = ops.Paths["/v1/events"]
    85  	assert.True(t, ok)
    86  	assert.NotNil(t, po.Get)
    87  	assertAnnotationOperation(t,
    88  		po.Get,
    89  		"getEvents",
    90  		"Events",
    91  		"Mitigation Events",
    92  		[]string{"Events"},
    93  	)
    94  	if po.Get != nil {
    95  		rsp, k := po.Get.Responses.StatusCodeResponses[200]
    96  		if assert.True(t, k) {
    97  			assert.Equal(t, "#/definitions/ListResponse", rsp.Schema.Ref.String())
    98  			assert.Equal(t, "200", rsp.Description)
    99  		}
   100  		rsp, k = po.Get.Responses.StatusCodeResponses[400]
   101  		if assert.True(t, k) {
   102  			assert.Equal(t, "#/definitions/ErrorResponse", rsp.Schema.Ref.String())
   103  			assert.Equal(t, "400", rsp.Description)
   104  		}
   105  	}
   106  }
   107  
   108  func assertAnnotationOperation(t *testing.T, op *spec.Operation, id, summary, description string, tags []string) {
   109  	assert.NotNil(t, op)
   110  	assert.Equal(t, summary, op.Summary)
   111  	assert.Equal(t, description, op.Description)
   112  	assert.Equal(t, id, op.ID)
   113  	assert.EqualValues(t, tags, op.Tags)
   114  	assert.Contains(t, op.Consumes, "application/json")
   115  	assert.Contains(t, op.Consumes, "application/xml")
   116  	assert.Contains(t, op.Produces, "application/json")
   117  	assert.Contains(t, op.Produces, "application/xml")
   118  	assert.Len(t, op.Security, 1)
   119  	if len(op.Security) > 0 {
   120  		akv, ok := op.Security[0]["petstore_auth"]
   121  		assert.True(t, ok)
   122  		// akv must be defined & not empty
   123  		assert.NotNil(t, akv)
   124  		assert.NotEmpty(t, akv)
   125  	}
   126  }