Nội dung
- Yêu cầu - Bước 1 - Tạo repository role cơ sở - Bước 2 - Chuẩn bị role của bạn - Bước 3 - Viết bài kiểm tra của bạn - Bước 4 - Thử nghiệm so với role của bạn - Bước 5 - Sử dụng Git để chia sẻ role đã cập nhật của bạn - Bước 6 - Tích hợp Travis CI - Kết luận

Thứ sáu, 01/02/2019 | 00:00 GMT+7

Cách thực hiện kiểm tra liên tục các vai trò không thể phục hồi bằng Molecule và Travis CI trên Ubuntu 18.04

Ansible là một công cụ quản lý cấu hình không cần tác nhân sử dụng các mẫu YAML để xác định danh sách các việc được thực hiện trên server . Trong Ansible, role là một tập hợp các biến, nhiệm vụ, file , mẫu và module được sử dụng cùng nhau để thực hiện một chức năng đơn lẻ, phức tạp.

Molecule là một công cụ để thực hiện kiểm tra tự động các role Ansible, được thiết kế đặc biệt để hỗ trợ phát triển các role được viết và duy trì một cách nhất quán. Các bài kiểm tra đơn vị của Molecule cho phép các nhà phát triển kiểm tra các role đồng thời trên nhiều môi trường và dưới các thông số khác nhau. Điều quan trọng là các nhà phát triển phải liên tục chạy các bài kiểm tra đối với mã thường xuyên thay đổi; dòng công việc này đảm bảo các role tiếp tục hoạt động khi bạn cập nhật các thư viện mã. Chạy Molecule bằng công cụ tích hợp liên tục, như Travis CI , cho phép các bài kiểm tra chạy liên tục, đảm bảo các đóng góp cho mã của bạn không tạo ra các thay đổi vi phạm.

Trong hướng dẫn này, bạn sẽ sử dụng role cơ sở được tạo sẵn để cài đặt và cấu hình web server Apache và firewall trên server Ubuntu và CentOS. Sau đó, bạn sẽ khởi tạo một kịch bản Phân tử trong role đó để tạo các bài kiểm tra và đảm bảo role đó hoạt động như dự định trong môi trường mục tiêu của bạn. Sau khi cấu hình Molecule, bạn sẽ sử dụng Travis CI để liên tục kiểm tra role mới tạo của bạn . Mỗi khi có thay đổi đối với mã của bạn, Travis CI sẽ chạy molecule test đảm bảo rằng role vẫn hoạt động chính xác.

Yêu cầu

Trước khi bắt đầu hướng dẫn này, bạn cần :

Một server Ubuntu 18.04 được cài đặt theo hướng dẫn Cài đặt Server Ban đầu Ubuntu 18.04 , bao gồm user không phải root có quyền sudo và firewall .
Đã cấu hình Ansible và Molecule, bạn có thể thực hiện theo Bước 1 của Cách kiểm tra role Ansible với Molecule trên Ubuntu 18.04 .
Git được cài đặt theo Cách đóng góp cho nguồn mở: Bắt đầu với Git .
Làm quen với tích hợp liên tục và các trường hợp sử dụng của nó. Để tìm hiểu thêm, hãy xem lại Giới thiệu về Tích hợp, Phân phối và Triển khai Liên tục .
Một account trên GitHub .
Một account trên Travis CI .

Bước 1 - Tạo repository role cơ sở

Bạn sẽ sử dụng một role tạo sẵn gọi là ansible-apache để cài đặt Apache và cấu hình firewall trên các bản phân phối dựa trên Debian và Red Hat. Bạn sẽ phân nhánh và sử dụng role này làm cơ sở và sau đó xây dựng các bài kiểm tra Phân tử trên đó. Forking cho phép bạn tạo bản sao của một repository để bạn có thể áp dụng các thay đổi đối với nó mà không làm xáo trộn dự án root .

Bắt đầu bằng cách tạo một nhánh của role ansible-apache . Đi tới repository ansible-apache và nhấp vào nút Fork .

