2016-10-11 04:14:39 +00:00
|
|
|
import pytest
|
|
|
|
import testinfra
|
2018-07-06 00:10:43 +00:00
|
|
|
from textwrap import dedent
|
2016-10-11 04:14:39 +00:00
|
|
|
|
|
|
|
check_output = testinfra.get_backend(
|
|
|
|
"local://"
|
|
|
|
).get_module("Command").check_output
|
|
|
|
|
2018-07-06 00:10:43 +00:00
|
|
|
SETUPVARS = {
|
|
|
|
'PIHOLE_INTERFACE': 'eth99',
|
|
|
|
'IPV4_ADDRESS': '1.1.1.1',
|
|
|
|
'IPV6_ADDRESS': 'FE80::240:D0FF:FE48:4672',
|
|
|
|
'PIHOLE_DNS_1': '4.2.2.1',
|
|
|
|
'PIHOLE_DNS_2': '4.2.2.2'
|
|
|
|
}
|
|
|
|
|
|
|
|
tick_box = "[\x1b[1;32m\xe2\x9c\x93\x1b[0m]".decode("utf-8")
|
|
|
|
cross_box = "[\x1b[1;31m\xe2\x9c\x97\x1b[0m]".decode("utf-8")
|
|
|
|
info_box = "[i]".decode("utf-8")
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2016-10-11 04:14:39 +00:00
|
|
|
@pytest.fixture
|
|
|
|
def Pihole(Docker):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
used to contain some script stubbing, now pretty much an alias.
|
|
|
|
Also provides bash as the default run function shell
|
|
|
|
'''
|
2016-11-03 04:58:54 +00:00
|
|
|
def run_bash(self, command, *args, **kwargs):
|
|
|
|
cmd = self.get_command(command, *args)
|
|
|
|
if self.user is not None:
|
|
|
|
out = self.run_local(
|
|
|
|
"docker exec -u %s %s /bin/bash -c %s",
|
|
|
|
self.user, self.name, cmd)
|
|
|
|
else:
|
|
|
|
out = self.run_local(
|
|
|
|
"docker exec %s /bin/bash -c %s", self.name, cmd)
|
|
|
|
out.command = self.encode(cmd)
|
|
|
|
return out
|
|
|
|
|
|
|
|
funcType = type(Docker.run)
|
2018-07-03 06:05:24 +00:00
|
|
|
Docker.run = funcType(run_bash,
|
|
|
|
Docker,
|
|
|
|
testinfra.backend.docker.DockerBackend)
|
2016-10-11 04:14:39 +00:00
|
|
|
return Docker
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2016-10-11 04:14:39 +00:00
|
|
|
@pytest.fixture
|
|
|
|
def Docker(request, args, image, cmd):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
combine our fixtures into a docker run command and setup finalizer to
|
|
|
|
cleanup
|
|
|
|
'''
|
2016-10-11 04:14:39 +00:00
|
|
|
assert 'docker' in check_output('id'), "Are you in the docker group?"
|
|
|
|
docker_run = "docker run {} {} {}".format(args, image, cmd)
|
|
|
|
docker_id = check_output(docker_run)
|
|
|
|
|
|
|
|
def teardown():
|
|
|
|
check_output("docker rm -f %s", docker_id)
|
|
|
|
request.addfinalizer(teardown)
|
|
|
|
|
|
|
|
docker_container = testinfra.get_backend("docker://" + docker_id)
|
|
|
|
docker_container.id = docker_id
|
|
|
|
return docker_container
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2016-10-11 04:14:39 +00:00
|
|
|
@pytest.fixture
|
|
|
|
def args(request):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
-t became required when tput began being used
|
|
|
|
'''
|
2016-10-11 04:14:39 +00:00
|
|
|
return '-t -d'
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2018-07-06 00:12:39 +00:00
|
|
|
@pytest.fixture(params=['debian', 'centos', 'fedora'])
|
2016-10-11 04:14:39 +00:00
|
|
|
def tag(request):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
consumed by image to make the test matrix
|
|
|
|
'''
|
2016-10-11 04:14:39 +00:00
|
|
|
return request.param
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2016-10-11 04:14:39 +00:00
|
|
|
@pytest.fixture()
|
|
|
|
def image(request, tag):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
built by test_000_build_containers.py
|
|
|
|
'''
|
2016-10-11 04:14:39 +00:00
|
|
|
return 'pytest_pihole:{}'.format(tag)
|
|
|
|
|
2018-07-02 20:54:19 +00:00
|
|
|
|
2016-10-11 04:14:39 +00:00
|
|
|
@pytest.fixture()
|
|
|
|
def cmd(request):
|
2018-07-03 06:05:24 +00:00
|
|
|
'''
|
|
|
|
default to doing nothing by tailing null, but don't exit
|
|
|
|
'''
|
2016-10-11 04:14:39 +00:00
|
|
|
return 'tail -f /dev/null'
|
2018-07-06 00:10:43 +00:00
|
|
|
|
|
|
|
|
|
|
|
# Helper functions
|
|
|
|
def mock_command(script, args, container):
|
|
|
|
'''
|
|
|
|
Allows for setup of commands we don't really want to have to run for real
|
|
|
|
in unit tests
|
|
|
|
'''
|
|
|
|
full_script_path = '/usr/local/bin/{}'.format(script)
|
|
|
|
mock_script = dedent('''\
|
|
|
|
#!/bin/bash -e
|
|
|
|
echo "\$0 \$@" >> /var/log/{script}
|
|
|
|
case "\$1" in'''.format(script=script))
|
|
|
|
for k, v in args.iteritems():
|
|
|
|
case = dedent('''
|
|
|
|
{arg})
|
|
|
|
echo {res}
|
|
|
|
exit {retcode}
|
|
|
|
;;'''.format(arg=k, res=v[0], retcode=v[1]))
|
|
|
|
mock_script += case
|
|
|
|
mock_script += dedent('''
|
|
|
|
esac''')
|
|
|
|
container.run('''
|
|
|
|
cat <<EOF> {script}\n{content}\nEOF
|
|
|
|
chmod +x {script}
|
|
|
|
rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
|
|
|
|
content=mock_script,
|
|
|
|
scriptlog=script))
|
|
|
|
|
|
|
|
|
|
|
|
def mock_command_2(script, args, container):
|
|
|
|
'''
|
|
|
|
Allows for setup of commands we don't really want to have to run for real
|
|
|
|
in unit tests
|
|
|
|
'''
|
|
|
|
full_script_path = '/usr/local/bin/{}'.format(script)
|
|
|
|
mock_script = dedent('''\
|
|
|
|
#!/bin/bash -e
|
|
|
|
echo "\$0 \$@" >> /var/log/{script}
|
|
|
|
case "\$1 \$2" in'''.format(script=script))
|
|
|
|
for k, v in args.iteritems():
|
|
|
|
case = dedent('''
|
|
|
|
\"{arg}\")
|
|
|
|
echo \"{res}\"
|
|
|
|
exit {retcode}
|
|
|
|
;;'''.format(arg=k, res=v[0], retcode=v[1]))
|
|
|
|
mock_script += case
|
|
|
|
mock_script += dedent('''
|
|
|
|
esac''')
|
|
|
|
container.run('''
|
|
|
|
cat <<EOF> {script}\n{content}\nEOF
|
|
|
|
chmod +x {script}
|
|
|
|
rm -f /var/log/{scriptlog}'''.format(script=full_script_path,
|
|
|
|
content=mock_script,
|
|
|
|
scriptlog=script))
|
|
|
|
|
|
|
|
|
|
|
|
def run_script(Pihole, script):
|
|
|
|
result = Pihole.run(script)
|
|
|
|
assert result.rc == 0
|
|
|
|
return result
|