Unittests Python em Jenkins?

135

Como você leva o Jenkins a executar casos unittest de python? É possível obter saída XML no estilo JUnit a partir do unittestpacote interno ?

python unit-testing jenkins junit xunit erikbwork
fonte
1
Todas as respostas presumem que você deseja iniciar os casos de teste na linha de comando. Mas se você deseja executar os testes de forma programática, tente o seguinte:import nose ; nose.runmodule() # aka nose.run(defaultTest=__name__)
MarkHu 3/09/15
1
IMHO, a sugestão simples 'py.test --junitxml results.xml test.py' responde melhor à pergunta. 'yum install pytest' para instalar o py.test. Em seguida, você pode executar qualquer script python unittest e obter JUnit resultados XML
gaoithe
1
@gaoithe que responde à parte de jenkins, mas não cumpre o requisito de usar o módulo mais unido incorporado. Nesse projeto, era um requisito dado.
Erikbwork
@ erikb85 Quando digo "execute qualquer script python mais unittest", quero dizer um script que usa o módulo unittest.
Gaoithe

Respostas:

173

testes de amostra:

tests.py:

# tests.py

import random
try:
    import unittest2 as unittest
except ImportError:
    import unittest

class SimpleTest(unittest.TestCase):
    @unittest.skip("demonstrating skipping")
    def test_skipped(self):
        self.fail("shouldn't happen")

    def test_pass(self):
        self.assertEqual(10, 7 + 3)

    def test_fail(self):
        self.assertEqual(11, 7 + 3)

JUnit com pytest

execute os testes com:

py.test --junitxml results.xml tests.py

results.xml:

<?xml version="1.0" encoding="utf-8"?>
<testsuite errors="0" failures="1" name="pytest" skips="1" tests="2" time="0.097">
    <testcase classname="tests.SimpleTest" name="test_fail" time="0.000301837921143">
        <failure message="test failure">self = &lt;tests.SimpleTest testMethod=test_fail&gt;

    def test_fail(self):
&gt;       self.assertEqual(11, 7 + 3)
E       AssertionError: 11 != 10

tests.py:16: AssertionError</failure>
    </testcase>
    <testcase classname="tests.SimpleTest" name="test_pass" time="0.000109910964966"/>
    <testcase classname="tests.SimpleTest" name="test_skipped" time="0.000164031982422">
        <skipped message="demonstrating skipping" type="pytest.skip">/home/damien/test-env/lib/python2.6/site-packages/_pytest/unittest.py:119: Skipped: demonstrating skipping</skipped>
    </testcase>
</testsuite>

JUnit com nariz

execute os testes com:

nosetests --with-xunit

nosetests.xml:

<?xml version="1.0" encoding="UTF-8"?>
<testsuite name="nosetests" tests="3" errors="0" failures="1" skip="1">
    <testcase classname="tests.SimpleTest" name="test_fail" time="0.000">
        <failure type="exceptions.AssertionError" message="11 != 10">
            <![CDATA[Traceback (most recent call last):
File "/opt/python-2.6.1/lib/python2.6/site-packages/unittest2-0.5.1-py2.6.egg/unittest2/case.py", line 340, in run
testMethod()
File "/home/damien/tests.py", line 16, in test_fail
self.assertEqual(11, 7 + 3)
File "/opt/python-2.6.1/lib/python2.6/site-packages/unittest2-0.5.1-py2.6.egg/unittest2/case.py", line 521, in assertEqual
assertion_func(first, second, msg=msg)
File "/opt/python-2.6.1/lib/python2.6/site-packages/unittest2-0.5.1-py2.6.egg/unittest2/case.py", line 514, in _baseAssertEqual
raise self.failureException(msg)
AssertionError: 11 != 10
]]>
        </failure>
    </testcase>
    <testcase classname="tests.SimpleTest" name="test_pass" time="0.000"></testcase>
    <testcase classname="tests.SimpleTest" name="test_skipped" time="0.000">
        <skipped type="nose.plugins.skip.SkipTest" message="demonstrating skipping">
            <![CDATA[SkipTest: demonstrating skipping
]]>
        </skipped>
    </testcase>
</testsuite>

Unidade com nariz2