Khi bạn đã phân nhánh repository , GitHub sẽ dẫn bạn đến trang phân nhánh của bạn. Đây sẽ là một bản sao của repository cơ sở, nhưng trên account của bạn .

Nhấp vào nút Sao chép hoặc Download màu xanh lục và bạn sẽ thấy một hộp có Nhân bản với HTTPS .

Sao chép URL được hiển thị cho repository của bạn. Bạn sẽ sử dụng nó trong bước tiếp theo. URL sẽ tương tự như sau:

https://github.com/username/ansible-apache.git

Bạn sẽ thay thế username bằng tên user GitHub của bạn .

Với cài đặt fork của bạn, bạn sẽ sao chép nó trên server của bạn và bắt đầu chuẩn bị role của bạn trong phần tiếp theo.

Bước 2 - Chuẩn bị role của bạn

Sau khi làm theo Bước 1 của yêu cầu Cách kiểm tra role Ansible với Molecule trên Ubuntu 18.04 , bạn sẽ cài đặt Molecule và Ansible trong môi trường ảo. Bạn sẽ sử dụng môi trường ảo này để phát triển role mới của bạn .

Đầu tiên, hãy kích hoạt môi trường ảo bạn đã tạo trong khi tuân theo các yêu cầu bằng lệnh:

source my_env/bin/activate

Chạy lệnh sau để sao chép repository bằng URL bạn vừa sao chép ở Bước 1:

git clone https://github.com/username/ansible-apache.git

Đầu ra của bạn sẽ trông giống như sau:

Output
Cloning into 'ansible-apache'... remote: Enumerating objects: 16, done. remote: Total 16 (delta 0), reused 0 (delta 0), pack-reused 16 Unpacking objects: 100% (16/16), done.

Di chuyển vào folder mới tạo:

cd ansible-apache

Role cơ sở mà bạn đã download thực hiện các việc sau:

Bao gồm các biến : Role bắt đầu bằng cách bao gồm tất cả các biến bắt buộc theo sự phân phối của server . Ansible sử dụng các biến để xử lý sự chênh lệch giữa các hệ thống khác nhau. Vì bạn đang sử dụng Ubuntu 18.04 và CentOS 7 làm server , role sẽ nhận ra rằng họ hệ điều hành tương ứng là Debian và Red Hat và bao gồm các biến từ vars/Debian.yml và vars/RedHat.yml .
Bao gồm các việc liên quan đến phân phối : Các việc này bao gồm tasks/install-Debian.yml và tasks/install-RedHat.yml . Tùy thuộc vào bản phân phối được chỉ định, nó cài đặt các gói có liên quan. Đối với Ubuntu, các gói này là apache2 và ufw . Đối với CentOS, các gói này là httpd và firewalld .
Đảm bảo có index.html mới nhất : Tác vụ này sao chép qua một mẫu templates/index.html.j2 mà Apache sẽ sử dụng làm trang chủ của web server .
Khởi động các dịch vụ liên quan và bật chúng khi khởi động : Khởi động và bật các dịch vụ cần thiết được cài đặt như một phần của tác vụ đầu tiên. Đối với CentOS, các dịch vụ này là httpd và firewalld , còn đối với Ubuntu, chúng là apache2 và ufw .
Cấu hình firewall để cho phép lưu lượng truy cập : Điều này bao gồm các tasks/configure-Debian-firewall.yml hoặc tasks/configure-RedHat-firewall.yml . Ansible cấu hình Firewalld hoặc UFW làm firewall và đưa dịch vụ http vào danh sách trắng.

Đến đây bạn đã hiểu về cách hoạt động của role này, bạn sẽ cấu hình Molecule để kiểm tra nó. Bạn sẽ viết các trường hợp thử nghiệm cho các nhiệm vụ này bao gồm các thay đổi mà chúng thực hiện.

Bước 3 - Viết bài kiểm tra của bạn

Để kiểm tra xem role cơ sở của bạn có thực hiện các nhiệm vụ của nó như dự định hay không, bạn sẽ bắt đầu một kịch bản Phân tử, chỉ định các môi trường mục tiêu của bạn và tạo ba file thử nghiệm tùy chỉnh.

