Planned update system-prepare role

Author: exitfound

.github/workflows/molecule-run-tests.yaml

@@ -314,11 +314,11 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --no-cache-dir --upgrade pip
-          pip install -r requirements.txt
+          pip3 install --no-cache-dir --upgrade pip
+          pip3 install -r requirements.txt
 
       - name: Run molecule tests when content changes in system-prepare role
         run: |
           molecule --version
-          molecule test
+          molecule test -s docker-all
         working-directory: ansible/roles/system-prepare

ansible/roles/system-prepare/defaults/main.yaml

@@ -11,7 +11,6 @@ suse_packages_list:
 
 redhat_packages_list:
   - bash-completion
-  - epel-release
   - python3-pip
   - yum-utils
   - wget

ansible/roles/system-prepare/molecule/README.md

@@ -1,19 +1,106 @@
 ## **Molecule:**
 
-Данная секция предназначена для запуска и выполнения тестов с помощью такого инструмента, как molecule. Этот инструмент осуществляет предварительный запуск ролей на указанных платформах (Docker, Vagrant, Cloud и т.д.). Делается это для того, чтобы, когда роль была создана или изменена, не приходилось выполнять её запуск непосредственно на реальных серверах, так это может привести к непредвиденным обстоятельствам.
+Данная секция предназначена для запуска и выполнения тестов с помощью такого инструмента, как `Molecule`. Этот инструмент осуществляет предварительный запуск ролей на указанных платформах (Docker, Cloud и т.д.). Делается это для того, чтобы когда роль была написана или изменена, не приходилось выполнять её запуск непосредственно на реальных серверах, так как это может привести к непредвиденным обстоятельствам.
 
 ### **Установка molecule:**
 
-Для того чтобы установить `molecule` локально, выполните следующую команду:
+Для того чтобы установить `Molecule` локально со всеми зависимостями, выполните следующую команду в корне проекта:
 
 ```
-python3 -m pip install molecule molecule-plugins 'molecule-plugins[docker]' ansible-core ansible-lint yamllint
+pip3 install -r --user requirements.txt
 ```
 
-### **Запуск тестов:**
+### **Запуск тестов в Docker:**
 
-Тесты по отношению к этой роли выполняются на базе платформы Docker. Чтобы запустить все тесты, необходимо выполнить следующую команду:
+Тесты по отношению к данной роли могут быть выполнены на базе таких платформ, как Docker и AWS EC2 (на данном этапе). Чтобы запустить полный прогон, необходимо выполнить команду, указав путь к тому или иному виду теста. Так, например, чтобы запустить тесты в среде Docker, выполните следующую команду:
 
 ```
-molecule test
+molecule test -s docker-all # Запускает роль для всех поддерживаемых дистрибутивов и соответствующих версий;
 ```
