Procedure from environment construction to operation test of testinfra, a server environment test tool made by Python

Built the environment of Python infrastructure test library Testinfra

background

In-house, server tests seem to be done manually, so I would like to introduce an automation mechanism to improve efficiency. At my previous workplace, I tried to use Ruby's Serverspec and Infrataster as server test tools, but I wanted to unify them with Python's configuration management tools such as Ansible and Fabric. I found a test tool called Testinfra. Even on the official website, Testinfra was written as a tool like Ruby's Serverspec, so I tried using it. This time, I described the procedure of the introduction part from environment construction to operation test.

1. Installation procedure

1-1. Prerequisites

It is assumed that the following environment has been created

1. pip is installed
2. There must be at least two servers that can be connected via SSH

1-2. Flow

1. Install testinfra
2. ssh connection settings (client side)
3. ssh connection settings (server side)
4. Create test code
5. Run test code (localhost)
6. Execution of test code (remote host)

2. Procedure

2-1. Installation of testinfra

$ pip install testinfra

2-2. Ssh connection settings (client side)

1. Create private key and public key

$ cd $HOME/.ssh
$ ssh-keygen -t rsa -f test_server

2. Transfer the public key to the remote connection destination server with scp

$ scp test_server.pub [email protected]:/var/tmp/

3. After completing step 2 of "3. ssh connection setting (server side)", try ssh connection for key authentication.

$ ssh -i $HOME/.ssh/test_server [email protected]

4. Create ssh_config

$ vi $HOME/.ssh/ssh_config

Here, the host name of the remote server is "redmine"

Host redmine
  HostName     192.168.1.31
  Port         22
  User         permit
  IdentityFile ~/.ssh/test_server

2-3. Ssh connection settings (server side)

1. Create an account for ssh connection This time I created a "permit" user

$ useradd -m permit -G wheel
$ passwd permit

2. Write the client's public key to authorized_keys

$ mkdir $HOME/.ssh
$ mv /var/tmp/test_server.pub $HOME/.ssh/
$ cd $HOME/.ssh/
$ cat test_server.pub >> authorized_keys
$ chmod 600 authorized_keys
$ rm test_server.pub

2-4. Creating test code

1. Create test code

$ vi test.py

Test code example

def test_passwd_file(File):
    passwd = File("/etc/passwd")
    assert passwd.contains("root")
    assert passwd.user == "root"
    assert passwd.group == "root"
    assert passwd.mode == 0o644

2-5. Execution of test code (localhost)

1. localhost test run

$ testinfra -v test.py

2. Confirmation of execution result

=================================== test session starts ====================================
platform linux2 -- Python 2.7.9, pytest-3.0.1, py-1.4.31, pluggy-0.3.1 -- /usr/local/bin/python2.7
cachedir: .cache
rootdir: /root, inifile: 
plugins: testinfra-1.4.2, pep8-1.0.6
collected 1 items 

test.py::test_passwd_file[local] PASSED

================================== pytest-warning summary ==================================
WP1 None Modules are already imported so can not be re-written: testinfra
======================= 1 passed, 1 pytest-warnings in 0.03 seconds ========================

2-6. Execution of test code (remote host)

1. Test run of remote host

$ testinfra test.py --connection=ssh --hosts=permit@redmine --ssh-config=/root/.ssh/ssh_config

2. Confirmation of execution result

=================================== test session starts ====================================
platform linux2 -- Python 2.7.9, pytest-3.0.1, py-1.4.31, pluggy-0.3.1 -- /usr/local/bin/python2.7
cachedir: .cache
rootdir: /root, inifile: 
plugins: testinfra-1.4.2, pep8-1.0.6
collected 1 items 

test.py::test_passwd_file[ssh://redmine] PASSED

================================== pytest-warning summary ==================================
WP1 None Modules are already imported so can not be re-written: testinfra
======================= 1 passed, 1 pytest-warnings in 0.66 seconds ========================

3. Reference

• Testinfra