Merge pull request #3099 from edx/saleem-latif/WL-506

WL-506: Update configuration ansible script for edxapp to support lms theming

CHANGELOG.md

@@ -143,3 +143,9 @@
     is now a list of directories. Change is backward incompatible.
   - Renamed `COMPREHENSIVE_THEME_DIR` to `COMPREHENSIVE_THEME_DIRS`, `COMPREHENSIVE_THEME_DIRS` is now a list of directories.
     Change is backward incompatible.
+
+- Role: Edxapp
+  - `EDXAPP_COMPREHENSIVE_THEME_DIR` is deprecated and is maintained for backward compatibility, `EDXAPP_COMPREHENSIVE_THEME_DIRS`
+    should be used instead which is a list of directories. `EDXAPP_COMPREHENSIVE_THEME_DIR` if present will have priority over `EDXAPP_COMPREHENSIVE_THEME_DIRS`
+  - `COMPREHENSIVE_THEME_DIR` is deprecated and is maintained for backward compatibility, `COMPREHENSIVE_THEME_DIRS` should be used
+    instead which is a list of directories. `COMPREHENSIVE_THEME_DIR` if present will have priority over `COMPREHENSIVE_THEME_DIRS`

playbooks/roles/edxapp/defaults/main.yml

@@ -574,11 +574,16 @@ EDXAPP_PROCTORING_BACKEND_PROVIDER:
   options: {}
 
 # Comprehensive Theming
-# Full path to the comprehensive theme directory
+# Deprecated, maintained for backward compatibility
 EDXAPP_COMPREHENSIVE_THEME_DIR: ""
 
+# list of paths to the comprehensive theme directories
+EDXAPP_COMPREHENSIVE_THEME_DIRS:
+  - "{{ EDXAPP_COMPREHENSIVE_THEME_DIR }}"
+
 # Name of the default site theme
 EDXAPP_DEFAULT_SITE_THEME: ""
+EDXAPP_ENABLE_COMPREHENSIVE_THEMING: false
 
 # Git repo for the comprehensive theme (if using a comprehensive theme
 # other than the ones bundled with edx/platform)
@@ -889,7 +894,12 @@ generic_env_config:  &edxapp_generic_env
   REGISTRATION_EXTRA_FIELDS: "{{ EDXAPP_REGISTRATION_EXTRA_FIELDS }}"
   XBLOCK_SETTINGS: "{{ EDXAPP_XBLOCK_SETTINGS }}"
   EDXMKTG_USER_INFO_COOKIE_NAME: "{{ EDXAPP_EDXMKTG_USER_INFO_COOKIE_NAME }}"
+
+  # Deprecated, maintained for backward compatibility
   COMPREHENSIVE_THEME_DIR: "{{ EDXAPP_COMPREHENSIVE_THEME_DIR }}"
+
+  COMPREHENSIVE_THEME_DIRS: "{{ EDXAPP_COMPREHENSIVE_THEME_DIRS }}"
+  ENABLE_COMPREHENSIVE_THEMING: "{{ EDXAPP_ENABLE_COMPREHENSIVE_THEMING }}"
   DEFAULT_SITE_THEME: "{{ EDXAPP_DEFAULT_SITE_THEME }}"
   SESSION_SAVE_EVERY_REQUEST: "{{ EDXAPP_SESSION_SAVE_EVERY_REQUEST }}"
   SOCIAL_SHARING_SETTINGS: "{{ EDXAPP_SOCIAL_SHARING_SETTINGS }}"

playbooks/roles/edxapp/meta/main.yml

@@ -11,3 +11,9 @@ dependencies:
         type: restricted
         authorized_keys: "{{ EDXAPP_AUTOMATOR_AUTHORIZED_KEYS }}"
     when: EDXAPP_AUTOMATOR_AUTHORIZED_KEYS|length != 0
+  - role: edx_themes
+    theme_users:
+      - "{{ edxapp_user }}"
+    additional_theme_dirs:
+      - "{{ EDXAPP_COMPREHENSIVE_THEME_DIRS }}"
+    when: "{{ EDXAPP_ENABLE_COMPREHENSIVE_THEMING }}"

playbooks/roles/edxapp/tasks/deploy.yml

@@ -86,25 +86,6 @@
     - install
     - install:code
 
-# To enable Comprehensive theming, point
-# EDXAPP_COMPREHENSIVE_THEME_SOURCE_REPO to your theme repo, and set
-# EDXAPP_COMPREHENSIVE_THEME_DIR to the directory you want to check
-# out to.
-- name: checkout comprehensive theme
-  git_2_0_1:
-    dest: "{{ EDXAPP_COMPREHENSIVE_THEME_DIR }}"
-    repo: "{{ EDXAPP_COMPREHENSIVE_THEME_SOURCE_REPO }}"
-    version: "{{ EDXAPP_COMPREHENSIVE_THEME_VERSION }}"
-    accept_hostkey: yes
-  when: EDXAPP_COMPREHENSIVE_THEME_SOURCE_REPO != ''
-  become_user: "{{ edxapp_user }}"
-  environment:
-    GIT_SSH: "{{ edxapp_git_ssh }}"
-  register: edxapp_comprehensive_theme_checkout
-  tags:
-    - install
-    - install:code
-
 - name: Stat each requirements file with Github URLs to ensure it exists
   stat:
     path: "{{ item }}"

util/jenkins/ansible-provision.sh

@@ -173,7 +173,7 @@ edx_ansible_source_repo: ${configuration_source_repo}
 edx_platform_repo: ${edx_platform_repo}
 
 EDXAPP_PLATFORM_NAME: $sandbox_platform_name
-EDXAPP_COMPREHENSIVE_THEME_DIR: $edxapp_comprehensive_theme_dir
+EDXAPP_COMPREHENSIVE_THEME_DIRS: $edxapp_comprehensive_theme_dirs
 
 EDXAPP_STATIC_URL_BASE: $static_url_base
 EDXAPP_LMS_NGINX_PORT: 80