안녕하십니까!

저는 호텔 예약 서비스에서 DevOps 엔지니어로 일하고 있습니다. Ostrovok.ru. 이 글에서는 Ansible 역할을 테스트한 경험에 대해 이야기하고 싶습니다.

Ostrovok.ru에서는 구성 관리자로 ansible을 사용합니다. 최근에 우리는 역할을 테스트해야 할 필요성을 느꼈지만 이를 위한 도구가 그리 많지 않은 것으로 나타났습니다. 아마도 가장 인기 있는 것은 Molecule 프레임워크일 것이므로 이를 사용하기로 결정했습니다. 그러나 그의 문서에는 많은 함정이 언급되어 있지 않은 것으로 밝혀졌습니다. 우리는 러시아어로 된 충분히 상세한 매뉴얼을 찾을 수 없었기 때문에 이 글을 쓰기로 결정했습니다.

분자

분자 - Ansible 역할을 테스트하는 데 도움이 되는 프레임워크입니다.

단순화된 설명: 분자는 사용자가 지정한 플랫폼(클라우드, 가상 머신, 컨테이너)에 인스턴스를 생성합니다. 자세한 내용은 섹션을 참조하세요. 운전기사), 해당 인스턴스에서 역할을 실행한 다음 테스트를 실행하고 인스턴스를 삭제합니다. 단계 중 하나가 실패할 경우 Molecule에서 이를 알려드립니다.

이제 더.

약간의 이론

분자의 두 가지 핵심 요소인 시나리오와 동인을 고려하십시오.

시나리오

스크립트에는 무엇을, 어디서, 어떻게, 어떤 순서로 수행할지에 대한 설명이 포함되어 있습니다. 하나의 역할에는 여러 스크립트가 있을 수 있으며 각 스크립트는 경로를 따라 있는 디렉터리입니다. <role>/molecule/<scenario>에는 테스트에 필요한 작업에 대한 설명이 포함되어 있습니다. 스크립트가 포함되어야 합니다. default, 분자로 역할을 초기화하면 자동으로 생성됩니다. 다음 스크립트의 이름은 귀하에게 달려 있습니다.

스크립트에서 일련의 테스트 작업을 호출합니다. 매트릭스이며 기본적으로 다음과 같습니다.

(레이블이 붙은 단계 ?, 사용자가 지정하지 않은 경우 기본적으로 건너뜁니다.)

• lint - 린터를 실행 중입니다. 기본적으로 사용됩니다 yamllint и flake8,
• destroy - Molecule의 마지막 실행에서 인스턴스 삭제(있는 경우),
• dependency? — 테스트된 역할의 ansible 종속성 설치,
• syntax - 다음을 사용하여 역할의 구문을 확인합니다. ansible-playbook --syntax-check,
• create - 인스턴스를 생성하고,
• prepare? - 인스턴스 준비 예: python2 확인/설치
• converge — 테스트 중인 플레이북 실행,
• idempotence - 멱등성 테스트를 위해 플레이북을 다시 시작합니다.
• side_effect? - 역할과 직접적인 관련은 없지만 테스트에 필요한 작업,
• verify - 다음을 사용하여 결과 구성에 대한 테스트를 실행합니다. testinfra(기본) /goss/inspec,
• cleanup? - (새 버전에서) - 대략적으로 말하면, 분자의 영향을 받은 외부 인프라를 "정리"합니다.
• destroy - 인스턴스를 삭제합니다.

이 순서는 대부분의 경우에 적용되지만 필요한 경우 변경할 수 있습니다.

위의 각 단계는 다음을 사용하여 별도로 실행할 수 있습니다. molecule <command>. 그러나 이러한 각 cli 명령에는 고유한 작업 순서가 있을 수 있으며 이를 실행하여 확인할 수 있다는 점을 이해해야 합니다. molecule matrix <command>. 예를 들어, 명령을 실행할 때 converge (테스트 중인 플레이북 실행) 다음 작업이 수행됩니다.

$ molecule matrix converge
...
└── default         # название сценария
    ├── dependency  # установка зависимостей
    ├── create      # создание инстанса
    ├── prepare     # преднастройка инстанса
    └── converge    # прогон плейбука

이러한 작업의 순서는 편집될 수 있습니다. 목록에 있는 항목이 이미 완료되면 건너뜁니다. 현재 상태와 인스턴스 구성은 Molecule이 디렉터리에 저장합니다. $TMPDIR/molecule/<role>/<scenario>.

