github.com/akamai/AkamaiOPEN-edgegrid-golang/v8@v8.1.0/pkg/appsec/tuning_recommendations_test.go (about)

     1  package appsec
     2  
     3  import (
     4  	"context"
     5  	"encoding/json"
     6  	"errors"
     7  	"net/http"
     8  	"net/http/httptest"
     9  	"testing"
    10  
    11  	"github.com/akamai/AkamaiOPEN-edgegrid-golang/v8/pkg/session"
    12  	"github.com/stretchr/testify/assert"
    13  	"github.com/stretchr/testify/require"
    14  )
    15  
    16  func TestAppSec_GetTuningRecommendations(t *testing.T) {
    17  
    18  	result := GetTuningRecommendationsResponse{}
    19  
    20  	respData := compactJSON(loadFixtureBytes("testdata/TestTuningRecommendations/Recommendations.json"))
    21  	err := json.Unmarshal([]byte(respData), &result)
    22  	require.NoError(t, err)
    23  
    24  	tests := map[string]struct {
    25  		params           GetTuningRecommendationsRequest
    26  		responseStatus   int
    27  		responseBody     string
    28  		expectedPath     string
    29  		expectedResponse *GetTuningRecommendationsResponse
    30  		withError        error
    31  		headers          http.Header
    32  	}{
    33  		"200 OK": {
    34  			params: GetTuningRecommendationsRequest{
    35  				ConfigID:    43253,
    36  				Version:     15,
    37  				PolicyID:    "AAAA_81230",
    38  				RulesetType: RulesetTypeActive,
    39  			},
    40  			headers: http.Header{
    41  				"Content-Type": []string{"application/json"},
    42  			},
    43  			responseStatus:   http.StatusOK,
    44  			responseBody:     string(respData),
    45  			expectedPath:     "/appsec/v1/configs/43253/versions/15/security-policies/AAAA_81230/recommendations?standardException=true&type=active",
    46  			expectedResponse: &result,
    47  		},
    48  		"500 internal server error": {
    49  			params: GetTuningRecommendationsRequest{
    50  				ConfigID:    43253,
    51  				Version:     15,
    52  				PolicyID:    "AAAA_81230",
    53  				RulesetType: RulesetTypeEvaluation,
    54  			},
    55  			headers:        http.Header{},
    56  			responseStatus: http.StatusInternalServerError,
    57  			responseBody: `
    58  {
    59      "type": "internal_error",
    60      "title": "Internal Server Error",
    61      "detail": "Error fetching propertys",
    62      "status": 500
    63  }`,
    64  			expectedPath: "/appsec/v1/configs/43253/versions/15/security-policies/AAAA_81230/recommendations?standardException=true&type=evaluation",
    65  			withError: &Error{
    66  				Type:       "internal_error",
    67  				Title:      "Internal Server Error",
    68  				Detail:     "Error fetching propertys",
    69  				StatusCode: http.StatusInternalServerError,
    70  			},
    71  		},
    72  	}
    73  
    74  	for name, test := range tests {
    75  		t.Run(name, func(t *testing.T) {
    76  			mockServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    77  				assert.Equal(t, test.expectedPath, r.URL.String())
    78  				assert.Equal(t, http.MethodGet, r.Method)
    79  				w.WriteHeader(test.responseStatus)
    80  				_, err := w.Write([]byte(test.responseBody))
    81  				assert.NoError(t, err)
    82  			}))
    83  			client := mockAPIClient(t, mockServer)
    84  			result, err := client.GetTuningRecommendations(
    85  				session.ContextWithOptions(
    86  					context.Background(),
    87  					session.WithContextHeaders(test.headers),
    88  				),
    89  				test.params)
    90  			if test.withError != nil {
    91  				assert.True(t, errors.Is(err, test.withError), "want: %s; got: %s", test.withError, err)
    92  				return
    93  			}
    94  			require.NoError(t, err)
    95  			assert.Equal(t, test.expectedResponse, result)
    96  		})
    97  	}
    98  }
    99  
   100  func TestAppSec_GetRuleRecommendations(t *testing.T) {
   101  
   102  	result := GetRuleRecommendationsResponse{}
   103  
   104  	respData := compactJSON(loadFixtureBytes("testdata/TestTuningRecommendations/RuleRecommendations.json"))
   105  	err := json.Unmarshal([]byte(respData), &result)
   106  	require.NoError(t, err)
   107  
   108  	tests := map[string]struct {
   109  		params           GetRuleRecommendationsRequest
   110  		responseStatus   int
   111  		responseBody     string
   112  		expectedPath     string
   113  		expectedResponse *GetRuleRecommendationsResponse
   114  		withError        error
   115  		headers          http.Header
   116  	}{
   117  		"200 OK": {
   118  			params: GetRuleRecommendationsRequest{
   119  				ConfigID:    43253,
   120  				Version:     15,
   121  				PolicyID:    "AAAA_81230",
   122  				RuleID:      958008,
   123  				RulesetType: RulesetTypeEvaluation,
   124  			},
   125  			headers: http.Header{
   126  				"Content-Type": []string{"application/json"},
   127  			},
   128  			responseStatus:   http.StatusOK,
   129  			responseBody:     string(respData),
   130  			expectedPath:     "/appsec/v1/configs/43253/versions/15/security-policies/AAAA_81230/recommendations/rules/958008?standardException=true&type=evaluation",
   131  			expectedResponse: &result,
   132  		},
   133  		"500 internal server error": {
   134  			params: GetRuleRecommendationsRequest{
   135  				ConfigID:    43253,
   136  				Version:     15,
   137  				PolicyID:    "AAAA_81230",
   138  				RuleID:      958008,
   139  				RulesetType: RulesetTypeActive,
   140  			},
   141  			headers:        http.Header{},
   142  			responseStatus: http.StatusInternalServerError,
   143  			responseBody: `
   144  {
   145      "type": "internal_error",
   146      "title": "Internal Server Error",
   147      "detail": "Error fetching propertys",
   148      "status": 500
   149  }`,
   150  			expectedPath: "/appsec/v1/configs/43253/versions/15/security-policies/AAAA_81230/recommendations/rules/958008?standardException=true&type=active",
   151  			withError: &Error{
   152  				Type:       "internal_error",
   153  				Title:      "Internal Server Error",
   154  				Detail:     "Error fetching propertys",
   155  				StatusCode: http.StatusInternalServerError,
   156  			},
   157  		},
   158  	}
   159  
   160  	for name, test := range tests {
   161  		t.Run(name, func(t *testing.T) {
   162  			mockServer := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
   163  				assert.Equal(t, test.expectedPath, r.URL.String())
   164  				assert.Equal(t, http.MethodGet, r.Method)
   165  				w.WriteHeader(test.responseStatus)
   166  				_, err := w.Write([]byte(test.responseBody))
   167  				assert.NoError(t, err)
   168  			}))
   169  			client := mockAPIClient(t, mockServer)
   170  			result, err := client.GetRuleRecommendations(
   171  				session.ContextWithOptions(
   172  					context.Background(),
   173  					session.WithContextHeaders(test.headers),
   174  				),
   175  				test.params)
   176  			if test.withError != nil {
   177  				assert.True(t, errors.Is(err, test.withError), "want: %s; got: %s", test.withError, err)
   178  				return
   179  			}
   180  			require.NoError(t, err)
   181  			assert.Equal(t, test.expectedResponse, result)
   182  		})
   183  	}
   184  }