Skip to content

Commit 1356e6a

Browse files
author
OpenShift Bot
committed
Merge pull request #3832 from stevekuznetsov/skuznets/update-swagger-descriptions
Merged by openshift-bot
2 parents 8e1fb74 + 52dc4bf commit 1356e6a

5 files changed

+313
-4
lines changed

‎Makefile

+2
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ check-test:
6565
hack/verify-generated-completions.sh
6666
hack/verify-generated-docs.sh
6767
hack/verify-generated-swagger-spec.sh
68+
hack/verify-api-descriptions.sh
6869
hack/test-cmd.sh
6970
KUBE_RACE=" " hack/test-integration.sh
7071
.PHONY: check-test
@@ -93,6 +94,7 @@ test:
9394
hack/verify-generated-completions.sh
9495
hack/verify-generated-docs.sh
9596
hack/verify-generated-swagger-spec.sh
97+
hack/verify-api-descriptions.sh
9698
hack/test-cmd.sh
9799
KUBE_RACE=" " hack/test-integration-docker.sh
98100
hack/test-end-to-end-docker.sh

‎hack/api-description-whitelist.txt

+221
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
## ---------------------------------------------- ##
2+
## THIS WHITELIST ALLOWS FOR THE VERIFY SCRIPT TO ##
3+
## SUCCEED WHILE DESCRIPTIONS ARE ADDED. IF A NEW ##
4+
## DESCRIPTION IS ADDED, THE CORRESPONDING ENTRY ##
5+
## IN THIS LIST SHOULD BE REMOVED. ##
6+
## ADDING NEW ENTRIES TO THIS LIST IS DISALLOWED ##
7+
## ---------------------------------------------- ##
8+
api.patch
9+
integer
10+
json.watchevent
11+
patch.object
12+
runtime.rawextension
13+
v1.awselasticblockstorevolumesource
14+
v1.binding
15+
v1.build
16+
v1.buildconfiglist
17+
v1.buildconfigspec
18+
v1.buildconfigstatus
19+
v1.buildlist
20+
v1.buildlog
21+
v1.buildoutput
22+
v1.buildrequest
23+
v1.buildsource
24+
v1.buildspec
25+
v1.buildstatus
26+
v1.buildstrategy
27+
v1.buildtriggerpolicy
28+
v1.capabilities
29+
v1.capability
30+
v1.cephfsvolumesource
31+
v1.clusternetwork
32+
v1.clusternetworklist
33+
v1.clusterpolicy
34+
v1.clusterpolicybinding
35+
v1.clusterpolicybindinglist
36+
v1.clusterpolicylist
37+
v1.clusterrole
38+
v1.clusterrolebinding
39+
v1.clusterrolebindinglist
40+
v1.clusterrolelist
41+
v1.componentcondition
42+
v1.componentstatus
43+
v1.componentstatuslist
44+
v1.container
45+
v1.containerport
46+
v1.containerstate
47+
v1.containerstaterunning
48+
v1.containerstateterminated
49+
v1.containerstatewaiting
50+
v1.containerstatus
51+
v1.custombuildstrategy
52+
v1.customdeploymentstrategyparams
53+
v1.deleteoptions
54+
v1.deploymentcause
55+
v1.deploymentcauseimagetrigger
56+
v1.deploymentconfiglist
57+
v1.deploymentconfigrollback
58+
v1.deploymentconfigrollbackspec
59+
v1.deploymentconfigspec
60+
v1.deploymentconfigstatus
61+
v1.deploymentdetails
62+
v1.deploymentstrategy
63+
v1.deploymenttriggerimagechangeparams
64+
v1.deploymenttriggerpolicy
65+
v1.dockerbuildstrategy
66+
v1.emptydirvolumesource
67+
v1.endpointaddress
68+
v1.endpointport
69+
v1.endpoints
70+
v1.endpointslist
71+
v1.endpointsubset
72+
v1.envvar
73+
v1.envvarsource
74+
v1.event
75+
v1.eventlist
76+
v1.eventsource
77+
v1.execaction
78+
v1.execnewpodhook
79+
v1.finalizername
80+
v1.gcepersistentdiskvolumesource
81+
v1.gitbuildsource
82+
v1.gitrepovolumesource
83+
v1.gitsourcerevision
84+
v1.glusterfsvolumesource
85+
v1.group
86+
v1.grouplist
87+
v1.handler
88+
v1.hostpathvolumesource
89+
v1.hostsubnet
90+
v1.hostsubnetlist
91+
v1.httpgetaction
92+
v1.identity
93+
v1.identitylist
94+
v1.image
95+
v1.imagechangetrigger
96+
v1.imagelist
97+
v1.imagestream
98+
v1.imagestreamimage
99+
v1.imagestreamlist
100+
v1.imagestreammapping
101+
v1.imagestreamspec
102+
v1.imagestreamstatus
103+
v1.imagestreamtag
104+
v1.iscsivolumesource
105+
v1.lifecycle
106+
v1.lifecyclehook
107+
v1.limitrange
108+
v1.limitrangeitem
109+
v1.limitrangelist
110+
v1.limitrangespec
111+
v1.listmeta
112+
v1.loadbalanceringress
113+
v1.loadbalancerstatus
114+
v1.localobjectreference
115+
v1.metadatafile
116+
v1.metadatavolumesource
117+
v1.namedclusterrole
118+
v1.namedclusterrolebinding
119+
v1.namedrole
120+
v1.namedrolebinding
121+
v1.namedtageventlist
122+
v1.namedtagreference
123+
v1.namespace
124+
v1.namespacelist
125+
v1.namespacespec
126+
v1.namespacestatus
127+
v1.nfsvolumesource
128+
v1.nodeaddress
129+
v1.nodecondition
130+
v1.nodelist
131+
v1.nodespec
132+
v1.nodestatus
133+
v1.nodesysteminfo
134+
v1.oauthaccesstoken
135+
v1.oauthaccesstokenlist
136+
v1.oauthauthorizetoken
137+
v1.oauthauthorizetokenlist
138+
v1.oauthclient
139+
v1.oauthclientauthorization
140+
v1.oauthclientauthorizationlist
141+
v1.oauthclientlist
142+
v1.objectfieldselector
143+
v1.objectmeta
144+
v1.objectreference
145+
v1.parameter
146+
v1.persistentvolumeaccessmode
147+
v1.persistentvolumeclaimlist
148+
v1.persistentvolumeclaimspec
149+
v1.persistentvolumeclaimstatus
150+
v1.persistentvolumeclaimvolumesource
151+
v1.persistentvolumelist
152+
v1.persistentvolumespec
153+
v1.persistentvolumestatus
154+
v1.podcondition
155+
v1.podlist
156+
v1.podspec
157+
v1.podstatus
158+
v1.podtemplate
159+
v1.podtemplatelist
160+
v1.podtemplatespec
161+
v1.policy
162+
v1.policybinding
163+
v1.policybindinglist
164+
v1.policylist
165+
v1.policyrule
166+
v1.probe
167+
v1.projectlist
168+
v1.projectrequest
169+
v1.projectspec
170+
v1.projectstatus
171+
v1.rbdvolumesource
172+
v1.recreatedeploymentstrategyparams
173+
v1.replicationcontroller
174+
v1.replicationcontrollerlist
175+
v1.replicationcontrollerspec
176+
v1.replicationcontrollerstatus
177+
v1.resourceaccessreview
178+
v1.resourcequota
179+
v1.resourcequotalist
180+
v1.resourcequotaspec
181+
v1.resourcequotastatus
182+
v1.resourcerequirements
183+
v1.role
184+
v1.rolebinding
185+
v1.rolebindinglist
186+
v1.rolelist
187+
v1.rollingdeploymentstrategyparams
188+
v1.routespec
189+
v1.routestatus
190+
v1.runasuserstrategyoptions
191+
v1.secret
192+
v1.secretlist
193+
v1.secretvolumesource
194+
v1.securitycontext
195+
v1.securitycontextconstraints
196+
v1.securitycontextconstraintslist
197+
v1.selinuxcontextstrategyoptions
198+
v1.selinuxoptions
199+
v1.serviceaccount
200+
v1.serviceaccountlist
201+
v1.servicelist
202+
v1.serviceport
203+
v1.servicespec
204+
v1.servicestatus
205+
v1.sourcebuildstrategy
206+
v1.sourcecontroluser
207+
v1.sourcerevision
208+
v1.status
209+
v1.statuscause
210+
v1.statusdetails
211+
v1.subjectaccessreview
212+
v1.tagevent
213+
v1.tcpsocketaction
214+
v1.template
215+
v1.templatelist
216+
v1.tlsconfig
217+
v1.useridentitymapping
218+
v1.userlist
219+
v1.volume
220+
v1.volumemount
221+
v1.webhooktrigger

