make settings file for github CI

.github/workflows/main.yml

@@ -48,7 +48,7 @@ jobs:
           sudo touch /var/log/alyx.log; sudo chmod 776 /var/log/alyx.log
           sudo touch /var/log/alyx_json.log; sudo chmod 776 /var/log/alyx_json.log
           cd alyx
-          mv alyx/settings_template.py alyx/settings.py
+          mv alyx/settings_ci.py alyx/settings.py
           coverage run manage.py test -n
           coveralls --service=github
         env:

alyx/alyx/settings_ci.py

@@ -0,0 +1,267 @@
+"""
+Django settings for alyx project.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/stable/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/stable/ref/settings/
+"""
+
+import os
+import structlog
+from django.conf.locale.en import formats as en_formats
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+try:
+    from .settings_secret import *  # noqa
+except ImportError:
+    # We're probably autobuilding some documentation so let's just import something
+    # to keep Django happy...
+    from .settings_secret_template import *  # noqa
+
+# Lab-specific settings
+try:
+    from .settings_lab import *  # noqa
+except ImportError:
+    from .settings_lab_template import *  # noqa
+
+en_formats.DATETIME_FORMAT = "d/m/Y H:i"
+DATE_INPUT_FORMATS = ('%d/%m/%Y',)
+
+
+if 'GITHUB_ACTIONS' in os.environ:
+    DATABASES = {
+        'default': {
+            'ENGINE': 'django.db.backends.postgresql_psycopg2',
+            'NAME': 'githubactions',
+            'USER': 'postgres',
+            'PASSWORD': 'postgres',
+            'HOST': 'localhost',
+            'PORT': '5432',
+        }
+    }
+
+
+# Custom User model with UUID primary key
+AUTH_USER_MODEL = 'misc.LabMember'
+
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+DATA_UPLOAD_MAX_NUMBER_FIELDS = 10000
+DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
+
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'formatters': {
+        'simple': {
+            '()': 'colorlog.ColoredFormatter',
+            'format': '%(log_color)s%(asctime)s [%(levelname)s] ' +
+                      '{%(filename)s:%(lineno)s} %(message)s',
+            'datefmt': '%d/%m %H:%M:%S',
+            'log_colors': {
+                'DEBUG': 'cyan',
+                'INFO': 'white',
+                'WARNING': 'yellow',
+                'ERROR': 'red',
+                'CRITICAL': 'bold_red',
+            },
+        },
+        'json_formatter': {
+            '()': structlog.stdlib.ProcessorFormatter,
+            'processor': structlog.processors.JSONRenderer(),
+        },
+    },
+    'handlers': {
+        'file': {
+            'level': 'DEBUG',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': '/var/log/alyx.log',
+            'maxBytes': 16777216,
+            'formatter': 'simple'
+        },
+        'console': {
+            'level': 'DEBUG',
+            'class': 'logging.StreamHandler',
+            'formatter': 'simple'
+        },
+        'json_file': {
+            'level': 'DEBUG',
+            'class': 'logging.handlers.RotatingFileHandler',
+            'filename': '/var/log/alyx_json.log',
+            'maxBytes': 16777216,
+            'backupCount': 3,
+            'formatter': 'json_formatter',
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['file'],
+            'level': 'INFO',
+            'propagate': True,
+        },
+        'django_structlog': {
+            'handlers': ['json_file'],
+            'level': 'INFO',
+        }
+    },
+    'root': {
+        'handlers': ['file', 'console'],
+        'level': 'WARNING',
+        'propagate': True,
+    }
+}
+
+
+if 'TRAVIS' in os.environ or 'READTHEDOCS' in os.environ:
+    LOGGING['handlers']['file']['filename'] = 'alyx.log'
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.8/howto/deployment/checklist/
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+# Production settings:
+if not DEBUG:
+    CSRF_COOKIE_SECURE = True
+    X_FRAME_OPTIONS = 'DENY'
+    SESSION_COOKIE_SECURE = True
+    SECURE_SSL_REDIRECT = True
+    SECURE_BROWSER_XSS_FILTER = True
+    SECURE_CONTENT_TYPE_NOSNIFF = True
+    SECURE_HSTS_SECONDS = 30
+    SECURE_HSTS_INCLUDE_SUBDOMAINS = True
+    SECURE_HSTS_PRELOAD = True
+
+
+# Application definition
+
+INSTALLED_APPS = (
+    # 'dal',
+    # 'dal_select2',
+    'django_admin_listfilter_dropdown',
+    'django_filters',
+    'django.contrib.admin',
+    'django.contrib.admindocs',
+    'django.contrib.contenttypes',
+    'django.contrib.auth',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'mptt',
+    'polymorphic',
+    'rangefilter',
+    'rest_framework',
+    'rest_framework.authtoken',
+    'rest_framework_docs',
+    'reversion',
+    'test_without_migrations',
+    # alyx-apps
+    'actions',
+    'data',
+    'misc',
+    'experiments',
+    'jobs',
+    'subjects',
+    'django_cleanup.apps.CleanupConfig',  # needs to be last in the list
+)
+
+MIDDLEWARE = (
+    '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',
+    'django.middleware.security.SecurityMiddleware',
+    'alyx.base.QueryPrintingMiddleware',
+    'django_structlog.middlewares.RequestMiddleware',
+)
+
+ROOT_URLCONF = 'alyx.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',
+            ],
+        },
+    },
+]
+
+TEMPLATE_LOADERS = (
+    ('django.template.loaders.cached.Loader', (
+        'django.template.loaders.filesystem.Loader',
+        'django.template.loaders.app_directories.Loader',
+    )),
+)
+
+WSGI_APPLICATION = 'alyx.wsgi.application'
+
+REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': (
+        'rest_framework.authentication.SessionAuthentication',
+        'rest_framework.authentication.TokenAuthentication',
+    ),
+    'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',),
+    'STRICT_JSON': False,
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
+    # 'DEFAULT_RENDERER_CLASSES': (
+    #     'rest_framework.renderers.JSONRenderer',
+    # ),
+    'EXCEPTION_HANDLER': 'alyx.base.rest_filters_exception_handler',
+    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
+    'PAGE_SIZE': 250,
+}
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.8/topics/i18n/
+
+
+USE_I18N = False
+USE_L10N = False
+USE_TZ = False
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.8/howto/static-files/
+
+STATIC_ROOT = os.path.join(BASE_DIR, 'static/')
+STATIC_URL = '/static/'
+
+MEDIA_ROOT = os.path.realpath(os.path.join(BASE_DIR, '../uploaded/'))
+MEDIA_ROOT = '/backups/uploaded/'
+MEDIA_URL = '/uploaded/'
+
+TABLES_ROOT = os.path.realpath(os.path.join(BASE_DIR, '../tables/'))
+TABLES_ROOT = '/backups/tables/'
+
+UPLOADED_IMAGE_WIDTH = 800
+
+
+structlog.configure(
+    processors=[
+        structlog.stdlib.filter_by_level,
+        structlog.processors.TimeStamper(fmt='iso'),
+        structlog.stdlib.add_log_level,
+        structlog.stdlib.PositionalArgumentsFormatter(),
+        structlog.processors.StackInfoRenderer(),
+        structlog.processors.format_exc_info,
+        structlog.processors.UnicodeDecoder(),
+        structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
+    ],
+    context_class=structlog.threadlocal.wrap_dict(dict),
+    logger_factory=structlog.stdlib.LoggerFactory(),
+    wrapper_class=structlog.stdlib.BoundLogger,
+    cache_logger_on_first_use=True,
+)