Skip to content

Commit 8ad9bbb

Browse files
alexsong93mhamann
alexsong93
authored and
mhamann
committed
Add support for set-variable in operation-switch (#282)
1 parent c389313 commit 8ad9bbb

File tree

5 files changed

+308
-54
lines changed

5 files changed

+308
-54
lines changed

‎scripts/lua/lib/utils.lua

+24
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,28 @@ function _Utils.hash(str)
117117
return resty_str.to_hex(digest)
118118
end
119119

120+
--- Return the length of the table
121+
-- @param table
122+
function _Utils.tableLength(table)
123+
local count = 0
124+
for _ in pairs(table) do
125+
count = count + 1
126+
end
127+
return count
128+
end
129+
130+
--- Create a deep clone of the given table
131+
-- @param table table to clone
132+
function _Utils.deepCloneTable(table)
133+
local tblRes = {}
134+
if type(table) == "table" then
135+
for k,v in pairs(table) do
136+
tblRes[k] = _Utils.deepCloneTable(v)
137+
end
138+
else
139+
tblRes = table
140+
end
141+
return tblRes
142+
end
143+
120144
return _Utils

‎scripts/lua/management/lib/swagger.lua

+86-33
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-- Module for parsing swagger file
2020

2121
local _M = {}
22+
local utils = require "lib/utils"
2223

2324
-- Convert passed-in swagger body to valid lua table
2425
-- @param swagger swagger file to parse
@@ -38,16 +39,34 @@ function _M.parseSwagger(swagger)
3839
for verb, value in pairs(verbObj) do
3940
decoded.resources[path].operations[verb] = {}
4041
local verbObj = decoded.resources[path].operations[verb]
42+
verbObj.policies = utils.deepCloneTable(policies) or {}
43+
verbObj.security = security
4144
if backends ~= nil then
4245
local backend = (backends["all"] ~= nil) and backends["all"] or backends[value.operationId]
4346
verbObj.backendUrl = backend.backendUrl
4447
verbObj.backendMethod = (backend.backendMethod == 'keep') and verb or backend.backendMethod
48+
if backend.policy ~= nil then
49+
local globalReqMappingPolicy = nil;
50+
for _, policy in pairs(verbObj.policies) do
51+
if policy.type == 'reqMapping' then
52+
globalReqMappingPolicy = policy;
53+
end
54+
end
55+
if globalReqMappingPolicy ~= nil then
56+
for _, v in pairs(backend.policy.value) do
57+
globalReqMappingPolicy.value[#globalReqMappingPolicy.value+1] = v
58+
end
59+
else
60+
verbObj.policies[#verbObj.policies+1] = {
61+
type = 'reqMapping',
62+
value = backend.policy.value
63+
}
64+
end
65+
end
4566
else
4667
verbObj.backendUrl = ''
4768
verbObj.backendMethod = verb
4869
end
49-
verbObj.policies = policies
50-
verbObj.security = security
5170
end
5271
end
5372
return decoded
@@ -66,10 +85,18 @@ function parseBackends(swagger)
6685
local caseObj = v.case
6786
for _, case in pairs(caseObj) do
6887
for _, op in pairs(case.operations) do
69-
res[op] = {
70-
backendUrl = case.execute[1]["invoke"]["target-url"],
71-
backendMethod = case.execute[1]["invoke"].verb
72-
}
88+
res[op] = {}
89+
for _, opPolicy in pairs(case.execute) do
90+
if opPolicy.invoke ~= nil then
91+
res[op].backendUrl = opPolicy.invoke["target-url"]
92+
res[op].backendMethod = opPolicy.invoke.verb
93+
elseif opPolicy["set-variable"] ~= nil then
94+
local reqMappingPolicy = parseRequestMapping(case)
95+
if reqMappingPolicy ~= nil then
96+
res[op].policy = reqMappingPolicy
97+
end
98+
end
99+
end
73100
end
74101
end
75102
return res
@@ -91,17 +118,27 @@ end
91118
function parsePolicies(swagger)
92119
local policies = {}
93120
-- parse rate limit
94-
policies = parseRateLimit(swagger, policies)
95-
policies = parseRequestMapping(swagger, policies)
121+
local rlObj = swagger["x-gateway-rate-limit"]
122+
rlObj = (rlObj == nil) and swagger["x-ibm-rate-limit"] or rlObj
123+
local rateLimitPolicy = parseRateLimit(rlObj)
124+
if rateLimitPolicy ~= nil then
125+
policies[#policies+1] = rateLimitPolicy
126+
end
127+
-- parse set-variable
128+
local configObj = swagger["x-gateway-configuration"]
129+
configObj = (configObj == nil) and swagger["x-ibm-configuration"] or configObj
130+
if configObj ~= nil then
131+
local reqMappingPolicy = parseRequestMapping(configObj.assembly)
132+
if reqMappingPolicy ~= nil then
133+
policies[#policies+1] = reqMappingPolicy
134+
end
135+
end
96136
return policies
97137
end
98138

99139
--- Parse rate limit
100-
function parseRateLimit(swagger, policies)
101-
local rlObj = swagger["x-gateway-rate-limit"]
102-
rlObj = (rlObj == nil) and swagger["x-ibm-rate-limit"] or rlObj
103-
local unit
104-
if rlObj ~= nil then
140+
function parseRateLimit(rlObj)
141+
if rlObj ~= nil and rlObj[1] ~= nil then
105142
rlObj = rlObj[1]
106143
if rlObj.unit == "second" then
107144
unit = 1
@@ -114,7 +151,7 @@ function parseRateLimit(swagger, policies)
114151
else
115152
unit = 60 -- default to minute
116153
end
117-
policies[#policies+1] = {
154+
return {
118155
type = "rateLimit",
119156
value = {
120157
interval = unit * rlObj.units,
@@ -124,14 +161,14 @@ function parseRateLimit(swagger, policies)
124161
}
125162
}
126163
end
127-
return policies
164+
return nil
128165
end
129166

130167
--- Parse request mapping
131-
function parseRequestMapping(swagger, policies)
168+
function parseRequestMapping(configObj)
132169
local valueList = {}
133-
if swagger["x-ibm-configuration"] ~= nil then
134-
for _, obj in pairs(swagger["x-ibm-configuration"].assembly.execute) do
170+
if configObj ~= nil then
171+
for _, obj in pairs(configObj.execute) do
135172
for policy, v in pairs(obj) do
136173
if policy == "set-variable" then
137174
for _, actionObj in pairs(v.actions) do
@@ -156,12 +193,13 @@ function parseRequestMapping(swagger, policies)
156193
end
157194
end
158195
if next(valueList) ~= nil then
159-
policies[#policies+1] ={
196+
return {
160197
type = "reqMapping",
161198
value = valueList
162199
}
200+
else
201+
return nil
163202
end
164-
return policies
165203
end
166204

167205
--- Parse security in swagger
@@ -170,19 +208,34 @@ function parseSecurity(swagger)
170208
local security = {}
171209
if swagger["securityDefinitions"] ~= nil then
172210
local secObject = swagger["securityDefinitions"]
173-
for key, sec in pairs(secObject) do
174-
if sec.type == 'apiKey' then
175-
security[#security+1] = {
176-
type = sec.type,
177-
scope = "api",
178-
header = sec.name
179-
}
180-
elseif sec.type == 'oauth2' then
181-
security[#security+1] = {
182-
type = sec.type,
183-
scope = "api",
184-
provider = key
185-
}
211+
if utils.tableLength(secObject) == 2 then
212+
secObj = {
213+
type = 'clientSecret',
214+
scope = 'api'
215+
}
216+
for key, sec in pairs(secObject) do
217+
if key == 'client_id' then
218+
secObj.idFieldName = sec.name
219+
elseif key == 'client_secret' then
220+
secObj.secretFieldName = sec.name
221+
end
222+
end
223+
security[#security+1] = secObj
224+
else
225+
for key, sec in pairs(secObject) do
226+
if sec.type == 'apiKey' then
227+
security[#security+1] = {
228+
type = sec.type,
229+
scope = "api",
230+
header = sec.name
231+
}
232+
elseif sec.type == 'oauth2' then
233+
security[#security+1] = {
234+
type = sec.type,
235+
scope = "api",
236+
provider = key
237+
}
238+
end
186239
end
187240
end
188241
end

‎tests/scripts/lua/management/examples/example2.json

+11-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
"rate": 100
6363
}
6464
],
65-
"x-ibm-configuration": {
65+
"x-gateway-configuration": {
6666
"assembly": {
6767
"execute": [
6868
{
@@ -83,6 +83,16 @@
8383
"getHello"
8484
],
8585
"execute": [
86+
{
87+
"set-variable": {
88+
"actions": [
89+
{
90+
"set": "message.headers.foo",
91+
"value": "bar"
92+
}
93+
]
94+
}
95+
},
8696
{
8797
"invoke": {
8898
"target-url": "https://openwhisk.ng.bluemix.net/api/some/action/path.http",

‎tests/scripts/lua/management/examples/example3.json

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "1.0",
5+
"title": "Hello World API"
6+
},
7+
"basePath": "/whisk2",
8+
"schemes": [
9+
"https"
10+
],
11+
"consumes": [
12+
"application/json"
13+
],
14+
"produces": [
15+
"application/json"
16+
],
17+
"paths": {
18+
"/bye": {
19+
"get": {
20+
"operationId": "getBye",
21+
"description": "Returns a greeting to the user!",
22+
"responses": {
23+
"200": {
24+
"description": "Returns the greeting.",
25+
"schema": {
26+
"type": "string"
27+
}
28+
},
29+
"400": {
30+
"description": "Invalid characters in \"user\" were provided."
31+
}
32+
}
33+
},
34+
"post": {
35+
"operationId": "postBye",
36+
"description": null
37+
}
38+
}
39+
},
40+
"securityDefinitions": {},
41+
"security": [],
42+
"x-ibm-rate-limit": [],
43+
"x-gateway-configuration": {
44+
"assembly": {
45+
"execute": [
46+
{
47+
"operation-switch": {
48+
"case": [
49+
{
50+
"operations": [
51+
"getBye"
52+
],
53+
"execute": [
54+
{
55+
"set-variable": {
56+
"actions": [
57+
{
58+
"set": "message.headers.foo",
59+
"value": "bar"
60+
}
61+
]
62+
}
63+
},
64+
{
65+
"set-variable": {
66+
"actions": [
67+
{
68+
"set": "message.headers.hello",
69+
"value": "world"
70+
}
71+
]
72+
}
73+
},
74+
{
75+
"invoke": {
76+
"target-url": "https://openwhisk.ng.bluemix.net/api/some/action/path.http",
77+
"verb": "keep"
78+
}
79+
}
80+
]
81+
},
82+
{
83+
"operations": [
84+
"postBye"
85+
],
86+
"execute": [
87+
{
88+
"invoke": {
89+
"target-url": "https://openwhisk.ng.bluemix.net/api/[email protected]/demo/createuser",
90+
"verb": "keep"
91+
}
92+
}
93+
]
94+
}
95+
],
96+
"otherwise": []
97+
}
98+
}
99+
]
100+
}
101+
}
102+
}

0 commit comments

Comments
 (0)