crd.sh 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  1. #!/usr/bin/env bash
  2. # Copyright 2018 The Kubernetes Authors.
  3. #
  4. # Licensed under the Apache License, Version 2.0 (the "License");
  5. # you may not use this file except in compliance with the License.
  6. # You may obtain a copy of the License at
  7. #
  8. # http://www.apache.org/licenses/LICENSE-2.0
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. set -o errexit
  16. set -o nounset
  17. set -o pipefail
  18. run_crd_tests() {
  19. set -o nounset
  20. set -o errexit
  21. create_and_use_new_namespace
  22. kube::log::status "Testing kubectl crd"
  23. kubectl "${kube_flags_with_token[@]}" create -f - << __EOF__
  24. {
  25. "kind": "CustomResourceDefinition",
  26. "apiVersion": "apiextensions.k8s.io/v1beta1",
  27. "metadata": {
  28. "name": "foos.company.com"
  29. },
  30. "spec": {
  31. "group": "company.com",
  32. "version": "v1",
  33. "scope": "Namespaced",
  34. "names": {
  35. "plural": "foos",
  36. "kind": "Foo"
  37. }
  38. }
  39. }
  40. __EOF__
  41. # Post-Condition: assertion object exist
  42. kube::test::get_object_assert customresourcedefinitions "{{range.items}}{{if eq $id_field \\\"foos.company.com\\\"}}{{$id_field}}:{{end}}{{end}}" 'foos.company.com:'
  43. kubectl "${kube_flags_with_token[@]}" create -f - << __EOF__
  44. {
  45. "kind": "CustomResourceDefinition",
  46. "apiVersion": "apiextensions.k8s.io/v1beta1",
  47. "metadata": {
  48. "name": "bars.company.com"
  49. },
  50. "spec": {
  51. "group": "company.com",
  52. "version": "v1",
  53. "scope": "Namespaced",
  54. "names": {
  55. "plural": "bars",
  56. "kind": "Bar"
  57. }
  58. }
  59. }
  60. __EOF__
  61. # Post-Condition: assertion object exist
  62. kube::test::get_object_assert customresourcedefinitions "{{range.items}}{{if eq $id_field \\\"foos.company.com\\\" \\\"bars.company.com\\\"}}{{$id_field}}:{{end}}{{end}}" 'bars.company.com:foos.company.com:'
  63. # This test ensures that the name printer is able to output a resource
  64. # in the proper "kind.group/resource_name" format, and that the
  65. # resource builder is able to resolve a GVK when a kind.group pair is given.
  66. kubectl "${kube_flags_with_token[@]}" create -f - << __EOF__
  67. {
  68. "kind": "CustomResourceDefinition",
  69. "apiVersion": "apiextensions.k8s.io/v1beta1",
  70. "metadata": {
  71. "name": "resources.mygroup.example.com"
  72. },
  73. "spec": {
  74. "group": "mygroup.example.com",
  75. "version": "v1alpha1",
  76. "scope": "Namespaced",
  77. "names": {
  78. "plural": "resources",
  79. "singular": "resource",
  80. "kind": "Kind",
  81. "listKind": "KindList"
  82. }
  83. }
  84. }
  85. __EOF__
  86. # Post-Condition: assertion crd with non-matching kind and resource exists
  87. kube::test::get_object_assert customresourcedefinitions "{{range.items}}{{if eq $id_field \\\"foos.company.com\\\" \\\"bars.company.com\\\" \\\"resources.mygroup.example.com\\\"}}{{$id_field}}:{{end}}{{end}}" 'bars.company.com:foos.company.com:resources.mygroup.example.com:'
  88. # This test ensures that we can create complex validation without client-side validation complaining
  89. kubectl "${kube_flags_with_token[@]}" create -f - << __EOF__
  90. {
  91. "kind": "CustomResourceDefinition",
  92. "apiVersion": "apiextensions.k8s.io/v1beta1",
  93. "metadata": {
  94. "name": "validfoos.company.com"
  95. },
  96. "spec": {
  97. "group": "company.com",
  98. "version": "v1",
  99. "scope": "Namespaced",
  100. "names": {
  101. "plural": "validfoos",
  102. "kind": "ValidFoo"
  103. },
  104. "validation": {
  105. "openAPIV3Schema": {
  106. "properties": {
  107. "spec": {
  108. "type": "array",
  109. "items": {
  110. "type": "number"
  111. }
  112. }
  113. }
  114. }
  115. }
  116. }
  117. }
  118. __EOF__
  119. # Post-Condition: assertion crd with non-matching kind and resource exists
  120. kube::test::get_object_assert customresourcedefinitions "{{range.items}}{{if eq $id_field \\\"foos.company.com\\\" \\\"bars.company.com\\\" \\\"resources.mygroup.example.com\\\" \\\"validfoos.company.com\\\"}}{{$id_field}}:{{end}}{{end}}" 'bars.company.com:foos.company.com:resources.mygroup.example.com:validfoos.company.com:'
  121. run_non_native_resource_tests
  122. # teardown
  123. kubectl delete customresourcedefinitions/foos.company.com "${kube_flags_with_token[@]}"
  124. kubectl delete customresourcedefinitions/bars.company.com "${kube_flags_with_token[@]}"
  125. kubectl delete customresourcedefinitions/resources.mygroup.example.com "${kube_flags_with_token[@]}"
  126. kubectl delete customresourcedefinitions/validfoos.company.com "${kube_flags_with_token[@]}"
  127. set +o nounset
  128. set +o errexit
  129. }
  130. kube::util::non_native_resources() {
  131. local times
  132. local wait
  133. local failed
  134. times=30
  135. wait=10
  136. local i
  137. for i in $(seq 1 $times); do
  138. failed=""
  139. kubectl "${kube_flags[@]}" get --raw '/apis/company.com/v1' || failed=true
  140. kubectl "${kube_flags[@]}" get --raw '/apis/company.com/v1/foos' || failed=true
  141. kubectl "${kube_flags[@]}" get --raw '/apis/company.com/v1/bars' || failed=true
  142. if [ -z "${failed}" ]; then
  143. return 0
  144. fi
  145. sleep ${wait}
  146. done
  147. kube::log::error "Timed out waiting for non-native-resources; tried ${times} waiting ${wait}s between each"
  148. return 1
  149. }
  150. run_non_native_resource_tests() {
  151. set -o nounset
  152. set -o errexit
  153. create_and_use_new_namespace
  154. kube::log::status "Testing kubectl non-native resources"
  155. kube::util::non_native_resources
  156. # Test that we can list this new CustomResource (foos)
  157. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  158. # Test that we can list this new CustomResource (bars)
  159. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  160. # Test that we can list this new CustomResource (resources)
  161. kube::test::get_object_assert resources "{{range.items}}{{$id_field}}:{{end}}" ''
  162. # Test that we can create a new resource of type Kind
  163. kubectl "${kube_flags[@]}" create -f hack/testdata/CRD/resource.yaml "${kube_flags[@]}"
  164. # Test that -o name returns kind.group/resourcename
  165. output_message=$(kubectl "${kube_flags[@]}" get resource/myobj -o name)
  166. kube::test::if_has_string "${output_message}" 'kind.mygroup.example.com/myobj'
  167. output_message=$(kubectl "${kube_flags[@]}" get resources/myobj -o name)
  168. kube::test::if_has_string "${output_message}" 'kind.mygroup.example.com/myobj'
  169. output_message=$(kubectl "${kube_flags[@]}" get kind.mygroup.example.com/myobj -o name)
  170. kube::test::if_has_string "${output_message}" 'kind.mygroup.example.com/myobj'
  171. # Delete the resource with cascade.
  172. kubectl "${kube_flags[@]}" delete resources myobj --cascade=true
  173. # Make sure it's gone
  174. kube::test::wait_object_assert resources "{{range.items}}{{$id_field}}:{{end}}" ''
  175. # Test that we can create a new resource of type Foo
  176. kubectl "${kube_flags[@]}" create -f hack/testdata/CRD/foo.yaml "${kube_flags[@]}"
  177. # Test that we can list this new custom resource
  178. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  179. # Test alternate forms
  180. kube::test::get_object_assert foo "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  181. kube::test::get_object_assert foos.company.com "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  182. kube::test::get_object_assert foos.v1.company.com "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  183. # Test all printers, with lists and individual items
  184. kube::log::status "Testing CustomResource printing"
  185. kubectl "${kube_flags[@]}" get foos
  186. kubectl "${kube_flags[@]}" get foos/test
  187. kubectl "${kube_flags[@]}" get foos -o name
  188. kubectl "${kube_flags[@]}" get foos/test -o name
  189. kubectl "${kube_flags[@]}" get foos -o wide
  190. kubectl "${kube_flags[@]}" get foos/test -o wide
  191. kubectl "${kube_flags[@]}" get foos -o json
  192. kubectl "${kube_flags[@]}" get foos/test -o json
  193. kubectl "${kube_flags[@]}" get foos -o yaml
  194. kubectl "${kube_flags[@]}" get foos/test -o yaml
  195. kubectl "${kube_flags[@]}" get foos -o "jsonpath={.items[*].someField}" --allow-missing-template-keys=false
  196. kubectl "${kube_flags[@]}" get foos/test -o "jsonpath={.someField}" --allow-missing-template-keys=false
  197. kubectl "${kube_flags[@]}" get foos -o "go-template={{range .items}}{{.someField}}{{end}}" --allow-missing-template-keys=false
  198. kubectl "${kube_flags[@]}" get foos/test -o "go-template={{.someField}}" --allow-missing-template-keys=false
  199. output_message=$(kubectl "${kube_flags[@]}" get foos/test -o name)
  200. kube::test::if_has_string "${output_message}" 'foo.company.com/test'
  201. # Test patching
  202. kube::log::status "Testing CustomResource patching"
  203. kubectl "${kube_flags[@]}" patch foos/test -p '{"patched":"value1"}' --type=merge
  204. kube::test::get_object_assert foos/test "{{.patched}}" 'value1'
  205. kubectl "${kube_flags[@]}" patch foos/test -p '{"patched":"value2"}' --type=merge --record
  206. kube::test::get_object_assert foos/test "{{.patched}}" 'value2'
  207. kubectl "${kube_flags[@]}" patch foos/test -p '{"patched":null}' --type=merge --record
  208. kube::test::get_object_assert foos/test "{{.patched}}" '<no value>'
  209. # Get local version
  210. CRD_RESOURCE_FILE="${KUBE_TEMP}/crd-foos-test.json"
  211. kubectl "${kube_flags[@]}" get foos/test -o json > "${CRD_RESOURCE_FILE}"
  212. # cannot apply strategic patch locally
  213. CRD_PATCH_ERROR_FILE="${KUBE_TEMP}/crd-foos-test-error"
  214. ! kubectl "${kube_flags[@]}" patch --local -f "${CRD_RESOURCE_FILE}" -p '{"patched":"value3"}' 2> "${CRD_PATCH_ERROR_FILE}"
  215. if grep -q "try --type merge" "${CRD_PATCH_ERROR_FILE}"; then
  216. kube::log::status "\"kubectl patch --local\" returns error as expected for CustomResource: $(cat ${CRD_PATCH_ERROR_FILE})"
  217. else
  218. kube::log::status "\"kubectl patch --local\" returns unexpected error or non-error: $(cat ${CRD_PATCH_ERROR_FILE})"
  219. exit 1
  220. fi
  221. # can apply merge patch locally
  222. kubectl "${kube_flags[@]}" patch --local -f "${CRD_RESOURCE_FILE}" -p '{"patched":"value3"}' --type=merge -o json
  223. # can apply merge patch remotely
  224. kubectl "${kube_flags[@]}" patch --record -f "${CRD_RESOURCE_FILE}" -p '{"patched":"value3"}' --type=merge -o json
  225. kube::test::get_object_assert foos/test "{{.patched}}" 'value3'
  226. rm "${CRD_RESOURCE_FILE}"
  227. rm "${CRD_PATCH_ERROR_FILE}"
  228. # Test labeling
  229. kube::log::status "Testing CustomResource labeling"
  230. kubectl "${kube_flags[@]}" label foos --all listlabel=true
  231. kubectl "${kube_flags[@]}" label foo/test itemlabel=true
  232. # Test annotating
  233. kube::log::status "Testing CustomResource annotating"
  234. kubectl "${kube_flags[@]}" annotate foos --all listannotation=true
  235. kubectl "${kube_flags[@]}" annotate foo/test itemannotation=true
  236. # Test describing
  237. kube::log::status "Testing CustomResource describing"
  238. kubectl "${kube_flags[@]}" describe foos
  239. kubectl "${kube_flags[@]}" describe foos/test
  240. kubectl "${kube_flags[@]}" describe foos | grep listlabel=true
  241. kubectl "${kube_flags[@]}" describe foos | grep itemlabel=true
  242. # Delete the resource with cascade.
  243. kubectl "${kube_flags[@]}" delete foos test --cascade=true
  244. # Make sure it's gone
  245. kube::test::wait_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  246. # Test that we can create a new resource of type Bar
  247. kubectl "${kube_flags[@]}" create -f hack/testdata/CRD/bar.yaml "${kube_flags[@]}"
  248. # Test that we can list this new custom resource
  249. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  250. # Test that we can watch the resource.
  251. # Start watcher in background with process substitution,
  252. # so we can read from stdout asynchronously.
  253. kube::log::status "Testing CustomResource watching"
  254. exec 3< <(kubectl "${kube_flags[@]}" get bars --request-timeout=1m --watch-only -o name & echo $! ; wait)
  255. local watch_pid
  256. read <&3 watch_pid
  257. # We can't be sure when the watch gets established,
  258. # so keep triggering events (in the background) until something comes through.
  259. local tries=0
  260. while [ ${tries} -lt 10 ]; do
  261. tries=$((tries+1))
  262. kubectl "${kube_flags[@]}" patch bars/test -p "{\"patched\":\"${tries}\"}" --type=merge
  263. sleep 1
  264. done &
  265. local patch_pid=$!
  266. # Wait up to 30s for a complete line of output.
  267. local watch_output
  268. read <&3 -t 30 watch_output
  269. # Stop the watcher and the patch loop.
  270. kill -9 ${watch_pid}
  271. kill -9 ${patch_pid}
  272. kube::test::if_has_string "${watch_output}" 'bar.company.com/test'
  273. # Delete the resource without cascade.
  274. kubectl "${kube_flags[@]}" delete bars test --cascade=false
  275. # Make sure it's gone
  276. kube::test::wait_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  277. # Test that we can create single item via apply
  278. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/foo.yaml
  279. # Test that we have create a foo named test
  280. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  281. # Test that the field has the expected value
  282. kube::test::get_object_assert foos/test '{{.someField}}' 'field1'
  283. # Test that apply an empty patch doesn't change fields
  284. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/foo.yaml
  285. # Test that the field has the same value after re-apply
  286. kube::test::get_object_assert foos/test '{{.someField}}' 'field1'
  287. # Test that apply has updated the subfield
  288. kube::test::get_object_assert foos/test '{{.nestedField.someSubfield}}' 'subfield1'
  289. # Update a subfield and then apply the change
  290. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/foo-updated-subfield.yaml
  291. # Test that apply has updated the subfield
  292. kube::test::get_object_assert foos/test '{{.nestedField.someSubfield}}' 'modifiedSubfield'
  293. # Test that the field has the expected value
  294. kube::test::get_object_assert foos/test '{{.nestedField.otherSubfield}}' 'subfield2'
  295. # Delete a subfield and then apply the change
  296. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/foo-deleted-subfield.yaml
  297. # Test that apply has deleted the field
  298. kube::test::get_object_assert foos/test '{{.nestedField.otherSubfield}}' '<no value>'
  299. # Test that the field does not exist
  300. kube::test::get_object_assert foos/test '{{.nestedField.newSubfield}}' '<no value>'
  301. # Add a field and then apply the change
  302. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/foo-added-subfield.yaml
  303. # Test that apply has added the field
  304. kube::test::get_object_assert foos/test '{{.nestedField.newSubfield}}' 'subfield3'
  305. # Delete the resource
  306. kubectl "${kube_flags[@]}" delete -f hack/testdata/CRD/foo.yaml
  307. # Make sure it's gone
  308. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  309. # Test that we can create list via apply
  310. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/multi-crd-list.yaml
  311. # Test that we have create a foo and a bar from a list
  312. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" 'test-list:'
  313. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" 'test-list:'
  314. # Test that the field has the expected value
  315. kube::test::get_object_assert foos/test-list '{{.someField}}' 'field1'
  316. kube::test::get_object_assert bars/test-list '{{.someField}}' 'field1'
  317. # Test that re-apply an list doesn't change anything
  318. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/multi-crd-list.yaml
  319. # Test that the field has the same value after re-apply
  320. kube::test::get_object_assert foos/test-list '{{.someField}}' 'field1'
  321. kube::test::get_object_assert bars/test-list '{{.someField}}' 'field1'
  322. # Test that the fields have the expected value
  323. kube::test::get_object_assert foos/test-list '{{.someField}}' 'field1'
  324. kube::test::get_object_assert bars/test-list '{{.someField}}' 'field1'
  325. # Update fields and then apply the change
  326. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/multi-crd-list-updated-field.yaml
  327. # Test that apply has updated the fields
  328. kube::test::get_object_assert foos/test-list '{{.someField}}' 'modifiedField'
  329. kube::test::get_object_assert bars/test-list '{{.someField}}' 'modifiedField'
  330. # Test that the field has the expected value
  331. kube::test::get_object_assert foos/test-list '{{.otherField}}' 'field2'
  332. kube::test::get_object_assert bars/test-list '{{.otherField}}' 'field2'
  333. # Delete fields and then apply the change
  334. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/multi-crd-list-deleted-field.yaml
  335. # Test that apply has deleted the fields
  336. kube::test::get_object_assert foos/test-list '{{.otherField}}' '<no value>'
  337. kube::test::get_object_assert bars/test-list '{{.otherField}}' '<no value>'
  338. # Test that the fields does not exist
  339. kube::test::get_object_assert foos/test-list '{{.newField}}' '<no value>'
  340. kube::test::get_object_assert bars/test-list '{{.newField}}' '<no value>'
  341. # Add a field and then apply the change
  342. kubectl "${kube_flags[@]}" apply -f hack/testdata/CRD/multi-crd-list-added-field.yaml
  343. # Test that apply has added the field
  344. kube::test::get_object_assert foos/test-list '{{.newField}}' 'field3'
  345. kube::test::get_object_assert bars/test-list '{{.newField}}' 'field3'
  346. # Delete the resource
  347. kubectl "${kube_flags[@]}" delete -f hack/testdata/CRD/multi-crd-list.yaml
  348. # Make sure it's gone
  349. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  350. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  351. ## kubectl apply --prune
  352. # Test that no foo or bar exist
  353. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  354. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  355. # apply --prune on foo.yaml that has foo/test
  356. kubectl apply --prune -l pruneGroup=true -f hack/testdata/CRD/foo.yaml "${kube_flags[@]}" --prune-whitelist=company.com/v1/Foo --prune-whitelist=company.com/v1/Bar
  357. # check right crds exist
  358. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  359. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  360. # apply --prune on bar.yaml that has bar/test
  361. kubectl apply --prune -l pruneGroup=true -f hack/testdata/CRD/bar.yaml "${kube_flags[@]}" --prune-whitelist=company.com/v1/Foo --prune-whitelist=company.com/v1/Bar
  362. # check right crds exist
  363. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  364. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" 'test:'
  365. # Delete the resource
  366. kubectl "${kube_flags[@]}" delete -f hack/testdata/CRD/bar.yaml
  367. # Make sure it's gone
  368. kube::test::get_object_assert foos "{{range.items}}{{$id_field}}:{{end}}" ''
  369. kube::test::get_object_assert bars "{{range.items}}{{$id_field}}:{{end}}" ''
  370. # Test 'kubectl create' with namespace, and namespace cleanup.
  371. kubectl "${kube_flags[@]}" create namespace non-native-resources
  372. kubectl "${kube_flags[@]}" create -f hack/testdata/CRD/bar.yaml --namespace=non-native-resources
  373. kube::test::get_object_assert bars '{{len .items}}' '1' --namespace=non-native-resources
  374. kubectl "${kube_flags[@]}" delete namespace non-native-resources
  375. # Make sure objects go away.
  376. kube::test::wait_object_assert bars '{{len .items}}' '0' --namespace=non-native-resources
  377. # Make sure namespace goes away.
  378. local tries=0
  379. while kubectl "${kube_flags[@]}" get namespace non-native-resources && [ ${tries} -lt 10 ]; do
  380. tries=$((tries+1))
  381. sleep ${tries}
  382. done
  383. set +o nounset
  384. set +o errexit
  385. }