From c68fac160b1045e7cf7ad97a9a3d4bd100ec5f23 Mon Sep 17 00:00:00 2001
From: bmedx <bmesick@edx.org>
Date: Fri, 20 Apr 2018 14:11:27 -0400
Subject: [PATCH] Add default retirement states to settings

---
 cms/envs/aws.py    |  1 +
 cms/envs/common.py |  1 +
 lms/envs/aws.py    |  1 +
 lms/envs/common.py | 36 ++++++++++++++++++++++++++++++++++++
 4 files changed, 39 insertions(+)

diff --git a/cms/envs/aws.py b/cms/envs/aws.py
index 16d0d262c9..56cb186bba 100644
--- a/cms/envs/aws.py
+++ b/cms/envs/aws.py
@@ -582,6 +582,7 @@ RETIREMENT_SERVICE_WORKER_USERNAME = ENV_TOKENS.get(
     'RETIREMENT_SERVICE_WORKER_USERNAME',
     RETIREMENT_SERVICE_WORKER_USERNAME
 )
+RETIREMENT_STATES = ENV_TOKENS.get('RETIREMENT_STATES', RETIREMENT_STATES)
 
 ####################### Plugin Settings ##########################
 
diff --git a/cms/envs/common.py b/cms/envs/common.py
index cea9c6aad9..fd75b9122a 100644
--- a/cms/envs/common.py
+++ b/cms/envs/common.py
@@ -134,6 +134,7 @@ from lms.envs.common import (
     RETIRED_EMAIL_FMT,
     RETIRED_USER_SALTS,
     RETIREMENT_SERVICE_WORKER_USERNAME,
+    RETIREMENT_STATES,
 
     # Methods to derive settings
     _make_mako_template_dirs,
diff --git a/lms/envs/aws.py b/lms/envs/aws.py
index 8f904bfb29..54d15384b6 100644
--- a/lms/envs/aws.py
+++ b/lms/envs/aws.py
@@ -1089,6 +1089,7 @@ RETIREMENT_SERVICE_WORKER_USERNAME = ENV_TOKENS.get(
     'RETIREMENT_SERVICE_WORKER_USERNAME',
     RETIREMENT_SERVICE_WORKER_USERNAME
 )
+RETIREMENT_STATES = ENV_TOKENS.get('RETIREMENT_STATES', RETIREMENT_STATES)
 
 ############################### Plugin Settings ###############################
 
diff --git a/lms/envs/common.py b/lms/envs/common.py
index 1e838cd6ba..94b4633036 100644
--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -3414,6 +3414,42 @@ derived('RETIRED_USERNAME_FMT', 'RETIRED_EMAIL_FMT')
 RETIRED_USER_SALTS = ['abc', '123']
 RETIREMENT_SERVICE_WORKER_USERNAME = 'RETIREMENT_SERVICE_USER'
 
+# These states are the default, but are designed to be overridden in configuration.
+RETIREMENT_STATES = [
+    'PENDING',
+
+    'LOCKING_ACCOUNT',
+    'LOCKING_COMPLETE',
+
+    'RETIRING_CREDENTIALS',
+    'CREDENTIALS_COMPLETE',
+
+    'RETIRING_ECOM',
+    'ECOM_COMPLETE',
+
+    'RETIRING_FORUMS',
+    'FORUMS_COMPLETE',
+
+    'RETIRING_EMAIL_LISTS',
+    'EMAIL_LISTS_COMPLETE',
+
+    'RETIRING_ENROLLMENTS',
+    'ENROLLMENTS_COMPLETE',
+
+    'RETIRING_NOTES',
+    'NOTES_COMPLETE',
+
+    'NOTIFYING_PARTNERS',
+    'PARTNERS_NOTIFIED',
+
+    'RETIRING_LMS',
+    'LMS_COMPLETE',
+
+    'ERRORED',
+    'ABORTED',
+    'COMPLETE',
+]
+
 ############### Settings for django-fernet-fields ##################
 FERNET_KEYS = [
     'DUMMY KEY CHANGE BEFORE GOING TO PRODUCTION',