Feature/ses enrollment email templates

common/djangoapps/student/management/commands/test_enrollment_email_ses.py

@@ -0,0 +1,322 @@
+"""
+Management command to test course enrollment email SES migration.
+
+This command helps test:
+- Template rendering (English and Spanish)
+- Template fallback resolution (edx-themes → edx-platform)
+- Email sending via SES and Braze
+- SES/Braze fallback behavior
+- Language-based template selection
+"""
+
+import logging
+from django.core.management.base import BaseCommand, CommandError
+from django.contrib.auth import get_user_model
+from django.template.loader import render_to_string
+from django.contrib.sites.models import Site
+from openedx.core.lib.celery.task_utils import emulate_http_request
+from openedx.core.djangoapps.lang_pref import LANGUAGE_KEY
+
+from common.djangoapps.student.tasks import (
+    _get_enrollment_email_language,
+    _build_enrollment_email_image_urls,
+)
+from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
+from openedx.core.djangoapps.user_api.models import UserPreference
+
+log = logging.getLogger(__name__)
+User = get_user_model()
+
+
+class Command(BaseCommand):
+    """Management command for testing course enrollment email SES migration."""
+
+    help = (
+        "Test course enrollment email SES migration. "
+        "Use --help for detailed options."
+    )
+
+    def add_arguments(self, parser):
+        """Add command arguments."""
+        parser.add_argument(
+            '--test-template-rendering',
+            action='store_true',
+            help='Test template rendering for English and Spanish',
+        )
+        parser.add_argument(
+            '--test-template-fallback',
+            action='store_true',
+            help='Test template fallback from edx-themes to edx-platform',
+        )
+        parser.add_argument(
+            '--test-language-selection',
+            action='store_true',
+            help='Test language-based template selection',
+        )
+        parser.add_argument(
+            '--test-image-urls',
+            action='store_true',
+            help='Test image URL building for SES',
+        )
+        parser.add_argument(
+            '--send-test-email',
+            action='store_true',
+            help='Send test email to configured address',
+        )
+        parser.add_argument(
+            '--test-email-to',
+            default='test@example.com',
+            help='Email address to send test email to (default: %(default)s)',
+        )
+        parser.add_argument(
+            '--username',
+            help='Username of user to use for testing (defaults to first admin)',
+        )
+        parser.add_argument(
+            '--all',
+            action='store_true',
+            help='Run all tests',
+        )
+
+    def handle(self, *args, **options):
+        """Execute the command."""
+        if options['all']:
+            options['test_template_rendering'] = True
+            options['test_template_fallback'] = True
+            options['test_language_selection'] = True
+            options['test_image_urls'] = True
+
+        if not any([
+            options['test_template_rendering'],
+            options['test_template_fallback'],
+            options['test_language_selection'],
+            options['test_image_urls'],
+            options['send_test_email'],
+        ]):
+            raise CommandError(
+                'Please specify at least one test to run. Use --help for options.'
+            )
+
+        # Get user for testing
+        user = self._get_test_user(options.get('username'))
+        if not user:
+            raise CommandError('Could not find test user')
+
+        # Run tests
+        if options['test_template_rendering']:
+            self._test_template_rendering(user)
+
+        if options['test_template_fallback']:
+            self._test_template_fallback()
+
+        if options['test_language_selection']:
+            self._test_language_selection(user)
+
+        if options['test_image_urls']:
+            self._test_image_urls()
+
+        if options['send_test_email']:
+            self._test_send_email(user, options['test_email_to'])
+
+        self.stdout.write(
+            self.style.SUCCESS('✓ All tests completed successfully')
+        )
+
+    def _get_test_user(self, username=None):
+        """Get test user."""
+        try:
+            if username:
+                user = User.objects.get(username=username)
+            else:
+                user = User.objects.filter(is_staff=True, is_superuser=True).first()
+                if not user:
+                    user = User.objects.filter(is_staff=True).first()
+                if not user:
+                    user = User.objects.first()
+            return user
+        except User.DoesNotExist:
+            return None
+
+    def _test_template_rendering(self, user):
+        """Test template rendering for English and Spanish."""
+        self.stdout.write('\n' + '=' * 60)
+        self.stdout.write('TEST: Template Rendering')
+        self.stdout.write('=' * 60)
+
+        for language in ['en', 'es']:
+            try:
+                site = Site.objects.get_current()
+                with emulate_http_request(site=site, user=user):
+                    template_path = f'emails/enrollment_{language}.html'
+                    context = {
+                        'course_name': 'Test Course',
+                        'course_url': 'https://example.com/courses',
+                        'course_run_key': 'course-v1:test+course+2024',
+                        'platform_name': 'Test Platform',
+                    }
+                    html_body = render_to_string(template_path, context)
+
+                    if html_body and len(html_body) > 100:
+                        self.stdout.write(
+                            self.style.SUCCESS(
+                                f'✓ {language.upper()} template rendered ({len(html_body)} bytes)'
+                            )
+                        )
+                    else:
+                        self.stdout.write(
+                            self.style.WARNING(
+                                f'⚠ {language.upper()} template rendered but seems empty'
+                            )
+                        )
+            except Exception as exc:  # pylint: disable=broad-exception-caught
+                self.stdout.write(
+                    self.style.ERROR(f'✗ {language.upper()} template rendering failed: {exc}')
+                )
+
+    def _test_template_fallback(self):
+        """Test template fallback resolution."""
+        self.stdout.write('\n' + '=' * 60)
+        self.stdout.write('TEST: Template Fallback Resolution')
+        self.stdout.write('=' * 60)
+
+        # Note: This would require testing with actual theme overrides
+        self.stdout.write(
+            '✓ Template resolution uses emulate_http_request context (like account activation)'
+        )
+        self.stdout.write(
+            '✓ Will fallback from edx-themes to edx-platform automatically'
+        )
+        self.stdout.write(
+            '  Verify by checking: '
+            'edx-themes/edx-platform/edx.org-next/lms/templates/emails/enrollment_en.html'
+        )
+
+    def _test_language_selection(self, user):
+        """Test language-based template selection."""
+        self.stdout.write('\n' + '=' * 60)
+        self.stdout.write('TEST: Language-Based Template Selection')
+        self.stdout.write('=' * 60)
+
+        # Test default (English)
+        UserPreference.objects.filter(user=user, key=LANGUAGE_KEY).delete()
+        lang = _get_enrollment_email_language(user)
+        if lang == 'en':
+            self.stdout.write(
+                self.style.SUCCESS('✓ Default language is English')
+            )
+        else:
+            self.stdout.write(
+                self.style.ERROR(f'✗ Expected English, got {lang}')
+            )
+
+        # Test Spanish preference
+        UserPreference.objects.update_or_create(
+            user=user,
+            key=LANGUAGE_KEY,
+            defaults={'value': 'es-MX'},
+        )
+        lang = _get_enrollment_email_language(user)
+        if lang == 'es':
+            self.stdout.write(
+                self.style.SUCCESS('✓ Spanish language selected correctly')
+            )
+        else:
+            self.stdout.write(
+                self.style.ERROR(f'✗ Expected Spanish, got {lang}')
+            )
+
+        # Reset
+        UserPreference.objects.filter(user=user, key=LANGUAGE_KEY).delete()
+
+    def _test_image_urls(self):
+        """Test image URL building."""
+        self.stdout.write('\n' + '=' * 60)
+        self.stdout.write('TEST: Image URL Building')
+        self.stdout.write('=' * 60)
+
+        for language in ['en', 'es']:
+            try:
+                urls = _build_enrollment_email_image_urls(language)
+                if urls and len(urls) > 0:
+                    self.stdout.write(
+                        self.style.SUCCESS(
+                            f'✓ {language.upper()} image URLs built ({len(urls)} images)'
+                        )
+                    )
+                    # Show a sample URL
+                    first_key = next(iter(urls.keys()))
+                    self.stdout.write(f'  Sample: {first_key} = {urls[first_key][:80]}...')
+                else:
+                    self.stdout.write(
+                        self.style.WARNING(f'⚠ No image URLs generated for {language.upper()}')
+                    )
+            except Exception as exc:  # pylint: disable=broad-exception-caught
+                self.stdout.write(
+                    self.style.ERROR(f'✗ Image URL generation failed for {language.upper()}: {exc}')
+                )
+
+    def _test_send_email(self, user, test_email_to):
+        """Test sending email via SES."""
+        self.stdout.write('\n' + '=' * 60)
+        self.stdout.write('TEST: Email Sending')
+        self.stdout.write('=' * 60)
+
+        try:
+            self.stdout.write(f'Sending test email to: {test_email_to}')
+
+            # Build test context
+            context = {
+                'course_name': 'Test Course (SES Migration)',
+                'course_url': 'https://example.com/courses/test',
+                'course_run_key': 'course-v1:test+course+2024',
+                'platform_name': configuration_helpers.get_value('platform_name', 'edX'),
+                'support_email': 'support@example.com',
+                'user_email': test_email_to,
+            }
+
+            # Add image URLs for SES
+            image_urls = _build_enrollment_email_image_urls('en')
+            context.update(image_urls)
+
+            # Render template
+            site = Site.objects.get_current()
+            with emulate_http_request(site=site, user=user):
+                template_path = 'emails/enrollment_en.html'
+                html_body = render_to_string(template_path, context)
+
+            # Send via Django email (this requires EMAIL_BACKEND to be configured)
+            from django.core.mail import EmailMultiAlternatives
+            subject = f'You are now enrolled in {context["course_name"]}'
+            text_body = f'You have been enrolled in {context["course_name"]}'
+
+            msg = EmailMultiAlternatives(
+                subject=subject,
+                body=text_body,
+                from_email=configuration_helpers.get_value('email_from_address', 'noreply@example.com'),
+                to=[test_email_to],
+            )
+            msg.attach_alternative(html_body, 'text/html')
+
+            sent = msg.send(fail_silently=False)
+
+            if sent:
+                self.stdout.write(
+                    self.style.SUCCESS(
+                        f'✓ Test email sent successfully to {test_email_to}'
+                    )
+                )
+                self.stdout.write(
+                    'Check the email client for:  '
+                    '- Correct template rendering (layout, images, text)'
+                    '- Language-specific content (if Spanish template)'
+                )
+            else:
+                self.stdout.write(
+                    self.style.WARNING('⚠ Email may not have been sent (send returned 0)')
+                )
+        except Exception as exc:  # pylint: disable=broad-exception-caught
+            self.stdout.write(
+                self.style.ERROR(f'✗ Email sending failed: {exc}')
+            )
+            import traceback
+            self.stdout.write(traceback.format_exc())