다음을 사용하여 단계를 추가하세요. ? ansible-playbook 형식으로 원하는 작업을 설명하고 단계에 따라 파일 이름을 만들 수 있습니다. prepare.yml/side_effect.yml. 다음 파일을 예상하세요. 분자는 스크립트 폴더에 있을 것입니다.

운전기사

드라이버는 테스트 인스턴스가 생성되는 엔터티입니다.
Molecule의 템플릿이 준비된 표준 드라이버 목록은 Azure, Docker, EC2, GCE, LXC, LXD, OpenStack, Vagrant, Delegated입니다.

대부분의 경우 템플릿은 파일입니다. create.yml и destroy.yml 인스턴스 생성 및 삭제를 각각 설명하는 스크립트 폴더에 있습니다.
앞서 언급한 파일 없이 해당 모듈과의 상호 작용이 발생할 수 있으므로 Docker 및 Vagrant는 예외입니다.

인스턴스 생성 및 삭제를 위해 파일에 사용된 경우 인스턴스 구성에 대한 작업만 설명하고 나머지는 엔지니어가 설명해야 하기 때문에 위임된 드라이버를 강조할 가치가 있습니다.

기본 드라이버는 Docker입니다.

이제 연습으로 넘어가서 추가 기능을 고려해 보겠습니다.

시작하기

"hello world"로서 간단한 nginx 설치 역할을 테스트해 보겠습니다. 드라이버로 docker를 선택하겠습니다. 대부분의 분들이 docker를 설치해 두셨을 것입니다(그리고 docker가 기본 드라이버라는 것을 기억하세요).

준비하자 virtualenv 그리고 거기에 설치 molecule:

> pip install virtualenv
> virtualenv -p `which python2` venv
> source venv/bin/activate
> pip install molecule docker  # molecule установит ansible как зависимость; docker для драйвера

다음 단계는 새 역할을 초기화하는 것입니다.
새 역할과 새 스크립트의 초기화는 다음 명령을 사용하여 수행됩니다. molecule init <params>:

> molecule init role -r nginx
--> Initializing new role nginx...
Initialized role in <path>/nginx successfully.
> cd nginx
> tree -L 1
.
├── README.md
├── defaults
├── handlers
├── meta
├── molecule
├── tasks
└── vars

6 directories, 1 file

전형적인 ansible 역할이 나타났습니다. 또한 CLI 분자와의 모든 상호 작용은 역할의 루트에서 이루어집니다.

역할 디렉터리에 무엇이 있는지 살펴보겠습니다.

> tree molecule/default/
molecule/default/
├── Dockerfile.j2  # Jinja-шаблон для Dockerfile
├── INSTALL.rst.   # Немного информации об установке зависимостей сценария
├── molecule.yml   # Файл конфигурации
├── playbook.yml   # Плейбук запуска роли
└── tests          # Директория с тестами стадии verify
    └── test_default.py

1 directory, 6 files

구성을 분석해보자 molecule/default/molecule.yml (도커 이미지만 교체):

---
dependency:
  name: galaxy
driver:
  name: docker
lint:
  name: yamllint
platforms:
  - name: instance
    image: centos:7
provisioner:
  name: ansible
  lint:
    name: ansible-lint
scenario:
  name: default
verifier:
  name: testinfra
  lint:
    name: flake8

의존

이 섹션에서는 종속성의 소스에 대해 설명합니다.

옵션은 다음과 같습니다. 은하, 암퇘지, 껍데기.

Shell은 galaxy와 gilt가 사용자의 요구 사항을 충족하지 못하는 경우에 사용되는 명령 셸일 뿐입니다.

나는 여기에 오랫동안 머물지 않을 것입니다. 선적 서류 비치.

운전사

운전자의 이름입니다. 우리는 도커입니다.

보풀

린터는 yamllint입니다.

구성의 이 부분에서 유용한 옵션은 yamllint에 대한 구성 파일을 지정하고 환경 변수를 전달하거나 linter를 비활성화하는 기능입니다.

lint:
  name: yamllint
  options:
    config-file: foo/bar
  env:
    FOO: bar
  enabled: False

플랫폼

인스턴스의 구성을 설명합니다.
드라이버인 docker의 경우 분자는 이 섹션에서 반복되며 목록의 각 요소는 다음에서 사용할 수 있습니다. Dockerfile.j2 변수로 item.

필요한 운전자의 경우 create.yml и destroy.yml, 섹션은 다음과 같이 사용할 수 있습니다. molecule_yml.platforms, 이에 대한 반복은 이미 이 파일에 설명되어 있습니다.