Você precisaria usar o nose2.plugins.junitxmlplugin. Você pode configurar nose2com um arquivo de configuração como faria normalmente ou com a --pluginopção de linha de comando.

execute os testes com:

nose2 --plugin nose2.plugins.junitxml --junit-xml tests

nose2-junit.xml:

<testsuite errors="0" failures="1" name="nose2-junit" skips="1" tests="3" time="0.001">
  <testcase classname="tests.SimpleTest" name="test_fail" time="0.000126">
    <failure message="test failure">Traceback (most recent call last):
  File "/Users/damien/Work/test2/tests.py", line 18, in test_fail
    self.assertEqual(11, 7 + 3)
AssertionError: 11 != 10
</failure>
  </testcase>
  <testcase classname="tests.SimpleTest" name="test_pass" time="0.000095" />
  <testcase classname="tests.SimpleTest" name="test_skipped" time="0.000058">
    <skipped />
  </testcase>
</testsuite>

JUnit com unittest-xml-reporting

Anexe o seguinte a tests.py

if __name__ == '__main__':
    import xmlrunner
    unittest.main(testRunner=xmlrunner.XMLTestRunner(output='test-reports'))

execute os testes com:

python tests.py

test-reports / TEST-SimpleTest-20131001140629.xml:

<?xml version="1.0" ?>
<testsuite errors="1" failures="0" name="SimpleTest-20131001140629" tests="3" time="0.000">
    <testcase classname="SimpleTest" name="test_pass" time="0.000"/>
    <testcase classname="SimpleTest" name="test_fail" time="0.000">
        <error message="11 != 10" type="AssertionError">
<![CDATA[Traceback (most recent call last):
  File "tests.py", line 16, in test_fail
    self.assertEqual(11, 7 + 3)
AssertionError: 11 != 10
]]>     </error>
    </testcase>
    <testcase classname="SimpleTest" name="test_skipped" time="0.000">
        <skipped message="demonstrating skipping" type="skip"/>
    </testcase>
    <system-out>
<![CDATA[]]>    </system-out>
    <system-err>
<![CDATA[]]>    </system-err>
</testsuite>
dnozay
fonte
4
+1 na sugestão simples 'py.test --junitxml results.xml test.py'. 'yum install pytest' para instalar o py.test. Em seguida, você pode executar qualquer script python mais unittest e obter resultados xml do jUnit.
Gaoithe
1
Se você deseja usar o unittest-xml-reporting e se beneficiar do recurso Test Discovery , você pode colocar unittest.main(module=None, testRunner=xmlrunner.XMLTestRunner(output='test-reports')).
Rosberg Linhares
@RosbergLinhares Por que você precisa module=Noneusar o Test Discovery? Funciona exatamente como descrito na resposta unittest.main(testRunner=xmlrunner.XMLTestRunner(output='test-reports')).
Acm
@RosbergLinhares, durante a descoberta de teste, os módulos são importados, mas não executados. Então, como alguma dessas soluções deve funcionar com a descoberta? Eu apenas tentei, nada disso funciona. Ou eu estou esquecendo de alguma coisa?
Konstantin
20

Eu usaria o nariz em segundo lugar. O relatório XML básico agora está embutido. Basta usar a opção de linha de comando --with-xunit e ela produzirá um arquivo nosetests.xml. Por exemplo:

nosetests --with-xunit

Em seguida, adicione uma ação de publicação "Publicar resultado do teste JUnit" e preencha o campo "XMLs do relatório de teste" com nosetests.xml (assumindo que você executou os testes nos $ WORKSPACE).

Joshua D. Boyd
fonte
11

Você pode instalar o pacote unittest-xml-reporting para adicionar um executor de teste que gere XML ao internounittest .

Usamos pytest , que possui saída XML embutida (é uma opção de linha de comando).

De qualquer maneira, a execução dos testes de unidade pode ser feita executando um comando shell.

Dave Bacher
fonte
4

Eu usei narizes. Existem complementos para gerar o XML para Jenkins

John La Rooy
fonte
2 
python -m pytest --junit-xml=pytest_unit.xml source_directory/test/unit || true # tests may fail

Execute isso como shell a partir de jenkins, você pode obter o relatório em pytest_unit.xml como artefato.

Rajib Mitra
fonte