+
+В данном случае имя `docker-all` подразумевает наличие всех поддерживаемых дистрибутивов в одном файле molecule.yml, поскольку роль очень проста в исполнении и не требует какого-либо количества ресурсов.
+
+### **Запуск тестов в AWS:**
+
+Принцип запуска тестов в AWS абсолютно идентичен примеру с Docker, за тем исключением, что контекстный путь отличается, однако в случае с AWS разделение по семействам присутствует. Вот пример запуска тестов для AWS:
+
+```
+molecule test -s [aws-debian, aws-ubuntu, aws-suse, aws-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+```
+
+Однако перед запуском рекомендуется заполнить ряд переменных значениями, выраженных в `group_vars` в корне директории `ansible` в проекте, которые актуальны для вас: имя профиля, регион, тип инстанса и т.д. Там же указано описание для каждой переменной. Вот полный список переменных на данный момент:
+
+```
+aws_profile: ""
+aws_region: ""
+aws_instance_type: ""
+aws_vpc_subnet_id: ""
+aws_vpc_id: ""
+aws_key_method: "" 
+aws_default_ssh_user: ""
+aws_local_private_key: ""
+aws_local_public_key: ""
+aws_custom_key_name: ""
+aws_security_group_name: ""
+```
+
+И ещё один аспект. Для каждого семейства дистрибутивов в AWS есть свои версии и реализации. Если по каким-то причинам вас не устраивают предоставленные мною версии дистрибутивов в файле molecule.yml для каждого из семейств или вы просто хотите протестировать те же роли на более старых или новых версиях, то в таком случае вы можете воспользоваться списком команд ниже для каждого из семейств. Эти команды выведут информацию в виде таблице, в которой будет представлен OwnerID семейства для AWS, а также полное имя самого образа, которое одинаково вне зависимости от используемого региона, в сравнении с AMI ID.
+
+* Для **Ubuntu** это:
+```
+# Для Ubuntu 20.04
+aws ec2 describe-images --owners 099720109477 --filters "Name=name,Values=ubuntu/images/hvm-ssd/ubuntu-focal-20.04-amd64-server*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+# Для Ubuntu 22.04
+aws ec2 describe-images --owners 099720109477 --filters "Name=name,Values=ubuntu/images/hvm-ssd/ubuntu-jammy-22.04-amd64-server*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+# Для Ubuntu 24.04
+aws ec2 describe-images --owners 099720109477 --filters "Name=name,Values=ubuntu/images/hvm-ssd-gp3/ubuntu-*-24.04-amd64-server*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+```
+
+* Для **Debian** это:
+```
+# Для Debian 10
+aws ec2 describe-images --owners 136693071363 --filters "Name=name,Values=debian-10-amd64-*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+# Для Debian 11
+aws ec2 describe-images --owners 136693071363 --filters "Name=name,Values=debian-11-amd64-*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+# Для Debian 12
+aws ec2 describe-images --owners 136693071363 --filters "Name=name,Values=debian-12-amd64-*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+```
+
+* Для **SUSE** это:
+```
+# Для SLEL 15 (можно менять версии сервис)
+aws ec2 describe-images --owners 013907871322 --filters "Name=name,Values=suse-sles-15-sp5-*-x86_64" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+```
+
+* Для **Red Hat** это:
+```
+# Для RHEL 8
+aws ec2 describe-images --owners 309956199498 --filters "Name=name,Values=*RHEL-8.10*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+# Для RHEL 9
+aws ec2 describe-images --owners 309956199498 --filters "Name=name,Values=*RHEL-9.5*" --query "Images[*].[OwnerId,CreationDate,Name,ImageId]" --output table
+```
+
+### **Прочие команды в Molecule:**
+
+Если вы хотите только подготовить ресурсную базу, без прогона самих ролей, то для этого выполните следующую команду на выбор в зависимости от вашей платформы (в первую очередь актуально для облаков, где мы подготавливаем инфраструктуру):
+
+```
+molecule create -s [docker-debian, docker-ubuntu, docker-suse, docker-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+molecule create -s [aws-debian, aws-ubuntu, aws-suse, aws-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+```
+
+Если вы хотите запустить прогон тестов для роли без проверки идемпотентности, то для этого выполните следующую команду на выбор в зависимости от вашей платформы:
+
+```
+molecule converge -s [docker-debian, docker-ubuntu, docker-suse, docker-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+molecule converge -s [aws-debian, aws-ubuntu, aws-suse, aws-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+```
+
+Чтобы явно уничтожить следы деятельности прогона тестов используйте следующую команду:
+
+```
+molecule destroy -s [docker-debian, docker-ubuntu, docker-suse, docker-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+molecule destroy -s [aws-debian, aws-ubuntu, aws-suse, aws-redhat] # Укажите на выбор одно из семейств дистрибутивов Linux;
+```
+
+Это может быть полезно в некоторых случаях, так как не всегда прогон тестов завершается успешно и иногда кэш или какие-либо другие следы предыдущего запуска могут помешать следующему. Особенно такое поведение можно наблюдать при работе с Docker.

ansible/roles/system-prepare/molecule/aws-debian/converge.yml

@@ -0,0 +1,12 @@
+---
+# Данный файл используется для преобразования состояния экземпляров в реальное состояние, объявленное в реальных тестируемых ролях:
+- name: Converge
+  hosts: all
+  gather_facts: true
+  become: true
+  become_method: sudo
+  tasks:
+    # Данный шаг вызывает роль system-prepare для прогона тестов с помощью Molecule:
+    - name: "Include system-prepare role for testing"
+      include_role:
+        name: "system-prepare"