Skip to content

Commit 1540a56

Browse files
tusharjadhav3302cursoragent
tusharjadhav3302
and
cursoragent
authored
Harden verification OpenStack CLI calls to use JSON output (#32)
* Harden verification OpenStack CLI calls to use JSON output Replace fragile -f value/-c/csv+grep parsing in Priority A verification tasks with -f json and structured parsing so OSC formatter drift (e.g. Invalid formatter provided on floating ip show) no longer fails nightlies. Co-authored-by: Cursor <cursoragent@cursor.com> * Use floating ip list instead of broken show -f formatters On shiftstackclient OSC, `openstack floating ip show … -f *` always returns Invalid formatter provided. Look up Fixed IP Address via `floating ip list --floating-ip-address … -f json` instead. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 54d97d5 commit 1540a56

5 files changed

Lines changed: 75 additions & 33 deletions

File tree

‎collection/stages/roles/verification/tasks/check_cinder_csi.yml‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,20 @@
4343
- name: Get volume az for workers (if any)
4444
ansible.builtin.shell: |
4545
set -o pipefail
46-
openstack volume show $(openstack volume list -c ID -c Name -f value | grep "{{ item }}" | cut -d' ' -f2) -c availability_zone -f value
46+
vol_id=$(openstack volume list -f json | jq -r --arg w "{{ item }}" '
47+
[.[] | select((.Name // .name // "") | contains($w)) | (.ID // .id)] | first // empty
48+
')
49+
if [ -z "${vol_id}" ]; then
50+
exit 0
51+
fi
52+
openstack volume show "${vol_id}" -f json | jq -r '.availability_zone // empty'
4753
environment:
4854
OS_CLOUD: "{{ user_cloud }}"
4955
loop: "{{ worker_names }}"
5056
register: temporary_output
5157
failed_when: false
5258
changed_when: false
59+
when: edge_nova_az is not defined
5360

5461
- name: Convert output on a list
5562
ansible.builtin.set_fact:
@@ -97,8 +104,7 @@
97104
existing_pvc_ids: "{{ existing_pvcs | json_query('resources[].spec.volumeName') | list }}"
98105

99106
- name: Get cinder volumes for PVCs
100-
ansible.builtin.shell: |
101-
openstack volume show "{{ item }}" -c availability_zone -f value
107+
ansible.builtin.command: openstack volume show "{{ item }}" -f json
102108
environment:
103109
OS_CLOUD: "{{ user_cloud }}"
104110
loop: "{{ existing_pvc_ids }}"
@@ -107,7 +113,7 @@
107113

108114
- name: Convert output on a list
109115
ansible.builtin.set_fact:
110-
existing_pvc_azs: "{{ existing_pvc_azs + [item.stdout] }}"
116+
existing_pvc_azs: "{{ existing_pvc_azs + [(item.stdout | from_json).availability_zone] }}"
111117
loop: "{{ temporary_output.results | list }}"
112118

113119
- name: Check - expected cinder AZs on PVCs

‎collection/stages/roles/verification/tasks/check_lb_svc.yml‎

Lines changed: 47 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -52,36 +52,45 @@
5252
- not internal_lb
5353
- lb_ingress_ip is match(ipv4_regex)
5454
block:
55-
- name: Get the LB internal IP on openstack when the lb is using a FIP
56-
ansible.builtin.shell: |
57-
openstack floating ip show {{ lb_ingress_ip }} -c fixed_ip_address -f value
55+
# NOTE: `openstack floating ip show … -f <any>` is broken on the
56+
# shiftstackclient OSC ("Invalid formatter provided"). Use list+filter.
57+
- name: Get the LB FIP details on openstack when the lb is using a FIP
58+
ansible.builtin.command: openstack floating ip list --floating-ip-address {{ lb_ingress_ip }} -f json
5859
environment:
5960
OS_CLOUD: "{{ user_cloud }}"
60-
register: lb_internal_ip_output
61+
register: lb_fip_list
6162
changed_when: false
6263

64+
- name: Check the FIP "{{ lb_ingress_ip }}" exists on OpenStack
65+
ansible.builtin.assert:
66+
that:
67+
- (lb_fip_list.stdout | from_json | length) > 0
68+
fail_msg: Could not find floating IP "{{ lb_ingress_ip }}" in OSP
69+
6370
- name: Define the internal IP
6471
ansible.builtin.set_fact:
65-
lb_internal_ip: "{{ internal_lb | ternary(lb_ingress_ip, lb_internal_ip_output.stdout) }}"
72+
lb_internal_ip: "{{ internal_lb | ternary(lb_ingress_ip, (lb_fip_list.stdout | from_json | first)['Fixed IP Address']) }}"
6673

67-
- name: Get the Octavia provider type for the LB
68-
ansible.builtin.shell: |
69-
set -o pipefail
70-
openstack loadbalancer list -c vip_address -c provider -f value | grep {{ lb_internal_ip }} | awk '{print $2}'
74+
- name: List load balancers on OpenStack
75+
ansible.builtin.command: openstack loadbalancer list -f json
7176
environment:
7277
OS_CLOUD: "{{ user_cloud }}"
73-
register: svc_lb_type
78+
register: svc_lb_list
7479
changed_when: false
7580

81+
- name: Select the LB matching VIP "{{ lb_internal_ip }}"
82+
ansible.builtin.set_fact:
83+
svc_lb_matches: "{{ svc_lb_list.stdout | from_json | selectattr('vip_address', 'defined') | selectattr('vip_address', 'equalto', lb_internal_ip) | list }}"
84+
7685
- name: Check the LB exists with the internal IP (VIP address) "{{ lb_internal_ip }}"
7786
ansible.builtin.assert:
78-
that: svc_lb_type.stdout | length > 0
87+
that: svc_lb_matches | length > 0
7988
fail_msg: Could not find a LB in OSP with the vip_address "{{ lb_internal_ip }}"
8089
success_msg: A LB with the vip_address "{{ lb_internal_ip }}" has been found in OSP
8190

8291
- name: Detecte LB Octavia provider
8392
ansible.builtin.debug:
84-
msg: "Detected LB Octavia provider: {{ svc_lb_type.stdout }}"
93+
msg: "Detected LB Octavia provider: {{ svc_lb_matches[0].provider }}"
8594

8695
- name: Get pod names
8796
kubernetes.core.k8s_info:
@@ -142,27 +151,42 @@
142151
delay: 15
143152
until: oc_project.resources|length == 0
144153

145-
- name: Check the LB with "{{ lb_ingress_ip }}" ingress IP has been removed from OSP
146-
ansible.builtin.shell: |
147-
set -o pipefail
148-
openstack loadbalancer list -f value | grep {{ lb_ingress_ip }}
154+
- name: List load balancers after project deletion
155+
ansible.builtin.command: openstack loadbalancer list -f json
149156
environment:
150157
OS_CLOUD: "{{ user_cloud }}"
151-
register: svc_lb
152-
failed_when: svc_lb.rc == 0
158+
register: svc_lb_after
153159
changed_when: false
154160
when:
155161
- lb_internal_ip is defined
156162
- lb_internal_ip | length > 0
157163

158-
- name: Check the fip "{{ lb_ingress_ip }}" has been removed from OSP
159-
ansible.builtin.shell: |
160-
openstack floating ip show {{ lb_ingress_ip }} -f value
164+
- name: Check the LB with "{{ lb_ingress_ip }}" ingress IP has been removed from OSP
165+
ansible.builtin.assert:
166+
that:
167+
- (svc_lb_after.stdout | from_json | selectattr('vip_address', 'defined') | selectattr('vip_address', 'equalto', lb_ingress_ip) | list | length) == 0
168+
- (svc_lb_after.stdout | from_json | selectattr('vip_address', 'defined') | selectattr('vip_address', 'equalto', lb_internal_ip) | list | length) == 0
169+
fail_msg: Found a LB in OSP still associated with vip_address "{{ lb_ingress_ip }}" or "{{ lb_internal_ip }}"
170+
when:
171+
- lb_internal_ip is defined
172+
- lb_internal_ip | length > 0
173+
174+
# Prefer list over show: floating ip show -f * fails on shiftstackclient OSC.
175+
- name: Check whether the fip "{{ lb_ingress_ip }}" still exists on OSP
176+
ansible.builtin.command: openstack floating ip list --floating-ip-address {{ lb_ingress_ip }} -f json
161177
environment:
162178
OS_CLOUD: "{{ user_cloud }}"
163-
register: fip
164-
failed_when: fip.rc == 0
179+
register: fip_list
165180
changed_when: false
166181
when:
167182
- lb_internal_ip is defined
168183
- lb_internal_ip | length > 0
184+
185+
- name: Check the fip "{{ lb_ingress_ip }}" has been removed from OSP
186+
ansible.builtin.assert:
187+
that:
188+
- (fip_list.stdout | from_json | length) == 0
189+
fail_msg: FIP "{{ lb_ingress_ip }}" is still present in OSP
190+
when:
191+
- lb_internal_ip is defined
192+
- lb_internal_ip | length > 0

‎collection/stages/roles/verification/tasks/check_prometheus_pvcs.yml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@
3232
monitoring_pvc_ids: "{{ monitoring_pvcs | json_query('resources[].spec.volumeName') | list }}"
3333

3434
- name: Check cinder volume for PVC exist
35-
ansible.builtin.shell: |
36-
set -o pipefail
37-
openstack volume list -f csv | grep {{ item }}
35+
ansible.builtin.command: openstack volume show "{{ item }}" -f json
3836
environment:
3937
OS_CLOUD: "{{ user_cloud }}"
4038
changed_when: false

‎collection/stages/roles/verification/tasks/check_registry.yml‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,14 @@
111111
- name: Get the images objects in swift for the {{ swift_check_ns }} namespace from the containers
112112
ansible.builtin.shell: |
113113
set -o pipefail
114-
openstack container list -c Name -f value | xargs -I% openstack object list % -c Name -f value | grep {{ swift_check_ns }}.{{ swift_check_image }}
114+
target="{{ swift_check_ns }}.{{ swift_check_image }}"
115+
openstack container list -f json \
116+
| jq -r '.[] | (.Name // .name // empty)' \
117+
| while read -r container; do
118+
[ -z "${container}" ] && continue
119+
openstack object list "${container}" -f json \
120+
| jq -r --arg t "${target}" '.[] | (.Name // .name // empty) | select(contains($t))'
121+
done
115122
environment:
116123
OS_CLOUD: "{{ user_cloud }}"
117124
register: image_registry_objects
@@ -123,7 +130,14 @@
123130
- name: List objects in case of failure from the containers
124131
ansible.builtin.shell: |
125132
set -o pipefail
126-
openstack container list -c Name -f value | xargs -I% openstack object list % -c Name -f value
133+
openstack container list -f json \
134+
| jq -r '.[] | (.Name // .name // empty)' \
135+
| while read -r container; do
136+
[ -z "${container}" ] && continue
137+
echo "=== container: ${container} ==="
138+
openstack object list "${container}" -f json \
139+
| jq -r '.[] | (.Name // .name // empty)'
140+
done
127141
environment:
128142
OS_CLOUD: "{{ user_cloud }}"
129143
changed_when: false

‎collection/stages/roles/verification/tasks/main.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
- not _skip_health # CSI is disabled post-adoption
120120

121121
- name: Check if manila is present on the OSP installation
122-
ansible.builtin.command: openstack catalog show manila -c name
122+
ansible.builtin.command: openstack catalog show manila -f json
123123
environment:
124124
OS_CLOUD: "{{ user_cloud }}"
125125
register: manila_enabled

0 commit comments

Comments
 (0)