modelの__repr__の出力項目が間違っていないかどうかのテストコードを書きたい

Question

以下、python3 及び SqlAlcehmyを利用しています。
__repr__でログに表示される項目をちゃんと書き忘れないようにテストコードを書いておきたいと考えています。
しかし、どう書いていけばよいか検討がついていません。何かしらのヒントを頂けませんでしょうか？
書きたいテストコードは、__repr__内のリターンがちゃんと返ってきているかどうかを確認したいです。

from modules import db

class Test(db.Model):
    __tablename__ = 'test'

    test_id = db.Column(db.String(64), primary_key=True, nullable=False)
    test_user = db.Column(db.String(64), primary_key=True, nullable=False)
    test_name = db.Column(db.String(225))

    def __repr__(self):
        return '<Test %r, %r>' % self.test_id, self.test_name

Answer 1

__repr__()を実行した結果をテストするのでは要件を満たしませんか？

test_instance = Test(....)
self.assertEqual(test_instance.__repr__(), 'exptected_value')

Comments

[sequelanonymous]

ありがとうございます！要件を満たします。すみません、初心者で初歩的な質問かもしれませんが、確認させてください。この際、テストコード側のTest()クラスの引数には何をいれるべきでしょうか？db.Modelはテストコード側で使う必要はないでしょうか？

[denzow]

あ、いえ`Test`は`class Test(db.Model):`のクラスを意図していました。

Unittestをするのであれば、一般的にはテスト用に別DBを用意するかfactory_boyというテスト専用のdbModelをつくるライブラリを使用することが一般的です。

こちらの方の記事等が参考になるかと思います。

http://momijiame.tumblr.com/post/108317509611/python-factory-boy-%E3%81%A7%E3%83%86%E3%82%B9%E3%83%88%E3%81%AB%E4%BD%BF%E3%81%86%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%82%92%E4%BD%9C%E3%82%8B

[sequelanonymous]

あ、いえ。認識あってます。pytest を使っていますが、今はやりたいことはただ単にrepreで帰ってくる値すらでもなく、項目を書き忘れていないかのチェックするコードを書きたいと思っています。もしかしたら、テストコードですらないかもしれません。例えば、ログに出しちゃいけない項目をうっかり記載していたりしてないかを目視ではなくコードで実行して確認しておきたいという意図です。
なので、まさにご提示頂いたコードが書きたかったコードなのですが、実際に書いてみると、動かせないので、引数にはなにをいれればいいかなとおもったしだいです。

[denzow]

`repr`が`return '<Test %r, %r>' % self.test_id, self.test_name`ですので、少なくともtest_id, test_nameは渡してインスタンス化する必要があるかと思います。

test_instance = Test(test_id=1, test_name='A')
self.assertEquals(test_instance.__repr__(), '<Test 1, A>')

ただ、Testクラスをインスタンス化するためにはバックエンドのDBを要しますので上述のFactoryBoy等を使うことになるかと思います。

[sequelanonymous]

ありがとうございます。実際に実行してみましたが、以下もようなエラーがでました。
引数がたりないといっていますが、これは、バックエンドのDBがないことが原因でしょうか？

テストコード
def test_(test_id='hoge', test_name='test'):
　　　　test_instance = Test(test_id='hoge', test_name='test')
　　　　assert test_instance.__repr__() == '<Test hoge, test>'

エラー
self = <[TypeError("not enough arguments for format string") raised in repr()] Test object at 0x10f494470>

def __repr__(self):
> return '<Test %r, %r>' % self.user_id, self.test_name
E TypeError: not enough arguments for format string

[tachikoma]

クラス変数にアクセスしようとしてるので、次のように__class__をいれなあかんかも。self.__class__.test_id, self.__class__.test_name

[sequelanonymous]

ご回答ありがとうございました、おかげさまで解決しました。

Answer 2

テストコード

def test_(test_id='hoge', test_name='test'):
　　　　test_instance = Test(test_id='hoge', test_name='test')
　　　　assert test_instance.__repr__() == '<Test hoge, test>'

エラー

self = <[TypeError("not enough arguments for format string") raised in repr()] Test object at 0x10f494470>

def __repr__(self):
> return '<Test %r, %r>' % self.user_id, self.test_name
E TypeError: not enough arguments for format string

return '<Test %r, %r>' % self.user_id, self.test_name を以下に修正することで解決

'<Test %r, %r>' % (self.user_id, self.test_name)