Debian Codegraph @

tests/admin_views/test_nav_sidebar.py

raw
1 from django.contrib import admin
2 from django.contrib.admin.tests import AdminSeleniumTestCase
3 from django.contrib.auth.models import User
4 from django.test import TestCase, override_settings
5 from django.urls import path, reverse
6
7 from .models import Héllo
8
9
10 class AdminSiteWithSidebar(admin.AdminSite):
11 pass
12
13
14 class AdminSiteWithoutSidebar(admin.AdminSite):
15 enable_nav_sidebar = False
16
17
18 site_with_sidebar = AdminSiteWithSidebar(name="test_with_sidebar")
19 site_without_sidebar = AdminSiteWithoutSidebar(name="test_without_sidebar")
20
21 site_with_sidebar.register(User)
22 site_with_sidebar.register(Héllo)
23
24 urlpatterns = [
25 path("test_sidebar/admin/", site_with_sidebar.urls),
26 path("test_wihout_sidebar/admin/", site_without_sidebar.urls),
27 ]
28
29
30 @override_settings(ROOT_URLCONF="admin_views.test_nav_sidebar")
31 class AdminSidebarTests(TestCase):
32 @classmethod
33 def setUpTestData(cls):
34 cls.superuser = User.objects.create_superuser(
35 username="super",
36 password="secret",
37 email="[email protected]",
38 )
39
40 def setUp(self):
41 self.client.force_login(self.superuser)
42
43 def test_sidebar_not_on_index(self):
44 response = self.client.get(reverse("test_with_sidebar:index"))
45 self.assertContains(response, '<div class="main" id="main">')
46 self.assertNotContains(
47 response, '<nav class="sticky" id="nav-sidebar" aria-label="Sidebar">'
48 )
49
50 def test_sidebar_disabled(self):
51 response = self.client.get(reverse("test_without_sidebar:index"))
52 self.assertNotContains(
53 response, '<nav class="sticky" id="nav-sidebar" aria-label="Sidebar">'
54 )
55
56 def test_sidebar_unauthenticated(self):
57 self.client.logout()
58 response = self.client.get(reverse("test_with_sidebar:login"))
59 self.assertNotContains(
60 response, '<nav class="sticky" id="nav-sidebar" aria-label="Sidebar">'
61 )
62
63 def test_sidebar_aria_current_page(self):
64 url = reverse("test_with_sidebar:auth_user_changelist")
65 response = self.client.get(url)
66 self.assertContains(
67 response, '<nav class="sticky" id="nav-sidebar" aria-label="Sidebar">'
68 )
69 self.assertContains(
70 response, '<a href="%s" aria-current="page">Users</a>' % url
71 )
72
73 @override_settings(
74 TEMPLATES=[
75 {
76 "BACKEND": "django.template.backends.django.DjangoTemplates",
77 "DIRS": [],
78 "APP_DIRS": True,
79 "OPTIONS": {
80 "context_processors": [
81 "django.contrib.auth.context_processors.auth",
82 "django.contrib.messages.context_processors.messages",
83 ],
84 },
85 }
86 ]
87 )
88 def test_sidebar_aria_current_page_missing_without_request_context_processor(self):
89 url = reverse("test_with_sidebar:auth_user_changelist")
90 response = self.client.get(url)
91 self.assertContains(
92 response, '<nav class="sticky" id="nav-sidebar" aria-label="Sidebar">'
93 )
94 # Does not include aria-current attribute.
95 self.assertContains(response, '<a href="%s">Users</a>' % url)
96 self.assertNotContains(response, "aria-current")
97
98 @override_settings(DEBUG=True)
99 def test_included_app_list_template_context_fully_set(self):
100 # All context variables should be set when rendering the sidebar.
101 url = reverse("test_with_sidebar:auth_user_changelist")
102 with self.assertNoLogs("django.template", "DEBUG"):
103 self.client.get(url)
104
105 def test_sidebar_model_name_non_ascii(self):
106 url = reverse("test_with_sidebar:admin_views_héllo_changelist")
107 response = self.client.get(url)
108 self.assertContains(
109 response, '<div class="app-admin_views module current-app">'
110 )
111 self.assertContains(response, '<tr class="model-héllo current-model">')
112 self.assertContains(
113 response,
114 '<th scope="row" id="admin_views-héllo">'
115 '<a href="/test_sidebar/admin/admin_views/h%C3%A9llo/" aria-current="page">'
116 "Héllos</a></th>",
117 html=True,
118 )
119
120
121 @override_settings(ROOT_URLCONF="admin_views.test_nav_sidebar")
122 class SeleniumTests(AdminSeleniumTestCase):
123 available_apps = ["admin_views"] + AdminSeleniumTestCase.available_apps
124
125 def setUp(self):
126 self.superuser = User.objects.create_superuser(
127 username="super",
128 password="secret",
129 email="[email protected]",
130 )
131 self.admin_login(
132 username="super",
133 password="secret",
134 login_url=reverse("test_with_sidebar:index"),
135 )
136 self.selenium.execute_script(
137 "localStorage.removeItem('django.admin.navSidebarIsOpen')"
138 )
139
140 def test_sidebar_starts_open(self):
141 from selenium.webdriver.common.by import By
142
143 self.selenium.get(
144 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
145 )
146 main_element = self.selenium.find_element(By.CSS_SELECTOR, "#main")
147 self.assertIn("shifted", main_element.get_attribute("class").split())
148
149 def test_sidebar_can_be_closed(self):
150 from selenium.webdriver.common.by import By
151
152 self.selenium.get(
153 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
154 )
155 toggle_button = self.selenium.find_element(
156 By.CSS_SELECTOR, "#toggle-nav-sidebar"
157 )
158 self.assertEqual(toggle_button.tag_name, "button")
159 self.assertEqual(toggle_button.get_attribute("aria-label"), "Toggle navigation")
160 nav_sidebar = self.selenium.find_element(By.ID, "nav-sidebar")
161 self.assertEqual(nav_sidebar.get_attribute("aria-expanded"), "true")
162 self.assertTrue(nav_sidebar.is_displayed())
163 toggle_button.click()
164
165 # Hidden sidebar is not visible.
166 nav_sidebar = self.selenium.find_element(By.ID, "nav-sidebar")
167 self.assertEqual(nav_sidebar.get_attribute("aria-expanded"), "false")
168 self.assertFalse(nav_sidebar.is_displayed())
169 main_element = self.selenium.find_element(By.CSS_SELECTOR, "#main")
170 self.assertNotIn("shifted", main_element.get_attribute("class").split())
171
172 def test_sidebar_state_persists(self):
173 from selenium.webdriver.common.by import By
174
175 self.selenium.get(
176 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
177 )
178 self.assertIsNone(
179 self.selenium.execute_script(
180 "return localStorage.getItem('django.admin.navSidebarIsOpen')"
181 )
182 )
183 toggle_button = self.selenium.find_element(
184 By.CSS_SELECTOR, "#toggle-nav-sidebar"
185 )
186 toggle_button.click()
187 self.assertEqual(
188 self.selenium.execute_script(
189 "return localStorage.getItem('django.admin.navSidebarIsOpen')"
190 ),
191 "false",
192 )
193 self.selenium.get(
194 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
195 )
196 main_element = self.selenium.find_element(By.CSS_SELECTOR, "#main")
197 self.assertNotIn("shifted", main_element.get_attribute("class").split())
198
199 toggle_button = self.selenium.find_element(
200 By.CSS_SELECTOR, "#toggle-nav-sidebar"
201 )
202 # Hidden sidebar is not visible.
203 nav_sidebar = self.selenium.find_element(By.ID, "nav-sidebar")
204 self.assertEqual(nav_sidebar.get_attribute("aria-expanded"), "false")
205 self.assertFalse(nav_sidebar.is_displayed())
206 toggle_button.click()
207 nav_sidebar = self.selenium.find_element(By.ID, "nav-sidebar")
208 self.assertEqual(nav_sidebar.get_attribute("aria-expanded"), "true")
209 self.assertTrue(nav_sidebar.is_displayed())
210 self.assertEqual(
211 self.selenium.execute_script(
212 "return localStorage.getItem('django.admin.navSidebarIsOpen')"
213 ),
214 "true",
215 )
216 self.selenium.get(
217 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
218 )
219 main_element = self.selenium.find_element(By.CSS_SELECTOR, "#main")
220 self.assertIn("shifted", main_element.get_attribute("class").split())
221
222 def test_sidebar_filter_persists(self):
223 from selenium.webdriver.common.by import By
224
225 self.selenium.get(
226 self.live_server_url + reverse("test_with_sidebar:auth_user_changelist")
227 )
228 filter_value_script = (
229 "return sessionStorage.getItem('django.admin.navSidebarFilterValue')"
230 )
231 self.assertIsNone(self.selenium.execute_script(filter_value_script))
232 filter_input = self.selenium.find_element(By.CSS_SELECTOR, "#nav-filter")
233 filter_input.send_keys("users")
234 self.assertEqual(self.selenium.execute_script(filter_value_script), "users")