From 62c7022e828c8208375cfef7f5c115c93591cd8b Mon Sep 17 00:00:00 2001
From: Tanner Prestegard <tanner.prestegard@ligo.org>
Date: Mon, 22 Oct 2018 15:26:59 -0500
Subject: [PATCH] Random cleanup and comments

---
 config/settings/dev.py                   | 1 +
 config/urls.py                           | 6 ------
 gracedb/core/tests/utils.py              | 9 ++++++++-
 gracedb/events/context_processors.py     | 2 +-
 gracedb/ligoauth/middleware.py           | 2 +-
 gracedb/ligoauth/models.py               | 6 ------
 gracedb/superevents/tests/test_access.py | 2 +-
 7 files changed, 12 insertions(+), 16 deletions(-)

diff --git a/config/settings/dev.py b/config/settings/dev.py
index 4a224125e..0685aa98d 100644
--- a/config/settings/dev.py
+++ b/config/settings/dev.py
@@ -18,6 +18,7 @@ MIDDLEWARE += [
     debug_middleware,
     #'silk.middleware.SilkyMiddleware',
     #'core.middleware.profiling.ProfileMiddleware',
+    #'core.middleware.admin.AdminsOnlyMiddleware',
 ]
 
 # Add to installed apps
diff --git a/config/urls.py b/config/urls.py
index 14c405e71..71ef79ead 100644
--- a/config/urls.py
+++ b/config/urls.py
@@ -1,9 +1,6 @@
-
-# Changed for Django 1.11 upgrade
 from django.conf import settings
 from django.conf.urls import url, include
 
-# Uncomment the next two lines to enable the admin:
 from django.contrib import admin
 from django.contrib.auth.views import logout
 from django.views.generic import TemplateView
@@ -11,9 +8,6 @@ from django.views.generic import TemplateView
 # Import feeds
 import core.views
 from events.feeds import EventFeed, feedview
-
-# After Django 1.10, have to import views directly, rather
-# than just using a string
 import events.reports
 import events.views
 from ligoauth.views import pre_login, post_login, shib_logout
diff --git a/gracedb/core/tests/utils.py b/gracedb/core/tests/utils.py
index f9127573f..6c0704d34 100644
--- a/gracedb/core/tests/utils.py
+++ b/gracedb/core/tests/utils.py
@@ -25,7 +25,14 @@ TEST_DATA_DIR = os.path.join('/tmp', 'test_data')
     GRACEDB_DATA_DIR=TEST_DATA_DIR,
 )
 class DefineTestSettings(TestCase):
-    """Defines base settings for testing and creates a data directory"""
+    """
+    Defines base settings for testing and creates a data directory.
+
+    NOTE: we technically should be checking for and creating/deleting
+    settings.GRACEDB_DATA_DIR since we are overriding it.  But we use
+    TEST_DATA_DIR instead just to be totally safe and not accidentally
+    delete all of the real data.
+    """
 
     def setUp(self):
         super(DefineTestSettings, self).setUp()
diff --git a/gracedb/events/context_processors.py b/gracedb/events/context_processors.py
index 0f056247a..4cc7ebc38 100644
--- a/gracedb/events/context_processors.py
+++ b/gracedb/events/context_processors.py
@@ -9,4 +9,4 @@ def LigoAuthContext(request):
         if set(list(internal_groups)) & set(list(request.user.groups.all())):
             user_is_internal = True
 
-    return { 'user' : request.user, 'user_is_internal' : user_is_internal }
+    return {'user': request.user, 'user_is_internal': user_is_internal}
diff --git a/gracedb/ligoauth/middleware.py b/gracedb/ligoauth/middleware.py
index f32819f4e..1d9b6ddf8 100644
--- a/gracedb/ligoauth/middleware.py
+++ b/gracedb/ligoauth/middleware.py
@@ -62,7 +62,7 @@ class ShibbolethWebAuthMiddleware(PersistentRemoteUserMiddleware):
 
         # Otherwise, we are seeing this user for the first time in this,
         # session, so we attempt to authenticate the user. The backend will
-        # create user accounts for unknown users (TBD)
+        # create user accounts for unknown users with session information.
         user = auth.authenticate(request, remote_user=username)
 
         # If user not found in database, create user account
diff --git a/gracedb/ligoauth/models.py b/gracedb/ligoauth/models.py
index 55e6a5b91..4f270fa52 100644
--- a/gracedb/ligoauth/models.py
+++ b/gracedb/ligoauth/models.py
@@ -70,12 +70,6 @@ class AlternateEmail(models.Model):
     user = models.ForeignKey(User)
     email = models.EmailField(max_length=254)
 
-def shibid_to_user(shibid):
-    try:
-        return User.objects.get(username=shibid)
-    except User.DoesNotExist:
-        return None
-
 def certdn_to_user(dn, username=None):
     try:
         possible_users = X509Cert.objects.get(subject=dn).users
diff --git a/gracedb/superevents/tests/test_access.py b/gracedb/superevents/tests/test_access.py
index c7ba6880c..ddbdca090 100644
--- a/gracedb/superevents/tests/test_access.py
+++ b/gracedb/superevents/tests/test_access.py
@@ -82,7 +82,7 @@ class TestSupereventDetailView(SignoffGroupsAndUsersSetup,
     def test_advocate_view_superevent(self):
         """EM advocate user can see advocate signoff form on superevent page"""
 
-        # Apply H1OPS label so we can do a full test
+        # Apply ADVREQ label so we can do a full test
         advreq = Label.objects.create(name='ADVREQ')
         self.internal_superevent.labelling_set.create(label=advreq,
             creator=self.internal_user)
-- 
GitLab