11241611246

Committed 08 Oct 2024 06:36PM UTC coverage: 54.668% (-0.1%) from 54.79%

Build # 11241611246

Build Type

Pull #86

github

Committed by

web-flow

Commit Message

Merge 212b6745a into 6a43c847c

Pull Request Pull Request #86: Improve instructions for dev env

Run Details

398 of 891 branches covered (44.67%)

Branch coverage included in aggregate %.

12 of 23 new or added lines in 3 files covered. (52.17%)

35 existing lines in 2 files now uncovered.

1505 of 2590 relevant lines covered (58.11%)

0.58 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.31

/tin/settings/__init__.py

"""Django settings for tin project.

Generated by 'django-admin startproject' using Django 2.1.3.

For more information on this file, see
https://docs.djangoproject.com/en/4.2/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.2/ref/settings/
"""

from __future__ import annotations

import os

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

MEDIA_ROOT = os.path.join(BASE_DIR, "media")


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = "naxigo(w3=$1&!-t4vbb9)g^8#lnt6ygr)(2qfi1z(h(r_cjhy"

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = [
    "127.0.0.1",
    "localhost",
    "tin",
    "tin.tjhsst.edu",
    "tin.csl.tjhsst.edu",
    "tin.sites.tjhsst.edu",
]

INTERNAL_IPS = [
    "127.0.0.1",
    "localhost",
]


# Application definition

INSTALLED_APPS = [
    "daphne",
    "django.contrib.admin",
    "django.contrib.auth",
    "django.contrib.contenttypes",
    "django.contrib.sessions",
    "django.contrib.messages",
    "django.contrib.staticfiles",
    "social_django",
    "django_extensions",
    "django_celery_results",
    "debug_toolbar",
    "markdownify.apps.MarkdownifyConfig",
    "tin.apps",
    "tin.apps.users",
    "tin.apps.auth",
    "tin.apps.courses",
    "tin.apps.assignments",
    "tin.apps.submissions",
    "tin.apps.docs",
    "tin.apps.venvs",
]

MIDDLEWARE = [
    "debug_toolbar.middleware.DebugToolbarMiddleware",
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
]

ROOT_URLCONF = "tin.urls"

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [os.path.join(BASE_DIR, "templates")],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
                "django.template.context_processors.debug",
                "django.template.context_processors.request",
                "django.contrib.auth.context_processors.auth",
                "django.contrib.messages.context_processors.messages",
                "social_django.context_processors.backends",
                "social_django.context_processors.login_redirect",
                "tin.apps.context_processors.response_footer",
            ]
        },
    }
]

WSGI_APPLICATION = "tin.wsgi.application"
ASGI_APPLICATION = "tin.asgi.application"


CHANNEL_LAYERS = {
    "default": {
        "BACKEND": "channels_redis.core.RedisChannelLayer",
        "CONFIG": {"hosts": [("localhost", 6379)]},
    },
}

DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

TEST_RUNNER = "tin.tests.runner.PytestRunner"


# Database
# https://docs.djangoproject.com/en/2.1/ref/settings/#databases

DATABASES = {
    "default": {
        "ENGINE": "django.db.backends.sqlite3",
        "NAME": os.path.join(BASE_DIR, "db.sqlite3"),
    }
}


# Password validation
# https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators

if DEBUG:
    AUTH_PASSWORD_VALIDATORS = []