Bắt đầu bằng cách khởi tạo một kịch bản Molecule cho role này bằng lệnh sau:

molecule init scenario -r ansible-apache

Bạn sẽ thấy kết quả sau:

Output
--> Initializing new scenario default... Initialized scenario in /home/sammy/ansible-apache/molecule/default successfully.

Bạn sẽ thêm CentOS và Ubuntu làm môi trường mục tiêu của bạn bằng cách đưa chúng làm nền tảng trong file cấu hình Molecule của bạn. Để thực hiện việc này, hãy chỉnh sửa file molecule.yml bằng editor :

nano molecule/default/molecule.yml

Thêm nội dung được đánh dấu sau vào cấu hình Molecule:

~ / ansible-apache / phân tử / mặc định / phân tử.yml

--- dependency:   name: galaxy driver:   name: docker lint:   name: yamllint platforms:   - name: centos7     image: milcom/centos7-systemd     privileged: true   - name: ubuntu18     image: solita/ubuntu-systemd     command: /sbin/init     privileged: true     volumes:       - /lib/modules:/lib/modules:ro provisioner:   name: ansible   lint:     name: ansible-lint scenario:   name: default verifier:   name: testinfra   lint:     name: flake8

Ở đây, bạn đang chỉ định hai nền tảng mục tiêu được chạy ở chế độ quyền vì bạn đang làm việc với các dịch vụ systemd:

centos7 là nền tảng đầu tiên và sử dụng hình ảnh milcom/centos7-systemd .
ubuntu18 là nền tảng thứ hai và sử dụng hình ảnh solita/ubuntu-systemd . Ngoài việc sử dụng chế độ quyền và gắn các module kernel cần thiết, bạn đang chạy /sbin/init khi chạy đảm bảo iptables được cài đặt và chạy.

Lưu và thoát khỏi file .

Để biết thêm thông tin về việc chạy các containers quyền , hãy truy cập tài liệu chính thức của Molecule .

Thay vì sử dụng file thử nghiệm Molecule mặc định, bạn sẽ tạo ba file thử nghiệm tùy chỉnh, một file cho mỗi nền tảng mục tiêu và một file để viết các bài kiểm tra phổ biến giữa tất cả các nền tảng. Bắt đầu bằng cách xóa file kiểm tra mặc định của kịch bản test_default.py bằng lệnh sau:

rm molecule/default/tests/test_default.py

Đến đây bạn có thể chuyển sang tạo ba file thử nghiệm tùy chỉnh, test_common.py , test_Debian.py và test_RedHat.py cho mỗi nền tảng mục tiêu của bạn .

Tệp thử nghiệm đầu tiên, test_common.py , sẽ chứa các thử nghiệm phổ biến mà mỗi server sẽ thực hiện. Tạo và chỉnh sửa file thử nghiệm chung, test_common.py :

nano molecule/default/tests/test_common.py

Thêm mã sau vào file :

~ / ansible-apache / phân tử / default / tests / test_common.py

