Comment doit-tests unitaires seront-ils documentés?

Peut-être le problème n'est pas dans la meilleure façon d'écrire de test docstrings, mais la façon d'écrire les tests eux-mêmes? Refactoring des tests de telle manière qu'ils sont auto documentation peut aller un long chemin, et votre docstring ne sera pas à jour lors de la modification de code.

Il y a quelques choses que vous pouvez faire pour rendre les tests plus clair:

• clair & descriptif de la méthode de test des noms (déjà mentionné)
• test de corps doit être clair et concis (auto documentation)
• abstraction compliqué d'installation/démontage etc. dans les méthodes
• plus?

Par exemple, si vous avez un test comme ceci:

def test_widget_run_returns_0():
    widget = Widget(param1, param2, "another param")
    widget.set_option(true)
    widget.set_temp_dir("/tmp/widget_tmp")
    widget.destination_ip = "10.10.10.99"

    return_value = widget.run()

    assert return_value == 0
    assert widget.response == "My expected response"
    assert widget.errors == None

Vous pouvez remplacer la configuration des énoncés à un appel de méthode:

def test_widget_run_returns_0():
    widget = create_basic_widget()
    return_value = widget.run()
    assert return_value == 0
    assert_basic_widget(widget)

def create_basic_widget():
    widget = Widget(param1, param2, "another param")
    widget.set_option(true)
    widget.set_temp_dir("/tmp/widget_tmp")
    widget.destination_ip = "10.10.10.99"
    return widget

def assert_basic_widget():
    assert widget.response == "My expected response"
    assert widget.errors == None

Noter que la méthode de test est maintenant composé d'une série d'appels de méthode avec l'intention de révéler les noms, une sorte de DSL spécifiques à votre tests. Fait un test comme ça encore besoin de documentation?

Une autre chose à noter est que votre méthode de test est principalement à un niveau d'abstraction. Quelqu'un de lire la méthode de test sera de voir l'algorithme est:

• la création d'un widget
• appel exécuter sur le widget
• affirmant le code fait ce que nous nous attendons à ce

Leur compréhension de la méthode d'essai n'est pas souillé par les détails de la mise en place du widget, qui est un niveau d'abstraction plus bas que la méthode de test.

La première version de la méthode d'essai qui suit l' Inline Installation modèle. La deuxième version suit Méthode De Création De et Installation Déléguée modèles.

En général, je suis contre les commentaires, sauf lorsqu'ils expliquer le "pourquoi" du code. La lecture de l'Oncle Bob Martin Code Propre m'a convaincu de cela. Il y a un chapitre sur les commentaires, et il y a un chapitre sur les tests. Je le recommande.

Pour en savoir plus sur les tests automatisés de meilleures pratiques, ne consultez xUnit Modèles.

Vous devez utiliser une combinaison de la méthode descriptive des noms et des commentaires dans la doc de la chaîne. Une bonne façon de le faire est, y compris une procédure de base et les étapes de vérification dans la doc de la chaîne. Alors si vous exécutez ces tests, une sorte de framework de test qui permet d'automatiser l'exécution des tests et de la collecte des résultats, vous pouvez demander le cadre du journal le contenu de la doc de chaîne pour chaque méthode de test avec son stdout+stderr.

Voici un exemple de base:

class SimpelTestCase(unittest.TestCase):
    def testSomething(self):
        """ Procedure:
            1. Print something
            2. Print something else
            ---------
            Verification:
            3. Verify no errors occurred
        """
        print "something"
        print "something else"

Avoir la procédure avec le test, il est beaucoup plus facile de comprendre ce que le test est en train de faire. Et si vous incluez la docstring avec la sortie du test, il permet de déterminer ce qui s'est passé lors du passage à travers les résultats par la suite beaucoup plus facile. Le dernier lieu, j'ai travaillé à fait quelque chose de ce genre et il a fonctionné très bien quand échecs. Nous avons couru les tests unitaires sur chaque checkin automatiquement, à l'aide de CruiseControl.