‎hack/list-swagger-objects.py

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import json;
2+
import sys;
3+
import string;
4+
5+
if len(sys.argv)!=2:
6+
print("Useage: python hack/list-swagger-objects.py <swagger-spec-location>")
7+
sys.exit(1)
8+
9+
swagger_spec_location=sys.argv[1]
10+
11+
with open(swagger_spec_location, 'r') as source:
12+
for model in json.load(source)["models"]:
13+
print(string.lower(model))

‎hack/update-generated-swagger-spec.sh

+11-4
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,15 @@ popd > /dev/null
6161
wait_for_url "${HOST}/healthz" "apiserver: " 0.25 80
6262

6363
echo "Updating ${SWAGGER_SPEC_OUT_DIR}:"
64-
echo "Updating ${SWAGGER_SPEC_OUT_DIR}/oapi-v1.json from ${SWAGGER_API_PATH}oapi/v1..."
65-
curl "${SWAGGER_API_PATH}oapi/v1" > "${SWAGGER_SPEC_OUT_DIR}/oapi-v1.json"
66-
echo "Updating ${SWAGGER_SPEC_OUT_DIR}/api-v1.json from ${SWAGGER_API_PATH}api/v1..."
67-
curl "${SWAGGER_API_PATH}api/v1" > "${SWAGGER_SPEC_OUT_DIR}/api-v1.json"
64+
65+
ENDPOINT_TYPES="oapi api"
66+
for type in $ENDPOINT_TYPES
67+
do
68+
ENDPOINTS=$(curl "${HOST}" | grep -Po "(?<=\/${type}\/)[a-z0-9]+" | sed '/v1beta3/d')
69+
for endpoint in $ENDPOINTS
70+
do
71+
echo "Updating ${SWAGGER_SPEC_OUT_DIR}/${type}-${endpoint}.json from ${SWAGGER_API_PATH}${type}/${endpoint}..."
72+
curl "${SWAGGER_API_PATH}${type}/${endpoint}" > "${SWAGGER_SPEC_OUT_DIR}/${type}-${endpoint}.json"
73+
done
74+
done
6875
echo "SUCCESS"