Molecule은 ansible 모듈에 대한 인스턴스 제어를 제공하므로 가능한 설정 목록도 여기에서 찾아야 합니다. 예를 들어 docker의 경우 모듈이 사용됩니다. docker_container_module. 다른 드라이버에서 사용되는 모듈은 다음에서 찾을 수 있습니다. 선적 서류 비치.

뿐만 아니라 다양한 드라이버의 활용 사례도 확인하실 수 있습니다. 분자 자체의 테스트에서.

여기에서 교체하세요 센토스:7 에 우분투.

제공자

"공급자" - 인스턴스를 관리하는 엔터티입니다. Molecule의 경우 이는 ansible이며, 그 외 지원은 예정되어 있지 않으므로 주의사항을 두고 이 부분을 ansible 확장 구성이라고 부를 수 있습니다.
여기에서 많은 사항을 지정할 수 있습니다. 제 생각에는 주요 사항을 강조하겠습니다.

• 희곡: 특정 단계에서 어떤 플레이북을 사용해야 하는지 지정할 수 있습니다.

provisioner:
  name: ansible
  playbooks:
    create: create.yml
    destroy: ../default/destroy.yml
    converge: playbook.yml
    side_effect: side_effect.yml
    cleanup: cleanup.yml

• 구성_옵션: 가능한 구성

provisioner:
  name: ansible
  config_options:
    defaults:
      fact_caching: jsonfile
    ssh_connection:
      scp_if_ssh: True

• 연결_옵션: 옵션 연결성

provisioner:
  name: ansible  
  connection_options:
    ansible_ssh_common_args: "-o 'UserKnownHostsFile=/dev/null' -o 'ForwardAgent=yes'"

• 옵션: Ansible 옵션 및 환경 변수

provisioner:
  name: ansible  
  options:
    vvv: true
    diff: true
  env:
    FOO: BAR

대본

스크립트 시퀀스의 이름 및 설명입니다.
키를 추가하여 모든 명령의 기본 동작 매트릭스를 변경할 수 있습니다 <command>_sequence 필요한 단계 목록을 정의하여 이에 대한 값으로 사용합니다.
플레이북 실행 명령을 실행할 때 작업 순서를 변경하고 싶다고 가정해 보겠습니다. molecule converge

# изначально:
# - dependency
# - create
# - prepare
# - converge
scenario:
  name: default
  converge_sequence:
    - create
    - converge

검

테스트를 위한 프레임워크와 이에 대한 린터를 설정합니다. 기본 린터는 다음과 같습니다. testinfra и flake8. 가능한 옵션은 위와 동일합니다.

