質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
Django

DjangoはPythonで書かれた、オープンソースウェブアプリケーションのフレームワークです。複雑なデータベースを扱うウェブサイトを開発する際に必要な労力を減らす為にデザインされました。

Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

Q&A

解決済

2回答

1110閲覧

login_requiredな関数へのurlsをテストする方法は?

yaxavr

総合スコア39

Django

DjangoはPythonで書かれた、オープンソースウェブアプリケーションのフレームワークです。複雑なデータベースを扱うウェブサイトを開発する際に必要な労力を減らす為にデザインされました。

Python 3.x

Python 3はPythonプログラミング言語の最新バージョンであり、2008年12月3日にリリースされました。

0グッド

0クリップ

投稿2022/01/28 17:12

編集2022/01/29 10:58

ログイン機能が付いたサービスを Django で初めて作っています。

今、urls.pyに書いたそれぞれの path が login_requredつきのメソッド or 関数に到達するかどうかのテストを書いているのですが、ログイン状態ではどう判定すればいいのか迷っています。

クラスベースのメソッドに対しては、view.func.view_classで判定すると意図通りに動いていますが、関数に対してはウェブで多く見られるview.funcで判定するとなぜか関数のアドレス不一致によってFAILEDとなってしまいます。

self.assertEqual(view.func, ajax_respond) AssertionError: <function ajax_respond at 0x10b3351f0> != <function ajax_respond at 0x10af44280>

到達先の関数をlogin_required()でラップしただけなのに、なぜその関数の配置が変わるのが理解できないのですが、しかたないので、関数の判定に関しては関数オブジェクトではなく、関数名で判定するようにしてみました。

まとめると現状では下表のようにしているのですが、なにかもっと良い方法がありましたらお教えいただけますと助かります。

到達先assert判定結果
クラスベースViewのメソッドself.assertEqual(view.func.view_class, DrillTopView)OK
関数(最初の実装)self.assertEqual(view.func, ajax_respond)FAILED
関数(改善した実装)self.assertEqual(view.func.__name__, ajax_respond.__name__)OK

よろしくお願いいたします。

テスト結果

(venv)$ ./manage.py test /Users/u/tmp/proj Creating test database for alias 'default'... System check identified no issues (0 silenced). F..... ====================================================================== FAIL: test_ajaxレスポンダに飛べるか (main.tests.test_urls.TestUrls) ---------------------------------------------------------------------- Traceback (most recent call last): File "/Users/u/tmp/proj/mysite/main/tests/test_urls.py", line 62, in test_ajaxレスポンダに飛べるか self.assertEqual(view.func, ajax_respond) AssertionError: <function ajax_respond at 0x10667d280> != <function ajax_respond at 0x1062931f0> ---------------------------------------------------------------------- Ran 6 tests in 2.307s FAILED (failures=1) Destroying test database for alias 'default'...

main/test_urls.py (抜粋)

Python

1from django.test import TestCase, Client 2from django.urls import reverse, resolve 3from django.contrib import auth 4from main.views import (ajax_respond, # snip 5 HomeView, # snip 6 ) 7from users.models import CustomUser 8 9from pprint import pprint 10 11class TestUrls(TestCase): 12 def setUp(self): 13 self.user = CustomUser.objects.create(username='tester', email='tester@example.com', password='pass') 14 self.user.set_password('pass') 15 self.user.save() 16 self.client = Client() 17 self.logged_in = self.client.login(username='tester', password='pass') 18 19 def test_ホーム指定でhomeページに飛べるか(self): 20 self.assertTrue(self.logged_in) 21 self.assertTrue(auth.get_user(self.client).is_authenticated) 22 23 url = '/home/' 24 view = resolve(url) 25 self.assertEqual(view.func.view_class, HomeView) 26 27 # snip 28 29 def test_ajaxレスポンダに飛べるか(self): 30 self.assertTrue(self.logged_in) 31 self.assertTrue(auth.get_user(self.client).is_authenticated) 32 33 url = '/1/ajax/' 34 view = resolve(url) 35 self.assertEqual(view.func.__name__, ajax_respond.__name__) # OK 36 self.assertEqual(view.func, ajax_respond) # FAILED 37 # => AssertionError: <function ajax_respond at 0x10b3351f0> != <function ajax_respond at 0x10af44280>

main/urls.py (抜粋)

python

1from django.urls import path 2from django.contrib.auth.decorators import login_required 3from .views import (ajax_respond, # snip 4 HomeView, # snip 5) 6 7app_name = 'main' 8 9urlpatterns = [ 10 # path('test/', test, name='test'), 11 path('home/', HomeView.as_view(), name='home'), 12 # snip 13 path('<int:pk>/ajax/', login_required(ajax_respond), name='ajax'), 14 # snip 15]

環境(ローカルでテスト中)

  • Django 3.2
  • Python 3.9
  • MacOS Big Sur 11.6.2

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答2

0

自己解決

そもそもajaxを別ののurlに投げるのがまずいと思ったので、下記を参考にajaxを投げるurlと同じところのViewクラスにajaxの受取先の関数をメソッドとして実装するようにしました。

https://qiita.com/skokado/items/a25d64cafa3db791b283

この方法ですとajaxが増える度にurls.pyに登録する必要がなくなるので、ajaxごとに個別にurlの到達確認のためのテストを書く必要もなくなります。

最初からこの方法を取っていれば、ややこしい質問をすることもなかったのに…_| ̄|○

今度からteratailに質問を投稿するのは、自分で20分以上調べてからにします。
ありがとうございました。

投稿2022/01/29 01:58

yaxavr

総合スコア39

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

0

一晩寝ると、もう少しマシなのを思いつきました。
django/contrib/auth/decorators.py にある login_required関数の実装は下記のようになっていて、

python

1def login_required(function=None, redirect_field_name=REDIRECT_FIELD_NAME, login_url=None): 2 """ 3 Decorator for views that checks that the user is logged in, redirecting 4 to the log-in page if necessary. 5 """ 6 actual_decorator = user_passes_test( 7 lambda u: u.is_authenticated, 8 login_url=login_url, 9 redirect_field_name=redirect_field_name 10 ) 11 if function: 12 return actual_decorator(function) 13 return actual_decorator

デコレータでラップした関数を返しているように見えるので、テストで使っている

python

1self.assertEqual(view.func, ajax_respond)

view.funcは、やはり元の関数ではなくラップした別の関数として見えているようです。

pprint(vars(view.func))すると__wrapped__という属性が見つかったので、これを使って以下のようにしてみました。

python

1self.assertEqual(view.func.__wrapped__, ajax_respond)

これで一応は意図通りに動き、名前で判断するよりもベターかなと思うのですが、アンダーバー2つで始まる名前なので、外から覗くのはちょっと行儀が悪いですね。

なにか他に、いい感じの書き方があるといいのですが。

投稿2022/01/29 00:49

編集2022/01/29 00:59
yaxavr

総合スコア39

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問