openstack-ansible/scripts/get-ansible-collection-requirements.yml
Jonathan Rosser 3d3ae5e003 Use local repositories for ansible collections in CI
This patch will search for repositories in the zuul git cache which
match the names of ansible collections, for example
'openstack/ansible-collections-openstack`, and rewrite the collections
requirement file to point to the local copies.

This reduces the number of external git clones, and permits the use
of depends-on to validate changes to collections.

Depends-On: Ice2dbac8a2b23e33523e9b6f120f8f16588b43e1
Change-Id: I2ba12ece8e765a6c409d50c95f4cfbe1f314180f
2022-01-11 13:52:32 +00:00

105 lines
4.0 KiB
YAML

---
# Copyright 2020 BBC R&D.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
- name: Clone the role ansible-role-requirements
hosts: localhost
connection: local
user: root
gather_facts: false
tasks:
- name: Ensure the default collections directory exists
file:
path: "{{ collection_path_default }}/ansible_collections"
state: directory
recurse: yes
- name: Read the list of user collections
set_fact:
user_collection_names: "{{ user_collections.collections | default([]) | map(attribute='name') | list }}"
- name: Get Zuul cloned repos path in CI
set_fact:
zuul_src_path: "{{ lookup('env', 'ZUUL_SRC_PATH') }}"
- name: Generate a list of required collections excluding user overridden collections
set_fact:
galaxy_collections_list : "{{ (galaxy_collections_list | default([])) + [ item ] }}"
when:
- item.name not in user_collection_names
with_items: "{{ required_collections.collections }}"
- name: Append user collections to filtered required collections
set_fact:
galaxy_collections_list: "{{ galaxy_collections_list + [ item ] }}"
with_items: "{{ user_collections.collections }}"
when:
- user_collections.collections is defined
- name: Check the Zuul src dir for cloned roles
stat:
path: "{{ zuul_src_path }}/{{ item.name.split('/')[-3:] | join('/') }}"
get_attributes: no
get_checksum: no
get_mime: no
register: zuul_collections
with_items: "{{ galaxy_collections_list }}"
- name: Override paths for zuul hosted collections in CI
vars:
zuul_item:
name: "git+file://{{ zuul_src_path }}/{{ item.item.name.split('/')[-3:] | join('/') }}"
version: "{{ item.item.version }}"
type: "{{ item.item.type | default('') }}"
set_fact:
galaxy_collections_list_ci: "{{ galaxy_collections_list_ci | default([]) + [ (item.stat.exists | ternary(zuul_item, item.item)) ] }}"
with_items: "{{ zuul_collections.results }}"
- name: Create temporary file for galaxy collection requirements
tempfile:
register: collection_requirements_tmpfile
- name: Copy content into galaxy collection requirements temporary file
vars:
content_var:
collections: "{{ galaxy_collections_list_ci }}"
copy:
content: "{{ content_var | to_nice_yaml }}"
dest: "{{ collection_requirements_tmpfile.path }}"
- name: Install collection requirements with ansible galaxy
command: >
/opt/ansible-runtime/bin/ansible-galaxy collection install --force
-r "{{ collection_requirements_tmpfile.path }}"
-p "{{ collection_path_default }}"
register: collection_install
until: collection_install is success
retries: 5
delay: 2
- name: Show collection install output
debug: msg="{{ collection_install.stdout.split('\n') }}"
- name: Clean up temporary file
file:
path: "{{ collection_requirements_tmpfile.path }}"
state: absent
vars:
collections_file: "{{ playbook_dir }}/../ansible-collection-requirements.yml"
required_collections: "{{ lookup('file', collections_file) | from_yaml }}"
collection_path_default: '/etc/ansible/'
user_collections: "{{ lookup('file', user_collections_path, errors='ignore')|default([], true) | from_yaml }}"
user_collections_path: "{{ lookup('env', 'OSA_CONFIG_DIR') | default('/etc/openstack_deploy', true) ~ '/' ~ (user_collection_file|default('')) }}"