verifier:
  name: testinfra
  additional_files_or_dirs:
    - ../path/to/test_1.py
    - ../path/to/test_2.py
    - ../path/to/directory/*
  options:
    n: 1
  enabled: False
  env:
    FOO: bar
  lint:
    name: flake8
    options:
      benchmark: True
    enabled: False
    env:
      FOO: bar

우리의 역할로 돌아가자. 파일을 편집해보자 tasks/main.yml 이런 종류의:

---
- name: Install nginx
  apt:
    name: nginx
    state: present

- name: Start nginx
  service:
    name: nginx
    state: started

그리고 테스트를 추가하세요. molecule/default/tests/test_default.py

def test_nginx_is_installed(host):
    nginx = host.package("nginx")
    assert nginx.is_installed

def test_nginx_running_and_enabled(host):
    nginx = host.service("nginx")
    assert nginx.is_running
    assert nginx.is_enabled

def test_nginx_config(host):
    host.run("nginx -t")

완료되었습니다. 실행만 남았습니다(역할의 루트에서 상기시켜 드리겠습니다).

> molecule test

스포일러 아래의 긴 배기 장치:

--> Validating schema <path>/nginx/molecule/default/molecule.yml.
Validation completed successfully.
--> Test matrix

└── default
    ├── lint
    ├── destroy
    ├── dependency
    ├── syntax
    ├── create
    ├── prepare
    ├── converge
    ├── idempotence
    ├── side_effect
    ├── verify
    └── destroy

--> Scenario: 'default'
--> Action: 'lint'
--> Executing Yamllint on files found in <path>/nginx/...
Lint completed successfully.
--> Executing Flake8 on files found in <path>/nginx/molecule/default/tests/...
Lint completed successfully.
--> Executing Ansible Lint on <path>/nginx/molecule/default/playbook.yml...
Lint completed successfully.
--> Scenario: 'default'
--> Action: 'destroy'

    PLAY [Destroy] *****************************************************************

    TASK [Destroy molecule instance(s)] ********************************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Wait for instance(s) deletion to complete] *******************************
    ok: [localhost] => (item=None)
    ok: [localhost]

    TASK [Delete docker network(s)] ************************************************

    PLAY RECAP *********************************************************************
    localhost                  : ok=2    changed=1    unreachable=0    failed=0

--> Scenario: 'default'
--> Action: 'dependency'
Skipping, missing the requirements file.
--> Scenario: 'default'
--> Action: 'syntax'

    playbook: <path>/nginx/molecule/default/playbook.yml

--> Scenario: 'default'
--> Action: 'create'

    PLAY [Create] ******************************************************************

    TASK [Log into a Docker registry] **********************************************
    skipping: [localhost] => (item=None)

    TASK [Create Dockerfiles from image names] *************************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Discover local Docker images] ********************************************
    ok: [localhost] => (item=None)
    ok: [localhost]

    TASK [Build an Ansible compatible image] ***************************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Create docker network(s)] ************************************************

    TASK [Create molecule instance(s)] *********************************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Wait for instance(s) creation to complete] *******************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    PLAY RECAP *********************************************************************
    localhost                  : ok=5    changed=4    unreachable=0    failed=0

--> Scenario: 'default'
--> Action: 'prepare'
Skipping, prepare playbook not configured.
--> Scenario: 'default'
--> Action: 'converge'

    PLAY [Converge] ****************************************************************

    TASK [Gathering Facts] *********************************************************
    ok: [instance]

    TASK [nginx : Install nginx] ***************************************************
    changed: [instance]

    TASK [nginx : Start nginx] *****************************************************
    changed: [instance]

    PLAY RECAP *********************************************************************
    instance                   : ok=3    changed=2    unreachable=0    failed=0

--> Scenario: 'default'
--> Action: 'idempotence'
Idempotence completed successfully.
--> Scenario: 'default'
--> Action: 'side_effect'
Skipping, side effect playbook not configured.
--> Scenario: 'default'
--> Action: 'verify'
--> Executing Testinfra tests found in <path>/nginx/molecule/default/tests/...
    ============================= test session starts ==============================
    platform darwin -- Python 2.7.15, pytest-4.3.0, py-1.8.0, pluggy-0.9.0
    rootdir: <path>/nginx/molecule/default, inifile:
    plugins: testinfra-1.16.0
collected 4 items

    tests/test_default.py ....                                               [100%]

    ========================== 4 passed in 27.23 seconds ===========================
Verifier completed successfully.
--> Scenario: 'default'
--> Action: 'destroy'

    PLAY [Destroy] *****************************************************************

    TASK [Destroy molecule instance(s)] ********************************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Wait for instance(s) deletion to complete] *******************************
    changed: [localhost] => (item=None)
    changed: [localhost]

    TASK [Delete docker network(s)] ************************************************

    PLAY RECAP *********************************************************************
    localhost                  : ok=2    changed=2    unreachable=0    failed=0

우리의 단순한 역할은 문제 없이 테스트되었습니다.
작업 중 문제가 발생하면 기억해두시면 좋습니다. molecule test, 기본 순서를 변경하지 않은 경우 Molecule은 인스턴스를 삭제합니다.

다음 명령은 디버깅에 유용합니다.

> molecule --debug <command> # debug info. При обычном запуске Молекула скрывает логи.
> molecule converge          # Оставляет инстанс после прогона тестируемой роли.
> molecule login             # Зайти в созданный инстанс.
> molecule --help            # Полный список команд.

기존 역할

기존 역할에 새 스크립트를 추가하는 것은 역할 디렉터리에서 다음 명령을 사용하십시오.

# полный список доступных параметров
> molecule init scenarion --help
# создание нового сценария
> molecule init scenario -r <role_name> -s <scenario_name>

이것이 역할의 첫 번째 시나리오인 경우 매개변수는 -s 스크립트를 생성하므로 생략 가능 default.

결론

보시다시피 Molecule은 그리 복잡하지 않으며 자체 템플릿을 사용하면 새 스크립트 배포가 인스턴스 생성 및 삭제 플레이북의 변수 편집으로 줄어들 수 있습니다. 분자는 CI 시스템과 원활하게 통합되므로 플레이북의 수동 테스트 시간을 줄여 개발 속도를 높일 수 있습니다.

관심을 가져주셔서 감사합니다. Ansible 역할을 테스트한 경험이 있고 Molecule과 관련이 없다면 댓글로 알려주세요!

출처 : habr.com