|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | +// |
| 3 | +// The OpenSearch Contributors require contributions made to |
| 4 | +// this file be licensed under the Apache-2.0 license or a |
| 5 | +// compatible open source license. |
| 6 | + |
| 7 | +package opensearchtransport_test |
| 8 | + |
| 9 | +import ( |
| 10 | + "net/http" |
| 11 | + "testing" |
| 12 | + |
| 13 | + "github.com/stretchr/testify/assert" |
| 14 | + "github.com/stretchr/testify/require" |
| 15 | + |
| 16 | + "github.com/opensearch-project/opensearch-go/v4/opensearchtransport" |
| 17 | +) |
| 18 | + |
| 19 | +func TestOperationClassifier(t *testing.T) { |
| 20 | + t.Parallel() |
| 21 | + c := opensearchtransport.NewOperationClassifier() |
| 22 | + |
| 23 | + tests := []struct { |
| 24 | + name string |
| 25 | + method string |
| 26 | + path string |
| 27 | + want opensearchtransport.OperationID |
| 28 | + }{ |
| 29 | + // Bulk |
| 30 | + {"bulk POST", http.MethodPost, "/_bulk", opensearchtransport.OpBulk}, |
| 31 | + {"bulk PUT", http.MethodPut, "/_bulk", opensearchtransport.OpBulk}, |
| 32 | + {"bulk with index", http.MethodPost, "/my-index/_bulk", opensearchtransport.OpBulk}, |
| 33 | + {"bulk stream", http.MethodPost, "/_bulk/stream", opensearchtransport.OpBulkStream}, |
| 34 | + {"reindex", http.MethodPost, "/_reindex", opensearchtransport.OpReindex}, |
| 35 | + |
| 36 | + // Search |
| 37 | + {"search GET", http.MethodGet, "/_search", opensearchtransport.OpSearch}, |
| 38 | + {"search POST", http.MethodPost, "/_search", opensearchtransport.OpSearch}, |
| 39 | + {"search with index", http.MethodPost, "/events/_search", opensearchtransport.OpSearch}, |
| 40 | + {"msearch", http.MethodPost, "/_msearch", opensearchtransport.OpMSearch}, |
| 41 | + {"count", http.MethodGet, "/_count", opensearchtransport.OpCount}, |
| 42 | + {"count with index", http.MethodPost, "/events/_count", opensearchtransport.OpCount}, |
| 43 | + {"delete_by_query", http.MethodPost, "/events/_delete_by_query", opensearchtransport.OpDeleteByQuery}, |
| 44 | + {"update_by_query", http.MethodPost, "/events/_update_by_query", opensearchtransport.OpUpdateByQuery}, |
| 45 | + {"validate", http.MethodGet, "/_validate/query", opensearchtransport.OpValidate}, |
| 46 | + {"rank_eval", http.MethodPost, "/_rank_eval", opensearchtransport.OpRankEval}, |
| 47 | + {"search shards", http.MethodGet, "/_search_shards", opensearchtransport.OpSearchShards}, |
| 48 | + {"field caps", http.MethodGet, "/_field_caps", opensearchtransport.OpFieldCaps}, |
| 49 | + |
| 50 | + // Templates |
| 51 | + {"search template", http.MethodPost, "/_search/template", opensearchtransport.OpSearchTemplate}, |
| 52 | + {"search template with index", http.MethodPost, "/events/_search/template", opensearchtransport.OpSearchTemplate}, |
| 53 | + {"msearch template", http.MethodPost, "/_msearch/template", opensearchtransport.OpMSearchTmpl}, |
| 54 | + |
| 55 | + // Scroll |
| 56 | + {"scroll get", http.MethodGet, "/_search/scroll", opensearchtransport.OpScrollGet}, |
| 57 | + {"scroll post", http.MethodPost, "/_search/scroll", opensearchtransport.OpScrollGet}, |
| 58 | + {"scroll delete", http.MethodDelete, "/_search/scroll", opensearchtransport.OpScrollDelete}, |
| 59 | + |
| 60 | + // PIT |
| 61 | + {"pit create", http.MethodPost, "/events/_search/point_in_time", opensearchtransport.OpPITCreate}, |
| 62 | + {"pit delete", http.MethodDelete, "/_search/point_in_time", opensearchtransport.OpPITDelete}, |
| 63 | + {"pit list", http.MethodGet, "/_search/point_in_time/_all", opensearchtransport.OpPITList}, |
| 64 | + |
| 65 | + // Document ops |
| 66 | + {"doc get", http.MethodGet, "/events/_doc/123", opensearchtransport.OpDocGet}, |
| 67 | + {"doc exists", http.MethodHead, "/events/_doc/123", opensearchtransport.OpDocExists}, |
| 68 | + {"doc index PUT", http.MethodPut, "/events/_doc/123", opensearchtransport.OpDocIndex}, |
| 69 | + {"doc index POST", http.MethodPost, "/events/_doc", opensearchtransport.OpDocIndex}, |
| 70 | + {"doc create", http.MethodPut, "/events/_create/123", opensearchtransport.OpDocCreate}, |
| 71 | + {"doc update", http.MethodPost, "/events/_update/123", opensearchtransport.OpDocUpdate}, |
| 72 | + {"doc delete", http.MethodDelete, "/events/_doc/123", opensearchtransport.OpDocDelete}, |
| 73 | + {"source get", http.MethodGet, "/events/_source/123", opensearchtransport.OpDocSourceGet}, |
| 74 | + {"source exists", http.MethodHead, "/events/_source/123", opensearchtransport.OpDocSourceExist}, |
| 75 | + {"mget", http.MethodPost, "/_mget", opensearchtransport.OpMGet}, |
| 76 | + {"termvectors", http.MethodGet, "/events/_termvectors", opensearchtransport.OpTermVectors}, |
| 77 | + {"mtermvectors", http.MethodPost, "/_mtermvectors", opensearchtransport.OpMTermVectors}, |
| 78 | + {"explain", http.MethodPost, "/events/_explain/123", opensearchtransport.OpExplain}, |
| 79 | + |
| 80 | + // Ingest |
| 81 | + {"ingest get", http.MethodGet, "/_ingest/pipeline/my-pipe", opensearchtransport.OpIngestGet}, |
| 82 | + {"ingest get all", http.MethodGet, "/_ingest/pipeline", opensearchtransport.OpIngestGet}, |
| 83 | + {"ingest create", http.MethodPut, "/_ingest/pipeline/my-pipe", opensearchtransport.OpIngestCreate}, |
| 84 | + {"ingest delete", http.MethodDelete, "/_ingest/pipeline/my-pipe", opensearchtransport.OpIngestDelete}, |
| 85 | + {"ingest simulate", http.MethodPost, "/_ingest/pipeline/my-pipe/_simulate", opensearchtransport.OpIngestSimulate}, |
| 86 | + |
| 87 | + // Maintenance |
| 88 | + {"refresh", http.MethodPost, "/_refresh", opensearchtransport.OpRefresh}, |
| 89 | + {"refresh index", http.MethodPost, "/events/_refresh", opensearchtransport.OpRefresh}, |
| 90 | + {"flush", http.MethodPost, "/_flush", opensearchtransport.OpFlush}, |
| 91 | + {"flush synced", http.MethodPost, "/_flush/synced", opensearchtransport.OpFlush}, |
| 92 | + {"forcemerge", http.MethodPost, "/_forcemerge", opensearchtransport.OpForceMerge}, |
| 93 | + {"segments", http.MethodGet, "/_segments", opensearchtransport.OpSegments}, |
| 94 | + {"cache clear", http.MethodPost, "/_cache/clear", opensearchtransport.OpCacheClear}, |
| 95 | + {"recovery", http.MethodGet, "/events/_recovery", opensearchtransport.OpRecovery}, |
| 96 | + {"shard stores", http.MethodGet, "/events/_shard_stores", opensearchtransport.OpShardStores}, |
| 97 | + {"stats", http.MethodGet, "/_stats", opensearchtransport.OpStats}, |
| 98 | + {"stats with metric", http.MethodGet, "/_stats/indexing", opensearchtransport.OpStats}, |
| 99 | + {"stats with index", http.MethodGet, "/events/_stats", opensearchtransport.OpStats}, |
| 100 | + |
| 101 | + // Rethrottle |
| 102 | + {"reindex rethrottle", http.MethodPost, "/_reindex/task1/_rethrottle", opensearchtransport.OpReindexRethrottle}, |
| 103 | + {"ubq rethrottle", http.MethodPost, "/_update_by_query/task1/_rethrottle", opensearchtransport.OpUBQRethrottle}, |
| 104 | + {"dbq rethrottle", http.MethodPost, "/_delete_by_query/task1/_rethrottle", opensearchtransport.OpDBQRethrottle}, |
| 105 | + |
| 106 | + // Cluster info |
| 107 | + {"root GET", http.MethodGet, "/", opensearchtransport.OpClusterInfo}, |
| 108 | + {"root HEAD", http.MethodHead, "/", opensearchtransport.OpClusterInfo}, |
| 109 | + |
| 110 | + // Unknown |
| 111 | + {"unrecognized path", http.MethodGet, "/_unknown/endpoint", opensearchtransport.OpOther}, |
| 112 | + {"unrecognized method", "DESTROY", "/_search", opensearchtransport.OpOther}, |
| 113 | + {"empty path", http.MethodGet, "", opensearchtransport.OpOther}, |
| 114 | + } |
| 115 | + |
| 116 | + for _, tt := range tests { |
| 117 | + t.Run(tt.name, func(t *testing.T) { |
| 118 | + t.Parallel() |
| 119 | + got := c.Classify(tt.method, tt.path) |
| 120 | + assert.Equal(t, tt.want, got, "Classify(%q, %q) = %s, want %s", |
| 121 | + tt.method, tt.path, got, tt.want) |
| 122 | + }) |
| 123 | + } |
| 124 | +} |
| 125 | + |
| 126 | +func TestOperationClassifier_ConcurrentSafety(t *testing.T) { |
| 127 | + t.Parallel() |
| 128 | + c := opensearchtransport.NewOperationClassifier() |
| 129 | + |
| 130 | + const goroutines = 50 |
| 131 | + done := make(chan struct{}) |
| 132 | + for range goroutines { |
| 133 | + go func() { |
| 134 | + defer func() { done <- struct{}{} }() |
| 135 | + for range 500 { |
| 136 | + c.Classify(http.MethodPost, "/events/_search") |
| 137 | + c.Classify(http.MethodPost, "/_bulk") |
| 138 | + c.Classify(http.MethodGet, "/events/_doc/123") |
| 139 | + } |
| 140 | + }() |
| 141 | + } |
| 142 | + for range goroutines { |
| 143 | + <-done |
| 144 | + } |
| 145 | +} |
| 146 | + |
| 147 | +func TestOperationID_Masking(t *testing.T) { |
| 148 | + t.Parallel() |
| 149 | + |
| 150 | + t.Run("IsWrite", func(t *testing.T) { |
| 151 | + t.Parallel() |
| 152 | + assert.False(t, opensearchtransport.OpSearch.IsWrite()) |
| 153 | + assert.False(t, opensearchtransport.OpDocGet.IsWrite()) |
| 154 | + assert.True(t, opensearchtransport.OpBulk.IsWrite()) |
| 155 | + assert.True(t, opensearchtransport.OpDocIndex.IsWrite()) |
| 156 | + assert.True(t, opensearchtransport.OpDocDelete.IsWrite()) |
| 157 | + }) |
| 158 | + |
| 159 | + t.Run("IsRead", func(t *testing.T) { |
| 160 | + t.Parallel() |
| 161 | + assert.True(t, opensearchtransport.OpSearch.IsRead()) |
| 162 | + assert.True(t, opensearchtransport.OpDocGet.IsRead()) |
| 163 | + assert.False(t, opensearchtransport.OpBulk.IsRead()) |
| 164 | + assert.False(t, opensearchtransport.OpDocIndex.IsRead()) |
| 165 | + }) |
| 166 | + |
| 167 | + t.Run("Category", func(t *testing.T) { |
| 168 | + t.Parallel() |
| 169 | + assert.Equal(t, opensearchtransport.CatSearch, opensearchtransport.OpSearch.Category()) |
| 170 | + assert.Equal(t, opensearchtransport.CatSearch, opensearchtransport.OpMSearch.Category()) |
| 171 | + assert.Equal(t, opensearchtransport.CatSearch, opensearchtransport.OpCount.Category()) |
| 172 | + assert.Equal(t, opensearchtransport.CatBulk, opensearchtransport.OpBulk.Category()) |
| 173 | + assert.Equal(t, opensearchtransport.CatDocRead, opensearchtransport.OpDocGet.Category()) |
| 174 | + assert.Equal(t, opensearchtransport.CatDocWrite, opensearchtransport.OpDocIndex.Category()) |
| 175 | + }) |
| 176 | + |
| 177 | + t.Run("IsSearchFamily", func(t *testing.T) { |
| 178 | + t.Parallel() |
| 179 | + isSearchFamily := func(op opensearchtransport.OperationID) bool { |
| 180 | + return op.Category() == opensearchtransport.CatSearch |
| 181 | + } |
| 182 | + assert.True(t, isSearchFamily(opensearchtransport.OpSearch)) |
| 183 | + assert.True(t, isSearchFamily(opensearchtransport.OpMSearch)) |
| 184 | + assert.True(t, isSearchFamily(opensearchtransport.OpCount)) |
| 185 | + assert.False(t, isSearchFamily(opensearchtransport.OpBulk)) |
| 186 | + assert.False(t, isSearchFamily(opensearchtransport.OpDocGet)) |
| 187 | + }) |
| 188 | +} |
| 189 | + |
| 190 | +func TestOperationID_String(t *testing.T) { |
| 191 | + t.Parallel() |
| 192 | + |
| 193 | + tests := []struct { |
| 194 | + op opensearchtransport.OperationID |
| 195 | + want string |
| 196 | + }{ |
| 197 | + {opensearchtransport.OpSearch, "search"}, |
| 198 | + {opensearchtransport.OpMSearch, "msearch"}, |
| 199 | + {opensearchtransport.OpCount, "count"}, |
| 200 | + {opensearchtransport.OpBulk, "bulk"}, |
| 201 | + {opensearchtransport.OpBulkStream, "bulk_stream"}, |
| 202 | + {opensearchtransport.OpReindex, "reindex"}, |
| 203 | + {opensearchtransport.OpDocGet, "doc_get"}, |
| 204 | + {opensearchtransport.OpDocIndex, "doc_index"}, |
| 205 | + {opensearchtransport.OpDocDelete, "doc_delete"}, |
| 206 | + {opensearchtransport.OpDocCreate, "doc_create"}, |
| 207 | + {opensearchtransport.OpDocUpdate, "doc_update"}, |
| 208 | + {opensearchtransport.OpScrollGet, "scroll_get"}, |
| 209 | + {opensearchtransport.OpScrollDelete, "scroll_delete"}, |
| 210 | + {opensearchtransport.OpRefresh, "refresh"}, |
| 211 | + {opensearchtransport.OpFlush, "flush"}, |
| 212 | + {opensearchtransport.OpForceMerge, "forcemerge"}, |
| 213 | + {opensearchtransport.OpStats, "stats"}, |
| 214 | + {opensearchtransport.OpClusterInfo, "cluster_info"}, |
| 215 | + {opensearchtransport.OpPing, "ping"}, |
| 216 | + {opensearchtransport.OpOther, "other"}, |
| 217 | + } |
| 218 | + |
| 219 | + for _, tt := range tests { |
| 220 | + t.Run(tt.want, func(t *testing.T) { |
| 221 | + t.Parallel() |
| 222 | + require.Equal(t, tt.want, tt.op.String()) |
| 223 | + }) |
| 224 | + } |
| 225 | +} |
0 commit comments