‎hack/verify-api-descriptions.sh

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
#!/bin/bash
2+
3+
set -o errexit
4+
set -o nounset
5+
set -o pipefail
6+
7+
OS_ROOT=$(dirname "${BASH_SOURCE}")/..
8+
source "${OS_ROOT}/hack/common.sh"
9+
10+
cd "${OS_ROOT}"
11+
12+
DEF_MISSING=false
13+
UPDATE_WHITELIST=false
14+
15+
function verify-api-descriptions-for-spec ()
16+
{
17+
SPEC=$1
18+
echo "Verifying Descriptions for Spec: ${SPEC}"
19+
OBJECTS=$(python hack/list-swagger-objects.py ${SPEC})
20+
for object in $OBJECTS
21+
do
22+
desc_location="api/definitions/${object}"
23+
if [ -d "${desc_location}" ]
24+
then
25+
if [ ! -s "${desc_location}/description.adoc" ]
26+
then
27+
if ! grep -qx "^${object}$" hack/api-description-whitelist.txt
28+
then
29+
echo "Description missing for: ${object}"
30+
DEF_MISSING=true
31+
fi
32+
else
33+
if grep -qx "^${object}$" hack/api-description-whitelist.txt
34+
then
35+
echo "Unnecessary whitelist entry for: ${object}"
36+
UPDATE_WHITELIST=true
37+
fi
38+
fi
39+
else
40+
if ! grep -q "${object}" hack/api-description-whitelist.txt
41+
then
42+
echo "Description missing for: ${object}"
43+
DEF_MISSING=true
44+
fi
45+
fi
46+
done
47+
}
48+
49+
SPECS="${OS_ROOT}/api/swagger-spec/*.json"
50+
for spec in $SPECS
51+
do
52+
verify-api-descriptions-for-spec $spec
53+
done
54+
55+
if $DEF_MISSING || $UPDATE_WHITELIST
56+
then
57+
if $DEF_MISSING
58+
then
59+
echo "FAILURE: Add missing descriptions to api/definitions"
60+
else
61+
echo "FAILURE: Prune unnecessary whitelist entries"
62+
fi
63+
exit 1
64+
else
65+
echo SUCCESS
66+
fi

0 commit comments

Comments
 (0)