import os import pytest  import testinfra.utils.ansible_runner  testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(     os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')   @pytest.mark.parametrize('file, content', [   ("/var/www/html/index.html", "Managed by Ansible") ]) def test_files(host, file, content):     file = host.file(file)      assert file.exists     assert file.contains(content)

Trong file test_common.py của bạn, bạn đã nhập các thư viện bắt buộc. Bạn cũng đã viết một bài kiểm tra có tên là test_files() , kiểm tra này giữ nhiệm vụ chung duy nhất giữa các bản phân phối mà role của bạn thực hiện: sao chép mẫu của bạn làm trang chủ web server .

Tệp thử nghiệm tiếp theo, test_Debian.py , chứa các thử nghiệm dành riêng cho các bản phân phối Debian. Tệp thử nghiệm này sẽ nhắm đến cụ thể đến nền tảng Ubuntu của bạn.

Tạo và chỉnh sửa file thử nghiệm Ubuntu bằng cách chạy lệnh sau:

nano molecule/default/tests/test_Debian.py

Đến đây bạn có thể nhập các thư viện cần thiết và xác định nền tảng ubuntu18 làm server đích. Thêm mã sau vào đầu file này:

~ / ansible-apache / phân tử / default / tests / test_Debian.py

import os import pytest  import testinfra.utils.ansible_runner  testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(     os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('ubuntu18')

Sau đó, trong cùng một file , bạn sẽ thêm thử nghiệm test_pkg() .

Thêm mã sau vào file để xác định kiểm tra test_pkg() :

~ / ansible-apache / phân tử / default / tests / test_Debian.py

... @pytest.mark.parametrize('pkg', [     'apache2',     'ufw' ]) def test_pkg(host, pkg):     package = host.package(pkg)      assert package.is_installed

Kiểm tra này sẽ kiểm tra xem các gói apache2 và ufw được cài đặt trên server hay chưa.

Lưu ý: Khi thêm nhiều bài kiểm tra vào file kiểm tra Molecule, hãy đảm bảo có hai dòng trống giữa mỗi bài kiểm tra, nếu không bạn sẽ gặp lỗi cú pháp từ Molecule.

Để xác định thử nghiệm tiếp theo, test_svc() , hãy thêm mã sau vào kiểm tra test_pkg() trong file của bạn:

~ / ansible-apache / phân tử / default / tests / test_Debian.py

... @pytest.mark.parametrize('svc', [     'apache2',     'ufw' ]) def test_svc(host, svc):     service = host.service(svc)      assert service.is_running     assert service.is_enabled

test_svc() sẽ kiểm tra xem các dịch vụ apache2 và ufw có đang chạy và được kích hoạt hay không.

Cuối cùng, bạn sẽ thêm bài kiểm tra cuối cùng của bạn , test_ufw_rules() , vào file test_Debian.py .

Thêm mã này trong kiểm tra test_svc() trong file của bạn để xác định test_ufw_rules() :

~ / ansible-apache / phân tử / default / tests / test_Debian.py

... @pytest.mark.parametrize('rule', [     '-A ufw-user-input -p tcp -m tcp --dport 80 -j ACCEPT' ]) def test_ufw_rules(host, rule):     cmd = host.run('iptables -t filter -S')      assert rule in cmd.stdout

test_ufw_rules() sẽ kiểm tra xem cấu hình firewall của bạn có cho phép lưu lượng truy cập trên cổng được dịch vụ Apache sử dụng hay không.

Với mỗi thử nghiệm này được thêm vào, file test_Debian.py của bạn sẽ trông giống như sau:

~ / ansible-apache / phân tử / default / tests / test_Debian.py

import os import pytest  import testinfra.utils.ansible_runner  testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(     os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('ubuntu18')   @pytest.mark.parametrize('pkg', [     'apache2',     'ufw' ]) def test_pkg(host, pkg):     package = host.package(pkg)      assert package.is_installed   @pytest.mark.parametrize('svc', [     'apache2',     'ufw' ]) def test_svc(host, svc):     service = host.service(svc)      assert service.is_running     assert service.is_enabled   @pytest.mark.parametrize('rule', [     '-A ufw-user-input -p tcp -m tcp --dport 80 -j ACCEPT' ]) def test_ufw_rules(host, rule):     cmd = host.run('iptables -t filter -S')      assert rule in cmd.stdout

Tệp test_Debian.py hiện bao gồm ba bài kiểm tra: test_pkg() , test_svc() và test_ufw_rules() .

Lưu và thoát test_Debian.py .

Tiếp theo, bạn sẽ tạo file thử nghiệm test_RedHat.py , file này sẽ chứa các thử nghiệm dành riêng cho các bản phân phối Red Hat để nhắm đến nền tảng CentOS của bạn.

Tạo và chỉnh sửa file thử nghiệm CentOS, test_RedHat.py , bằng cách chạy lệnh sau:

nano molecule/default/tests/test_RedHat.py

Tương tự với file kiểm tra Ubuntu, bây giờ bạn sẽ viết ba bài kiểm tra để đưa vào file test_RedHat.py của bạn . Trước khi thêm mã kiểm tra, bạn có thể nhập các thư viện cần thiết và xác định nền tảng centos7 làm server đích, bằng cách thêm mã sau vào đầu file của bạn: