Skip to content

Commit

Permalink
Revert - wait for all snapshots to drain before returning
Browse files Browse the repository at this point in the history
Add a check that the all snapshots were drained
Add test
Add changelog fragement

Signed-off-by: Ygal Blum <[email protected]>
  • Loading branch information
ygalblum committed Sep 28, 2023
1 parent 33a4850 commit ac9257d
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 0 deletions.
Empty file added changelogs/fragments/.gitkeep
Empty file.
2 changes: 2 additions & 0 deletions changelogs/fragments/revert-wait-for-drain.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
minor_changes:
- Revert - wait for snapshot to drain before returning
9 changes: 9 additions & 0 deletions roles/lvm_snapshots/tasks/revert.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,12 @@
path: "/root/boot-backup-{{ lvm_snapshots_set_name }}.tgz"
state: absent
when: lvm_snapshots_boot_backup

- name: Wait for the snapshot to drain
ansible.builtin.command: "lvs --select 'lv_name = {{ item.origin }}' --reportformat json"
register: _lv_drain_check
until: (_lv_drain_check.stdout | from_json).report[0].lv[0].data_percent == ""
retries: 20
delay: 30
loop: "{{ lvm_snapshots_snapshots }}"
changed_when: false
39 changes: 39 additions & 0 deletions tests/fill-snapshot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
- name: Fill the volume
block:
- name: Set the retry count

Check failure on line 3 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

fqcn[action-core]

Use FQCN for builtin module actions (set_fact).
set_fact:
_retry_count: "{{ (_retry_count | default('-1') | int) + 1 }}"

- name: Generate the Sub-Directory name
ansible.builtin.set_fact:
_sub_dir_name: "{{ lookup('community.general.random_string', upper=false, numbers=false, special=false) }}"

- name: Make a copy of the boot partition

Check failure on line 11 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

risky-file-permissions

File permissions unset or incorrect.
ansible.builtin.copy:
src: /boot
dest: "{{ test_directory }}/{{ _sub_dir_name }}"
remote_src: yes

Check failure on line 15 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[truthy]

Truthy value should be one of \[false, true]

Check failure on line 15 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

yaml[truthy]

Truthy value should be one of \[false, true]

- name: Get the status of the snapshot
ansible.builtin.command: "lvs --select 'lv_name = {{ volume_name }}_{{ snapshot_set_name }}' --reportformat json"
register: _lv_status_check
changed_when: false

- name: Store the snapshot data_percent
ansible.builtin.set_fact:
_snapshot_data_percent: "{{ ((_lv_status_check.stdout | from_json).report[0].lv[0].data_percent) }}"

- name: Check if snapshot is full enough
ansible.builtin.assert:
that: _snapshot_data_percent|float > snapshot_fill_percent|float
quiet: true

rescue:
- ansible.builtin.fail:

Check failure on line 32 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

name[missing]

All tasks should be named.
msg: "Ended after {{ snapshot_max_retry }} retries"
when: (_retry_count|int) == (snapshot_max_retry|int)

- ansible.builtin.debug:

Check failure on line 36 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

name[missing]

All tasks should be named.
msg: "Volume is not full enought ({{ _snapshot_data_percent }}) - Run again..."

- ansible.builtin.include_tasks: fill-snapshot.yml

Check failure on line 39 in tests/fill-snapshot.yml

View workflow job for this annotation

GitHub Actions / Ansible Lint

name[missing]

All tasks should be named.
53 changes: 53 additions & 0 deletions tests/test-drain-snapshot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
- name: Test revering to the snapshots
hosts: all
become: true
vars:
volume_group: test_vg
test_directory: "/mnt/test"
volume_name: test_lv
volumes:
- name: "{{ volume_name }}"
size: 4g
directory: "{{ test_directory }}"
snapshot_set_name: demo_snap
snapshot_fill_percent: 60
snapshot_max_retry: 100
tasks:
- name: Run pre-test steps
ansible.builtin.include_tasks: pre-test-tasks.yml

- name: Create the snapshot
ansible.builtin.include_tasks: create-snapshot.yml

- name: Fill the snapshot
ansible.builtin.include_tasks: fill-snapshot.yml

- name: Revert to Snapshot
vars:
lvm_snapshots_action: revert
lvm_snapshots_set_name: "{{ snapshot_set_name }}"
ansible.builtin.include_role:
name: lvm_snapshots

- name: Verify that the snapshot was completly drained
block:
- name: Verify that the snapshot no longer exists
vars:
volume_name: test_lv
ansible.builtin.include_tasks: verify-snapshot-not-exist.yml
- name: Verify that the snapshot was drained before returning
block:
- name: Get the status of the volume
ansible.builtin.command: "lvs --select 'lv_name = {{ volume_name }}' --reportformat json"
register: _lv_status_check
changed_when: false
- name: Store the snapshot data_percent
ansible.builtin.set_fact:
volume_data_percent: "{{ ((_lv_status_check.stdout | from_json).report[0].lv[0].data_percent) }}"
- name: Assert volume_data_percent is 0
ansible.builtin.assert:
that: volume_data_percent|float == 0.0
fail_msg: "Volume data percent is {{ volume_data_percent }} while it should be 0"
always:
- name: Cleanup
ansible.builtin.include_tasks: post-test-tasks.yml

0 comments on commit ac9257d

Please sign in to comment.