else:
    AUTH_PASSWORD_VALIDATORS = [
        {"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"},
        {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
        {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
        {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
    ]


# Authentication-related settings

AUTHENTICATION_BACKENDS = ("tin.apps.auth.oauth.IonOauth2",)

if DEBUG:
    AUTHENTICATION_BACKENDS += ("django.contrib.auth.backends.ModelBackend",)

SOCIAL_AUTH_USER_FIELDS = [
    "username",
    "full_name",
    "first_name",
    "last_name",
    "email",
    "id",
    "is_student",
    "is_teacher",
]

SOCIAL_AUTH_URL_NAMESPACE = "social"

SOCIAL_AUTH_PIPELINE = (
    "social_core.pipeline.social_auth.social_details",
    "social_core.pipeline.social_auth.social_uid",
    "social_core.pipeline.social_auth.auth_allowed",
    "social_core.pipeline.social_auth.social_user",
    "tin.apps.auth.oauth.get_username",
    "social_core.pipeline.social_auth.associate_by_email",
    "social_core.pipeline.user.create_user",
    "social_core.pipeline.social_auth.associate_user",
    "social_core.pipeline.social_auth.load_extra_data",
)

AUTH_USER_MODEL = "users.User"

SOCIAL_AUTH_ALWAYS_ASSOCIATE = True

LOGOUT_URL = "/logout/"

LOGIN_URL = "/login/"

LOGIN_REDIRECT_URL = "/"

SOCIAL_AUTH_LOGIN_ERROR_URL = "/"
SOCIAL_AUTH_RAISE_EXCEPTIONS = False


# Internationalization
# https://docs.djangoproject.com/en/2.1/topics/i18n/

LANGUAGE_CODE = "en-us"

TIME_ZONE = "America/New_York"

USE_I18N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.1/howto/static-files/

STATIC_URL = "/static/"

STATICFILES_DIRS = (os.path.join(BASE_DIR, "static"),)
STATIC_ROOT = os.path.join(BASE_DIR, "serve")


# Logging

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,
    "formatters": {"simple": {"format": "{asctime}: {levelname:>8s}: {message}", "style": "{"}},
    "handlers": {
        "console": {"level": "DEBUG", "class": "logging.StreamHandler", "formatter": "simple"},
        "info_log": {
            "level": "INFO",
            "class": "logging.FileHandler",
            "filename": os.path.join(BASE_DIR, "logs/info.log"),
            "formatter": "simple",
        },
    },
    "loggers": {
        "django": {"handlers": ["console", "info_log"], "level": "INFO", "propagate": True},
        "tin": {"handlers": ["console", "info_log"], "level": "INFO", "propagate": True},
    },
}


# Celery settings

CELERY_RESULT_BACKEND = "django-db"


CELERY_BROKER_URL = "redis://localhost:6379/1"


# Markdown
MARKDOWNIFY = {
    "default": {
        "MARKDOWN_EXTENSIONS": [
            "fenced_code",
        ],
        "WHITELIST_ATTRS": ["class", "href", "src", "alt"],
        "WHITELIST_TAGS": [
            "a",
            "abbr",
            "acronym",
            "b",
            "blockquote",
            "code",
            "em",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6",
            "i",
            "img",
            "li",
            "ol",
            "p",
            "pre",
            "span",
            "strong",
            "ul",
        ],
    }
}


# Django debug toolbar settings

_enabled_panels = {
    "debug_toolbar.panels.history.HistoryPanel",
    "debug_toolbar.panels.versions.VersionsPanel",
    "debug_toolbar.panels.timer.TimerPanel",
    "debug_toolbar.panels.settings.SettingsPanel",
    "debug_toolbar.panels.headers.HeadersPanel",
    "debug_toolbar.panels.request.RequestPanel",
    "debug_toolbar.panels.sql.SQLPanel",
    "debug_toolbar.panels.staticfiles.StaticFilesPanel",
    "debug_toolbar.panels.templates.TemplatesPanel",
    "debug_toolbar.panels.cache.CachePanel",
    "debug_toolbar.panels.signals.SignalsPanel",
    "debug_toolbar.panels.redirects.RedirectsPanel",
    "debug_toolbar.panels.profiling.ProfilingPanel",
}

DEBUG_TOOLBAR_CONFIG = {
    "DISABLE_PANELS": _enabled_panels,
    "SHOW_COLLAPSED": True,
}

# Tin-specific settings

SUBMISSION_SIZE_LIMIT = 1 * 1000 * 1000  # 1 MB

DEVELOPER_EMAIL = "tin@tjhsst.edu"
REPO_URL = "https://github.com/tjcsl/tin"

VENV_FILE_SIZE_LIMIT = 1 * 1000 * 1000 * 1000  # 1 GB

# Spaces and special characters may not be handled correctly
# Not importing correctly - specified directly in apps/submissions/tasks.py
# as of 8/3/2022, 2022ldelwich
SUBMISSION_PYTHON = "/usr/bin/python3.10"

SUBMISSION_NAMESERVERS = ["198.38.16.40", "198.38.16.41"]

# Users may only have this many submissions running
CONCURRENT_USER_SUBMISSION_LIMIT = 2

# Threshold for log messages being issues
QUIZ_ISSUE_THRESHOLD = 5

# ImgBB API key (set in secret.py)
IMGBB_API_KEY = ""

try:
    from .secret import *
except ImportError:
    pass

1	"""Django settings for tin project.
2
3	Generated by 'django-admin startproject' using Django 2.1.3.
4
5	For more information on this file, see
6	https://docs.djangoproject.com/en/4.2/topics/settings/
7
8	For the full list of settings and their values, see
9	https://docs.djangoproject.com/en/4.2/ref/settings/
10	"""
11
12	from __future__ import annotations	1✔
13
14	import os	1✔
15
16	# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
17	BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))	1✔
18
19	MEDIA_ROOT = os.path.join(BASE_DIR, "media")	1✔
20
21
22	# Quick-start development settings - unsuitable for production
23	# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
24
25	# SECURITY WARNING: keep the secret key used in production secret!
26	SECRET_KEY = "naxigo(w3=$1&!-t4vbb9)g^8#lnt6ygr)(2qfi1z(h(r_cjhy"	1✔
27
28	# SECURITY WARNING: don't run with debug turned on in production!
29	DEBUG = True	1✔
30
31	ALLOWED_HOSTS = [	1✔
32	"127.0.0.1",
33	"localhost",
34	"tin",
35	"tin.tjhsst.edu",
36	"tin.csl.tjhsst.edu",
37	"tin.sites.tjhsst.edu",
38	]
39
40	INTERNAL_IPS = [	1✔
41	"127.0.0.1",
42	"localhost",
43	]
44
45
46	# Application definition
47
48	INSTALLED_APPS = [	1✔
49	"daphne",
50	"django.contrib.admin",
51	"django.contrib.auth",
52	"django.contrib.contenttypes",
53	"django.contrib.sessions",
54	"django.contrib.messages",
55	"django.contrib.staticfiles",
56	"social_django",
57	"django_extensions",
58	"django_celery_results",
59	"debug_toolbar",
60	"markdownify.apps.MarkdownifyConfig",
61	"tin.apps",
62	"tin.apps.users",
63	"tin.apps.auth",
64	"tin.apps.courses",
65	"tin.apps.assignments",
66	"tin.apps.submissions",
67	"tin.apps.docs",
68	"tin.apps.venvs",
69	]
70
71	MIDDLEWARE = [	1✔
72	"debug_toolbar.middleware.DebugToolbarMiddleware",
73	"django.middleware.security.SecurityMiddleware",
74	"django.contrib.sessions.middleware.SessionMiddleware",
75	"django.middleware.common.CommonMiddleware",
76	"django.middleware.csrf.CsrfViewMiddleware",
77	"django.contrib.auth.middleware.AuthenticationMiddleware",
78	"django.contrib.messages.middleware.MessageMiddleware",
79	"django.middleware.clickjacking.XFrameOptionsMiddleware",
80	]
81
82	ROOT_URLCONF = "tin.urls"	1✔
83
84	TEMPLATES = [	1✔
85	{
86	"BACKEND": "django.template.backends.django.DjangoTemplates",
87	"DIRS": [os.path.join(BASE_DIR, "templates")],
88	"APP_DIRS": True,
89	"OPTIONS": {
90	"context_processors": [
91	"django.template.context_processors.debug",
92	"django.template.context_processors.request",
93	"django.contrib.auth.context_processors.auth",
94	"django.contrib.messages.context_processors.messages",
95	"social_django.context_processors.backends",
96	"social_django.context_processors.login_redirect",
97	"tin.apps.context_processors.response_footer",
98	]
99	},
100	}
101	]
102
103	WSGI_APPLICATION = "tin.wsgi.application"	1✔
104	ASGI_APPLICATION = "tin.asgi.application"	1✔
105
106
107	CHANNEL_LAYERS = {	1✔
108	"default": {
109	"BACKEND": "channels_redis.core.RedisChannelLayer",
110	"CONFIG": {"hosts": [("localhost", 6379)]},
111	},
112	}
113
114	DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"	1✔
115
116	TEST_RUNNER = "tin.tests.runner.PytestRunner"	1✔
117
118
119	# Database
120	# https://docs.djangoproject.com/en/2.1/ref/settings/#databases
121
122	DATABASES = {	1✔
123	"default": {
124	"ENGINE": "django.db.backends.sqlite3",
125	"NAME": os.path.join(BASE_DIR, "db.sqlite3"),
126	}
127	}
128
129
130	# Password validation
131	# https://docs.djangoproject.com/en/2.1/ref/settings/#auth-password-validators
132
133	if DEBUG:	1!
134	AUTH_PASSWORD_VALIDATORS = []	1✔
135	else:
UNCOV 136	AUTH_PASSWORD_VALIDATORS = [	×
137	{"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"},
138	{"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"},
139	{"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"},
140	{"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"},
141	]
142
143
144	# Authentication-related settings
145
146	AUTHENTICATION_BACKENDS = ("tin.apps.auth.oauth.IonOauth2",)	1✔
147
148	if DEBUG:	1!
149	AUTHENTICATION_BACKENDS += ("django.contrib.auth.backends.ModelBackend",)	1✔
150
151	SOCIAL_AUTH_USER_FIELDS = [	1✔
152	"username",
153	"full_name",
154	"first_name",
155	"last_name",
156	"email",
157	"id",
158	"is_student",
159	"is_teacher",
160	]
161
162	SOCIAL_AUTH_URL_NAMESPACE = "social"	1✔
163
164	SOCIAL_AUTH_PIPELINE = (	1✔
165	"social_core.pipeline.social_auth.social_details",
166	"social_core.pipeline.social_auth.social_uid",
167	"social_core.pipeline.social_auth.auth_allowed",
168	"social_core.pipeline.social_auth.social_user",
169	"tin.apps.auth.oauth.get_username",
170	"social_core.pipeline.social_auth.associate_by_email",
171	"social_core.pipeline.user.create_user",
172	"social_core.pipeline.social_auth.associate_user",
173	"social_core.pipeline.social_auth.load_extra_data",
174	)
175
176	AUTH_USER_MODEL = "users.User"	1✔
177
178	SOCIAL_AUTH_ALWAYS_ASSOCIATE = True	1✔
179
180	LOGOUT_URL = "/logout/"	1✔
181
182	LOGIN_URL = "/login/"	1✔
183
184	LOGIN_REDIRECT_URL = "/"	1✔
185
186	SOCIAL_AUTH_LOGIN_ERROR_URL = "/"	1✔
187	SOCIAL_AUTH_RAISE_EXCEPTIONS = False	1✔
188
189
190	# Internationalization
191	# https://docs.djangoproject.com/en/2.1/topics/i18n/
192
193	LANGUAGE_CODE = "en-us"	1✔
194
195	TIME_ZONE = "America/New_York"	1✔
196
197	USE_I18N = True	1✔
198
199	USE_TZ = True	1✔
200
201
202	# Static files (CSS, JavaScript, Images)
203	# https://docs.djangoproject.com/en/2.1/howto/static-files/
204
205	STATIC_URL = "/static/"	1✔
206
207	STATICFILES_DIRS = (os.path.join(BASE_DIR, "static"),)	1✔
208	STATIC_ROOT = os.path.join(BASE_DIR, "serve")	1✔
209
210
211	# Logging
212
213	LOGGING = {	1✔
214	"version": 1,
215	"disable_existing_loggers": False,
216	"formatters": {"simple": {"format": "{asctime}: {levelname:>8s}: {message}", "style": "{"}},
217	"handlers": {
218	"console": {"level": "DEBUG", "class": "logging.StreamHandler", "formatter": "simple"},
219	"info_log": {
220	"level": "INFO",
221	"class": "logging.FileHandler",
222	"filename": os.path.join(BASE_DIR, "logs/info.log"),
223	"formatter": "simple",
224	},
225	},
226	"loggers": {
227	"django": {"handlers": ["console", "info_log"], "level": "INFO", "propagate": True},
228	"tin": {"handlers": ["console", "info_log"], "level": "INFO", "propagate": True},
229	},
230	}
231
232
233	# Celery settings
234
235	CELERY_RESULT_BACKEND = "django-db"	1✔
236
237
238	CELERY_BROKER_URL = "redis://localhost:6379/1"	1✔
239
240
241	# Markdown
242	MARKDOWNIFY = {	1✔
243	"default": {
244	"MARKDOWN_EXTENSIONS": [
245	"fenced_code",
246	],
247	"WHITELIST_ATTRS": ["class", "href", "src", "alt"],
248	"WHITELIST_TAGS": [
249	"a",
250	"abbr",
251	"acronym",
252	"b",
253	"blockquote",
254	"code",
255	"em",
256	"h1",
257	"h2",
258	"h3",
259	"h4",
260	"h5",
261	"h6",
262	"i",
263	"img",
264	"li",
265	"ol",
266	"p",
267	"pre",
268	"span",
269	"strong",
270	"ul",
271	],
272	}
273	}
274
275
276	# Django debug toolbar settings
277
278	_enabled_panels = {	1✔
279	"debug_toolbar.panels.history.HistoryPanel",
280	"debug_toolbar.panels.versions.VersionsPanel",
281	"debug_toolbar.panels.timer.TimerPanel",
282	"debug_toolbar.panels.settings.SettingsPanel",
283	"debug_toolbar.panels.headers.HeadersPanel",
284	"debug_toolbar.panels.request.RequestPanel",
285	"debug_toolbar.panels.sql.SQLPanel",
286	"debug_toolbar.panels.staticfiles.StaticFilesPanel",
287	"debug_toolbar.panels.templates.TemplatesPanel",
288	"debug_toolbar.panels.cache.CachePanel",
289	"debug_toolbar.panels.signals.SignalsPanel",
290	"debug_toolbar.panels.redirects.RedirectsPanel",
291	"debug_toolbar.panels.profiling.ProfilingPanel",
292	}
293
294	DEBUG_TOOLBAR_CONFIG = {	1✔
295	"DISABLE_PANELS": _enabled_panels,
296	"SHOW_COLLAPSED": True,
297	}
298
299	# Tin-specific settings
300
301	SUBMISSION_SIZE_LIMIT = 1 * 1000 * 1000 # 1 MB	1✔
302
303	DEVELOPER_EMAIL = "tin@tjhsst.edu"	1✔
304	REPO_URL = "https://github.com/tjcsl/tin"	1✔
305
306	VENV_FILE_SIZE_LIMIT = 1 * 1000 * 1000 * 1000 # 1 GB	1✔
307
308	# Spaces and special characters may not be handled correctly
309	# Not importing correctly - specified directly in apps/submissions/tasks.py
310	# as of 8/3/2022, 2022ldelwich
311	SUBMISSION_PYTHON = "/usr/bin/python3.10"	1✔
312
313	SUBMISSION_NAMESERVERS = ["198.38.16.40", "198.38.16.41"]	1✔
314
315	# Users may only have this many submissions running
316	CONCURRENT_USER_SUBMISSION_LIMIT = 2	1✔
317
318	# Threshold for log messages being issues
319	QUIZ_ISSUE_THRESHOLD = 5	1✔
320
321	# ImgBB API key (set in secret.py)
322	IMGBB_API_KEY = ""	1✔
323
324	try:	1✔
325	from .secret import *	1✔
326	except ImportError:	1✔
327	pass	1✔

tjcsl / tin / 11241611246

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous